diff --git a/docs/api/_category_.json b/docs/api/_category_.json deleted file mode 100644 index 07569f1..0000000 --- a/docs/api/_category_.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "label": "API Documentation", - "position": 7 -} diff --git a/docs/api/verida-js/.nojekyll b/docs/api/verida-js/.nojekyll deleted file mode 100644 index e2ac661..0000000 --- a/docs/api/verida-js/.nojekyll +++ /dev/null @@ -1 +0,0 @@ -TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false. \ No newline at end of file diff --git a/docs/api/verida-js/README.md b/docs/api/verida-js/README.md deleted file mode 100644 index be83be9..0000000 --- a/docs/api/verida-js/README.md +++ /dev/null @@ -1,70 +0,0 @@ -root / [Modules](modules.md) - -# Verida Javascript Library - -This monorepo contains [Verida Client Library](https://github.com/verida/verida-js/tree/main/packages/verida-ts) and a variety of utility packages that support that library. - -There is a React Native repository that maintains a slightly modified version of the `Verida Client Library` that is used to generate the [@verida/client-rn](https://github.com/verida/client-rn) package. - -## Packages - -These are the main packages you are likely to use: - -- [client-ts](https://github.com/verida/verida-js/tree/main/packages/client-ts): Verida client library. Install this library in your project to add support for the Verida protocol. -- [account-web-vault](https://github.com/verida/verida-js/tree/main/packages/account-web-vault): Create a Verida network connection that uses a QR code and the Verida Vault to sign authentication requests. Use this for your web application. -- [account-node](https://github.com/verida/verida-js/tree/main/packages/account-node): Create an instance of a Verida account using a private key or seed phrase. Automatically signs all authentication requests. Use this for NodeJS server side applications or React Native applications. - -These are helper packages that typically aren't used directly: - -- [account](https://github.com/verida/verida-js/tree/main/packages/account): Common code shared amongst the various `account-xxx` implementations -- [encryption-utils](https://github.com/verida/verida-js/encryption-utils): Encryption utilities to make using `tweetnacl` a bit easier -- [keyring](https://github.com/verida/verida-js/tree/main/packages/keyring): Keyring for managing asym, sym and signing keys for a given account context -- [storage-link](https://github.com/verida/verida-js/tree/main/packages/storage-link): Utilities to help linking storage endpoint information to a Verida account - -## Developer Notes - -### Node Version - -This requires **node v14.17.1** to build. We use [nvm](https://github.com/nvm-sh/nvm) to manage this: - -``` -nvm install v14.17.1 -nvm use v14.17.1 -``` - -### Linking dependencies - -It's not possible to add dependencies between monorepo packages using yarn (ie: `yarn add @verida/encryption-utils`) if that package hasn't been published to `npm`. - -Unpublished dependencies between monorepo packages can be linked by: - -- Manually adding the expected dependency to `package.json` (ie: `@verida/encryption-utils`) -- Run `npx lerna bootstrap` in the root directory of this project - -### Building - -Build everything: - -In the root directory: - -``` -npx lerna bootstrap -npx lerna run build -``` - -To build a specific package: - -* `cd package/package-name` -* `yarn` -* `yarn build` - -## Creating a release - -Update all the CHANGELOG.md files in each package to include entries for all the changes made since the last release. - -``` -$ npx lerna run build -$ npx lerna publish --dist-tag next -``` - -Use tag `next` for an upcoming release or `latest` for the latest version. diff --git a/docs/api/verida-js/classes/verida_account.Account.md b/docs/api/verida-js/classes/verida_account.Account.md deleted file mode 100644 index 4f1d8e2..0000000 --- a/docs/api/verida-js/classes/verida_account.Account.md +++ /dev/null @@ -1,346 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account](../modules/verida_account.md) / Account - -# Class: Account - -[@verida/account](../modules/verida_account.md).Account - -An Authenticator that automatically signs everything - -## Implements - -- [`IAccount`](../interfaces/verida_account._internal_.IAccount.md) - -## Table of contents - -### Constructors - -- [constructor](verida_account.Account.md#constructor) - -### Methods - -- [createDidJwt](verida_account.Account.md#createdidjwt) -- [did](verida_account.Account.md#did) -- [disconnect](verida_account.Account.md#disconnect) -- [disconnectDevice](verida_account.Account.md#disconnectdevice) -- [getAuthContext](verida_account.Account.md#getauthcontext) -- [keyring](verida_account.Account.md#keyring) -- [linkStorage](verida_account.Account.md#linkstorage) -- [linkStorageContextService](verida_account.Account.md#linkstoragecontextservice) -- [setAccountConfig](verida_account.Account.md#setaccountconfig) -- [sign](verida_account.Account.md#sign) -- [storageConfig](verida_account.Account.md#storageconfig) -- [unlinkStorage](verida_account.Account.md#unlinkstorage) - -## Constructors - -### constructor - -• **new Account**() - -## Methods - -### createDidJwt - -▸ **createDidJwt**(`contextName`, `data`, `config?`): `Promise`<`string`\> - -Create a DID-JWT from a data object - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | -| `data` | `object` | -| `config` | `any` | - -#### Returns - -`Promise`<`string`\> - -#### Implementation of - -[IAccount](../interfaces/verida_account._internal_.IAccount.md).[createDidJwt](../interfaces/verida_account._internal_.IAccount.md#createdidjwt) - -#### Defined in - -[packages/account/src/account.ts:71](https://github.com/verida/verida-js/blob/5040472/packages/account/src/account.ts#L71) - -___ - -### did - -▸ **did**(): `Promise`<`string`\> - -Get the DID of the current user - -#### Returns - -`Promise`<`string`\> - -#### Implementation of - -[IAccount](../interfaces/verida_account._internal_.IAccount.md).[did](../interfaces/verida_account._internal_.IAccount.md#did) - -#### Defined in - -[packages/account/src/account.ts:33](https://github.com/verida/verida-js/blob/5040472/packages/account/src/account.ts#L33) - -___ - -### disconnect - -▸ **disconnect**(`contextName?`): `Promise`<`void`\> - -An optional method that can be used to disconnect the current user. - -For example, in a web browser context, it would remove any stored signatures from local storage. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName?` | `string` | - -#### Returns - -`Promise`<`void`\> - -#### Implementation of - -[IAccount](../interfaces/verida_account._internal_.IAccount.md).[disconnect](../interfaces/verida_account._internal_.IAccount.md#disconnect) - -#### Defined in - -[packages/account/src/account.ts:102](https://github.com/verida/verida-js/blob/5040472/packages/account/src/account.ts#L102) - -___ - -### disconnectDevice - -▸ **disconnectDevice**(`contextName`, `deviceId?`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `contextName` | `string` | `undefined` | -| `deviceId` | `string` | `"Test device"` | - -#### Returns - -`Promise`<`boolean`\> - -#### Implementation of - -[IAccount](../interfaces/verida_account._internal_.IAccount.md).[disconnectDevice](../interfaces/verida_account._internal_.IAccount.md#disconnectdevice) - -#### Defined in - -[packages/account/src/account.ts:112](https://github.com/verida/verida-js/blob/5040472/packages/account/src/account.ts#L112) - -___ - -### getAuthContext - -▸ **getAuthContext**(`contextName`, `contextConfig`, `authConfig?`, `authType?`): `Promise`<[`AuthContext`](../interfaces/verida_account._internal_.AuthContext.md)\> - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `contextName` | `string` | `undefined` | -| `contextConfig` | [`SecureContextConfig`](../interfaces/verida_account._internal_.SecureContextConfig.md) | `undefined` | -| `authConfig` | [`AuthTypeConfig`](../interfaces/verida_account._internal_.AuthTypeConfig.md) | `undefined` | -| `authType` | `string` | `"database"` | - -#### Returns - -`Promise`<[`AuthContext`](../interfaces/verida_account._internal_.AuthContext.md)\> - -#### Implementation of - -[IAccount](../interfaces/verida_account._internal_.IAccount.md).[getAuthContext](../interfaces/verida_account._internal_.IAccount.md#getauthcontext) - -#### Defined in - -[packages/account/src/account.ts:106](https://github.com/verida/verida-js/blob/5040472/packages/account/src/account.ts#L106) - -___ - -### keyring - -▸ **keyring**(`contextName`): `Promise`<[`default`](verida_account._internal_.default.md)\> - -Generate a keyring for this user for a given storage context. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | - -#### Returns - -`Promise`<[`default`](verida_account._internal_.default.md)\> - -#### Implementation of - -[IAccount](../interfaces/verida_account._internal_.IAccount.md).[keyring](../interfaces/verida_account._internal_.IAccount.md#keyring) - -#### Defined in - -[packages/account/src/account.ts:17](https://github.com/verida/verida-js/blob/5040472/packages/account/src/account.ts#L17) - -___ - -### linkStorage - -▸ **linkStorage**(`storageConfig`): `Promise`<`boolean`\> - -Link storage to this user - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `storageConfig` | [`SecureContextConfig`](../interfaces/verida_account._internal_.SecureContextConfig.md) | - -#### Returns - -`Promise`<`boolean`\> - -#### Implementation of - -[IAccount](../interfaces/verida_account._internal_.IAccount.md).[linkStorage](../interfaces/verida_account._internal_.IAccount.md#linkstorage) - -#### Defined in - -[packages/account/src/account.ts:42](https://github.com/verida/verida-js/blob/5040472/packages/account/src/account.ts#L42) - -___ - -### linkStorageContextService - -▸ **linkStorageContextService**(`contextName`, `endpointType`, `serverType`, `endpointUris`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | -| `endpointType` | `string` | -| `serverType` | `string` | -| `endpointUris` | `string`[] | - -#### Returns - -`Promise`<`boolean`\> - -#### Implementation of - -[IAccount](../interfaces/verida_account._internal_.IAccount.md).[linkStorageContextService](../interfaces/verida_account._internal_.IAccount.md#linkstoragecontextservice) - -#### Defined in - -[packages/account/src/account.ts:59](https://github.com/verida/verida-js/blob/5040472/packages/account/src/account.ts#L59) - -___ - -### setAccountConfig - -▸ **setAccountConfig**(`accountConfig`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `accountConfig` | [`AccountConfig`](../interfaces/verida_account._internal_.AccountConfig.md) | - -#### Returns - -`void` - -#### Implementation of - -[IAccount](../interfaces/verida_account._internal_.IAccount.md).[setAccountConfig](../interfaces/verida_account._internal_.IAccount.md#setaccountconfig) - -#### Defined in - -[packages/account/src/account.ts:63](https://github.com/verida/verida-js/blob/5040472/packages/account/src/account.ts#L63) - -___ - -### sign - -▸ **sign**(`input`): `Promise`<`string`\> - -Sign a string as the current user - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `input` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Implementation of - -[IAccount](../interfaces/verida_account._internal_.IAccount.md).[sign](../interfaces/verida_account._internal_.IAccount.md#sign) - -#### Defined in - -[packages/account/src/account.ts:26](https://github.com/verida/verida-js/blob/5040472/packages/account/src/account.ts#L26) - -___ - -### storageConfig - -▸ **storageConfig**(`contextName`, `forceCreate?`): `Promise`<`undefined` \| [`SecureContextConfig`](../interfaces/verida_account._internal_.SecureContextConfig.md)\> - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `contextName` | `string` | `undefined` | -| `forceCreate` | `boolean` | `false` | - -#### Returns - -`Promise`<`undefined` \| [`SecureContextConfig`](../interfaces/verida_account._internal_.SecureContextConfig.md)\> - -#### Implementation of - -[IAccount](../interfaces/verida_account._internal_.IAccount.md).[storageConfig](../interfaces/verida_account._internal_.IAccount.md#storageconfig) - -#### Defined in - -[packages/account/src/account.ts:55](https://github.com/verida/verida-js/blob/5040472/packages/account/src/account.ts#L55) - -___ - -### unlinkStorage - -▸ **unlinkStorage**(`contextName`): `Promise`<`boolean`\> - -Unlink storage for this user - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | - -#### Returns - -`Promise`<`boolean`\> - -#### Implementation of - -[IAccount](../interfaces/verida_account._internal_.IAccount.md).[unlinkStorage](../interfaces/verida_account._internal_.IAccount.md#unlinkstorage) - -#### Defined in - -[packages/account/src/account.ts:51](https://github.com/verida/verida-js/blob/5040472/packages/account/src/account.ts#L51) diff --git a/docs/api/verida-js/classes/verida_account.AuthType.md b/docs/api/verida-js/classes/verida_account.AuthType.md deleted file mode 100644 index 72c2338..0000000 --- a/docs/api/verida-js/classes/verida_account.AuthType.md +++ /dev/null @@ -1,154 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account](../modules/verida_account.md) / AuthType - -# Class: AuthType - -[@verida/account](../modules/verida_account.md).AuthType - -## Table of contents - -### Constructors - -- [constructor](verida_account.AuthType.md#constructor) - -### Properties - -- [account](verida_account.AuthType.md#account) -- [contextAuth](verida_account.AuthType.md#contextauth) -- [contextName](verida_account.AuthType.md#contextname) -- [serviceEndpoint](verida_account.AuthType.md#serviceendpoint) -- [signKey](verida_account.AuthType.md#signkey) - -### Methods - -- [disconnectDevice](verida_account.AuthType.md#disconnectdevice) -- [getAuthContext](verida_account.AuthType.md#getauthcontext) -- [setAuthContext](verida_account.AuthType.md#setauthcontext) - -## Constructors - -### constructor - -• **new AuthType**(`account`, `contextName`, `serviceEndpoint`, `signKey`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `account` | [`Account`](verida_account.Account.md) | -| `contextName` | `string` | -| `serviceEndpoint` | [`ServiceEndpoint`](../modules/verida_account._internal_.md#serviceendpoint) | -| `signKey` | [`SecureContextPublicKey`](../interfaces/verida_account._internal_.SecureContextPublicKey.md) | - -#### Defined in - -[packages/account/src/auth-type.ts:13](https://github.com/verida/verida-js/blob/5040472/packages/account/src/auth-type.ts#L13) - -## Properties - -### account - -• `Protected` **account**: [`Account`](verida_account.Account.md) - -#### Defined in - -[packages/account/src/auth-type.ts:8](https://github.com/verida/verida-js/blob/5040472/packages/account/src/auth-type.ts#L8) - -___ - -### contextAuth - -• `Protected` `Optional` **contextAuth**: [`AuthContext`](../interfaces/verida_account._internal_.AuthContext.md) - -#### Defined in - -[packages/account/src/auth-type.ts:7](https://github.com/verida/verida-js/blob/5040472/packages/account/src/auth-type.ts#L7) - -___ - -### contextName - -• `Protected` **contextName**: `string` - -#### Defined in - -[packages/account/src/auth-type.ts:9](https://github.com/verida/verida-js/blob/5040472/packages/account/src/auth-type.ts#L9) - -___ - -### serviceEndpoint - -• `Protected` **serviceEndpoint**: [`ServiceEndpoint`](../modules/verida_account._internal_.md#serviceendpoint) - -#### Defined in - -[packages/account/src/auth-type.ts:10](https://github.com/verida/verida-js/blob/5040472/packages/account/src/auth-type.ts#L10) - -___ - -### signKey - -• `Protected` **signKey**: [`SecureContextPublicKey`](../interfaces/verida_account._internal_.SecureContextPublicKey.md) - -#### Defined in - -[packages/account/src/auth-type.ts:11](https://github.com/verida/verida-js/blob/5040472/packages/account/src/auth-type.ts#L11) - -## Methods - -### disconnectDevice - -▸ **disconnectDevice**(`deviceId?`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `deviceId` | `string` | `"Test device"` | - -#### Returns - -`Promise`<`boolean`\> - -#### Defined in - -[packages/account/src/auth-type.ts:28](https://github.com/verida/verida-js/blob/5040472/packages/account/src/auth-type.ts#L28) - -___ - -### getAuthContext - -▸ **getAuthContext**(`config`): `Promise`<[`AuthContext`](../interfaces/verida_account._internal_.AuthContext.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | [`AuthTypeConfig`](../interfaces/verida_account._internal_.AuthTypeConfig.md) | - -#### Returns - -`Promise`<[`AuthContext`](../interfaces/verida_account._internal_.AuthContext.md)\> - -#### Defined in - -[packages/account/src/auth-type.ts:20](https://github.com/verida/verida-js/blob/5040472/packages/account/src/auth-type.ts#L20) - -___ - -### setAuthContext - -▸ **setAuthContext**(`contextAuth`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextAuth` | [`AuthContext`](../interfaces/verida_account._internal_.AuthContext.md) | - -#### Returns - -`void` - -#### Defined in - -[packages/account/src/auth-type.ts:24](https://github.com/verida/verida-js/blob/5040472/packages/account/src/auth-type.ts#L24) diff --git a/docs/api/verida-js/classes/verida_account._internal_.default.md b/docs/api/verida-js/classes/verida_account._internal_.default.md deleted file mode 100644 index 53de838..0000000 --- a/docs/api/verida-js/classes/verida_account._internal_.default.md +++ /dev/null @@ -1,423 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account](../modules/verida_account.md) / [](../modules/verida_account._internal_.md) / default - -# Class: default - -[@verida/account](../modules/verida_account.md).[](../modules/verida_account._internal_.md).default - -Class that takes a signature (generated from a signed consent message) and generates a -collection of asymmetric keys, symmetric key and signing key for a given secure storage -context. - -## Implements - -- [`IKeyring`](../interfaces/verida_account._internal_.IKeyring.md) - -## Table of contents - -### Constructors - -- [constructor](verida_account._internal_.default.md#constructor) - -### Properties - -- [asymKeyPair](verida_account._internal_.default.md#asymkeypair) -- [buildKey](verida_account._internal_.default.md#buildkey) -- [seed](verida_account._internal_.default.md#seed) -- [signKeyPair](verida_account._internal_.default.md#signkeypair) -- [storageContextKeys](verida_account._internal_.default.md#storagecontextkeys) -- [symKey](verida_account._internal_.default.md#symkey) - -### Methods - -- [\_init](verida_account._internal_.default.md#_init) -- [asymDecrypt](verida_account._internal_.default.md#asymdecrypt) -- [asymEncrypt](verida_account._internal_.default.md#asymencrypt) -- [buildSharedKeyEnd](verida_account._internal_.default.md#buildsharedkeyend) -- [buildSharedKeyStart](verida_account._internal_.default.md#buildsharedkeystart) -- [getKeys](verida_account._internal_.default.md#getkeys) -- [getSeed](verida_account._internal_.default.md#getseed) -- [getStorageContextKey](verida_account._internal_.default.md#getstoragecontextkey) -- [publicKeys](verida_account._internal_.default.md#publickeys) -- [sign](verida_account._internal_.default.md#sign) -- [symDecrypt](verida_account._internal_.default.md#symdecrypt) -- [symEncrypt](verida_account._internal_.default.md#symencrypt) -- [verifySig](verida_account._internal_.default.md#verifysig) - -## Constructors - -### constructor - -• **new default**(`seed`) - -A string used as a seed for this keyring. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `seed` | `string` | - -#### Defined in - -packages/keyring/dist/keyring.d.ts:19 - -## Properties - -### asymKeyPair - -• `Optional` **asymKeyPair**: `any` - -#### Defined in - -packages/keyring/dist/keyring.d.ts:9 - -___ - -### buildKey - -• `Private` **buildKey**: `any` - -Helper function that generates a key of the appropriate type - -**`param`** - -**`param`** - -**`returns`** - -#### Defined in - -packages/keyring/dist/keyring.d.ts:29 - -___ - -### seed - -• `Private` **seed**: `any` - -#### Defined in - -packages/keyring/dist/keyring.d.ts:12 - -___ - -### signKeyPair - -• `Optional` **signKeyPair**: `any` - -#### Defined in - -packages/keyring/dist/keyring.d.ts:10 - -___ - -### storageContextKeys - -• `Private` **storageContextKeys**: `any` - -#### Defined in - -packages/keyring/dist/keyring.d.ts:13 - -___ - -### symKey - -• `Optional` **symKey**: `Uint8Array` - -#### Defined in - -packages/keyring/dist/keyring.d.ts:11 - -## Methods - -### \_init - -▸ **_init**(): `Promise`<`void`\> - -#### Returns - -`Promise`<`void`\> - -#### Implementation of - -[IKeyring](../interfaces/verida_account._internal_.IKeyring.md).[_init](../interfaces/verida_account._internal_.IKeyring.md#_init) - -#### Defined in - -packages/keyring/dist/keyring.d.ts:21 - -___ - -### asymDecrypt - -▸ **asymDecrypt**(`messageWithNonce`, `secretOrSharedKey`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `messageWithNonce` | `string` | -| `secretOrSharedKey` | `Uint8Array` | - -#### Returns - -`Promise`<`any`\> - -#### Implementation of - -[IKeyring](../interfaces/verida_account._internal_.IKeyring.md).[asymDecrypt](../interfaces/verida_account._internal_.IKeyring.md#asymdecrypt) - -#### Defined in - -packages/keyring/dist/keyring.d.ts:41 - -___ - -### asymEncrypt - -▸ **asymEncrypt**(`data`, `secretOrSharedKey`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `string` | -| `secretOrSharedKey` | `Uint8Array` | - -#### Returns - -`Promise`<`string`\> - -#### Implementation of - -[IKeyring](../interfaces/verida_account._internal_.IKeyring.md).[asymEncrypt](../interfaces/verida_account._internal_.IKeyring.md#asymencrypt) - -#### Defined in - -packages/keyring/dist/keyring.d.ts:40 - -___ - -### buildSharedKeyEnd - -▸ **buildSharedKeyEnd**(`publicKey`): `Promise`<`Uint8Array`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `publicKey` | `Uint8Array` | - -#### Returns - -`Promise`<`Uint8Array`\> - -#### Implementation of - -[IKeyring](../interfaces/verida_account._internal_.IKeyring.md).[buildSharedKeyEnd](../interfaces/verida_account._internal_.IKeyring.md#buildsharedkeyend) - -#### Defined in - -packages/keyring/dist/keyring.d.ts:43 - -___ - -### buildSharedKeyStart - -▸ **buildSharedKeyStart**(`privateKey`): `Promise`<`Uint8Array`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `privateKey` | `Uint8Array` | - -#### Returns - -`Promise`<`Uint8Array`\> - -#### Implementation of - -[IKeyring](../interfaces/verida_account._internal_.IKeyring.md).[buildSharedKeyStart](../interfaces/verida_account._internal_.IKeyring.md#buildsharedkeystart) - -#### Defined in - -packages/keyring/dist/keyring.d.ts:42 - -___ - -### getKeys - -▸ **getKeys**(): `Promise`<`any`\> - -#### Returns - -`Promise`<`any`\> - -#### Implementation of - -[IKeyring](../interfaces/verida_account._internal_.IKeyring.md).[getKeys](../interfaces/verida_account._internal_.IKeyring.md#getkeys) - -#### Defined in - -packages/keyring/dist/keyring.d.ts:20 - -___ - -### getSeed - -▸ **getSeed**(): `string` - -#### Returns - -`string` - -#### Implementation of - -[IKeyring](../interfaces/verida_account._internal_.IKeyring.md).[getSeed](../interfaces/verida_account._internal_.IKeyring.md#getseed) - -#### Defined in - -packages/keyring/dist/keyring.d.ts:44 - -___ - -### getStorageContextKey - -▸ **getStorageContextKey**(`databaseName`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `databaseName` | `string` | - -#### Returns - -`Promise`<`any`\> - -#### Implementation of - -[IKeyring](../interfaces/verida_account._internal_.IKeyring.md).[getStorageContextKey](../interfaces/verida_account._internal_.IKeyring.md#getstoragecontextkey) - -#### Defined in - -packages/keyring/dist/keyring.d.ts:45 - -___ - -### publicKeys - -▸ **publicKeys**(): `Promise`<[`KeyringPublicKeys`](../interfaces/verida_account._internal_.KeyringPublicKeys.md)\> - -Generate an object containing all the public keys for this Keyring - -#### Returns - -`Promise`<[`KeyringPublicKeys`](../interfaces/verida_account._internal_.KeyringPublicKeys.md)\> - -#### Implementation of - -[IKeyring](../interfaces/verida_account._internal_.IKeyring.md).[publicKeys](../interfaces/verida_account._internal_.IKeyring.md#publickeys) - -#### Defined in - -packages/keyring/dist/keyring.d.ts:35 - -___ - -### sign - -▸ **sign**(`data`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `any` | - -#### Returns - -`Promise`<`string`\> - -#### Implementation of - -[IKeyring](../interfaces/verida_account._internal_.IKeyring.md).[sign](../interfaces/verida_account._internal_.IKeyring.md#sign) - -#### Defined in - -packages/keyring/dist/keyring.d.ts:36 - -___ - -### symDecrypt - -▸ **symDecrypt**(`data`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `string` | - -#### Returns - -`Promise`<`any`\> - -#### Implementation of - -[IKeyring](../interfaces/verida_account._internal_.IKeyring.md).[symDecrypt](../interfaces/verida_account._internal_.IKeyring.md#symdecrypt) - -#### Defined in - -packages/keyring/dist/keyring.d.ts:39 - -___ - -### symEncrypt - -▸ **symEncrypt**(`data`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Implementation of - -[IKeyring](../interfaces/verida_account._internal_.IKeyring.md).[symEncrypt](../interfaces/verida_account._internal_.IKeyring.md#symencrypt) - -#### Defined in - -packages/keyring/dist/keyring.d.ts:38 - -___ - -### verifySig - -▸ **verifySig**(`data`, `sig`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `string` | -| `sig` | `string` | - -#### Returns - -`Promise`<`boolean`\> - -#### Implementation of - -[IKeyring](../interfaces/verida_account._internal_.IKeyring.md).[verifySig](../interfaces/verida_account._internal_.IKeyring.md#verifysig) - -#### Defined in - -packages/keyring/dist/keyring.d.ts:37 diff --git a/docs/api/verida-js/classes/verida_account_node.AuthContextAccount.md b/docs/api/verida-js/classes/verida_account_node.AuthContextAccount.md deleted file mode 100644 index 5031904..0000000 --- a/docs/api/verida-js/classes/verida_account_node.AuthContextAccount.md +++ /dev/null @@ -1,523 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account-node](../modules/verida_account_node.md) / AuthContextAccount - -# Class: AuthContextAccount - -[@verida/account-node](../modules/verida_account_node.md).AuthContextAccount - -A NodeJs account that only signs messages for a limited list of contexts. - -Used for testing. - -## Hierarchy - -- [`LimitedAccount`](verida_account_node.LimitedAccount.md) - - ↳ **`AuthContextAccount`** - -## Table of contents - -### Constructors - -- [constructor](verida_account_node.AuthContextAccount.md#constructor) - -### Properties - -- [accountConfig](verida_account_node.AuthContextAccount.md#accountconfig) -- [autoConfig](verida_account_node.AuthContextAccount.md#autoconfig) -- [contextAuths](verida_account_node.AuthContextAccount.md#contextauths) -- [defaultNodes](verida_account_node.AuthContextAccount.md#defaultnodes) - -### Methods - -- [createDidJwt](verida_account_node.AuthContextAccount.md#createdidjwt) -- [did](verida_account_node.AuthContextAccount.md#did) -- [disconnect](verida_account_node.AuthContextAccount.md#disconnect) -- [disconnectDevice](verida_account_node.AuthContextAccount.md#disconnectdevice) -- [getAccountConfig](verida_account_node.AuthContextAccount.md#getaccountconfig) -- [getAuthContext](verida_account_node.AuthContextAccount.md#getauthcontext) -- [getDIDClient](verida_account_node.AuthContextAccount.md#getdidclient) -- [getDidClient](verida_account_node.AuthContextAccount.md#getdidclient) -- [keyring](verida_account_node.AuthContextAccount.md#keyring) -- [linkStorage](verida_account_node.AuthContextAccount.md#linkstorage) -- [linkStorageContextService](verida_account_node.AuthContextAccount.md#linkstoragecontextservice) -- [loadDefaultStorageNodes](verida_account_node.AuthContextAccount.md#loaddefaultstoragenodes) -- [setAccountConfig](verida_account_node.AuthContextAccount.md#setaccountconfig) -- [sign](verida_account_node.AuthContextAccount.md#sign) -- [storageConfig](verida_account_node.AuthContextAccount.md#storageconfig) -- [unlinkStorage](verida_account_node.AuthContextAccount.md#unlinkstorage) - -## Constructors - -### constructor - -• **new AuthContextAccount**(`autoConfig`, `signingContext`, `authContext`, `accountConfig?`) - -This will need to be refactored when more db engines are supported. - -We are assuming we are dealing with a Verida Database Auth Context and then injecting -a known context object into the in memory database. - -This is used for testing, by setting invalid access / request tokens in unit tests - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `autoConfig` | [`AccountNodeConfig`](../interfaces/verida_account_node._internal_.AccountNodeConfig.md) | -| `signingContext` | `string` | -| `authContext` | [`VeridaDatabaseAuthContext`](../interfaces/verida_account_node._internal_.VeridaDatabaseAuthContext.md) | -| `accountConfig?` | [`AccountConfig`](../interfaces/verida_account_node._internal_.AccountConfig.md) | - -#### Overrides - -[LimitedAccount](verida_account_node.LimitedAccount.md).[constructor](verida_account_node.LimitedAccount.md#constructor) - -#### Defined in - -[packages/account-node/src/authcontext.ts:25](https://github.com/verida/verida-js/blob/5040472/packages/account-node/src/authcontext.ts#L25) - -## Properties - -### accountConfig - -• `Protected` `Optional` **accountConfig**: [`AccountConfig`](../interfaces/verida_account_node._internal_.AccountConfig.md) - -#### Inherited from - -[LimitedAccount](verida_account_node.LimitedAccount.md).[accountConfig](verida_account_node.LimitedAccount.md#accountconfig) - -#### Defined in - -[packages/account-node/src/auto.ts:20](https://github.com/verida/verida-js/blob/5040472/packages/account-node/src/auto.ts#L20) - -___ - -### autoConfig - -• `Protected` **autoConfig**: [`AccountNodeConfig`](../interfaces/verida_account_node._internal_.AccountNodeConfig.md) - -#### Inherited from - -[LimitedAccount](verida_account_node.LimitedAccount.md).[autoConfig](verida_account_node.LimitedAccount.md#autoconfig) - -#### Defined in - -[packages/account-node/src/auto.ts:21](https://github.com/verida/verida-js/blob/5040472/packages/account-node/src/auto.ts#L21) - -___ - -### contextAuths - -• `Protected` **contextAuths**: [`Record`](../modules/verida_account_node._internal_.md#record)<`string`, [`Record`](../modules/verida_account_node._internal_.md#record)<`string`, [`VeridaDatabaseAuthType`](verida_account_node.VeridaDatabaseAuthType.md)\>\> = `{}` - -#### Inherited from - -[LimitedAccount](verida_account_node.LimitedAccount.md).[contextAuths](verida_account_node.LimitedAccount.md#contextauths) - -#### Defined in - -[packages/account-node/src/auto.ts:22](https://github.com/verida/verida-js/blob/5040472/packages/account-node/src/auto.ts#L22) - -___ - -### defaultNodes - -• `Protected` **defaultNodes**: `string`[] = `[]` - -#### Inherited from - -[LimitedAccount](verida_account_node.LimitedAccount.md).[defaultNodes](verida_account_node.LimitedAccount.md#defaultnodes) - -#### Defined in - -[packages/account-node/src/auto.ts:23](https://github.com/verida/verida-js/blob/5040472/packages/account-node/src/auto.ts#L23) - -## Methods - -### createDidJwt - -▸ **createDidJwt**(`contextName`, `data`, `config?`): `Promise`<`string`\> - -Create a DID-JWT from a data object - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | -| `data` | `object` | -| `config?` | `any` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[LimitedAccount](verida_account_node.LimitedAccount.md).[createDidJwt](verida_account_node.LimitedAccount.md#createdidjwt) - -#### Defined in - -packages/account/dist/account.d.ts:42 - -___ - -### did - -▸ **did**(): `Promise`<`string`\> - -Get the DID of the current user - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[LimitedAccount](verida_account_node.LimitedAccount.md).[did](verida_account_node.LimitedAccount.md#did) - -#### Defined in - -[packages/account-node/src/auto.ts:62](https://github.com/verida/verida-js/blob/5040472/packages/account-node/src/auto.ts#L62) - -___ - -### disconnect - -▸ **disconnect**(`contextName?`): `Promise`<`void`\> - -An optional method that can be used to disconnect the current user. - -For example, in a web browser context, it would remove any stored signatures from local storage. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName?` | `string` | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[LimitedAccount](verida_account_node.LimitedAccount.md).[disconnect](verida_account_node.LimitedAccount.md#disconnect) - -#### Defined in - -packages/account/dist/account.d.ts:48 - -___ - -### disconnectDevice - -▸ **disconnectDevice**(`contextName`, `deviceId?`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `contextName` | `string` | `undefined` | -| `deviceId` | `string` | `"Test device"` | - -#### Returns - -`Promise`<`boolean`\> - -#### Inherited from - -[LimitedAccount](verida_account_node.LimitedAccount.md).[disconnectDevice](verida_account_node.LimitedAccount.md#disconnectdevice) - -#### Defined in - -[packages/account-node/src/auto.ts:234](https://github.com/verida/verida-js/blob/5040472/packages/account-node/src/auto.ts#L234) - -___ - -### getAccountConfig - -▸ **getAccountConfig**(): `undefined` \| [`AccountConfig`](../interfaces/verida_account_node._internal_.AccountConfig.md) - -#### Returns - -`undefined` \| [`AccountConfig`](../interfaces/verida_account_node._internal_.AccountConfig.md) - -#### Inherited from - -[LimitedAccount](verida_account_node.LimitedAccount.md).[getAccountConfig](verida_account_node.LimitedAccount.md#getaccountconfig) - -#### Defined in - -[packages/account-node/src/auto.ts:45](https://github.com/verida/verida-js/blob/5040472/packages/account-node/src/auto.ts#L45) - -___ - -### getAuthContext - -▸ **getAuthContext**(`contextName`, `contextConfig`, `authConfig`, `authType?`): `Promise`<[`AuthContext`](../interfaces/verida_account_node._internal_.AuthContext.md)\> - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `contextName` | `string` | `undefined` | -| `contextConfig` | [`SecureContextConfig`](../interfaces/verida_account_node._internal_.SecureContextConfig.md) | `undefined` | -| `authConfig` | [`AuthTypeConfig`](../interfaces/verida_account_node._internal_.AuthTypeConfig.md) | `undefined` | -| `authType` | `string` | `"database"` | - -#### Returns - -`Promise`<[`AuthContext`](../interfaces/verida_account_node._internal_.AuthContext.md)\> - -#### Overrides - -[LimitedAccount](verida_account_node.LimitedAccount.md).[getAuthContext](verida_account_node.LimitedAccount.md#getauthcontext) - -#### Defined in - -[packages/account-node/src/authcontext.ts:41](https://github.com/verida/verida-js/blob/5040472/packages/account-node/src/authcontext.ts#L41) - -___ - -### getDIDClient - -▸ **getDIDClient**(): [`DIDClient`](verida_account_node._internal_.DIDClient.md) - -#### Returns - -[`DIDClient`](verida_account_node._internal_.DIDClient.md) - -#### Inherited from - -[LimitedAccount](verida_account_node.LimitedAccount.md).[getDIDClient](verida_account_node.LimitedAccount.md#getdidclient) - -#### Defined in - -[packages/account-node/src/auto.ts:37](https://github.com/verida/verida-js/blob/5040472/packages/account-node/src/auto.ts#L37) - -___ - -### getDidClient - -▸ **getDidClient**(): `Promise`<[`DIDClient`](verida_account_node._internal_.DIDClient.md)\> - -#### Returns - -`Promise`<[`DIDClient`](verida_account_node._internal_.DIDClient.md)\> - -#### Inherited from - -[LimitedAccount](verida_account_node.LimitedAccount.md).[getDidClient](verida_account_node.LimitedAccount.md#getdidclient) - -#### Defined in - -[packages/account-node/src/auto.ts:194](https://github.com/verida/verida-js/blob/5040472/packages/account-node/src/auto.ts#L194) - -___ - -### keyring - -▸ **keyring**(`contextName`): `Promise`<[`default`](verida_account_node._internal_.default-2.md)\> - -Generate a keyring for this user for a given storage context. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | - -#### Returns - -`Promise`<[`default`](verida_account_node._internal_.default-2.md)\> - -#### Inherited from - -[LimitedAccount](verida_account_node.LimitedAccount.md).[keyring](verida_account_node.LimitedAccount.md#keyring) - -#### Defined in - -[packages/account-node/src/limited.ts:19](https://github.com/verida/verida-js/blob/5040472/packages/account-node/src/limited.ts#L19) - -___ - -### linkStorage - -▸ **linkStorage**(`storageConfig`): `Promise`<`boolean`\> - -Link storage to this user - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `storageConfig` | [`SecureContextConfig`](../interfaces/verida_account_node._internal_.SecureContextConfig.md) | - -#### Returns - -`Promise`<`boolean`\> - -#### Inherited from - -[LimitedAccount](verida_account_node.LimitedAccount.md).[linkStorage](verida_account_node.LimitedAccount.md#linkstorage) - -#### Defined in - -[packages/account-node/src/auto.ts:138](https://github.com/verida/verida-js/blob/5040472/packages/account-node/src/auto.ts#L138) - -___ - -### linkStorageContextService - -▸ **linkStorageContextService**(`contextName`, `endpointType`, `serverType`, `endpointUris`): `Promise`<`boolean`\> - -Link storage context service endpoint - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | -| `endpointType` | [`SecureContextEndpointType`](../enums/verida_account_node._internal_.SecureContextEndpointType.md) | -| `serverType` | `string` | -| `endpointUris` | `string`[] | - -#### Returns - -`Promise`<`boolean`\> - -#### Inherited from - -[LimitedAccount](verida_account_node.LimitedAccount.md).[linkStorageContextService](verida_account_node.LimitedAccount.md#linkstoragecontextservice) - -#### Defined in - -[packages/account-node/src/auto.ts:180](https://github.com/verida/verida-js/blob/5040472/packages/account-node/src/auto.ts#L180) - -___ - -### loadDefaultStorageNodes - -▸ **loadDefaultStorageNodes**(`countryCode?`, `numNodes?`, `config?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `countryCode?` | `string` | `undefined` | -| `numNodes` | `number` | `3` | -| `config` | [`NodeSelectorParams`](../interfaces/verida_account_node.NodeSelectorParams.md) | `{}` | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[LimitedAccount](verida_account_node.LimitedAccount.md).[loadDefaultStorageNodes](verida_account_node.LimitedAccount.md#loaddefaultstoragenodes) - -#### Defined in - -[packages/account-node/src/auto.ts:66](https://github.com/verida/verida-js/blob/5040472/packages/account-node/src/auto.ts#L66) - -___ - -### setAccountConfig - -▸ **setAccountConfig**(`accountConfig`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `accountConfig` | [`AccountConfig`](../interfaces/verida_account_node._internal_.AccountConfig.md) | - -#### Returns - -`void` - -#### Inherited from - -[LimitedAccount](verida_account_node.LimitedAccount.md).[setAccountConfig](verida_account_node.LimitedAccount.md#setaccountconfig) - -#### Defined in - -[packages/account-node/src/auto.ts:41](https://github.com/verida/verida-js/blob/5040472/packages/account-node/src/auto.ts#L41) - -___ - -### sign - -▸ **sign**(`message`): `Promise`<`string`\> - -Sign a string as the current user - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `message` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[LimitedAccount](verida_account_node.LimitedAccount.md).[sign](verida_account_node.LimitedAccount.md#sign) - -#### Defined in - -[packages/account-node/src/auto.ts:58](https://github.com/verida/verida-js/blob/5040472/packages/account-node/src/auto.ts#L58) - -___ - -### storageConfig - -▸ **storageConfig**(`contextName`, `forceCreate?`): `Promise`<`undefined` \| [`SecureContextConfig`](../interfaces/verida_account_node._internal_.SecureContextConfig.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | -| `forceCreate?` | `boolean` | - -#### Returns - -`Promise`<`undefined` \| [`SecureContextConfig`](../interfaces/verida_account_node._internal_.SecureContextConfig.md)\> - -#### Inherited from - -[LimitedAccount](verida_account_node.LimitedAccount.md).[storageConfig](verida_account_node.LimitedAccount.md#storageconfig) - -#### Defined in - -[packages/account-node/src/limited.ts:27](https://github.com/verida/verida-js/blob/5040472/packages/account-node/src/limited.ts#L27) - -___ - -### unlinkStorage - -▸ **unlinkStorage**(`contextName`): `Promise`<`boolean`\> - -Unlink storage for this user - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | - -#### Returns - -`Promise`<`boolean`\> - -#### Inherited from - -[LimitedAccount](verida_account_node.LimitedAccount.md).[unlinkStorage](verida_account_node.LimitedAccount.md#unlinkstorage) - -#### Defined in - -[packages/account-node/src/limited.ts:35](https://github.com/verida/verida-js/blob/5040472/packages/account-node/src/limited.ts#L35) diff --git a/docs/api/verida-js/classes/verida_account_node.AutoAccount.md b/docs/api/verida-js/classes/verida_account_node.AutoAccount.md deleted file mode 100644 index e46fb29..0000000 --- a/docs/api/verida-js/classes/verida_account_node.AutoAccount.md +++ /dev/null @@ -1,542 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account-node](../modules/verida_account_node.md) / AutoAccount - -# Class: AutoAccount - -[@verida/account-node](../modules/verida_account_node.md).AutoAccount - -An Authenticator that automatically signs everything - -## Hierarchy - -- [`default`](verida_account_node._internal_.default.md) - - ↳ **`AutoAccount`** - - ↳↳ [`LimitedAccount`](verida_account_node.LimitedAccount.md) - -## Table of contents - -### Constructors - -- [constructor](verida_account_node.AutoAccount.md#constructor) - -### Properties - -- [accountConfig](verida_account_node.AutoAccount.md#accountconfig) -- [autoConfig](verida_account_node.AutoAccount.md#autoconfig) -- [contextAuths](verida_account_node.AutoAccount.md#contextauths) -- [defaultNodes](verida_account_node.AutoAccount.md#defaultnodes) -- [didClient](verida_account_node.AutoAccount.md#didclient) -- [wallet](verida_account_node.AutoAccount.md#wallet) - -### Methods - -- [createDidJwt](verida_account_node.AutoAccount.md#createdidjwt) -- [did](verida_account_node.AutoAccount.md#did) -- [disconnect](verida_account_node.AutoAccount.md#disconnect) -- [disconnectDevice](verida_account_node.AutoAccount.md#disconnectdevice) -- [ensureAuthenticated](verida_account_node.AutoAccount.md#ensureauthenticated) -- [getAccountConfig](verida_account_node.AutoAccount.md#getaccountconfig) -- [getAuthContext](verida_account_node.AutoAccount.md#getauthcontext) -- [getDIDClient](verida_account_node.AutoAccount.md#getdidclient) -- [getDefaultNodes](verida_account_node.AutoAccount.md#getdefaultnodes) -- [getDidClient](verida_account_node.AutoAccount.md#getdidclient) -- [keyring](verida_account_node.AutoAccount.md#keyring) -- [linkStorage](verida_account_node.AutoAccount.md#linkstorage) -- [linkStorageContextService](verida_account_node.AutoAccount.md#linkstoragecontextservice) -- [loadDefaultStorageNodes](verida_account_node.AutoAccount.md#loaddefaultstoragenodes) -- [setAccountConfig](verida_account_node.AutoAccount.md#setaccountconfig) -- [sign](verida_account_node.AutoAccount.md#sign) -- [storageConfig](verida_account_node.AutoAccount.md#storageconfig) -- [unlinkStorage](verida_account_node.AutoAccount.md#unlinkstorage) - -## Constructors - -### constructor - -• **new AutoAccount**(`autoConfig`, `accountConfig?`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `autoConfig` | [`AccountNodeConfig`](../interfaces/verida_account_node._internal_.AccountNodeConfig.md) | -| `accountConfig?` | [`AccountConfig`](../interfaces/verida_account_node._internal_.AccountConfig.md) | - -#### Overrides - -[default](verida_account_node._internal_.default.md).[constructor](verida_account_node._internal_.default.md#constructor) - -#### Defined in - -[packages/account-node/src/auto.ts:25](https://github.com/verida/verida-js/blob/5040472/packages/account-node/src/auto.ts#L25) - -## Properties - -### accountConfig - -• `Protected` `Optional` **accountConfig**: [`AccountConfig`](../interfaces/verida_account_node._internal_.AccountConfig.md) - -#### Defined in - -[packages/account-node/src/auto.ts:20](https://github.com/verida/verida-js/blob/5040472/packages/account-node/src/auto.ts#L20) - -___ - -### autoConfig - -• `Protected` **autoConfig**: [`AccountNodeConfig`](../interfaces/verida_account_node._internal_.AccountNodeConfig.md) - -#### Defined in - -[packages/account-node/src/auto.ts:21](https://github.com/verida/verida-js/blob/5040472/packages/account-node/src/auto.ts#L21) - -___ - -### contextAuths - -• `Protected` **contextAuths**: [`Record`](../modules/verida_account_node._internal_.md#record)<`string`, [`Record`](../modules/verida_account_node._internal_.md#record)<`string`, [`VeridaDatabaseAuthType`](verida_account_node.VeridaDatabaseAuthType.md)\>\> = `{}` - -#### Defined in - -[packages/account-node/src/auto.ts:22](https://github.com/verida/verida-js/blob/5040472/packages/account-node/src/auto.ts#L22) - -___ - -### defaultNodes - -• `Protected` **defaultNodes**: `string`[] = `[]` - -#### Defined in - -[packages/account-node/src/auto.ts:23](https://github.com/verida/verida-js/blob/5040472/packages/account-node/src/auto.ts#L23) - -___ - -### didClient - -• `Private` **didClient**: [`DIDClient`](verida_account_node._internal_.DIDClient.md) - -#### Defined in - -[packages/account-node/src/auto.ts:17](https://github.com/verida/verida-js/blob/5040472/packages/account-node/src/auto.ts#L17) - -___ - -### wallet - -• `Private` **wallet**: [`default`](verida_account_node._internal_.default-1.md) - -#### Defined in - -[packages/account-node/src/auto.ts:19](https://github.com/verida/verida-js/blob/5040472/packages/account-node/src/auto.ts#L19) - -## Methods - -### createDidJwt - -▸ **createDidJwt**(`contextName`, `data`, `config?`): `Promise`<`string`\> - -Create a DID-JWT from a data object - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | -| `data` | `object` | -| `config?` | `any` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[default](verida_account_node._internal_.default.md).[createDidJwt](verida_account_node._internal_.default.md#createdidjwt) - -#### Defined in - -packages/account/dist/account.d.ts:42 - -___ - -### did - -▸ **did**(): `Promise`<`string`\> - -Get the DID of the current user - -#### Returns - -`Promise`<`string`\> - -#### Overrides - -[default](verida_account_node._internal_.default.md).[did](verida_account_node._internal_.default.md#did) - -#### Defined in - -[packages/account-node/src/auto.ts:62](https://github.com/verida/verida-js/blob/5040472/packages/account-node/src/auto.ts#L62) - -___ - -### disconnect - -▸ **disconnect**(`contextName?`): `Promise`<`void`\> - -An optional method that can be used to disconnect the current user. - -For example, in a web browser context, it would remove any stored signatures from local storage. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName?` | `string` | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[default](verida_account_node._internal_.default.md).[disconnect](verida_account_node._internal_.default.md#disconnect) - -#### Defined in - -packages/account/dist/account.d.ts:48 - -___ - -### disconnectDevice - -▸ **disconnectDevice**(`contextName`, `deviceId?`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `contextName` | `string` | `undefined` | -| `deviceId` | `string` | `"Test device"` | - -#### Returns - -`Promise`<`boolean`\> - -#### Overrides - -[default](verida_account_node._internal_.default.md).[disconnectDevice](verida_account_node._internal_.default.md#disconnectdevice) - -#### Defined in - -[packages/account-node/src/auto.ts:234](https://github.com/verida/verida-js/blob/5040472/packages/account-node/src/auto.ts#L234) - -___ - -### ensureAuthenticated - -▸ `Private` **ensureAuthenticated**(): `Promise`<`void`\> - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -[packages/account-node/src/auto.ts:250](https://github.com/verida/verida-js/blob/5040472/packages/account-node/src/auto.ts#L250) - -___ - -### getAccountConfig - -▸ **getAccountConfig**(): `undefined` \| [`AccountConfig`](../interfaces/verida_account_node._internal_.AccountConfig.md) - -#### Returns - -`undefined` \| [`AccountConfig`](../interfaces/verida_account_node._internal_.AccountConfig.md) - -#### Defined in - -[packages/account-node/src/auto.ts:45](https://github.com/verida/verida-js/blob/5040472/packages/account-node/src/auto.ts#L45) - -___ - -### getAuthContext - -▸ **getAuthContext**(`contextName`, `contextConfig`, `authConfig`, `authType?`): `Promise`<[`AuthContext`](../interfaces/verida_account_node._internal_.AuthContext.md)\> - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `contextName` | `string` | `undefined` | -| `contextConfig` | [`SecureContextConfig`](../interfaces/verida_account_node._internal_.SecureContextConfig.md) | `undefined` | -| `authConfig` | [`VeridaDatabaseAuthTypeConfig`](../interfaces/verida_account_node._internal_.VeridaDatabaseAuthTypeConfig.md) | `undefined` | -| `authType` | `string` | `"database"` | - -#### Returns - -`Promise`<[`AuthContext`](../interfaces/verida_account_node._internal_.AuthContext.md)\> - -#### Overrides - -[default](verida_account_node._internal_.default.md).[getAuthContext](verida_account_node._internal_.default.md#getauthcontext) - -#### Defined in - -[packages/account-node/src/auto.ts:199](https://github.com/verida/verida-js/blob/5040472/packages/account-node/src/auto.ts#L199) - -___ - -### getDIDClient - -▸ **getDIDClient**(): [`DIDClient`](verida_account_node._internal_.DIDClient.md) - -#### Returns - -[`DIDClient`](verida_account_node._internal_.DIDClient.md) - -#### Defined in - -[packages/account-node/src/auto.ts:37](https://github.com/verida/verida-js/blob/5040472/packages/account-node/src/auto.ts#L37) - -___ - -### getDefaultNodes - -▸ `Private` **getDefaultNodes**(`countryCode?`, `numNodes?`, `config?`): `Promise`<[`ServiceEndpoint`](../modules/verida_account_node._internal_.md#serviceendpoint)[]\> - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `countryCode?` | `string` | `undefined` | -| `numNodes` | `number` | `3` | -| `config` | [`NodeSelectorParams`](../interfaces/verida_account_node.NodeSelectorParams.md) | `{}` | - -#### Returns - -`Promise`<[`ServiceEndpoint`](../modules/verida_account_node._internal_.md#serviceendpoint)[]\> - -#### Defined in - -[packages/account-node/src/auto.ts:85](https://github.com/verida/verida-js/blob/5040472/packages/account-node/src/auto.ts#L85) - -___ - -### getDidClient - -▸ **getDidClient**(): `Promise`<[`DIDClient`](verida_account_node._internal_.DIDClient.md)\> - -#### Returns - -`Promise`<[`DIDClient`](verida_account_node._internal_.DIDClient.md)\> - -#### Defined in - -[packages/account-node/src/auto.ts:194](https://github.com/verida/verida-js/blob/5040472/packages/account-node/src/auto.ts#L194) - -___ - -### keyring - -▸ **keyring**(`contextName`): `Promise`<[`default`](verida_account_node._internal_.default-2.md)\> - -Generate a keyring for this user for a given storage context. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | - -#### Returns - -`Promise`<[`default`](verida_account_node._internal_.default-2.md)\> - -#### Overrides - -[default](verida_account_node._internal_.default.md).[keyring](verida_account_node._internal_.default.md#keyring) - -#### Defined in - -[packages/account-node/src/auto.ts:49](https://github.com/verida/verida-js/blob/5040472/packages/account-node/src/auto.ts#L49) - -___ - -### linkStorage - -▸ **linkStorage**(`storageConfig`): `Promise`<`boolean`\> - -Link storage to this user - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `storageConfig` | [`SecureContextConfig`](../interfaces/verida_account_node._internal_.SecureContextConfig.md) | - -#### Returns - -`Promise`<`boolean`\> - -#### Overrides - -[default](verida_account_node._internal_.default.md).[linkStorage](verida_account_node._internal_.default.md#linkstorage) - -#### Defined in - -[packages/account-node/src/auto.ts:138](https://github.com/verida/verida-js/blob/5040472/packages/account-node/src/auto.ts#L138) - -___ - -### linkStorageContextService - -▸ **linkStorageContextService**(`contextName`, `endpointType`, `serverType`, `endpointUris`): `Promise`<`boolean`\> - -Link storage context service endpoint - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | -| `endpointType` | [`SecureContextEndpointType`](../enums/verida_account_node._internal_.SecureContextEndpointType.md) | -| `serverType` | `string` | -| `endpointUris` | `string`[] | - -#### Returns - -`Promise`<`boolean`\> - -#### Overrides - -[default](verida_account_node._internal_.default.md).[linkStorageContextService](verida_account_node._internal_.default.md#linkstoragecontextservice) - -#### Defined in - -[packages/account-node/src/auto.ts:180](https://github.com/verida/verida-js/blob/5040472/packages/account-node/src/auto.ts#L180) - -___ - -### loadDefaultStorageNodes - -▸ **loadDefaultStorageNodes**(`countryCode?`, `numNodes?`, `config?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `countryCode?` | `string` | `undefined` | -| `numNodes` | `number` | `3` | -| `config` | [`NodeSelectorParams`](../interfaces/verida_account_node.NodeSelectorParams.md) | `{}` | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -[packages/account-node/src/auto.ts:66](https://github.com/verida/verida-js/blob/5040472/packages/account-node/src/auto.ts#L66) - -___ - -### setAccountConfig - -▸ **setAccountConfig**(`accountConfig`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `accountConfig` | [`AccountConfig`](../interfaces/verida_account_node._internal_.AccountConfig.md) | - -#### Returns - -`void` - -#### Overrides - -[default](verida_account_node._internal_.default.md).[setAccountConfig](verida_account_node._internal_.default.md#setaccountconfig) - -#### Defined in - -[packages/account-node/src/auto.ts:41](https://github.com/verida/verida-js/blob/5040472/packages/account-node/src/auto.ts#L41) - -___ - -### sign - -▸ **sign**(`message`): `Promise`<`string`\> - -Sign a string as the current user - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `message` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Overrides - -[default](verida_account_node._internal_.default.md).[sign](verida_account_node._internal_.default.md#sign) - -#### Defined in - -[packages/account-node/src/auto.ts:58](https://github.com/verida/verida-js/blob/5040472/packages/account-node/src/auto.ts#L58) - -___ - -### storageConfig - -▸ **storageConfig**(`contextName`, `forceCreate?`): `Promise`<`undefined` \| [`SecureContextConfig`](../interfaces/verida_account_node._internal_.SecureContextConfig.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | -| `forceCreate?` | `boolean` | - -#### Returns - -`Promise`<`undefined` \| [`SecureContextConfig`](../interfaces/verida_account_node._internal_.SecureContextConfig.md)\> - -#### Overrides - -[default](verida_account_node._internal_.default.md).[storageConfig](verida_account_node._internal_.default.md#storageconfig) - -#### Defined in - -[packages/account-node/src/auto.ts:101](https://github.com/verida/verida-js/blob/5040472/packages/account-node/src/auto.ts#L101) - -___ - -### unlinkStorage - -▸ **unlinkStorage**(`contextName`): `Promise`<`boolean`\> - -Unlink storage for this user - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | - -#### Returns - -`Promise`<`boolean`\> - -#### Overrides - -[default](verida_account_node._internal_.default.md).[unlinkStorage](verida_account_node._internal_.default.md#unlinkstorage) - -#### Defined in - -[packages/account-node/src/auto.ts:158](https://github.com/verida/verida-js/blob/5040472/packages/account-node/src/auto.ts#L158) diff --git a/docs/api/verida-js/classes/verida_account_node.LimitedAccount.md b/docs/api/verida-js/classes/verida_account_node.LimitedAccount.md deleted file mode 100644 index f793550..0000000 --- a/docs/api/verida-js/classes/verida_account_node.LimitedAccount.md +++ /dev/null @@ -1,528 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account-node](../modules/verida_account_node.md) / LimitedAccount - -# Class: LimitedAccount - -[@verida/account-node](../modules/verida_account_node.md).LimitedAccount - -A NodeJs account that only signs messages for a limited list of contexts. - -Used for testing. - -## Hierarchy - -- [`AutoAccount`](verida_account_node.AutoAccount.md) - - ↳ **`LimitedAccount`** - - ↳↳ [`AuthContextAccount`](verida_account_node.AuthContextAccount.md) - -## Table of contents - -### Constructors - -- [constructor](verida_account_node.LimitedAccount.md#constructor) - -### Properties - -- [accountConfig](verida_account_node.LimitedAccount.md#accountconfig) -- [autoConfig](verida_account_node.LimitedAccount.md#autoconfig) -- [contextAuths](verida_account_node.LimitedAccount.md#contextauths) -- [defaultNodes](verida_account_node.LimitedAccount.md#defaultnodes) -- [signingContexts](verida_account_node.LimitedAccount.md#signingcontexts) - -### Methods - -- [createDidJwt](verida_account_node.LimitedAccount.md#createdidjwt) -- [did](verida_account_node.LimitedAccount.md#did) -- [disconnect](verida_account_node.LimitedAccount.md#disconnect) -- [disconnectDevice](verida_account_node.LimitedAccount.md#disconnectdevice) -- [getAccountConfig](verida_account_node.LimitedAccount.md#getaccountconfig) -- [getAuthContext](verida_account_node.LimitedAccount.md#getauthcontext) -- [getDIDClient](verida_account_node.LimitedAccount.md#getdidclient) -- [getDidClient](verida_account_node.LimitedAccount.md#getdidclient) -- [keyring](verida_account_node.LimitedAccount.md#keyring) -- [linkStorage](verida_account_node.LimitedAccount.md#linkstorage) -- [linkStorageContextService](verida_account_node.LimitedAccount.md#linkstoragecontextservice) -- [loadDefaultStorageNodes](verida_account_node.LimitedAccount.md#loaddefaultstoragenodes) -- [setAccountConfig](verida_account_node.LimitedAccount.md#setaccountconfig) -- [sign](verida_account_node.LimitedAccount.md#sign) -- [storageConfig](verida_account_node.LimitedAccount.md#storageconfig) -- [unlinkStorage](verida_account_node.LimitedAccount.md#unlinkstorage) - -## Constructors - -### constructor - -• **new LimitedAccount**(`autoConfig`, `accountConfig?`, `signingContexts?`) - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `autoConfig` | [`AccountNodeConfig`](../interfaces/verida_account_node._internal_.AccountNodeConfig.md) | `undefined` | -| `accountConfig?` | [`AccountConfig`](../interfaces/verida_account_node._internal_.AccountConfig.md) | `undefined` | -| `signingContexts` | `string`[] | `[]` | - -#### Overrides - -[AutoAccount](verida_account_node.AutoAccount.md).[constructor](verida_account_node.AutoAccount.md#constructor) - -#### Defined in - -[packages/account-node/src/limited.ts:14](https://github.com/verida/verida-js/blob/5040472/packages/account-node/src/limited.ts#L14) - -## Properties - -### accountConfig - -• `Protected` `Optional` **accountConfig**: [`AccountConfig`](../interfaces/verida_account_node._internal_.AccountConfig.md) - -#### Inherited from - -[AutoAccount](verida_account_node.AutoAccount.md).[accountConfig](verida_account_node.AutoAccount.md#accountconfig) - -#### Defined in - -[packages/account-node/src/auto.ts:20](https://github.com/verida/verida-js/blob/5040472/packages/account-node/src/auto.ts#L20) - -___ - -### autoConfig - -• `Protected` **autoConfig**: [`AccountNodeConfig`](../interfaces/verida_account_node._internal_.AccountNodeConfig.md) - -#### Inherited from - -[AutoAccount](verida_account_node.AutoAccount.md).[autoConfig](verida_account_node.AutoAccount.md#autoconfig) - -#### Defined in - -[packages/account-node/src/auto.ts:21](https://github.com/verida/verida-js/blob/5040472/packages/account-node/src/auto.ts#L21) - -___ - -### contextAuths - -• `Protected` **contextAuths**: [`Record`](../modules/verida_account_node._internal_.md#record)<`string`, [`Record`](../modules/verida_account_node._internal_.md#record)<`string`, [`VeridaDatabaseAuthType`](verida_account_node.VeridaDatabaseAuthType.md)\>\> = `{}` - -#### Inherited from - -[AutoAccount](verida_account_node.AutoAccount.md).[contextAuths](verida_account_node.AutoAccount.md#contextauths) - -#### Defined in - -[packages/account-node/src/auto.ts:22](https://github.com/verida/verida-js/blob/5040472/packages/account-node/src/auto.ts#L22) - -___ - -### defaultNodes - -• `Protected` **defaultNodes**: `string`[] = `[]` - -#### Inherited from - -[AutoAccount](verida_account_node.AutoAccount.md).[defaultNodes](verida_account_node.AutoAccount.md#defaultnodes) - -#### Defined in - -[packages/account-node/src/auto.ts:23](https://github.com/verida/verida-js/blob/5040472/packages/account-node/src/auto.ts#L23) - -___ - -### signingContexts - -• `Private` **signingContexts**: `string`[] - -#### Defined in - -[packages/account-node/src/limited.ts:12](https://github.com/verida/verida-js/blob/5040472/packages/account-node/src/limited.ts#L12) - -## Methods - -### createDidJwt - -▸ **createDidJwt**(`contextName`, `data`, `config?`): `Promise`<`string`\> - -Create a DID-JWT from a data object - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | -| `data` | `object` | -| `config?` | `any` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[AutoAccount](verida_account_node.AutoAccount.md).[createDidJwt](verida_account_node.AutoAccount.md#createdidjwt) - -#### Defined in - -packages/account/dist/account.d.ts:42 - -___ - -### did - -▸ **did**(): `Promise`<`string`\> - -Get the DID of the current user - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[AutoAccount](verida_account_node.AutoAccount.md).[did](verida_account_node.AutoAccount.md#did) - -#### Defined in - -[packages/account-node/src/auto.ts:62](https://github.com/verida/verida-js/blob/5040472/packages/account-node/src/auto.ts#L62) - -___ - -### disconnect - -▸ **disconnect**(`contextName?`): `Promise`<`void`\> - -An optional method that can be used to disconnect the current user. - -For example, in a web browser context, it would remove any stored signatures from local storage. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName?` | `string` | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[AutoAccount](verida_account_node.AutoAccount.md).[disconnect](verida_account_node.AutoAccount.md#disconnect) - -#### Defined in - -packages/account/dist/account.d.ts:48 - -___ - -### disconnectDevice - -▸ **disconnectDevice**(`contextName`, `deviceId?`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `contextName` | `string` | `undefined` | -| `deviceId` | `string` | `"Test device"` | - -#### Returns - -`Promise`<`boolean`\> - -#### Inherited from - -[AutoAccount](verida_account_node.AutoAccount.md).[disconnectDevice](verida_account_node.AutoAccount.md#disconnectdevice) - -#### Defined in - -[packages/account-node/src/auto.ts:234](https://github.com/verida/verida-js/blob/5040472/packages/account-node/src/auto.ts#L234) - -___ - -### getAccountConfig - -▸ **getAccountConfig**(): `undefined` \| [`AccountConfig`](../interfaces/verida_account_node._internal_.AccountConfig.md) - -#### Returns - -`undefined` \| [`AccountConfig`](../interfaces/verida_account_node._internal_.AccountConfig.md) - -#### Inherited from - -[AutoAccount](verida_account_node.AutoAccount.md).[getAccountConfig](verida_account_node.AutoAccount.md#getaccountconfig) - -#### Defined in - -[packages/account-node/src/auto.ts:45](https://github.com/verida/verida-js/blob/5040472/packages/account-node/src/auto.ts#L45) - -___ - -### getAuthContext - -▸ **getAuthContext**(`contextName`, `contextConfig`, `authConfig`, `authType?`): `Promise`<[`AuthContext`](../interfaces/verida_account_node._internal_.AuthContext.md)\> - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `contextName` | `string` | `undefined` | -| `contextConfig` | [`SecureContextConfig`](../interfaces/verida_account_node._internal_.SecureContextConfig.md) | `undefined` | -| `authConfig` | [`VeridaDatabaseAuthTypeConfig`](../interfaces/verida_account_node._internal_.VeridaDatabaseAuthTypeConfig.md) | `undefined` | -| `authType` | `string` | `"database"` | - -#### Returns - -`Promise`<[`AuthContext`](../interfaces/verida_account_node._internal_.AuthContext.md)\> - -#### Inherited from - -[AutoAccount](verida_account_node.AutoAccount.md).[getAuthContext](verida_account_node.AutoAccount.md#getauthcontext) - -#### Defined in - -[packages/account-node/src/auto.ts:199](https://github.com/verida/verida-js/blob/5040472/packages/account-node/src/auto.ts#L199) - -___ - -### getDIDClient - -▸ **getDIDClient**(): [`DIDClient`](verida_account_node._internal_.DIDClient.md) - -#### Returns - -[`DIDClient`](verida_account_node._internal_.DIDClient.md) - -#### Inherited from - -[AutoAccount](verida_account_node.AutoAccount.md).[getDIDClient](verida_account_node.AutoAccount.md#getdidclient) - -#### Defined in - -[packages/account-node/src/auto.ts:37](https://github.com/verida/verida-js/blob/5040472/packages/account-node/src/auto.ts#L37) - -___ - -### getDidClient - -▸ **getDidClient**(): `Promise`<[`DIDClient`](verida_account_node._internal_.DIDClient.md)\> - -#### Returns - -`Promise`<[`DIDClient`](verida_account_node._internal_.DIDClient.md)\> - -#### Inherited from - -[AutoAccount](verida_account_node.AutoAccount.md).[getDidClient](verida_account_node.AutoAccount.md#getdidclient) - -#### Defined in - -[packages/account-node/src/auto.ts:194](https://github.com/verida/verida-js/blob/5040472/packages/account-node/src/auto.ts#L194) - -___ - -### keyring - -▸ **keyring**(`contextName`): `Promise`<[`default`](verida_account_node._internal_.default-2.md)\> - -Generate a keyring for this user for a given storage context. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | - -#### Returns - -`Promise`<[`default`](verida_account_node._internal_.default-2.md)\> - -#### Overrides - -[AutoAccount](verida_account_node.AutoAccount.md).[keyring](verida_account_node.AutoAccount.md#keyring) - -#### Defined in - -[packages/account-node/src/limited.ts:19](https://github.com/verida/verida-js/blob/5040472/packages/account-node/src/limited.ts#L19) - -___ - -### linkStorage - -▸ **linkStorage**(`storageConfig`): `Promise`<`boolean`\> - -Link storage to this user - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `storageConfig` | [`SecureContextConfig`](../interfaces/verida_account_node._internal_.SecureContextConfig.md) | - -#### Returns - -`Promise`<`boolean`\> - -#### Inherited from - -[AutoAccount](verida_account_node.AutoAccount.md).[linkStorage](verida_account_node.AutoAccount.md#linkstorage) - -#### Defined in - -[packages/account-node/src/auto.ts:138](https://github.com/verida/verida-js/blob/5040472/packages/account-node/src/auto.ts#L138) - -___ - -### linkStorageContextService - -▸ **linkStorageContextService**(`contextName`, `endpointType`, `serverType`, `endpointUris`): `Promise`<`boolean`\> - -Link storage context service endpoint - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | -| `endpointType` | [`SecureContextEndpointType`](../enums/verida_account_node._internal_.SecureContextEndpointType.md) | -| `serverType` | `string` | -| `endpointUris` | `string`[] | - -#### Returns - -`Promise`<`boolean`\> - -#### Inherited from - -[AutoAccount](verida_account_node.AutoAccount.md).[linkStorageContextService](verida_account_node.AutoAccount.md#linkstoragecontextservice) - -#### Defined in - -[packages/account-node/src/auto.ts:180](https://github.com/verida/verida-js/blob/5040472/packages/account-node/src/auto.ts#L180) - -___ - -### loadDefaultStorageNodes - -▸ **loadDefaultStorageNodes**(`countryCode?`, `numNodes?`, `config?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `countryCode?` | `string` | `undefined` | -| `numNodes` | `number` | `3` | -| `config` | [`NodeSelectorParams`](../interfaces/verida_account_node.NodeSelectorParams.md) | `{}` | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[AutoAccount](verida_account_node.AutoAccount.md).[loadDefaultStorageNodes](verida_account_node.AutoAccount.md#loaddefaultstoragenodes) - -#### Defined in - -[packages/account-node/src/auto.ts:66](https://github.com/verida/verida-js/blob/5040472/packages/account-node/src/auto.ts#L66) - -___ - -### setAccountConfig - -▸ **setAccountConfig**(`accountConfig`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `accountConfig` | [`AccountConfig`](../interfaces/verida_account_node._internal_.AccountConfig.md) | - -#### Returns - -`void` - -#### Inherited from - -[AutoAccount](verida_account_node.AutoAccount.md).[setAccountConfig](verida_account_node.AutoAccount.md#setaccountconfig) - -#### Defined in - -[packages/account-node/src/auto.ts:41](https://github.com/verida/verida-js/blob/5040472/packages/account-node/src/auto.ts#L41) - -___ - -### sign - -▸ **sign**(`message`): `Promise`<`string`\> - -Sign a string as the current user - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `message` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[AutoAccount](verida_account_node.AutoAccount.md).[sign](verida_account_node.AutoAccount.md#sign) - -#### Defined in - -[packages/account-node/src/auto.ts:58](https://github.com/verida/verida-js/blob/5040472/packages/account-node/src/auto.ts#L58) - -___ - -### storageConfig - -▸ **storageConfig**(`contextName`, `forceCreate?`): `Promise`<`undefined` \| [`SecureContextConfig`](../interfaces/verida_account_node._internal_.SecureContextConfig.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | -| `forceCreate?` | `boolean` | - -#### Returns - -`Promise`<`undefined` \| [`SecureContextConfig`](../interfaces/verida_account_node._internal_.SecureContextConfig.md)\> - -#### Overrides - -[AutoAccount](verida_account_node.AutoAccount.md).[storageConfig](verida_account_node.AutoAccount.md#storageconfig) - -#### Defined in - -[packages/account-node/src/limited.ts:27](https://github.com/verida/verida-js/blob/5040472/packages/account-node/src/limited.ts#L27) - -___ - -### unlinkStorage - -▸ **unlinkStorage**(`contextName`): `Promise`<`boolean`\> - -Unlink storage for this user - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | - -#### Returns - -`Promise`<`boolean`\> - -#### Overrides - -[AutoAccount](verida_account_node.AutoAccount.md).[unlinkStorage](verida_account_node.AutoAccount.md#unlinkstorage) - -#### Defined in - -[packages/account-node/src/limited.ts:35](https://github.com/verida/verida-js/blob/5040472/packages/account-node/src/limited.ts#L35) diff --git a/docs/api/verida-js/classes/verida_account_node.NodeSelector.md b/docs/api/verida-js/classes/verida_account_node.NodeSelector.md deleted file mode 100644 index a49f424..0000000 --- a/docs/api/verida-js/classes/verida_account_node.NodeSelector.md +++ /dev/null @@ -1,257 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account-node](../modules/verida_account_node.md) / NodeSelector - -# Class: NodeSelector - -[@verida/account-node](../modules/verida_account_node.md).NodeSelector - -## Table of contents - -### Constructors - -- [constructor](verida_account_node.NodeSelector.md#constructor) - -### Properties - -- [config](verida_account_node.NodeSelector.md#config) -- [nodeList](verida_account_node.NodeSelector.md#nodelist) - -### Methods - -- [fetchConfigJson](verida_account_node.NodeSelector.md#fetchconfigjson) -- [loadStorageNodes](verida_account_node.NodeSelector.md#loadstoragenodes) -- [nodesByCountry](verida_account_node.NodeSelector.md#nodesbycountry) -- [nodesByRegion](verida_account_node.NodeSelector.md#nodesbyregion) -- [notificationEndpoints](verida_account_node.NodeSelector.md#notificationendpoints) -- [selectEndpointUris](verida_account_node.NodeSelector.md#selectendpointuris) -- [selectNodesByCountry](verida_account_node.NodeSelector.md#selectnodesbycountry) -- [selectNodesByRegion](verida_account_node.NodeSelector.md#selectnodesbyregion) -- [selectNodesFromList](verida_account_node.NodeSelector.md#selectnodesfromlist) -- [verifyNodeAvailable](verida_account_node.NodeSelector.md#verifynodeavailable) - -## Constructors - -### constructor - -• **new NodeSelector**(`config`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | [`NodeSelectorConfig`](../interfaces/verida_account_node.NodeSelectorConfig.md) | - -#### Defined in - -[packages/account-node/src/nodeSelector.ts:46](https://github.com/verida/verida-js/blob/5040472/packages/account-node/src/nodeSelector.ts#L46) - -## Properties - -### config - -• **config**: [`NodeSelectorConfig`](../interfaces/verida_account_node.NodeSelectorConfig.md) - -#### Defined in - -[packages/account-node/src/nodeSelector.ts:43](https://github.com/verida/verida-js/blob/5040472/packages/account-node/src/nodeSelector.ts#L43) - -___ - -### nodeList - -• `Optional` **nodeList**: [`StorageNode`](../interfaces/verida_account_node.StorageNode.md)[] - -#### Defined in - -[packages/account-node/src/nodeSelector.ts:44](https://github.com/verida/verida-js/blob/5040472/packages/account-node/src/nodeSelector.ts#L44) - -## Methods - -### fetchConfigJson - -▸ `Private` **fetchConfigJson**(`url`): `Promise`<[`StorageNode`](../interfaces/verida_account_node.StorageNode.md)[]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | - -#### Returns - -`Promise`<[`StorageNode`](../interfaces/verida_account_node.StorageNode.md)[]\> - -#### Defined in - -[packages/account-node/src/nodeSelector.ts:229](https://github.com/verida/verida-js/blob/5040472/packages/account-node/src/nodeSelector.ts#L229) - -___ - -### loadStorageNodes - -▸ `Private` **loadStorageNodes**(`nodes?`): `Promise`<[`StorageNode`](../interfaces/verida_account_node.StorageNode.md)[]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `nodes?` | [`StorageNode`](../interfaces/verida_account_node.StorageNode.md)[] | - -#### Returns - -`Promise`<[`StorageNode`](../interfaces/verida_account_node.StorageNode.md)[]\> - -#### Defined in - -[packages/account-node/src/nodeSelector.ts:209](https://github.com/verida/verida-js/blob/5040472/packages/account-node/src/nodeSelector.ts#L209) - -___ - -### nodesByCountry - -▸ **nodesByCountry**(): `Promise`<`any`\> - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -[packages/account-node/src/nodeSelector.ts:155](https://github.com/verida/verida-js/blob/5040472/packages/account-node/src/nodeSelector.ts#L155) - -___ - -### nodesByRegion - -▸ **nodesByRegion**(): `Promise`<`any`\> - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -[packages/account-node/src/nodeSelector.ts:168](https://github.com/verida/verida-js/blob/5040472/packages/account-node/src/nodeSelector.ts#L168) - -___ - -### notificationEndpoints - -▸ **notificationEndpoints**(): `string`[] - -#### Returns - -`string`[] - -#### Defined in - -[packages/account-node/src/nodeSelector.ts:184](https://github.com/verida/verida-js/blob/5040472/packages/account-node/src/nodeSelector.ts#L184) - -___ - -### selectEndpointUris - -▸ **selectEndpointUris**(`countryCode?`, `numNodes?`): `Promise`<`string`[]\> - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `countryCode?` | `string` | `undefined` | -| `numNodes` | `number` | `3` | - -#### Returns - -`Promise`<`string`[]\> - -#### Defined in - -[packages/account-node/src/nodeSelector.ts:141](https://github.com/verida/verida-js/blob/5040472/packages/account-node/src/nodeSelector.ts#L141) - -___ - -### selectNodesByCountry - -▸ **selectNodesByCountry**(`countryCode?`, `numNodes?`): `Promise`<[`StorageNode`](../interfaces/verida_account_node.StorageNode.md)[]\> - -Select random nodes for a given country code - -#### Parameters - -| Name | Type | Default value | Description | -| :------ | :------ | :------ | :------ | -| `countryCode?` | `string` | `undefined` | 2-character country code | -| `numNodes` | `number` | `3` | Number of nodes to randomly select | - -#### Returns - -`Promise`<[`StorageNode`](../interfaces/verida_account_node.StorageNode.md)[]\> - -Array of found storage nodes up to `numNodes` maximum - -#### Defined in - -[packages/account-node/src/nodeSelector.ts:56](https://github.com/verida/verida-js/blob/5040472/packages/account-node/src/nodeSelector.ts#L56) - -___ - -### selectNodesByRegion - -▸ **selectNodesByRegion**(`region`, `ignoredNodes`, `numNodes?`): `Promise`<[`StorageNode`](../interfaces/verida_account_node.StorageNode.md)[]\> - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `region` | `string` | `undefined` | -| `ignoredNodes` | [`StorageNode`](../interfaces/verida_account_node.StorageNode.md)[] | `undefined` | -| `numNodes` | `number` | `3` | - -#### Returns - -`Promise`<[`StorageNode`](../interfaces/verida_account_node.StorageNode.md)[]\> - -#### Defined in - -[packages/account-node/src/nodeSelector.ts:87](https://github.com/verida/verida-js/blob/5040472/packages/account-node/src/nodeSelector.ts#L87) - -___ - -### selectNodesFromList - -▸ `Private` **selectNodesFromList**(`possibleNodes`, `ignoredNodes`, `numNodes?`): `Promise`<[`StorageNode`](../interfaces/verida_account_node.StorageNode.md)[]\> - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `possibleNodes` | [`StorageNode`](../interfaces/verida_account_node.StorageNode.md)[] | `undefined` | -| `ignoredNodes` | [`StorageNode`](../interfaces/verida_account_node.StorageNode.md)[] | `undefined` | -| `numNodes` | `number` | `3` | - -#### Returns - -`Promise`<[`StorageNode`](../interfaces/verida_account_node.StorageNode.md)[]\> - -#### Defined in - -[packages/account-node/src/nodeSelector.ts:115](https://github.com/verida/verida-js/blob/5040472/packages/account-node/src/nodeSelector.ts#L115) - -___ - -### verifyNodeAvailable - -▸ **verifyNodeAvailable**(`storageNode`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `storageNode` | [`StorageNode`](../interfaces/verida_account_node.StorageNode.md) | - -#### Returns - -`Promise`<`boolean`\> - -#### Defined in - -[packages/account-node/src/nodeSelector.ts:188](https://github.com/verida/verida-js/blob/5040472/packages/account-node/src/nodeSelector.ts#L188) diff --git a/docs/api/verida-js/classes/verida_account_node.VeridaDatabaseAuthType.md b/docs/api/verida-js/classes/verida_account_node.VeridaDatabaseAuthType.md deleted file mode 100644 index 1d1a138..0000000 --- a/docs/api/verida-js/classes/verida_account_node.VeridaDatabaseAuthType.md +++ /dev/null @@ -1,229 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account-node](../modules/verida_account_node.md) / VeridaDatabaseAuthType - -# Class: VeridaDatabaseAuthType - -[@verida/account-node](../modules/verida_account_node.md).VeridaDatabaseAuthType - -## Hierarchy - -- [`AuthType`](verida_account_node._internal_.AuthType.md) - - ↳ **`VeridaDatabaseAuthType`** - -## Table of contents - -### Constructors - -- [constructor](verida_account_node.VeridaDatabaseAuthType.md#constructor) - -### Properties - -- [account](verida_account_node.VeridaDatabaseAuthType.md#account) -- [contextAuth](verida_account_node.VeridaDatabaseAuthType.md#contextauth) -- [contextName](verida_account_node.VeridaDatabaseAuthType.md#contextname) -- [serviceEndpoint](verida_account_node.VeridaDatabaseAuthType.md#serviceendpoint) -- [signKey](verida_account_node.VeridaDatabaseAuthType.md#signkey) -- [timeout](verida_account_node.VeridaDatabaseAuthType.md#timeout) - -### Methods - -- [disconnectDevice](verida_account_node.VeridaDatabaseAuthType.md#disconnectdevice) -- [getAuthContext](verida_account_node.VeridaDatabaseAuthType.md#getauthcontext) -- [getAxios](verida_account_node.VeridaDatabaseAuthType.md#getaxios) -- [setAuthContext](verida_account_node.VeridaDatabaseAuthType.md#setauthcontext) - -## Constructors - -### constructor - -• **new VeridaDatabaseAuthType**(`account`, `contextName`, `serviceEndpoint`, `signKey`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `account` | [`default`](verida_account_node._internal_.default.md) | -| `contextName` | `string` | -| `serviceEndpoint` | [`ServiceEndpoint`](../modules/verida_account_node._internal_.md#serviceendpoint) | -| `signKey` | [`SecureContextPublicKey`](../interfaces/verida_account_node._internal_.SecureContextPublicKey.md) | - -#### Overrides - -[AuthType](verida_account_node._internal_.AuthType.md).[constructor](verida_account_node._internal_.AuthType.md#constructor) - -#### Defined in - -[packages/account-node/src/authTypes/VeridaDatabase.ts:15](https://github.com/verida/verida-js/blob/5040472/packages/account-node/src/authTypes/VeridaDatabase.ts#L15) - -## Properties - -### account - -• `Protected` **account**: [`AutoAccount`](verida_account_node.AutoAccount.md) - -#### Overrides - -[AuthType](verida_account_node._internal_.AuthType.md).[account](verida_account_node._internal_.AuthType.md#account) - -#### Defined in - -[packages/account-node/src/authTypes/VeridaDatabase.ts:11](https://github.com/verida/verida-js/blob/5040472/packages/account-node/src/authTypes/VeridaDatabase.ts#L11) - -___ - -### contextAuth - -• `Protected` `Optional` **contextAuth**: [`VeridaDatabaseAuthContext`](../interfaces/verida_account_node._internal_.VeridaDatabaseAuthContext.md) - -#### Overrides - -[AuthType](verida_account_node._internal_.AuthType.md).[contextAuth](verida_account_node._internal_.AuthType.md#contextauth) - -#### Defined in - -[packages/account-node/src/authTypes/VeridaDatabase.ts:10](https://github.com/verida/verida-js/blob/5040472/packages/account-node/src/authTypes/VeridaDatabase.ts#L10) - -___ - -### contextName - -• `Protected` **contextName**: `string` - -#### Inherited from - -[AuthType](verida_account_node._internal_.AuthType.md).[contextName](verida_account_node._internal_.AuthType.md#contextname) - -#### Defined in - -packages/account/dist/auth-type.d.ts:7 - -___ - -### serviceEndpoint - -• `Protected` **serviceEndpoint**: [`ServiceEndpoint`](../modules/verida_account_node._internal_.md#serviceendpoint) - -#### Inherited from - -[AuthType](verida_account_node._internal_.AuthType.md).[serviceEndpoint](verida_account_node._internal_.AuthType.md#serviceendpoint) - -#### Defined in - -packages/account/dist/auth-type.d.ts:8 - -___ - -### signKey - -• `Protected` **signKey**: [`SecureContextPublicKey`](../interfaces/verida_account_node._internal_.SecureContextPublicKey.md) - -#### Inherited from - -[AuthType](verida_account_node._internal_.AuthType.md).[signKey](verida_account_node._internal_.AuthType.md#signkey) - -#### Defined in - -packages/account/dist/auth-type.d.ts:9 - -___ - -### timeout - -• `Protected` **timeout**: `number` = `10000` - -#### Defined in - -[packages/account-node/src/authTypes/VeridaDatabase.ts:13](https://github.com/verida/verida-js/blob/5040472/packages/account-node/src/authTypes/VeridaDatabase.ts#L13) - -## Methods - -### disconnectDevice - -▸ **disconnectDevice**(`deviceId?`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `deviceId` | `string` | `"Test device"` | - -#### Returns - -`Promise`<`boolean`\> - -#### Overrides - -[AuthType](verida_account_node._internal_.AuthType.md).[disconnectDevice](verida_account_node._internal_.AuthType.md#disconnectdevice) - -#### Defined in - -[packages/account-node/src/authTypes/VeridaDatabase.ts:133](https://github.com/verida/verida-js/blob/5040472/packages/account-node/src/authTypes/VeridaDatabase.ts#L133) - -___ - -### getAuthContext - -▸ **getAuthContext**(`config?`): `Promise`<[`VeridaDatabaseAuthContext`](../interfaces/verida_account_node._internal_.VeridaDatabaseAuthContext.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | [`VeridaDatabaseAuthTypeConfig`](../interfaces/verida_account_node._internal_.VeridaDatabaseAuthTypeConfig.md) | - -#### Returns - -`Promise`<[`VeridaDatabaseAuthContext`](../interfaces/verida_account_node._internal_.VeridaDatabaseAuthContext.md)\> - -#### Overrides - -[AuthType](verida_account_node._internal_.AuthType.md).[getAuthContext](verida_account_node._internal_.AuthType.md#getauthcontext) - -#### Defined in - -[packages/account-node/src/authTypes/VeridaDatabase.ts:20](https://github.com/verida/verida-js/blob/5040472/packages/account-node/src/authTypes/VeridaDatabase.ts#L20) - -___ - -### getAxios - -▸ `Private` **getAxios**(`storageContext`, `accessToken?`): [`AxiosInstance`](../interfaces/verida_account_node._internal_.AxiosInstance.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `storageContext` | `string` | -| `accessToken?` | `string` | - -#### Returns - -[`AxiosInstance`](../interfaces/verida_account_node._internal_.AxiosInstance.md) - -#### Defined in - -[packages/account-node/src/authTypes/VeridaDatabase.ts:162](https://github.com/verida/verida-js/blob/5040472/packages/account-node/src/authTypes/VeridaDatabase.ts#L162) - -___ - -### setAuthContext - -▸ **setAuthContext**(`contextAuth`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextAuth` | [`AuthContext`](../interfaces/verida_account_node._internal_.AuthContext.md) | - -#### Returns - -`void` - -#### Inherited from - -[AuthType](verida_account_node._internal_.AuthType.md).[setAuthContext](verida_account_node._internal_.AuthType.md#setauthcontext) - -#### Defined in - -packages/account/dist/auth-type.d.ts:12 diff --git a/docs/api/verida-js/classes/verida_account_node._internal_.AuthType.md b/docs/api/verida-js/classes/verida_account_node._internal_.AuthType.md deleted file mode 100644 index 0e76e9f..0000000 --- a/docs/api/verida-js/classes/verida_account_node._internal_.AuthType.md +++ /dev/null @@ -1,160 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account-node](../modules/verida_account_node.md) / [](../modules/verida_account_node._internal_.md) / AuthType - -# Class: AuthType - -[@verida/account-node](../modules/verida_account_node.md).[](../modules/verida_account_node._internal_.md).AuthType - -## Hierarchy - -- **`AuthType`** - - ↳ [`VeridaDatabaseAuthType`](verida_account_node.VeridaDatabaseAuthType.md) - -## Table of contents - -### Constructors - -- [constructor](verida_account_node._internal_.AuthType.md#constructor) - -### Properties - -- [account](verida_account_node._internal_.AuthType.md#account) -- [contextAuth](verida_account_node._internal_.AuthType.md#contextauth) -- [contextName](verida_account_node._internal_.AuthType.md#contextname) -- [serviceEndpoint](verida_account_node._internal_.AuthType.md#serviceendpoint) -- [signKey](verida_account_node._internal_.AuthType.md#signkey) - -### Methods - -- [disconnectDevice](verida_account_node._internal_.AuthType.md#disconnectdevice) -- [getAuthContext](verida_account_node._internal_.AuthType.md#getauthcontext) -- [setAuthContext](verida_account_node._internal_.AuthType.md#setauthcontext) - -## Constructors - -### constructor - -• **new AuthType**(`account`, `contextName`, `serviceEndpoint`, `signKey`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `account` | [`default`](verida_account_node._internal_.default.md) | -| `contextName` | `string` | -| `serviceEndpoint` | [`ServiceEndpoint`](../modules/verida_account_node._internal_.md#serviceendpoint) | -| `signKey` | [`SecureContextPublicKey`](../interfaces/verida_account_node._internal_.SecureContextPublicKey.md) | - -#### Defined in - -packages/account/dist/auth-type.d.ts:10 - -## Properties - -### account - -• `Protected` **account**: [`default`](verida_account_node._internal_.default.md) - -#### Defined in - -packages/account/dist/auth-type.d.ts:6 - -___ - -### contextAuth - -• `Protected` `Optional` **contextAuth**: [`AuthContext`](../interfaces/verida_account_node._internal_.AuthContext.md) - -#### Defined in - -packages/account/dist/auth-type.d.ts:5 - -___ - -### contextName - -• `Protected` **contextName**: `string` - -#### Defined in - -packages/account/dist/auth-type.d.ts:7 - -___ - -### serviceEndpoint - -• `Protected` **serviceEndpoint**: [`ServiceEndpoint`](../modules/verida_account_node._internal_.md#serviceendpoint) - -#### Defined in - -packages/account/dist/auth-type.d.ts:8 - -___ - -### signKey - -• `Protected` **signKey**: [`SecureContextPublicKey`](../interfaces/verida_account_node._internal_.SecureContextPublicKey.md) - -#### Defined in - -packages/account/dist/auth-type.d.ts:9 - -## Methods - -### disconnectDevice - -▸ **disconnectDevice**(`deviceId?`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `deviceId?` | `string` | - -#### Returns - -`Promise`<`boolean`\> - -#### Defined in - -packages/account/dist/auth-type.d.ts:13 - -___ - -### getAuthContext - -▸ **getAuthContext**(`config`): `Promise`<[`AuthContext`](../interfaces/verida_account_node._internal_.AuthContext.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | [`AuthTypeConfig`](../interfaces/verida_account_node._internal_.AuthTypeConfig.md) | - -#### Returns - -`Promise`<[`AuthContext`](../interfaces/verida_account_node._internal_.AuthContext.md)\> - -#### Defined in - -packages/account/dist/auth-type.d.ts:11 - -___ - -### setAuthContext - -▸ **setAuthContext**(`contextAuth`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextAuth` | [`AuthContext`](../interfaces/verida_account_node._internal_.AuthContext.md) | - -#### Returns - -`void` - -#### Defined in - -packages/account/dist/auth-type.d.ts:12 diff --git a/docs/api/verida-js/classes/verida_account_node._internal_.Axios.md b/docs/api/verida-js/classes/verida_account_node._internal_.Axios.md deleted file mode 100644 index 3fa85ff..0000000 --- a/docs/api/verida-js/classes/verida_account_node._internal_.Axios.md +++ /dev/null @@ -1,424 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account-node](../modules/verida_account_node.md) / [](../modules/verida_account_node._internal_.md) / Axios - -# Class: Axios - -[@verida/account-node](../modules/verida_account_node.md).[](../modules/verida_account_node._internal_.md).Axios - -## Hierarchy - -- **`Axios`** - - ↳ [`AxiosInstance`](../interfaces/verida_account_node._internal_.AxiosInstance.md) - -## Table of contents - -### Constructors - -- [constructor](verida_account_node._internal_.Axios.md#constructor) - -### Properties - -- [defaults](verida_account_node._internal_.Axios.md#defaults) -- [interceptors](verida_account_node._internal_.Axios.md#interceptors) - -### Methods - -- [delete](verida_account_node._internal_.Axios.md#delete) -- [get](verida_account_node._internal_.Axios.md#get) -- [getUri](verida_account_node._internal_.Axios.md#geturi) -- [head](verida_account_node._internal_.Axios.md#head) -- [options](verida_account_node._internal_.Axios.md#options) -- [patch](verida_account_node._internal_.Axios.md#patch) -- [patchForm](verida_account_node._internal_.Axios.md#patchform) -- [post](verida_account_node._internal_.Axios.md#post) -- [postForm](verida_account_node._internal_.Axios.md#postform) -- [put](verida_account_node._internal_.Axios.md#put) -- [putForm](verida_account_node._internal_.Axios.md#putform) -- [request](verida_account_node._internal_.Axios.md#request) - -## Constructors - -### constructor - -• **new Axios**(`config?`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config?` | [`AxiosRequestConfig`](../interfaces/verida_account_node._internal_.AxiosRequestConfig.md)<`any`\> | - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:215 - -## Properties - -### defaults - -• **defaults**: [`AxiosDefaults`](../interfaces/verida_account_node._internal_.AxiosDefaults.md)<`any`\> - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:216 - -___ - -### interceptors - -• **interceptors**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `request` | [`AxiosInterceptorManager`](../interfaces/verida_account_node._internal_.AxiosInterceptorManager.md)<[`AxiosRequestConfig`](../interfaces/verida_account_node._internal_.AxiosRequestConfig.md)<`any`\>\> | -| `response` | [`AxiosInterceptorManager`](../interfaces/verida_account_node._internal_.AxiosInterceptorManager.md)<[`AxiosResponse`](../interfaces/verida_account_node._internal_.AxiosResponse.md)<`any`, `any`\>\> | - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:217 - -## Methods - -### delete - -▸ **delete**<`T`, `R`, `D`\>(`url`, `config?`): `Promise`<`R`\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `any` | -| `R` | [`AxiosResponse`](../interfaces/verida_account_node._internal_.AxiosResponse.md)<`T`, `any`\> | -| `D` | `any` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `config?` | [`AxiosRequestConfig`](../interfaces/verida_account_node._internal_.AxiosRequestConfig.md)<`D`\> | - -#### Returns - -`Promise`<`R`\> - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:224 - -___ - -### get - -▸ **get**<`T`, `R`, `D`\>(`url`, `config?`): `Promise`<`R`\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `any` | -| `R` | [`AxiosResponse`](../interfaces/verida_account_node._internal_.AxiosResponse.md)<`T`, `any`\> | -| `D` | `any` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `config?` | [`AxiosRequestConfig`](../interfaces/verida_account_node._internal_.AxiosRequestConfig.md)<`D`\> | - -#### Returns - -`Promise`<`R`\> - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:223 - -___ - -### getUri - -▸ **getUri**(`config?`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config?` | [`AxiosRequestConfig`](../interfaces/verida_account_node._internal_.AxiosRequestConfig.md)<`any`\> | - -#### Returns - -`string` - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:221 - -___ - -### head - -▸ **head**<`T`, `R`, `D`\>(`url`, `config?`): `Promise`<`R`\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `any` | -| `R` | [`AxiosResponse`](../interfaces/verida_account_node._internal_.AxiosResponse.md)<`T`, `any`\> | -| `D` | `any` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `config?` | [`AxiosRequestConfig`](../interfaces/verida_account_node._internal_.AxiosRequestConfig.md)<`D`\> | - -#### Returns - -`Promise`<`R`\> - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:225 - -___ - -### options - -▸ **options**<`T`, `R`, `D`\>(`url`, `config?`): `Promise`<`R`\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `any` | -| `R` | [`AxiosResponse`](../interfaces/verida_account_node._internal_.AxiosResponse.md)<`T`, `any`\> | -| `D` | `any` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `config?` | [`AxiosRequestConfig`](../interfaces/verida_account_node._internal_.AxiosRequestConfig.md)<`D`\> | - -#### Returns - -`Promise`<`R`\> - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:226 - -___ - -### patch - -▸ **patch**<`T`, `R`, `D`\>(`url`, `data?`, `config?`): `Promise`<`R`\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `any` | -| `R` | [`AxiosResponse`](../interfaces/verida_account_node._internal_.AxiosResponse.md)<`T`, `any`\> | -| `D` | `any` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `data?` | `D` | -| `config?` | [`AxiosRequestConfig`](../interfaces/verida_account_node._internal_.AxiosRequestConfig.md)<`D`\> | - -#### Returns - -`Promise`<`R`\> - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:229 - -___ - -### patchForm - -▸ **patchForm**<`T`, `R`, `D`\>(`url`, `data?`, `config?`): `Promise`<`R`\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `any` | -| `R` | [`AxiosResponse`](../interfaces/verida_account_node._internal_.AxiosResponse.md)<`T`, `any`\> | -| `D` | `any` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `data?` | `D` | -| `config?` | [`AxiosRequestConfig`](../interfaces/verida_account_node._internal_.AxiosRequestConfig.md)<`D`\> | - -#### Returns - -`Promise`<`R`\> - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:232 - -___ - -### post - -▸ **post**<`T`, `R`, `D`\>(`url`, `data?`, `config?`): `Promise`<`R`\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `any` | -| `R` | [`AxiosResponse`](../interfaces/verida_account_node._internal_.AxiosResponse.md)<`T`, `any`\> | -| `D` | `any` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `data?` | `D` | -| `config?` | [`AxiosRequestConfig`](../interfaces/verida_account_node._internal_.AxiosRequestConfig.md)<`D`\> | - -#### Returns - -`Promise`<`R`\> - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:227 - -___ - -### postForm - -▸ **postForm**<`T`, `R`, `D`\>(`url`, `data?`, `config?`): `Promise`<`R`\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `any` | -| `R` | [`AxiosResponse`](../interfaces/verida_account_node._internal_.AxiosResponse.md)<`T`, `any`\> | -| `D` | `any` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `data?` | `D` | -| `config?` | [`AxiosRequestConfig`](../interfaces/verida_account_node._internal_.AxiosRequestConfig.md)<`D`\> | - -#### Returns - -`Promise`<`R`\> - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:230 - -___ - -### put - -▸ **put**<`T`, `R`, `D`\>(`url`, `data?`, `config?`): `Promise`<`R`\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `any` | -| `R` | [`AxiosResponse`](../interfaces/verida_account_node._internal_.AxiosResponse.md)<`T`, `any`\> | -| `D` | `any` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `data?` | `D` | -| `config?` | [`AxiosRequestConfig`](../interfaces/verida_account_node._internal_.AxiosRequestConfig.md)<`D`\> | - -#### Returns - -`Promise`<`R`\> - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:228 - -___ - -### putForm - -▸ **putForm**<`T`, `R`, `D`\>(`url`, `data?`, `config?`): `Promise`<`R`\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `any` | -| `R` | [`AxiosResponse`](../interfaces/verida_account_node._internal_.AxiosResponse.md)<`T`, `any`\> | -| `D` | `any` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `data?` | `D` | -| `config?` | [`AxiosRequestConfig`](../interfaces/verida_account_node._internal_.AxiosRequestConfig.md)<`D`\> | - -#### Returns - -`Promise`<`R`\> - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:231 - -___ - -### request - -▸ **request**<`T`, `R`, `D`\>(`config`): `Promise`<`R`\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `any` | -| `R` | [`AxiosResponse`](../interfaces/verida_account_node._internal_.AxiosResponse.md)<`T`, `any`\> | -| `D` | `any` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | [`AxiosRequestConfig`](../interfaces/verida_account_node._internal_.AxiosRequestConfig.md)<`D`\> | - -#### Returns - -`Promise`<`R`\> - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:222 diff --git a/docs/api/verida-js/classes/verida_account_node._internal_.BigNumber.md b/docs/api/verida-js/classes/verida_account_node._internal_.BigNumber.md deleted file mode 100644 index 6504e3c..0000000 --- a/docs/api/verida-js/classes/verida_account_node._internal_.BigNumber.md +++ /dev/null @@ -1,631 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account-node](../modules/verida_account_node.md) / [](../modules/verida_account_node._internal_.md) / BigNumber - -# Class: BigNumber - -[@verida/account-node](../modules/verida_account_node.md).[](../modules/verida_account_node._internal_.md).BigNumber - -## Implements - -- [`Hexable`](../interfaces/verida_account_node._internal_.Hexable.md) - -## Table of contents - -### Constructors - -- [constructor](verida_account_node._internal_.BigNumber.md#constructor) - -### Properties - -- [\_hex](verida_account_node._internal_.BigNumber.md#_hex) -- [\_isBigNumber](verida_account_node._internal_.BigNumber.md#_isbignumber) - -### Methods - -- [abs](verida_account_node._internal_.BigNumber.md#abs) -- [add](verida_account_node._internal_.BigNumber.md#add) -- [and](verida_account_node._internal_.BigNumber.md#and) -- [div](verida_account_node._internal_.BigNumber.md#div) -- [eq](verida_account_node._internal_.BigNumber.md#eq) -- [fromTwos](verida_account_node._internal_.BigNumber.md#fromtwos) -- [gt](verida_account_node._internal_.BigNumber.md#gt) -- [gte](verida_account_node._internal_.BigNumber.md#gte) -- [isNegative](verida_account_node._internal_.BigNumber.md#isnegative) -- [isZero](verida_account_node._internal_.BigNumber.md#iszero) -- [lt](verida_account_node._internal_.BigNumber.md#lt) -- [lte](verida_account_node._internal_.BigNumber.md#lte) -- [mask](verida_account_node._internal_.BigNumber.md#mask) -- [mod](verida_account_node._internal_.BigNumber.md#mod) -- [mul](verida_account_node._internal_.BigNumber.md#mul) -- [or](verida_account_node._internal_.BigNumber.md#or) -- [pow](verida_account_node._internal_.BigNumber.md#pow) -- [shl](verida_account_node._internal_.BigNumber.md#shl) -- [shr](verida_account_node._internal_.BigNumber.md#shr) -- [sub](verida_account_node._internal_.BigNumber.md#sub) -- [toBigInt](verida_account_node._internal_.BigNumber.md#tobigint) -- [toHexString](verida_account_node._internal_.BigNumber.md#tohexstring) -- [toJSON](verida_account_node._internal_.BigNumber.md#tojson) -- [toNumber](verida_account_node._internal_.BigNumber.md#tonumber) -- [toString](verida_account_node._internal_.BigNumber.md#tostring) -- [toTwos](verida_account_node._internal_.BigNumber.md#totwos) -- [xor](verida_account_node._internal_.BigNumber.md#xor) -- [from](verida_account_node._internal_.BigNumber.md#from) -- [isBigNumber](verida_account_node._internal_.BigNumber.md#isbignumber) - -## Constructors - -### constructor - -• **new BigNumber**(`constructorGuard`, `hex`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `constructorGuard` | `any` | -| `hex` | `string` | - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:7 - -## Properties - -### \_hex - -• `Readonly` **\_hex**: `string` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:5 - -___ - -### \_isBigNumber - -• `Readonly` **\_isBigNumber**: `boolean` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:6 - -## Methods - -### abs - -▸ **abs**(): [`BigNumber`](verida_account_node._internal_.BigNumber.md) - -#### Returns - -[`BigNumber`](verida_account_node._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:10 - -___ - -### add - -▸ **add**(`other`): [`BigNumber`](verida_account_node._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_account_node._internal_.md#bignumberish) | - -#### Returns - -[`BigNumber`](verida_account_node._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:11 - -___ - -### and - -▸ **and**(`other`): [`BigNumber`](verida_account_node._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_account_node._internal_.md#bignumberish) | - -#### Returns - -[`BigNumber`](verida_account_node._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:17 - -___ - -### div - -▸ **div**(`other`): [`BigNumber`](verida_account_node._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_account_node._internal_.md#bignumberish) | - -#### Returns - -[`BigNumber`](verida_account_node._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:13 - -___ - -### eq - -▸ **eq**(`other`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_account_node._internal_.md#bignumberish) | - -#### Returns - -`boolean` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:23 - -___ - -### fromTwos - -▸ **fromTwos**(`value`): [`BigNumber`](verida_account_node._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `number` | - -#### Returns - -[`BigNumber`](verida_account_node._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:8 - -___ - -### gt - -▸ **gt**(`other`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_account_node._internal_.md#bignumberish) | - -#### Returns - -`boolean` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:26 - -___ - -### gte - -▸ **gte**(`other`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_account_node._internal_.md#bignumberish) | - -#### Returns - -`boolean` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:27 - -___ - -### isNegative - -▸ **isNegative**(): `boolean` - -#### Returns - -`boolean` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:28 - -___ - -### isZero - -▸ **isZero**(): `boolean` - -#### Returns - -`boolean` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:29 - -___ - -### lt - -▸ **lt**(`other`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_account_node._internal_.md#bignumberish) | - -#### Returns - -`boolean` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:24 - -___ - -### lte - -▸ **lte**(`other`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_account_node._internal_.md#bignumberish) | - -#### Returns - -`boolean` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:25 - -___ - -### mask - -▸ **mask**(`value`): [`BigNumber`](verida_account_node._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `number` | - -#### Returns - -[`BigNumber`](verida_account_node._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:20 - -___ - -### mod - -▸ **mod**(`other`): [`BigNumber`](verida_account_node._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_account_node._internal_.md#bignumberish) | - -#### Returns - -[`BigNumber`](verida_account_node._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:15 - -___ - -### mul - -▸ **mul**(`other`): [`BigNumber`](verida_account_node._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_account_node._internal_.md#bignumberish) | - -#### Returns - -[`BigNumber`](verida_account_node._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:14 - -___ - -### or - -▸ **or**(`other`): [`BigNumber`](verida_account_node._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_account_node._internal_.md#bignumberish) | - -#### Returns - -[`BigNumber`](verida_account_node._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:18 - -___ - -### pow - -▸ **pow**(`other`): [`BigNumber`](verida_account_node._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_account_node._internal_.md#bignumberish) | - -#### Returns - -[`BigNumber`](verida_account_node._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:16 - -___ - -### shl - -▸ **shl**(`value`): [`BigNumber`](verida_account_node._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `number` | - -#### Returns - -[`BigNumber`](verida_account_node._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:21 - -___ - -### shr - -▸ **shr**(`value`): [`BigNumber`](verida_account_node._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `number` | - -#### Returns - -[`BigNumber`](verida_account_node._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:22 - -___ - -### sub - -▸ **sub**(`other`): [`BigNumber`](verida_account_node._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_account_node._internal_.md#bignumberish) | - -#### Returns - -[`BigNumber`](verida_account_node._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:12 - -___ - -### toBigInt - -▸ **toBigInt**(): `bigint` - -#### Returns - -`bigint` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:31 - -___ - -### toHexString - -▸ **toHexString**(): `string` - -#### Returns - -`string` - -#### Implementation of - -[Hexable](../interfaces/verida_account_node._internal_.Hexable.md).[toHexString](../interfaces/verida_account_node._internal_.Hexable.md#tohexstring) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:33 - -___ - -### toJSON - -▸ **toJSON**(`key?`): `any` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `key?` | `string` | - -#### Returns - -`any` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:34 - -___ - -### toNumber - -▸ **toNumber**(): `number` - -#### Returns - -`number` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:30 - -___ - -### toString - -▸ **toString**(): `string` - -#### Returns - -`string` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:32 - -___ - -### toTwos - -▸ **toTwos**(`value`): [`BigNumber`](verida_account_node._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `number` | - -#### Returns - -[`BigNumber`](verida_account_node._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:9 - -___ - -### xor - -▸ **xor**(`other`): [`BigNumber`](verida_account_node._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_account_node._internal_.md#bignumberish) | - -#### Returns - -[`BigNumber`](verida_account_node._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:19 - -___ - -### from - -▸ `Static` **from**(`value`): [`BigNumber`](verida_account_node._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `any` | - -#### Returns - -[`BigNumber`](verida_account_node._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:35 - -___ - -### isBigNumber - -▸ `Static` **isBigNumber**(`value`): value is BigNumber - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `any` | - -#### Returns - -value is BigNumber - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:36 diff --git a/docs/api/verida-js/classes/verida_account_node._internal_.DIDClient.md b/docs/api/verida-js/classes/verida_account_node._internal_.DIDClient.md deleted file mode 100644 index a1a42a4..0000000 --- a/docs/api/verida-js/classes/verida_account_node._internal_.DIDClient.md +++ /dev/null @@ -1,305 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account-node](../modules/verida_account_node.md) / [](../modules/verida_account_node._internal_.md) / DIDClient - -# Class: DIDClient - -[@verida/account-node](../modules/verida_account_node.md).[](../modules/verida_account_node._internal_.md).DIDClient - -## Implements - -- [`IDIDClient`](../interfaces/verida_account_node._internal_.IDIDClient.md) - -## Table of contents - -### Constructors - -- [constructor](verida_account_node._internal_.DIDClient.md#constructor) - -### Properties - -- [config](verida_account_node._internal_.DIDClient.md#config) -- [defaultEndpoints](verida_account_node._internal_.DIDClient.md#defaultendpoints) -- [didResolver](verida_account_node._internal_.DIDClient.md#didresolver) -- [endpointErrors](verida_account_node._internal_.DIDClient.md#endpointerrors) -- [vdaDid](verida_account_node._internal_.DIDClient.md#vdadid) -- [veridaWallet](verida_account_node._internal_.DIDClient.md#veridawallet) - -### Methods - -- [authenticate](verida_account_node._internal_.DIDClient.md#authenticate) -- [authenticated](verida_account_node._internal_.DIDClient.md#authenticated) -- [destroy](verida_account_node._internal_.DIDClient.md#destroy) -- [get](verida_account_node._internal_.DIDClient.md#get) -- [getDid](verida_account_node._internal_.DIDClient.md#getdid) -- [getLastEndpointErrors](verida_account_node._internal_.DIDClient.md#getlastendpointerrors) -- [getPublicKey](verida_account_node._internal_.DIDClient.md#getpublickey) -- [getRpcUrl](verida_account_node._internal_.DIDClient.md#getrpcurl) -- [save](verida_account_node._internal_.DIDClient.md#save) - -## Constructors - -### constructor - -• **new DIDClient**(`config`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | [`DIDClientConfig`](../interfaces/verida_account_node._internal_.DIDClientConfig.md) | - -#### Defined in - -packages/did-client/dist/did-client.d.ts:10 - -## Properties - -### config - -• `Private` **config**: `any` - -#### Defined in - -packages/did-client/dist/did-client.d.ts:4 - -___ - -### defaultEndpoints - -• `Private` `Optional` **defaultEndpoints**: `any` - -#### Defined in - -packages/did-client/dist/did-client.d.ts:8 - -___ - -### didResolver - -• `Private` **didResolver**: `any` - -#### Defined in - -packages/did-client/dist/did-client.d.ts:5 - -___ - -### endpointErrors - -• `Private` `Optional` **endpointErrors**: `any` - -#### Defined in - -packages/did-client/dist/did-client.d.ts:9 - -___ - -### vdaDid - -• `Private` `Optional` **vdaDid**: `any` - -#### Defined in - -packages/did-client/dist/did-client.d.ts:6 - -___ - -### veridaWallet - -• `Private` **veridaWallet**: `any` - -#### Defined in - -packages/did-client/dist/did-client.d.ts:7 - -## Methods - -### authenticate - -▸ **authenticate**(`veridaPrivateKey`, `callType`, `web3Config`, `defaultEndpoints`): `void` - -Unlock save() function by providing verida signing key. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `veridaPrivateKey` | `string` | Private key of a Verida Account. Used to sign transactions in the DID Registry to verify the request originated from the DID owner / controller | -| `callType` | [`Web3CallType`](../modules/verida_account_node._internal_.md#web3calltype) | Blockchain interaction mode. 'web3' \| 'gasless' | -| `web3Config` | [`Web3SelfTransactionConfigPart`](../interfaces/verida_account_node._internal_.Web3SelfTransactionConfigPart.md) \| [`Web3MetaTransactionConfig`](../interfaces/verida_account_node._internal_.Web3MetaTransactionConfig.md) | Web3 configuration. If `web3`, you must provide `privateKey` (MATIC private key that will pay for gas). If `gasless` you must specify `endpointUrl` (URL of the meta transaction server) and any appropriate `serverConfig` and `postConfig`. | -| `defaultEndpoints` | `string`[] | - | - -#### Returns - -`void` - -#### Implementation of - -[IDIDClient](../interfaces/verida_account_node._internal_.IDIDClient.md).[authenticate](../interfaces/verida_account_node._internal_.IDIDClient.md#authenticate) - -#### Defined in - -packages/did-client/dist/did-client.d.ts:19 - -___ - -### authenticated - -▸ **authenticated**(): `boolean` - -#### Returns - -`boolean` - -#### Implementation of - -[IDIDClient](../interfaces/verida_account_node._internal_.IDIDClient.md).[authenticated](../interfaces/verida_account_node._internal_.IDIDClient.md#authenticated) - -#### Defined in - -packages/did-client/dist/did-client.d.ts:20 - -___ - -### destroy - -▸ **destroy**(): `Promise`<[`VdaDidEndpointResponses`](../modules/verida_account_node._internal_.md#vdadidendpointresponses)\> - -Destroy this DID - -Note: This can not be reversed and is written to the blockchain - -#### Returns - -`Promise`<[`VdaDidEndpointResponses`](../modules/verida_account_node._internal_.md#vdadidendpointresponses)\> - -#### Defined in - -packages/did-client/dist/did-client.d.ts:28 - -___ - -### get - -▸ **get**(`did`): `Promise`<[`default`](verida_account_node._internal_.default-3.md)\> - -Get original document loaded from blockchain. Creates a new document if it didn't exist - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did` | `string` | - -#### Returns - -`Promise`<[`default`](verida_account_node._internal_.default-3.md)\> - -DID Document instance - -#### Implementation of - -[IDIDClient](../interfaces/verida_account_node._internal_.IDIDClient.md).[get](../interfaces/verida_account_node._internal_.IDIDClient.md#get) - -#### Defined in - -packages/did-client/dist/did-client.d.ts:42 - -___ - -### getDid - -▸ **getDid**(): `undefined` \| `string` - -#### Returns - -`undefined` \| `string` - -#### Implementation of - -[IDIDClient](../interfaces/verida_account_node._internal_.IDIDClient.md).[getDid](../interfaces/verida_account_node._internal_.IDIDClient.md#getdid) - -#### Defined in - -packages/did-client/dist/did-client.d.ts:21 - -___ - -### getLastEndpointErrors - -▸ **getLastEndpointErrors**(): [`VdaDidEndpointResponses`](../modules/verida_account_node._internal_.md#vdadidendpointresponses) - -#### Returns - -[`VdaDidEndpointResponses`](../modules/verida_account_node._internal_.md#vdadidendpointresponses) - -#### Implementation of - -[IDIDClient](../interfaces/verida_account_node._internal_.IDIDClient.md).[getLastEndpointErrors](../interfaces/verida_account_node._internal_.IDIDClient.md#getlastendpointerrors) - -#### Defined in - -packages/did-client/dist/did-client.d.ts:36 - -___ - -### getPublicKey - -▸ **getPublicKey**(): `undefined` \| `string` - -#### Returns - -`undefined` \| `string` - -#### Implementation of - -[IDIDClient](../interfaces/verida_account_node._internal_.IDIDClient.md).[getPublicKey](../interfaces/verida_account_node._internal_.IDIDClient.md#getpublickey) - -#### Defined in - -packages/did-client/dist/did-client.d.ts:22 - -___ - -### getRpcUrl - -▸ **getRpcUrl**(): `string` - -#### Returns - -`string` - -#### Implementation of - -[IDIDClient](../interfaces/verida_account_node._internal_.IDIDClient.md).[getRpcUrl](../interfaces/verida_account_node._internal_.IDIDClient.md#getrpcurl) - -#### Defined in - -packages/did-client/dist/did-client.d.ts:11 - -___ - -### save - -▸ **save**(`document`): `Promise`<[`VdaDidEndpointResponses`](../modules/verida_account_node._internal_.md#vdadidendpointresponses)\> - -Save DIDDocument to the chain - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `document` | [`default`](verida_account_node._internal_.default-3.md) | Updated DIDDocuent | - -#### Returns - -`Promise`<[`VdaDidEndpointResponses`](../modules/verida_account_node._internal_.md#vdadidendpointresponses)\> - -true if success. - -#### Implementation of - -[IDIDClient](../interfaces/verida_account_node._internal_.IDIDClient.md).[save](../interfaces/verida_account_node._internal_.IDIDClient.md#save) - -#### Defined in - -packages/did-client/dist/did-client.d.ts:35 diff --git a/docs/api/verida-js/classes/verida_account_node._internal_.Description.md b/docs/api/verida-js/classes/verida_account_node._internal_.Description.md deleted file mode 100644 index 5477fb1..0000000 --- a/docs/api/verida-js/classes/verida_account_node._internal_.Description.md +++ /dev/null @@ -1,45 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account-node](../modules/verida_account_node.md) / [](../modules/verida_account_node._internal_.md) / Description - -# Class: Description - -[@verida/account-node](../modules/verida_account_node.md).[](../modules/verida_account_node._internal_.md).Description - -## Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `any` | - -## Hierarchy - -- **`Description`** - - ↳ [`ForkEvent`](verida_account_node._internal_.ForkEvent.md) - -## Table of contents - -### Constructors - -- [constructor](verida_account_node._internal_.Description.md#constructor) - -## Constructors - -### constructor - -• **new Description**<`T`\>(`info`) - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `any` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `info` | { [K in string \| number \| symbol]: T[K] } | - -#### Defined in - -node_modules/@ethersproject/properties/lib/index.d.ts:13 diff --git a/docs/api/verida-js/classes/verida_account_node._internal_.ForkEvent.md b/docs/api/verida-js/classes/verida_account_node._internal_.ForkEvent.md deleted file mode 100644 index 742b5e8..0000000 --- a/docs/api/verida-js/classes/verida_account_node._internal_.ForkEvent.md +++ /dev/null @@ -1,86 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account-node](../modules/verida_account_node.md) / [](../modules/verida_account_node._internal_.md) / ForkEvent - -# Class: ForkEvent - -[@verida/account-node](../modules/verida_account_node.md).[](../modules/verida_account_node._internal_.md).ForkEvent - -## Hierarchy - -- [`Description`](verida_account_node._internal_.Description.md) - - ↳ **`ForkEvent`** - -## Table of contents - -### Constructors - -- [constructor](verida_account_node._internal_.ForkEvent.md#constructor) - -### Properties - -- [\_isForkEvent](verida_account_node._internal_.ForkEvent.md#_isforkevent) -- [expiry](verida_account_node._internal_.ForkEvent.md#expiry) - -### Methods - -- [isForkEvent](verida_account_node._internal_.ForkEvent.md#isforkevent) - -## Constructors - -### constructor - -• **new ForkEvent**(`info`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `info` | `Object` | - -#### Inherited from - -[Description](verida_account_node._internal_.Description.md).[constructor](verida_account_node._internal_.Description.md#constructor) - -#### Defined in - -node_modules/@ethersproject/properties/lib/index.d.ts:13 - -## Properties - -### \_isForkEvent - -• `Optional` `Readonly` **\_isForkEvent**: `boolean` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:103 - -___ - -### expiry - -• `Readonly` **expiry**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:102 - -## Methods - -### isForkEvent - -▸ `Static` **isForkEvent**(`value`): value is ForkEvent - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `any` | - -#### Returns - -value is ForkEvent - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:104 diff --git a/docs/api/verida-js/classes/verida_account_node._internal_.Provider.md b/docs/api/verida-js/classes/verida_account_node._internal_.Provider.md deleted file mode 100644 index 0e9045c..0000000 --- a/docs/api/verida-js/classes/verida_account_node._internal_.Provider.md +++ /dev/null @@ -1,645 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account-node](../modules/verida_account_node.md) / [](../modules/verida_account_node._internal_.md) / Provider - -# Class: Provider - -[@verida/account-node](../modules/verida_account_node.md).[](../modules/verida_account_node._internal_.md).Provider - -## Implements - -- [`OnceBlockable`](../interfaces/verida_account_node._internal_.OnceBlockable.md) - -## Table of contents - -### Constructors - -- [constructor](verida_account_node._internal_.Provider.md#constructor) - -### Properties - -- [\_isProvider](verida_account_node._internal_.Provider.md#_isprovider) - -### Methods - -- [addListener](verida_account_node._internal_.Provider.md#addlistener) -- [call](verida_account_node._internal_.Provider.md#call) -- [emit](verida_account_node._internal_.Provider.md#emit) -- [estimateGas](verida_account_node._internal_.Provider.md#estimategas) -- [getBalance](verida_account_node._internal_.Provider.md#getbalance) -- [getBlock](verida_account_node._internal_.Provider.md#getblock) -- [getBlockNumber](verida_account_node._internal_.Provider.md#getblocknumber) -- [getBlockWithTransactions](verida_account_node._internal_.Provider.md#getblockwithtransactions) -- [getCode](verida_account_node._internal_.Provider.md#getcode) -- [getFeeData](verida_account_node._internal_.Provider.md#getfeedata) -- [getGasPrice](verida_account_node._internal_.Provider.md#getgasprice) -- [getLogs](verida_account_node._internal_.Provider.md#getlogs) -- [getNetwork](verida_account_node._internal_.Provider.md#getnetwork) -- [getStorageAt](verida_account_node._internal_.Provider.md#getstorageat) -- [getTransaction](verida_account_node._internal_.Provider.md#gettransaction) -- [getTransactionCount](verida_account_node._internal_.Provider.md#gettransactioncount) -- [getTransactionReceipt](verida_account_node._internal_.Provider.md#gettransactionreceipt) -- [listenerCount](verida_account_node._internal_.Provider.md#listenercount) -- [listeners](verida_account_node._internal_.Provider.md#listeners) -- [lookupAddress](verida_account_node._internal_.Provider.md#lookupaddress) -- [off](verida_account_node._internal_.Provider.md#off) -- [on](verida_account_node._internal_.Provider.md#on) -- [once](verida_account_node._internal_.Provider.md#once) -- [removeAllListeners](verida_account_node._internal_.Provider.md#removealllisteners) -- [removeListener](verida_account_node._internal_.Provider.md#removelistener) -- [resolveName](verida_account_node._internal_.Provider.md#resolvename) -- [sendTransaction](verida_account_node._internal_.Provider.md#sendtransaction) -- [waitForTransaction](verida_account_node._internal_.Provider.md#waitfortransaction) -- [isProvider](verida_account_node._internal_.Provider.md#isprovider) - -## Constructors - -### constructor - -• **new Provider**() - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:153 - -## Properties - -### \_isProvider - -• `Readonly` **\_isProvider**: `boolean` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:152 - -## Methods - -### addListener - -▸ **addListener**(`eventName`, `listener`): [`Provider`](verida_account_node._internal_.Provider.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | [`EventType`](../modules/verida_account_node._internal_.md#eventtype) | -| `listener` | [`Listener`](../modules/verida_account_node._internal_.md#listener) | - -#### Returns - -[`Provider`](verida_account_node._internal_.Provider.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:149 - -___ - -### call - -▸ `Abstract` **call**(`transaction`, `blockTag?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transaction` | [`Deferrable`](../modules/verida_account_node._internal_.md#deferrable)<[`TransactionRequest`](../modules/verida_account_node._internal_.md#transactionrequest)\> | -| `blockTag?` | [`BlockTag`](../modules/verida_account_node._internal_.md#blocktag) \| `Promise`<[`BlockTag`](../modules/verida_account_node._internal_.md#blocktag)\> | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:133 - -___ - -### emit - -▸ `Abstract` **emit**(`eventName`, ...`args`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | [`EventType`](../modules/verida_account_node._internal_.md#eventtype) | -| `...args` | `any`[] | - -#### Returns - -`boolean` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:144 - -___ - -### estimateGas - -▸ `Abstract` **estimateGas**(`transaction`): `Promise`<[`BigNumber`](verida_account_node._internal_.BigNumber.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transaction` | [`Deferrable`](../modules/verida_account_node._internal_.md#deferrable)<[`TransactionRequest`](../modules/verida_account_node._internal_.md#transactionrequest)\> | - -#### Returns - -`Promise`<[`BigNumber`](verida_account_node._internal_.BigNumber.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:134 - -___ - -### getBalance - -▸ `Abstract` **getBalance**(`addressOrName`, `blockTag?`): `Promise`<[`BigNumber`](verida_account_node._internal_.BigNumber.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `addressOrName` | `string` \| `Promise`<`string`\> | -| `blockTag?` | [`BlockTag`](../modules/verida_account_node._internal_.md#blocktag) \| `Promise`<[`BlockTag`](../modules/verida_account_node._internal_.md#blocktag)\> | - -#### Returns - -`Promise`<[`BigNumber`](verida_account_node._internal_.BigNumber.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:128 - -___ - -### getBlock - -▸ `Abstract` **getBlock**(`blockHashOrBlockTag`): `Promise`<[`Block`](../interfaces/verida_account_node._internal_.Block.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `blockHashOrBlockTag` | [`BlockTag`](../modules/verida_account_node._internal_.md#blocktag) \| `Promise`<[`BlockTag`](../modules/verida_account_node._internal_.md#blocktag)\> | - -#### Returns - -`Promise`<[`Block`](../interfaces/verida_account_node._internal_.Block.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:135 - -___ - -### getBlockNumber - -▸ `Abstract` **getBlockNumber**(): `Promise`<`number`\> - -#### Returns - -`Promise`<`number`\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:125 - -___ - -### getBlockWithTransactions - -▸ `Abstract` **getBlockWithTransactions**(`blockHashOrBlockTag`): `Promise`<[`BlockWithTransactions`](../interfaces/verida_account_node._internal_.BlockWithTransactions.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `blockHashOrBlockTag` | [`BlockTag`](../modules/verida_account_node._internal_.md#blocktag) \| `Promise`<[`BlockTag`](../modules/verida_account_node._internal_.md#blocktag)\> | - -#### Returns - -`Promise`<[`BlockWithTransactions`](../interfaces/verida_account_node._internal_.BlockWithTransactions.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:136 - -___ - -### getCode - -▸ `Abstract` **getCode**(`addressOrName`, `blockTag?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `addressOrName` | `string` \| `Promise`<`string`\> | -| `blockTag?` | [`BlockTag`](../modules/verida_account_node._internal_.md#blocktag) \| `Promise`<[`BlockTag`](../modules/verida_account_node._internal_.md#blocktag)\> | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:130 - -___ - -### getFeeData - -▸ **getFeeData**(): `Promise`<[`FeeData`](../interfaces/verida_account_node._internal_.FeeData.md)\> - -#### Returns - -`Promise`<[`FeeData`](../interfaces/verida_account_node._internal_.FeeData.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:127 - -___ - -### getGasPrice - -▸ `Abstract` **getGasPrice**(): `Promise`<[`BigNumber`](verida_account_node._internal_.BigNumber.md)\> - -#### Returns - -`Promise`<[`BigNumber`](verida_account_node._internal_.BigNumber.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:126 - -___ - -### getLogs - -▸ `Abstract` **getLogs**(`filter`): `Promise`<[`Log`](../interfaces/verida_account_node._internal_.Log.md)[]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `filter` | [`Filter`](../interfaces/verida_account_node._internal_.Filter.md) | - -#### Returns - -`Promise`<[`Log`](../interfaces/verida_account_node._internal_.Log.md)[]\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:139 - -___ - -### getNetwork - -▸ `Abstract` **getNetwork**(): `Promise`<[`Network`](../modules/verida_account_node._internal_.md#network)\> - -#### Returns - -`Promise`<[`Network`](../modules/verida_account_node._internal_.md#network)\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:124 - -___ - -### getStorageAt - -▸ `Abstract` **getStorageAt**(`addressOrName`, `position`, `blockTag?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `addressOrName` | `string` \| `Promise`<`string`\> | -| `position` | [`BigNumberish`](../modules/verida_account_node._internal_.md#bignumberish) \| `Promise`<[`BigNumberish`](../modules/verida_account_node._internal_.md#bignumberish)\> | -| `blockTag?` | [`BlockTag`](../modules/verida_account_node._internal_.md#blocktag) \| `Promise`<[`BlockTag`](../modules/verida_account_node._internal_.md#blocktag)\> | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:131 - -___ - -### getTransaction - -▸ `Abstract` **getTransaction**(`transactionHash`): `Promise`<[`TransactionResponse`](../interfaces/verida_account_node._internal_.TransactionResponse.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transactionHash` | `string` | - -#### Returns - -`Promise`<[`TransactionResponse`](../interfaces/verida_account_node._internal_.TransactionResponse.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:137 - -___ - -### getTransactionCount - -▸ `Abstract` **getTransactionCount**(`addressOrName`, `blockTag?`): `Promise`<`number`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `addressOrName` | `string` \| `Promise`<`string`\> | -| `blockTag?` | [`BlockTag`](../modules/verida_account_node._internal_.md#blocktag) \| `Promise`<[`BlockTag`](../modules/verida_account_node._internal_.md#blocktag)\> | - -#### Returns - -`Promise`<`number`\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:129 - -___ - -### getTransactionReceipt - -▸ `Abstract` **getTransactionReceipt**(`transactionHash`): `Promise`<[`TransactionReceipt`](../interfaces/verida_account_node._internal_.TransactionReceipt.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transactionHash` | `string` | - -#### Returns - -`Promise`<[`TransactionReceipt`](../interfaces/verida_account_node._internal_.TransactionReceipt.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:138 - -___ - -### listenerCount - -▸ `Abstract` **listenerCount**(`eventName?`): `number` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName?` | [`EventType`](../modules/verida_account_node._internal_.md#eventtype) | - -#### Returns - -`number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:145 - -___ - -### listeners - -▸ `Abstract` **listeners**(`eventName?`): [`Listener`](../modules/verida_account_node._internal_.md#listener)[] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName?` | [`EventType`](../modules/verida_account_node._internal_.md#eventtype) | - -#### Returns - -[`Listener`](../modules/verida_account_node._internal_.md#listener)[] - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:146 - -___ - -### lookupAddress - -▸ `Abstract` **lookupAddress**(`address`): `Promise`<``null`` \| `string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `address` | `string` \| `Promise`<`string`\> | - -#### Returns - -`Promise`<``null`` \| `string`\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:141 - -___ - -### off - -▸ `Abstract` **off**(`eventName`, `listener?`): [`Provider`](verida_account_node._internal_.Provider.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | [`EventType`](../modules/verida_account_node._internal_.md#eventtype) | -| `listener?` | [`Listener`](../modules/verida_account_node._internal_.md#listener) | - -#### Returns - -[`Provider`](verida_account_node._internal_.Provider.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:147 - -___ - -### on - -▸ `Abstract` **on**(`eventName`, `listener`): [`Provider`](verida_account_node._internal_.Provider.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | [`EventType`](../modules/verida_account_node._internal_.md#eventtype) | -| `listener` | [`Listener`](../modules/verida_account_node._internal_.md#listener) | - -#### Returns - -[`Provider`](verida_account_node._internal_.Provider.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:142 - -___ - -### once - -▸ `Abstract` **once**(`eventName`, `listener`): [`Provider`](verida_account_node._internal_.Provider.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | [`EventType`](../modules/verida_account_node._internal_.md#eventtype) | -| `listener` | [`Listener`](../modules/verida_account_node._internal_.md#listener) | - -#### Returns - -[`Provider`](verida_account_node._internal_.Provider.md) - -#### Implementation of - -[OnceBlockable](../interfaces/verida_account_node._internal_.OnceBlockable.md).[once](../interfaces/verida_account_node._internal_.OnceBlockable.md#once) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:143 - -___ - -### removeAllListeners - -▸ `Abstract` **removeAllListeners**(`eventName?`): [`Provider`](verida_account_node._internal_.Provider.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName?` | [`EventType`](../modules/verida_account_node._internal_.md#eventtype) | - -#### Returns - -[`Provider`](verida_account_node._internal_.Provider.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:148 - -___ - -### removeListener - -▸ **removeListener**(`eventName`, `listener`): [`Provider`](verida_account_node._internal_.Provider.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | [`EventType`](../modules/verida_account_node._internal_.md#eventtype) | -| `listener` | [`Listener`](../modules/verida_account_node._internal_.md#listener) | - -#### Returns - -[`Provider`](verida_account_node._internal_.Provider.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:150 - -___ - -### resolveName - -▸ `Abstract` **resolveName**(`name`): `Promise`<``null`` \| `string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` \| `Promise`<`string`\> | - -#### Returns - -`Promise`<``null`` \| `string`\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:140 - -___ - -### sendTransaction - -▸ `Abstract` **sendTransaction**(`signedTransaction`): `Promise`<[`TransactionResponse`](../interfaces/verida_account_node._internal_.TransactionResponse.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `signedTransaction` | `string` \| `Promise`<`string`\> | - -#### Returns - -`Promise`<[`TransactionResponse`](../interfaces/verida_account_node._internal_.TransactionResponse.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:132 - -___ - -### waitForTransaction - -▸ `Abstract` **waitForTransaction**(`transactionHash`, `confirmations?`, `timeout?`): `Promise`<[`TransactionReceipt`](../interfaces/verida_account_node._internal_.TransactionReceipt.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transactionHash` | `string` | -| `confirmations?` | `number` | -| `timeout?` | `number` | - -#### Returns - -`Promise`<[`TransactionReceipt`](../interfaces/verida_account_node._internal_.TransactionReceipt.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:151 - -___ - -### isProvider - -▸ `Static` **isProvider**(`value`): value is Provider - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `any` | - -#### Returns - -value is Provider - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:154 diff --git a/docs/api/verida-js/classes/verida_account_node._internal_.Signer.md b/docs/api/verida-js/classes/verida_account_node._internal_.Signer.md deleted file mode 100644 index 57e8176..0000000 --- a/docs/api/verida-js/classes/verida_account_node._internal_.Signer.md +++ /dev/null @@ -1,383 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account-node](../modules/verida_account_node.md) / [](../modules/verida_account_node._internal_.md) / Signer - -# Class: Signer - -[@verida/account-node](../modules/verida_account_node.md).[](../modules/verida_account_node._internal_.md).Signer - -## Table of contents - -### Constructors - -- [constructor](verida_account_node._internal_.Signer.md#constructor) - -### Properties - -- [\_isSigner](verida_account_node._internal_.Signer.md#_issigner) -- [provider](verida_account_node._internal_.Signer.md#provider) - -### Methods - -- [\_checkProvider](verida_account_node._internal_.Signer.md#_checkprovider) -- [call](verida_account_node._internal_.Signer.md#call) -- [checkTransaction](verida_account_node._internal_.Signer.md#checktransaction) -- [connect](verida_account_node._internal_.Signer.md#connect) -- [estimateGas](verida_account_node._internal_.Signer.md#estimategas) -- [getAddress](verida_account_node._internal_.Signer.md#getaddress) -- [getBalance](verida_account_node._internal_.Signer.md#getbalance) -- [getChainId](verida_account_node._internal_.Signer.md#getchainid) -- [getFeeData](verida_account_node._internal_.Signer.md#getfeedata) -- [getGasPrice](verida_account_node._internal_.Signer.md#getgasprice) -- [getTransactionCount](verida_account_node._internal_.Signer.md#gettransactioncount) -- [populateTransaction](verida_account_node._internal_.Signer.md#populatetransaction) -- [resolveName](verida_account_node._internal_.Signer.md#resolvename) -- [sendTransaction](verida_account_node._internal_.Signer.md#sendtransaction) -- [signMessage](verida_account_node._internal_.Signer.md#signmessage) -- [signTransaction](verida_account_node._internal_.Signer.md#signtransaction) -- [isSigner](verida_account_node._internal_.Signer.md#issigner) - -## Constructors - -### constructor - -• **new Signer**() - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:30 - -## Properties - -### \_isSigner - -• `Readonly` **\_isSigner**: `boolean` - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:29 - -___ - -### provider - -• `Optional` `Readonly` **provider**: [`Provider`](verida_account_node._internal_.Provider.md) - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:24 - -## Methods - -### \_checkProvider - -▸ **_checkProvider**(`operation?`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `operation?` | `string` | - -#### Returns - -`void` - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:42 - -___ - -### call - -▸ **call**(`transaction`, `blockTag?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transaction` | [`Deferrable`](../modules/verida_account_node._internal_.md#deferrable)<[`TransactionRequest`](../modules/verida_account_node._internal_.md#transactionrequest)\> | -| `blockTag?` | [`BlockTag`](../modules/verida_account_node._internal_.md#blocktag) | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:34 - -___ - -### checkTransaction - -▸ **checkTransaction**(`transaction`): [`Deferrable`](../modules/verida_account_node._internal_.md#deferrable)<[`TransactionRequest`](../modules/verida_account_node._internal_.md#transactionrequest)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transaction` | [`Deferrable`](../modules/verida_account_node._internal_.md#deferrable)<[`TransactionRequest`](../modules/verida_account_node._internal_.md#transactionrequest)\> | - -#### Returns - -[`Deferrable`](../modules/verida_account_node._internal_.md#deferrable)<[`TransactionRequest`](../modules/verida_account_node._internal_.md#transactionrequest)\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:40 - -___ - -### connect - -▸ `Abstract` **connect**(`provider`): [`Signer`](verida_account_node._internal_.Signer.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `provider` | [`Provider`](verida_account_node._internal_.Provider.md) | - -#### Returns - -[`Signer`](verida_account_node._internal_.Signer.md) - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:28 - -___ - -### estimateGas - -▸ **estimateGas**(`transaction`): `Promise`<[`BigNumber`](verida_account_node._internal_.BigNumber.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transaction` | [`Deferrable`](../modules/verida_account_node._internal_.md#deferrable)<[`TransactionRequest`](../modules/verida_account_node._internal_.md#transactionrequest)\> | - -#### Returns - -`Promise`<[`BigNumber`](verida_account_node._internal_.BigNumber.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:33 - -___ - -### getAddress - -▸ `Abstract` **getAddress**(): `Promise`<`string`\> - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:25 - -___ - -### getBalance - -▸ **getBalance**(`blockTag?`): `Promise`<[`BigNumber`](verida_account_node._internal_.BigNumber.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `blockTag?` | [`BlockTag`](../modules/verida_account_node._internal_.md#blocktag) | - -#### Returns - -`Promise`<[`BigNumber`](verida_account_node._internal_.BigNumber.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:31 - -___ - -### getChainId - -▸ **getChainId**(): `Promise`<`number`\> - -#### Returns - -`Promise`<`number`\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:36 - -___ - -### getFeeData - -▸ **getFeeData**(): `Promise`<[`FeeData`](../interfaces/verida_account_node._internal_.FeeData.md)\> - -#### Returns - -`Promise`<[`FeeData`](../interfaces/verida_account_node._internal_.FeeData.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:38 - -___ - -### getGasPrice - -▸ **getGasPrice**(): `Promise`<[`BigNumber`](verida_account_node._internal_.BigNumber.md)\> - -#### Returns - -`Promise`<[`BigNumber`](verida_account_node._internal_.BigNumber.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:37 - -___ - -### getTransactionCount - -▸ **getTransactionCount**(`blockTag?`): `Promise`<`number`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `blockTag?` | [`BlockTag`](../modules/verida_account_node._internal_.md#blocktag) | - -#### Returns - -`Promise`<`number`\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:32 - -___ - -### populateTransaction - -▸ **populateTransaction**(`transaction`): `Promise`<[`TransactionRequest`](../modules/verida_account_node._internal_.md#transactionrequest)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transaction` | [`Deferrable`](../modules/verida_account_node._internal_.md#deferrable)<[`TransactionRequest`](../modules/verida_account_node._internal_.md#transactionrequest)\> | - -#### Returns - -`Promise`<[`TransactionRequest`](../modules/verida_account_node._internal_.md#transactionrequest)\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:41 - -___ - -### resolveName - -▸ **resolveName**(`name`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:39 - -___ - -### sendTransaction - -▸ **sendTransaction**(`transaction`): `Promise`<[`TransactionResponse`](../interfaces/verida_account_node._internal_.TransactionResponse.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transaction` | [`Deferrable`](../modules/verida_account_node._internal_.md#deferrable)<[`TransactionRequest`](../modules/verida_account_node._internal_.md#transactionrequest)\> | - -#### Returns - -`Promise`<[`TransactionResponse`](../interfaces/verida_account_node._internal_.TransactionResponse.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:35 - -___ - -### signMessage - -▸ `Abstract` **signMessage**(`message`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `message` | `string` \| [`Bytes`](../modules/verida_account_node._internal_.md#bytes) | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:26 - -___ - -### signTransaction - -▸ `Abstract` **signTransaction**(`transaction`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transaction` | [`Deferrable`](../modules/verida_account_node._internal_.md#deferrable)<[`TransactionRequest`](../modules/verida_account_node._internal_.md#transactionrequest)\> | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:27 - -___ - -### isSigner - -▸ `Static` **isSigner**(`value`): value is Signer - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `any` | - -#### Returns - -value is Signer - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:43 diff --git a/docs/api/verida-js/classes/verida_account_node._internal_.default-1.md b/docs/api/verida-js/classes/verida_account_node._internal_.default-1.md deleted file mode 100644 index ae85d7d..0000000 --- a/docs/api/verida-js/classes/verida_account_node._internal_.default-1.md +++ /dev/null @@ -1,218 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account-node](../modules/verida_account_node.md) / [](../modules/verida_account_node._internal_.md) / default - -# Class: default - -[@verida/account-node](../modules/verida_account_node.md).[](../modules/verida_account_node._internal_.md).default - -## Table of contents - -### Constructors - -- [constructor](verida_account_node._internal_.default-1.md#constructor) - -### Properties - -- [\_did](verida_account_node._internal_.default-1.md#_did) -- [\_network](verida_account_node._internal_.default-1.md#_network) -- [\_privateKey](verida_account_node._internal_.default-1.md#_privatekey) -- [\_publicKey](verida_account_node._internal_.default-1.md#_publickey) -- [load](verida_account_node._internal_.default-1.md#load) - -### Accessors - -- [did](verida_account_node._internal_.default-1.md#did) -- [privateKey](verida_account_node._internal_.default-1.md#privatekey) -- [privateKeyBase58](verida_account_node._internal_.default-1.md#privatekeybase58) -- [privateKeyBuffer](verida_account_node._internal_.default-1.md#privatekeybuffer) -- [publicKey](verida_account_node._internal_.default-1.md#publickey) -- [publicKeyBase58](verida_account_node._internal_.default-1.md#publickeybase58) -- [publicKeyBuffer](verida_account_node._internal_.default-1.md#publickeybuffer) - -### Methods - -- [createRandom](verida_account_node._internal_.default-1.md#createrandom) - -## Constructors - -### constructor - -• **new default**(`privateKey`, `network`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `privateKey` | `string` | -| `network` | `string` | - -#### Defined in - -packages/did-client/dist/wallet.d.ts:6 - -## Properties - -### \_did - -• `Private` **\_did**: `any` - -#### Defined in - -packages/did-client/dist/wallet.d.ts:2 - -___ - -### \_network - -• `Private` **\_network**: `any` - -#### Defined in - -packages/did-client/dist/wallet.d.ts:5 - -___ - -### \_privateKey - -• `Private` **\_privateKey**: `any` - -#### Defined in - -packages/did-client/dist/wallet.d.ts:4 - -___ - -### \_publicKey - -• `Private` **\_publicKey**: `any` - -#### Defined in - -packages/did-client/dist/wallet.d.ts:3 - -___ - -### load - -• `Private` **load**: `any` - -#### Defined in - -packages/did-client/dist/wallet.d.ts:8 - -## Accessors - -### did - -• `get` **did**(): `string` - -#### Returns - -`string` - -#### Defined in - -packages/did-client/dist/wallet.d.ts:9 - -___ - -### privateKey - -• `get` **privateKey**(): `string` - -#### Returns - -`string` - -#### Defined in - -packages/did-client/dist/wallet.d.ts:10 - -___ - -### privateKeyBase58 - -• `get` **privateKeyBase58**(): `string` - -#### Returns - -`string` - -#### Defined in - -packages/did-client/dist/wallet.d.ts:14 - -___ - -### privateKeyBuffer - -• `get` **privateKeyBuffer**(): `Uint8Array` - -#### Returns - -`Uint8Array` - -#### Defined in - -packages/did-client/dist/wallet.d.ts:12 - -___ - -### publicKey - -• `get` **publicKey**(): `string` - -#### Returns - -`string` - -#### Defined in - -packages/did-client/dist/wallet.d.ts:11 - -___ - -### publicKeyBase58 - -• `get` **publicKeyBase58**(): `string` - -#### Returns - -`string` - -#### Defined in - -packages/did-client/dist/wallet.d.ts:15 - -___ - -### publicKeyBuffer - -• `get` **publicKeyBuffer**(): `Uint8Array` - -#### Returns - -`Uint8Array` - -#### Defined in - -packages/did-client/dist/wallet.d.ts:13 - -## Methods - -### createRandom - -▸ `Static` **createRandom**(`network?`): [`default`](verida_account_node._internal_.default-1.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `network?` | `string` | - -#### Returns - -[`default`](verida_account_node._internal_.default-1.md) - -#### Defined in - -packages/did-client/dist/wallet.d.ts:7 diff --git a/docs/api/verida-js/classes/verida_account_node._internal_.default-2.md b/docs/api/verida-js/classes/verida_account_node._internal_.default-2.md deleted file mode 100644 index 5d0d9c3..0000000 --- a/docs/api/verida-js/classes/verida_account_node._internal_.default-2.md +++ /dev/null @@ -1,423 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account-node](../modules/verida_account_node.md) / [](../modules/verida_account_node._internal_.md) / default - -# Class: default - -[@verida/account-node](../modules/verida_account_node.md).[](../modules/verida_account_node._internal_.md).default - -Class that takes a signature (generated from a signed consent message) and generates a -collection of asymmetric keys, symmetric key and signing key for a given secure storage -context. - -## Implements - -- [`IKeyring`](../interfaces/verida_account_node._internal_.IKeyring.md) - -## Table of contents - -### Constructors - -- [constructor](verida_account_node._internal_.default-2.md#constructor) - -### Properties - -- [asymKeyPair](verida_account_node._internal_.default-2.md#asymkeypair) -- [buildKey](verida_account_node._internal_.default-2.md#buildkey) -- [seed](verida_account_node._internal_.default-2.md#seed) -- [signKeyPair](verida_account_node._internal_.default-2.md#signkeypair) -- [storageContextKeys](verida_account_node._internal_.default-2.md#storagecontextkeys) -- [symKey](verida_account_node._internal_.default-2.md#symkey) - -### Methods - -- [\_init](verida_account_node._internal_.default-2.md#_init) -- [asymDecrypt](verida_account_node._internal_.default-2.md#asymdecrypt) -- [asymEncrypt](verida_account_node._internal_.default-2.md#asymencrypt) -- [buildSharedKeyEnd](verida_account_node._internal_.default-2.md#buildsharedkeyend) -- [buildSharedKeyStart](verida_account_node._internal_.default-2.md#buildsharedkeystart) -- [getKeys](verida_account_node._internal_.default-2.md#getkeys) -- [getSeed](verida_account_node._internal_.default-2.md#getseed) -- [getStorageContextKey](verida_account_node._internal_.default-2.md#getstoragecontextkey) -- [publicKeys](verida_account_node._internal_.default-2.md#publickeys) -- [sign](verida_account_node._internal_.default-2.md#sign) -- [symDecrypt](verida_account_node._internal_.default-2.md#symdecrypt) -- [symEncrypt](verida_account_node._internal_.default-2.md#symencrypt) -- [verifySig](verida_account_node._internal_.default-2.md#verifysig) - -## Constructors - -### constructor - -• **new default**(`seed`) - -A string used as a seed for this keyring. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `seed` | `string` | - -#### Defined in - -packages/keyring/dist/keyring.d.ts:19 - -## Properties - -### asymKeyPair - -• `Optional` **asymKeyPair**: `any` - -#### Defined in - -packages/keyring/dist/keyring.d.ts:9 - -___ - -### buildKey - -• `Private` **buildKey**: `any` - -Helper function that generates a key of the appropriate type - -**`param`** - -**`param`** - -**`returns`** - -#### Defined in - -packages/keyring/dist/keyring.d.ts:29 - -___ - -### seed - -• `Private` **seed**: `any` - -#### Defined in - -packages/keyring/dist/keyring.d.ts:12 - -___ - -### signKeyPair - -• `Optional` **signKeyPair**: `any` - -#### Defined in - -packages/keyring/dist/keyring.d.ts:10 - -___ - -### storageContextKeys - -• `Private` **storageContextKeys**: `any` - -#### Defined in - -packages/keyring/dist/keyring.d.ts:13 - -___ - -### symKey - -• `Optional` **symKey**: `Uint8Array` - -#### Defined in - -packages/keyring/dist/keyring.d.ts:11 - -## Methods - -### \_init - -▸ **_init**(): `Promise`<`void`\> - -#### Returns - -`Promise`<`void`\> - -#### Implementation of - -[IKeyring](../interfaces/verida_account_node._internal_.IKeyring.md).[_init](../interfaces/verida_account_node._internal_.IKeyring.md#_init) - -#### Defined in - -packages/keyring/dist/keyring.d.ts:21 - -___ - -### asymDecrypt - -▸ **asymDecrypt**(`messageWithNonce`, `secretOrSharedKey`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `messageWithNonce` | `string` | -| `secretOrSharedKey` | `Uint8Array` | - -#### Returns - -`Promise`<`any`\> - -#### Implementation of - -[IKeyring](../interfaces/verida_account_node._internal_.IKeyring.md).[asymDecrypt](../interfaces/verida_account_node._internal_.IKeyring.md#asymdecrypt) - -#### Defined in - -packages/keyring/dist/keyring.d.ts:41 - -___ - -### asymEncrypt - -▸ **asymEncrypt**(`data`, `secretOrSharedKey`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `string` | -| `secretOrSharedKey` | `Uint8Array` | - -#### Returns - -`Promise`<`string`\> - -#### Implementation of - -[IKeyring](../interfaces/verida_account_node._internal_.IKeyring.md).[asymEncrypt](../interfaces/verida_account_node._internal_.IKeyring.md#asymencrypt) - -#### Defined in - -packages/keyring/dist/keyring.d.ts:40 - -___ - -### buildSharedKeyEnd - -▸ **buildSharedKeyEnd**(`publicKey`): `Promise`<`Uint8Array`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `publicKey` | `Uint8Array` | - -#### Returns - -`Promise`<`Uint8Array`\> - -#### Implementation of - -[IKeyring](../interfaces/verida_account_node._internal_.IKeyring.md).[buildSharedKeyEnd](../interfaces/verida_account_node._internal_.IKeyring.md#buildsharedkeyend) - -#### Defined in - -packages/keyring/dist/keyring.d.ts:43 - -___ - -### buildSharedKeyStart - -▸ **buildSharedKeyStart**(`privateKey`): `Promise`<`Uint8Array`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `privateKey` | `Uint8Array` | - -#### Returns - -`Promise`<`Uint8Array`\> - -#### Implementation of - -[IKeyring](../interfaces/verida_account_node._internal_.IKeyring.md).[buildSharedKeyStart](../interfaces/verida_account_node._internal_.IKeyring.md#buildsharedkeystart) - -#### Defined in - -packages/keyring/dist/keyring.d.ts:42 - -___ - -### getKeys - -▸ **getKeys**(): `Promise`<`any`\> - -#### Returns - -`Promise`<`any`\> - -#### Implementation of - -[IKeyring](../interfaces/verida_account_node._internal_.IKeyring.md).[getKeys](../interfaces/verida_account_node._internal_.IKeyring.md#getkeys) - -#### Defined in - -packages/keyring/dist/keyring.d.ts:20 - -___ - -### getSeed - -▸ **getSeed**(): `string` - -#### Returns - -`string` - -#### Implementation of - -[IKeyring](../interfaces/verida_account_node._internal_.IKeyring.md).[getSeed](../interfaces/verida_account_node._internal_.IKeyring.md#getseed) - -#### Defined in - -packages/keyring/dist/keyring.d.ts:44 - -___ - -### getStorageContextKey - -▸ **getStorageContextKey**(`databaseName`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `databaseName` | `string` | - -#### Returns - -`Promise`<`any`\> - -#### Implementation of - -[IKeyring](../interfaces/verida_account_node._internal_.IKeyring.md).[getStorageContextKey](../interfaces/verida_account_node._internal_.IKeyring.md#getstoragecontextkey) - -#### Defined in - -packages/keyring/dist/keyring.d.ts:45 - -___ - -### publicKeys - -▸ **publicKeys**(): `Promise`<[`KeyringPublicKeys`](../interfaces/verida_account_node._internal_.KeyringPublicKeys.md)\> - -Generate an object containing all the public keys for this Keyring - -#### Returns - -`Promise`<[`KeyringPublicKeys`](../interfaces/verida_account_node._internal_.KeyringPublicKeys.md)\> - -#### Implementation of - -[IKeyring](../interfaces/verida_account_node._internal_.IKeyring.md).[publicKeys](../interfaces/verida_account_node._internal_.IKeyring.md#publickeys) - -#### Defined in - -packages/keyring/dist/keyring.d.ts:35 - -___ - -### sign - -▸ **sign**(`data`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `any` | - -#### Returns - -`Promise`<`string`\> - -#### Implementation of - -[IKeyring](../interfaces/verida_account_node._internal_.IKeyring.md).[sign](../interfaces/verida_account_node._internal_.IKeyring.md#sign) - -#### Defined in - -packages/keyring/dist/keyring.d.ts:36 - -___ - -### symDecrypt - -▸ **symDecrypt**(`data`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `string` | - -#### Returns - -`Promise`<`any`\> - -#### Implementation of - -[IKeyring](../interfaces/verida_account_node._internal_.IKeyring.md).[symDecrypt](../interfaces/verida_account_node._internal_.IKeyring.md#symdecrypt) - -#### Defined in - -packages/keyring/dist/keyring.d.ts:39 - -___ - -### symEncrypt - -▸ **symEncrypt**(`data`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Implementation of - -[IKeyring](../interfaces/verida_account_node._internal_.IKeyring.md).[symEncrypt](../interfaces/verida_account_node._internal_.IKeyring.md#symencrypt) - -#### Defined in - -packages/keyring/dist/keyring.d.ts:38 - -___ - -### verifySig - -▸ **verifySig**(`data`, `sig`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `string` | -| `sig` | `string` | - -#### Returns - -`Promise`<`boolean`\> - -#### Implementation of - -[IKeyring](../interfaces/verida_account_node._internal_.IKeyring.md).[verifySig](../interfaces/verida_account_node._internal_.IKeyring.md#verifysig) - -#### Defined in - -packages/keyring/dist/keyring.d.ts:37 diff --git a/docs/api/verida-js/classes/verida_account_node._internal_.default-3.md b/docs/api/verida-js/classes/verida_account_node._internal_.default-3.md deleted file mode 100644 index 5dbae9d..0000000 --- a/docs/api/verida-js/classes/verida_account_node._internal_.default-3.md +++ /dev/null @@ -1,515 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account-node](../modules/verida_account_node.md) / [](../modules/verida_account_node._internal_.md) / default - -# Class: default - -[@verida/account-node](../modules/verida_account_node.md).[](../modules/verida_account_node._internal_.md).default - -## Implements - -- [`IDIDDocument`](../interfaces/verida_account_node._internal_.IDIDDocument.md) - -## Table of contents - -### Constructors - -- [constructor](verida_account_node._internal_.default-3.md#constructor) - -### Properties - -- [doc](verida_account_node._internal_.default-3.md#doc) -- [errors](verida_account_node._internal_.default-3.md#errors) -- [getProofData](verida_account_node._internal_.default-3.md#getproofdata) - -### Accessors - -- [id](verida_account_node._internal_.default-3.md#id) - -### Methods - -- [addContext](verida_account_node._internal_.default-3.md#addcontext) -- [addContextAsymKey](verida_account_node._internal_.default-3.md#addcontextasymkey) -- [addContextService](verida_account_node._internal_.default-3.md#addcontextservice) -- [addContextSignKey](verida_account_node._internal_.default-3.md#addcontextsignkey) -- [buildTimestamp](verida_account_node._internal_.default-3.md#buildtimestamp) -- [export](verida_account_node._internal_.default-3.md#export) -- [getErrors](verida_account_node._internal_.default-3.md#geterrors) -- [import](verida_account_node._internal_.default-3.md#import) -- [locateContextProof](verida_account_node._internal_.default-3.md#locatecontextproof) -- [locateServiceEndpoint](verida_account_node._internal_.default-3.md#locateserviceendpoint) -- [removeContext](verida_account_node._internal_.default-3.md#removecontext) -- [setAttributes](verida_account_node._internal_.default-3.md#setattributes) -- [signProof](verida_account_node._internal_.default-3.md#signproof) -- [verifyContextSignature](verida_account_node._internal_.default-3.md#verifycontextsignature) -- [verifyProof](verida_account_node._internal_.default-3.md#verifyproof) -- [verifySig](verida_account_node._internal_.default-3.md#verifysig) -- [generateContextHash](verida_account_node._internal_.default-3.md#generatecontexthash) - -## Constructors - -### constructor - -• **new default**(`doc`, `publicKeyHex?`) - -Force lower case DID as we can't guarantee the DID will always be provided with checksum - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `doc` | `string` \| [`VeridaDocInterface`](../interfaces/verida_account_node._internal_.VeridaDocInterface.md) | this value can be a DocInterface or DID. | -| `publicKeyHex?` | `string` | - | - -#### Defined in - -packages/did-document/dist/did-document.d.ts:11 - -## Properties - -### doc - -• `Private` **doc**: `any` - -#### Defined in - -packages/did-document/dist/did-document.d.ts:4 - -___ - -### errors - -• `Protected` **errors**: `string`[] - -#### Defined in - -packages/did-document/dist/did-document.d.ts:5 - -___ - -### getProofData - -• `Private` **getProofData**: `any` - -#### Defined in - -packages/did-document/dist/did-document.d.ts:37 - -## Accessors - -### id - -• `get` **id**(): `string` - -#### Returns - -`string` - -#### Implementation of - -IDIDDocument.id - -#### Defined in - -packages/did-document/dist/did-document.d.ts:12 - -## Methods - -### addContext - -▸ **addContext**(`contextName`, `keyring`, `privateKey`, `endpoints`): `Promise`<`void`\> - -Not used directly, used for testing - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `contextName` | `string` | string | -| `keyring` | [`IKeyring`](../interfaces/verida_account_node._internal_.IKeyring.md) | Keyring | -| `privateKey` | `string` | Private key of the DID that controls this DID Document | -| `endpoints` | [`SecureContextEndpoints`](../interfaces/verida_account_node._internal_.SecureContextEndpoints.md) | Endpoints | - -#### Returns - -`Promise`<`void`\> - -#### Implementation of - -[IDIDDocument](../interfaces/verida_account_node._internal_.IDIDDocument.md).[addContext](../interfaces/verida_account_node._internal_.IDIDDocument.md#addcontext) - -#### Defined in - -packages/did-document/dist/did-document.d.ts:22 - -___ - -### addContextAsymKey - -▸ **addContextAsymKey**(`contextHash`, `publicKeyHex`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextHash` | `string` | -| `publicKeyHex` | `string` | - -#### Returns - -`void` - -#### Implementation of - -[IDIDDocument](../interfaces/verida_account_node._internal_.IDIDDocument.md).[addContextAsymKey](../interfaces/verida_account_node._internal_.IDIDDocument.md#addcontextasymkey) - -#### Defined in - -packages/did-document/dist/did-document.d.ts:29 - -___ - -### addContextService - -▸ **addContextService**(`contextHash`, `endpointType`, `serviceType`, `endpointUris`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextHash` | `string` | -| `endpointType` | [`SecureContextEndpointType`](../enums/verida_account_node._internal_.SecureContextEndpointType.md) | -| `serviceType` | `string` | -| `endpointUris` | [`ServiceEndpoint`](../modules/verida_account_node._internal_.md#serviceendpoint)[] | - -#### Returns - -`void` - -#### Implementation of - -[IDIDDocument](../interfaces/verida_account_node._internal_.IDIDDocument.md).[addContextService](../interfaces/verida_account_node._internal_.IDIDDocument.md#addcontextservice) - -#### Defined in - -packages/did-document/dist/did-document.d.ts:27 - -___ - -### addContextSignKey - -▸ **addContextSignKey**(`contextHash`, `publicKeyHex`, `proof`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextHash` | `string` | -| `publicKeyHex` | `string` | -| `proof` | `string` | - -#### Returns - -`void` - -#### Implementation of - -[IDIDDocument](../interfaces/verida_account_node._internal_.IDIDDocument.md).[addContextSignKey](../interfaces/verida_account_node._internal_.IDIDDocument.md#addcontextsignkey) - -#### Defined in - -packages/did-document/dist/did-document.d.ts:28 - -___ - -### buildTimestamp - -▸ **buildTimestamp**(`date`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `date` | `Date` | - -#### Returns - -`string` - -#### Implementation of - -[IDIDDocument](../interfaces/verida_account_node._internal_.IDIDDocument.md).[buildTimestamp](../interfaces/verida_account_node._internal_.IDIDDocument.md#buildtimestamp) - -#### Defined in - -packages/did-document/dist/did-document.d.ts:38 - -___ - -### export - -▸ **export**(): [`VeridaDocInterface`](../interfaces/verida_account_node._internal_.VeridaDocInterface.md) - -#### Returns - -[`VeridaDocInterface`](../interfaces/verida_account_node._internal_.VeridaDocInterface.md) - -#### Implementation of - -[IDIDDocument](../interfaces/verida_account_node._internal_.IDIDDocument.md).[export](../interfaces/verida_account_node._internal_.IDIDDocument.md#export) - -#### Defined in - -packages/did-document/dist/did-document.d.ts:26 - -___ - -### getErrors - -▸ **getErrors**(): `string`[] - -#### Returns - -`string`[] - -#### Implementation of - -[IDIDDocument](../interfaces/verida_account_node._internal_.IDIDDocument.md).[getErrors](../interfaces/verida_account_node._internal_.IDIDDocument.md#geterrors) - -#### Defined in - -packages/did-document/dist/did-document.d.ts:13 - -___ - -### import - -▸ **import**(`doc`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `doc` | [`VeridaDocInterface`](../interfaces/verida_account_node._internal_.VeridaDocInterface.md) | - -#### Returns - -`void` - -#### Implementation of - -[IDIDDocument](../interfaces/verida_account_node._internal_.IDIDDocument.md).[import](../interfaces/verida_account_node._internal_.IDIDDocument.md#import) - -#### Defined in - -packages/did-document/dist/did-document.d.ts:25 - -___ - -### locateContextProof - -▸ **locateContextProof**(`contextName`): `undefined` \| `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | - -#### Returns - -`undefined` \| `string` - -#### Implementation of - -[IDIDDocument](../interfaces/verida_account_node._internal_.IDIDDocument.md).[locateContextProof](../interfaces/verida_account_node._internal_.IDIDDocument.md#locatecontextproof) - -#### Defined in - -packages/did-document/dist/did-document.d.ts:34 - -___ - -### locateServiceEndpoint - -▸ **locateServiceEndpoint**(`contextName`, `endpointType`): `undefined` \| [`Service`](../interfaces/verida_account_node._internal_.Service.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | -| `endpointType` | [`SecureContextEndpointType`](../enums/verida_account_node._internal_.SecureContextEndpointType.md) | - -#### Returns - -`undefined` \| [`Service`](../interfaces/verida_account_node._internal_.Service.md) - -#### Implementation of - -[IDIDDocument](../interfaces/verida_account_node._internal_.IDIDDocument.md).[locateServiceEndpoint](../interfaces/verida_account_node._internal_.IDIDDocument.md#locateserviceendpoint) - -#### Defined in - -packages/did-document/dist/did-document.d.ts:33 - -___ - -### removeContext - -▸ **removeContext**(`contextName`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | - -#### Returns - -`boolean` - -#### Implementation of - -[IDIDDocument](../interfaces/verida_account_node._internal_.IDIDDocument.md).[removeContext](../interfaces/verida_account_node._internal_.IDIDDocument.md#removecontext) - -#### Defined in - -packages/did-document/dist/did-document.d.ts:23 - -___ - -### setAttributes - -▸ **setAttributes**(`attributes`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `attributes` | [`Record`](../modules/verida_account_node._internal_.md#record)<`string`, `any`\> | - -#### Returns - -`void` - -#### Implementation of - -[IDIDDocument](../interfaces/verida_account_node._internal_.IDIDDocument.md).[setAttributes](../interfaces/verida_account_node._internal_.IDIDDocument.md#setattributes) - -#### Defined in - -packages/did-document/dist/did-document.d.ts:24 - -___ - -### signProof - -▸ **signProof**(`privateKey`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `privateKey` | `string` \| `Uint8Array` | - -#### Returns - -`void` - -#### Implementation of - -[IDIDDocument](../interfaces/verida_account_node._internal_.IDIDDocument.md).[signProof](../interfaces/verida_account_node._internal_.IDIDDocument.md#signproof) - -#### Defined in - -packages/did-document/dist/did-document.d.ts:35 - -___ - -### verifyContextSignature - -▸ **verifyContextSignature**(`data`, `contextName`, `signature`, `contextIsHash?`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `any` | -| `contextName` | `string` | -| `signature` | `string` | -| `contextIsHash?` | `boolean` | - -#### Returns - -`boolean` - -#### Implementation of - -[IDIDDocument](../interfaces/verida_account_node._internal_.IDIDDocument.md).[verifyContextSignature](../interfaces/verida_account_node._internal_.IDIDDocument.md#verifycontextsignature) - -#### Defined in - -packages/did-document/dist/did-document.d.ts:31 - -___ - -### verifyProof - -▸ **verifyProof**(): `boolean` - -#### Returns - -`boolean` - -#### Implementation of - -[IDIDDocument](../interfaces/verida_account_node._internal_.IDIDDocument.md).[verifyProof](../interfaces/verida_account_node._internal_.IDIDDocument.md#verifyproof) - -#### Defined in - -packages/did-document/dist/did-document.d.ts:36 - -___ - -### verifySig - -▸ **verifySig**(`data`, `signature`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `any` | -| `signature` | `string` | - -#### Returns - -`boolean` - -#### Implementation of - -[IDIDDocument](../interfaces/verida_account_node._internal_.IDIDDocument.md).[verifySig](../interfaces/verida_account_node._internal_.IDIDDocument.md#verifysig) - -#### Defined in - -packages/did-document/dist/did-document.d.ts:30 - -___ - -### generateContextHash - -▸ `Static` **generateContextHash**(`did`, `contextName`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did` | `string` | -| `contextName` | `string` | - -#### Returns - -`string` - -#### Defined in - -packages/did-document/dist/did-document.d.ts:32 diff --git a/docs/api/verida-js/classes/verida_account_node._internal_.default-4.md b/docs/api/verida-js/classes/verida_account_node._internal_.default-4.md deleted file mode 100644 index 74f3a2d..0000000 --- a/docs/api/verida-js/classes/verida_account_node._internal_.default-4.md +++ /dev/null @@ -1,378 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account-node](../modules/verida_account_node.md) / [](../modules/verida_account_node._internal_.md) / default - -# Class: default - -[@verida/account-node](../modules/verida_account_node.md).[](../modules/verida_account_node._internal_.md).default - -## Table of contents - -### Constructors - -- [constructor](verida_account_node._internal_.default-4.md#constructor) - -### Properties - -- [doc](verida_account_node._internal_.default-4.md#doc) -- [errors](verida_account_node._internal_.default-4.md#errors) -- [getProofData](verida_account_node._internal_.default-4.md#getproofdata) - -### Accessors - -- [id](verida_account_node._internal_.default-4.md#id) - -### Methods - -- [addContext](verida_account_node._internal_.default-4.md#addcontext) -- [addContextAsymKey](verida_account_node._internal_.default-4.md#addcontextasymkey) -- [addContextService](verida_account_node._internal_.default-4.md#addcontextservice) -- [addContextSignKey](verida_account_node._internal_.default-4.md#addcontextsignkey) -- [export](verida_account_node._internal_.default-4.md#export) -- [getErrors](verida_account_node._internal_.default-4.md#geterrors) -- [import](verida_account_node._internal_.default-4.md#import) -- [locateServiceEndpoint](verida_account_node._internal_.default-4.md#locateserviceendpoint) -- [removeContext](verida_account_node._internal_.default-4.md#removecontext) -- [signProof](verida_account_node._internal_.default-4.md#signproof) -- [verifyContextSignature](verida_account_node._internal_.default-4.md#verifycontextsignature) -- [verifyProof](verida_account_node._internal_.default-4.md#verifyproof) -- [verifySig](verida_account_node._internal_.default-4.md#verifysig) -- [generateContextHash](verida_account_node._internal_.default-4.md#generatecontexthash) - -## Constructors - -### constructor - -• **new default**(`doc`, `publicKeyHex?`) - -Force lower case DID as we can't guarantee the DID will always be provided with checksum - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `doc` | `string` \| [`DIDDocumentStruct`](../interfaces/verida_account_node._internal_.DIDDocumentStruct.md) | -| `publicKeyHex?` | `string` | - -#### Defined in - -packages/did-document/dist/did-document.d.ts:12 - -## Properties - -### doc - -• `Private` **doc**: `any` - -#### Defined in - -packages/did-document/dist/did-document.d.ts:5 - -___ - -### errors - -• `Protected` **errors**: `string`[] - -#### Defined in - -packages/did-document/dist/did-document.d.ts:6 - -___ - -### getProofData - -• `Private` **getProofData**: `any` - -#### Defined in - -packages/did-document/dist/did-document.d.ts:33 - -## Accessors - -### id - -• `get` **id**(): `string` - -#### Returns - -`string` - -#### Defined in - -packages/did-document/dist/did-document.d.ts:13 - -## Methods - -### addContext - -▸ **addContext**(`contextName`, `keyring`, `endpoints`): `Promise`<`void`\> - -Not used directly, used for testing - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | -| `keyring` | [`default`](verida_account_node._internal_.default-3.md) | -| `endpoints` | [`Endpoints`](../interfaces/verida_account_node._internal_.Endpoints.md) | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -packages/did-document/dist/did-document.d.ts:22 - -___ - -### addContextAsymKey - -▸ **addContextAsymKey**(`contextHash`, `publicKeyHex`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextHash` | `string` | -| `publicKeyHex` | `string` | - -#### Returns - -`void` - -#### Defined in - -packages/did-document/dist/did-document.d.ts:28 - -___ - -### addContextService - -▸ **addContextService**(`contextHash`, `endpointType`, `serviceType`, `endpointUri`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextHash` | `string` | -| `endpointType` | [`EndpointType`](../enums/verida_account_node._internal_.EndpointType.md) | -| `serviceType` | `string` | -| `endpointUri` | `string` | - -#### Returns - -`void` - -#### Defined in - -packages/did-document/dist/did-document.d.ts:26 - -___ - -### addContextSignKey - -▸ **addContextSignKey**(`contextHash`, `publicKeyHex`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextHash` | `string` | -| `publicKeyHex` | `string` | - -#### Returns - -`void` - -#### Defined in - -packages/did-document/dist/did-document.d.ts:27 - -___ - -### export - -▸ **export**(): [`DIDDocumentStruct`](../interfaces/verida_account_node._internal_.DIDDocumentStruct.md) - -#### Returns - -[`DIDDocumentStruct`](../interfaces/verida_account_node._internal_.DIDDocumentStruct.md) - -#### Defined in - -packages/did-document/dist/did-document.d.ts:25 - -___ - -### getErrors - -▸ **getErrors**(): `string`[] - -#### Returns - -`string`[] - -#### Defined in - -packages/did-document/dist/did-document.d.ts:14 - -___ - -### import - -▸ **import**(`doc`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `doc` | [`DIDDocumentStruct`](../interfaces/verida_account_node._internal_.DIDDocumentStruct.md) | - -#### Returns - -`void` - -#### Defined in - -packages/did-document/dist/did-document.d.ts:24 - -___ - -### locateServiceEndpoint - -▸ **locateServiceEndpoint**(`contextName`, `endpointType`): `undefined` \| [`ServiceEndpoint`](../interfaces/verida_account_node._internal_.ServiceEndpoint.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | -| `endpointType` | [`EndpointType`](../enums/verida_account_node._internal_.EndpointType.md) | - -#### Returns - -`undefined` \| [`ServiceEndpoint`](../interfaces/verida_account_node._internal_.ServiceEndpoint.md) - -#### Defined in - -packages/did-document/dist/did-document.d.ts:35 - -___ - -### removeContext - -▸ **removeContext**(`contextName`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | - -#### Returns - -`boolean` - -#### Defined in - -packages/did-document/dist/did-document.d.ts:23 - -___ - -### signProof - -▸ **signProof**(`privateKey`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `privateKey` | `string` \| `Uint8Array` | - -#### Returns - -`void` - -#### Defined in - -packages/did-document/dist/did-document.d.ts:29 - -___ - -### verifyContextSignature - -▸ **verifyContextSignature**(`data`, `contextName`, `signature`, `contextIsHash?`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `any` | -| `contextName` | `string` | -| `signature` | `string` | -| `contextIsHash?` | `boolean` | - -#### Returns - -`boolean` - -#### Defined in - -packages/did-document/dist/did-document.d.ts:32 - -___ - -### verifyProof - -▸ **verifyProof**(): `boolean` - -#### Returns - -`boolean` - -#### Defined in - -packages/did-document/dist/did-document.d.ts:30 - -___ - -### verifySig - -▸ **verifySig**(`data`, `signature`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `any` | -| `signature` | `string` | - -#### Returns - -`boolean` - -#### Defined in - -packages/did-document/dist/did-document.d.ts:31 - -___ - -### generateContextHash - -▸ `Static` **generateContextHash**(`did`, `contextName`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did` | `string` | -| `contextName` | `string` | - -#### Returns - -`string` - -#### Defined in - -packages/did-document/dist/did-document.d.ts:34 diff --git a/docs/api/verida-js/classes/verida_account_node._internal_.default.md b/docs/api/verida-js/classes/verida_account_node._internal_.default.md deleted file mode 100644 index 435180e..0000000 --- a/docs/api/verida-js/classes/verida_account_node._internal_.default.md +++ /dev/null @@ -1,352 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account-node](../modules/verida_account_node.md) / [](../modules/verida_account_node._internal_.md) / default - -# Class: default - -[@verida/account-node](../modules/verida_account_node.md).[](../modules/verida_account_node._internal_.md).default - -An Authenticator that automatically signs everything - -## Hierarchy - -- **`default`** - - ↳ [`AutoAccount`](verida_account_node.AutoAccount.md) - -## Implements - -- [`IAccount`](../interfaces/verida_account_node._internal_.IAccount.md) - -## Table of contents - -### Constructors - -- [constructor](verida_account_node._internal_.default.md#constructor) - -### Methods - -- [createDidJwt](verida_account_node._internal_.default.md#createdidjwt) -- [did](verida_account_node._internal_.default.md#did) -- [disconnect](verida_account_node._internal_.default.md#disconnect) -- [disconnectDevice](verida_account_node._internal_.default.md#disconnectdevice) -- [getAuthContext](verida_account_node._internal_.default.md#getauthcontext) -- [keyring](verida_account_node._internal_.default.md#keyring) -- [linkStorage](verida_account_node._internal_.default.md#linkstorage) -- [linkStorageContextService](verida_account_node._internal_.default.md#linkstoragecontextservice) -- [setAccountConfig](verida_account_node._internal_.default.md#setaccountconfig) -- [sign](verida_account_node._internal_.default.md#sign) -- [storageConfig](verida_account_node._internal_.default.md#storageconfig) -- [unlinkStorage](verida_account_node._internal_.default.md#unlinkstorage) - -## Constructors - -### constructor - -• **new default**() - -## Methods - -### createDidJwt - -▸ **createDidJwt**(`contextName`, `data`, `config?`): `Promise`<`string`\> - -Create a DID-JWT from a data object - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | -| `data` | `object` | -| `config?` | `any` | - -#### Returns - -`Promise`<`string`\> - -#### Implementation of - -[IAccount](../interfaces/verida_account_node._internal_.IAccount.md).[createDidJwt](../interfaces/verida_account_node._internal_.IAccount.md#createdidjwt) - -#### Defined in - -packages/account/dist/account.d.ts:42 - -___ - -### did - -▸ **did**(): `Promise`<`string`\> - -Get the DID of the current user - -#### Returns - -`Promise`<`string`\> - -#### Implementation of - -[IAccount](../interfaces/verida_account_node._internal_.IAccount.md).[did](../interfaces/verida_account_node._internal_.IAccount.md#did) - -#### Defined in - -packages/account/dist/account.d.ts:22 - -___ - -### disconnect - -▸ **disconnect**(`contextName?`): `Promise`<`void`\> - -An optional method that can be used to disconnect the current user. - -For example, in a web browser context, it would remove any stored signatures from local storage. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName?` | `string` | - -#### Returns - -`Promise`<`void`\> - -#### Implementation of - -[IAccount](../interfaces/verida_account_node._internal_.IAccount.md).[disconnect](../interfaces/verida_account_node._internal_.IAccount.md#disconnect) - -#### Defined in - -packages/account/dist/account.d.ts:48 - -___ - -### disconnectDevice - -▸ **disconnectDevice**(`contextName`, `deviceId?`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | -| `deviceId?` | `string` | - -#### Returns - -`Promise`<`boolean`\> - -#### Implementation of - -[IAccount](../interfaces/verida_account_node._internal_.IAccount.md).[disconnectDevice](../interfaces/verida_account_node._internal_.IAccount.md#disconnectdevice) - -#### Defined in - -packages/account/dist/account.d.ts:50 - -___ - -### getAuthContext - -▸ **getAuthContext**(`contextName`, `contextConfig`, `authConfig?`, `authType?`): `Promise`<[`AuthContext`](../interfaces/verida_account_node._internal_.AuthContext.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | -| `contextConfig` | [`SecureContextConfig`](../interfaces/verida_account_node._internal_.SecureContextConfig.md) | -| `authConfig?` | [`AuthTypeConfig`](../interfaces/verida_account_node._internal_.AuthTypeConfig.md) | -| `authType?` | `string` | - -#### Returns - -`Promise`<[`AuthContext`](../interfaces/verida_account_node._internal_.AuthContext.md)\> - -#### Implementation of - -[IAccount](../interfaces/verida_account_node._internal_.IAccount.md).[getAuthContext](../interfaces/verida_account_node._internal_.IAccount.md#getauthcontext) - -#### Defined in - -packages/account/dist/account.d.ts:49 - -___ - -### keyring - -▸ **keyring**(`contextName`): `Promise`<[`default`](verida_account_node._internal_.default-2.md)\> - -Generate a keyring for this user for a given storage context. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | - -#### Returns - -`Promise`<[`default`](verida_account_node._internal_.default-2.md)\> - -#### Implementation of - -[IAccount](../interfaces/verida_account_node._internal_.IAccount.md).[keyring](../interfaces/verida_account_node._internal_.IAccount.md#keyring) - -#### Defined in - -packages/account/dist/account.d.ts:12 - -___ - -### linkStorage - -▸ **linkStorage**(`storageConfig`): `Promise`<`boolean`\> - -Link storage to this user - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `storageConfig` | [`SecureContextConfig`](../interfaces/verida_account_node._internal_.SecureContextConfig.md) | - -#### Returns - -`Promise`<`boolean`\> - -#### Implementation of - -[IAccount](../interfaces/verida_account_node._internal_.IAccount.md).[linkStorage](../interfaces/verida_account_node._internal_.IAccount.md#linkstorage) - -#### Defined in - -packages/account/dist/account.d.ts:28 - -___ - -### linkStorageContextService - -▸ **linkStorageContextService**(`contextName`, `endpointType`, `serverType`, `endpointUris`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | -| `endpointType` | `string` | -| `serverType` | `string` | -| `endpointUris` | `string`[] | - -#### Returns - -`Promise`<`boolean`\> - -#### Implementation of - -[IAccount](../interfaces/verida_account_node._internal_.IAccount.md).[linkStorageContextService](../interfaces/verida_account_node._internal_.IAccount.md#linkstoragecontextservice) - -#### Defined in - -packages/account/dist/account.d.ts:36 - -___ - -### setAccountConfig - -▸ **setAccountConfig**(`accountConfig`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `accountConfig` | [`AccountConfig`](../interfaces/verida_account_node._internal_.AccountConfig.md) | - -#### Returns - -`void` - -#### Implementation of - -[IAccount](../interfaces/verida_account_node._internal_.IAccount.md).[setAccountConfig](../interfaces/verida_account_node._internal_.IAccount.md#setaccountconfig) - -#### Defined in - -packages/account/dist/account.d.ts:37 - -___ - -### sign - -▸ **sign**(`input`): `Promise`<`string`\> - -Sign a string as the current user - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `input` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Implementation of - -[IAccount](../interfaces/verida_account_node._internal_.IAccount.md).[sign](../interfaces/verida_account_node._internal_.IAccount.md#sign) - -#### Defined in - -packages/account/dist/account.d.ts:18 - -___ - -### storageConfig - -▸ **storageConfig**(`contextName`, `forceCreate?`): `Promise`<`undefined` \| [`SecureContextConfig`](../interfaces/verida_account_node._internal_.SecureContextConfig.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | -| `forceCreate?` | `boolean` | - -#### Returns - -`Promise`<`undefined` \| [`SecureContextConfig`](../interfaces/verida_account_node._internal_.SecureContextConfig.md)\> - -#### Implementation of - -[IAccount](../interfaces/verida_account_node._internal_.IAccount.md).[storageConfig](../interfaces/verida_account_node._internal_.IAccount.md#storageconfig) - -#### Defined in - -packages/account/dist/account.d.ts:35 - -___ - -### unlinkStorage - -▸ **unlinkStorage**(`contextName`): `Promise`<`boolean`\> - -Unlink storage for this user - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | - -#### Returns - -`Promise`<`boolean`\> - -#### Implementation of - -[IAccount](../interfaces/verida_account_node._internal_.IAccount.md).[unlinkStorage](../interfaces/verida_account_node._internal_.IAccount.md#unlinkstorage) - -#### Defined in - -packages/account/dist/account.d.ts:34 diff --git a/docs/api/verida-js/classes/verida_account_web_vault.VaultAccount.md b/docs/api/verida-js/classes/verida_account_web_vault.VaultAccount.md deleted file mode 100644 index fdeefb2..0000000 --- a/docs/api/verida-js/classes/verida_account_web_vault.VaultAccount.md +++ /dev/null @@ -1,553 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account-web-vault](../modules/verida_account_web_vault.md) / VaultAccount - -# Class: VaultAccount - -[@verida/account-web-vault](../modules/verida_account_web_vault.md).VaultAccount - -An Authenticator that requests for authorization from the Vault - -## Hierarchy - -- [`default`](verida_account_web_vault._internal_.default.md) - - ↳ **`VaultAccount`** - -## Table of contents - -### Constructors - -- [constructor](verida_account_web_vault.VaultAccount.md#constructor) - -### Properties - -- [accountDid](verida_account_web_vault.VaultAccount.md#accountdid) -- [config](verida_account_web_vault.VaultAccount.md#config) -- [contextCache](verida_account_web_vault.VaultAccount.md#contextcache) - -### Methods - -- [addContext](verida_account_web_vault.VaultAccount.md#addcontext) -- [connectContext](verida_account_web_vault.VaultAccount.md#connectcontext) -- [contextAuthIsValid](verida_account_web_vault.VaultAccount.md#contextauthisvalid) -- [createDidJwt](verida_account_web_vault.VaultAccount.md#createdidjwt) -- [did](verida_account_web_vault.VaultAccount.md#did) -- [disconnect](verida_account_web_vault.VaultAccount.md#disconnect) -- [disconnectDevice](verida_account_web_vault.VaultAccount.md#disconnectdevice) -- [getAuthContext](verida_account_web_vault.VaultAccount.md#getauthcontext) -- [getAxios](verida_account_web_vault.VaultAccount.md#getaxios) -- [keyring](verida_account_web_vault.VaultAccount.md#keyring) -- [linkStorage](verida_account_web_vault.VaultAccount.md#linkstorage) -- [linkStorageContextService](verida_account_web_vault.VaultAccount.md#linkstoragecontextservice) -- [loadFromSession](verida_account_web_vault.VaultAccount.md#loadfromsession) -- [locateEndpointContextAuth](verida_account_web_vault.VaultAccount.md#locateendpointcontextauth) -- [setAccountConfig](verida_account_web_vault.VaultAccount.md#setaccountconfig) -- [setDid](verida_account_web_vault.VaultAccount.md#setdid) -- [sign](verida_account_web_vault.VaultAccount.md#sign) -- [storageConfig](verida_account_web_vault.VaultAccount.md#storageconfig) -- [unlinkStorage](verida_account_web_vault.VaultAccount.md#unlinkstorage) - -## Constructors - -### constructor - -• **new VaultAccount**(`config?`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | [`AccountVaultConfig`](../interfaces/verida_account_web_vault._internal_.AccountVaultConfig.md) | - -#### Overrides - -[default](verida_account_web_vault._internal_.default.md).[constructor](verida_account_web_vault._internal_.default.md#constructor) - -#### Defined in - -[packages/account-web-vault/src/vault-account.ts:84](https://github.com/verida/verida-js/blob/5040472/packages/account-web-vault/src/vault-account.ts#L84) - -## Properties - -### accountDid - -• `Private` `Optional` **accountDid**: `string` - -#### Defined in - -[packages/account-web-vault/src/vault-account.ts:81](https://github.com/verida/verida-js/blob/5040472/packages/account-web-vault/src/vault-account.ts#L81) - -___ - -### config - -• `Private` **config**: [`AccountVaultConfig`](../interfaces/verida_account_web_vault._internal_.AccountVaultConfig.md) - -#### Defined in - -[packages/account-web-vault/src/vault-account.ts:79](https://github.com/verida/verida-js/blob/5040472/packages/account-web-vault/src/vault-account.ts#L79) - -___ - -### contextCache - -• `Private` **contextCache**: `any` = `{}` - -#### Defined in - -[packages/account-web-vault/src/vault-account.ts:82](https://github.com/verida/verida-js/blob/5040472/packages/account-web-vault/src/vault-account.ts#L82) - -## Methods - -### addContext - -▸ **addContext**(`contextName`, `contextConfig`, `keyring`, `contextAuths`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | -| `contextConfig` | [`SecureContextConfig`](../interfaces/verida_account_web_vault._internal_.SecureContextConfig.md) | -| `keyring` | [`default`](verida_account_web_vault._internal_.default-1.md) | -| `contextAuths` | [`VeridaDatabaseAuthContext`](../interfaces/verida_account_web_vault._internal_.VeridaDatabaseAuthContext.md)[] | - -#### Returns - -`void` - -#### Defined in - -[packages/account-web-vault/src/vault-account.ts:237](https://github.com/verida/verida-js/blob/5040472/packages/account-web-vault/src/vault-account.ts#L237) - -___ - -### connectContext - -▸ **connectContext**(`contextName`, `ignoreSession?`): `Promise`<`boolean` \| [`SecureContextConfig`](../interfaces/verida_account_web_vault._internal_.SecureContextConfig.md)\> - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `contextName` | `string` | `undefined` | -| `ignoreSession` | `boolean` | `false` | - -#### Returns - -`Promise`<`boolean` \| [`SecureContextConfig`](../interfaces/verida_account_web_vault._internal_.SecureContextConfig.md)\> - -#### Defined in - -[packages/account-web-vault/src/vault-account.ts:97](https://github.com/verida/verida-js/blob/5040472/packages/account-web-vault/src/vault-account.ts#L97) - -___ - -### contextAuthIsValid - -▸ **contextAuthIsValid**(`contextAuths`): `boolean` - -Verify we have valid JWT's and non-expired accessToken and refreshToken - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextAuths` | [`VeridaDatabaseAuthContext`](../interfaces/verida_account_web_vault._internal_.VeridaDatabaseAuthContext.md)[] | - -#### Returns - -`boolean` - -#### Defined in - -[packages/account-web-vault/src/vault-account.ts:149](https://github.com/verida/verida-js/blob/5040472/packages/account-web-vault/src/vault-account.ts#L149) - -___ - -### createDidJwt - -▸ **createDidJwt**(`contextName`, `data`, `config?`): `Promise`<`string`\> - -Create a DID-JWT from a data object - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | -| `data` | `object` | -| `config?` | `any` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[default](verida_account_web_vault._internal_.default.md).[createDidJwt](verida_account_web_vault._internal_.default.md#createdidjwt) - -#### Defined in - -packages/account/dist/account.d.ts:42 - -___ - -### did - -▸ **did**(): `Promise`<`string`\> - -Get the DID of the current user - -#### Returns - -`Promise`<`string`\> - -#### Overrides - -[default](verida_account_web_vault._internal_.default.md).[did](verida_account_web_vault._internal_.default.md#did) - -#### Defined in - -[packages/account-web-vault/src/vault-account.ts:263](https://github.com/verida/verida-js/blob/5040472/packages/account-web-vault/src/vault-account.ts#L263) - -___ - -### disconnect - -▸ **disconnect**(`contextName?`): `Promise`<`void`\> - -An optional method that can be used to disconnect the current user. - -For example, in a web browser context, it would remove any stored signatures from local storage. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName?` | `string` | - -#### Returns - -`Promise`<`void`\> - -#### Overrides - -[default](verida_account_web_vault._internal_.default.md).[disconnect](verida_account_web_vault._internal_.default.md#disconnect) - -#### Defined in - -[packages/account-web-vault/src/vault-account.ts:289](https://github.com/verida/verida-js/blob/5040472/packages/account-web-vault/src/vault-account.ts#L289) - -___ - -### disconnectDevice - -▸ **disconnectDevice**(`contextName`, `deviceId?`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | -| `deviceId?` | `string` | - -#### Returns - -`Promise`<`boolean`\> - -#### Inherited from - -[default](verida_account_web_vault._internal_.default.md).[disconnectDevice](verida_account_web_vault._internal_.default.md#disconnectdevice) - -#### Defined in - -packages/account/dist/account.d.ts:50 - -___ - -### getAuthContext - -▸ **getAuthContext**(`contextName`, `contextConfig`, `authConfig?`, `authType?`): `Promise`<[`AuthContext`](../interfaces/verida_account_web_vault._internal_.AuthContext.md)\> - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `contextName` | `string` | `undefined` | -| `contextConfig` | [`SecureContextConfig`](../interfaces/verida_account_web_vault._internal_.SecureContextConfig.md) | `undefined` | -| `authConfig` | [`AuthTypeConfig`](../interfaces/verida_account_web_vault._internal_.AuthTypeConfig.md) | `undefined` | -| `authType` | `string` | `"database"` | - -#### Returns - -`Promise`<[`AuthContext`](../interfaces/verida_account_web_vault._internal_.AuthContext.md)\> - -#### Overrides - -[default](verida_account_web_vault._internal_.default.md).[getAuthContext](verida_account_web_vault._internal_.default.md#getauthcontext) - -#### Defined in - -[packages/account-web-vault/src/vault-account.ts:310](https://github.com/verida/verida-js/blob/5040472/packages/account-web-vault/src/vault-account.ts#L310) - -___ - -### getAxios - -▸ `Private` **getAxios**(`storageContext`, `accessToken?`): [`AxiosInstance`](../interfaces/verida_account_web_vault._internal_.AxiosInstance.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `storageContext` | `string` | -| `accessToken?` | `string` | - -#### Returns - -[`AxiosInstance`](../interfaces/verida_account_web_vault._internal_.AxiosInstance.md) - -#### Defined in - -[packages/account-web-vault/src/vault-account.ts:364](https://github.com/verida/verida-js/blob/5040472/packages/account-web-vault/src/vault-account.ts#L364) - -___ - -### keyring - -▸ **keyring**(`contextName`): `Promise`<[`default`](verida_account_web_vault._internal_.default-1.md)\> - -Generate a keyring for this user for a given storage context. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | - -#### Returns - -`Promise`<[`default`](verida_account_web_vault._internal_.default-1.md)\> - -#### Overrides - -[default](verida_account_web_vault._internal_.default.md).[keyring](verida_account_web_vault._internal_.default.md#keyring) - -#### Defined in - -[packages/account-web-vault/src/vault-account.ts:229](https://github.com/verida/verida-js/blob/5040472/packages/account-web-vault/src/vault-account.ts#L229) - -___ - -### linkStorage - -▸ **linkStorage**(`storageConfig`): `Promise`<`boolean`\> - -Link storage to this user - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `storageConfig` | [`SecureContextConfig`](../interfaces/verida_account_web_vault._internal_.SecureContextConfig.md) | - -#### Returns - -`Promise`<`boolean`\> - -#### Overrides - -[default](verida_account_web_vault._internal_.default.md).[linkStorage](verida_account_web_vault._internal_.default.md#linkstorage) - -#### Defined in - -[packages/account-web-vault/src/vault-account.ts:276](https://github.com/verida/verida-js/blob/5040472/packages/account-web-vault/src/vault-account.ts#L276) - -___ - -### linkStorageContextService - -▸ **linkStorageContextService**(`contextName`, `endpointType`, `serverType`, `endpointUris`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | -| `endpointType` | `string` | -| `serverType` | `string` | -| `endpointUris` | `string`[] | - -#### Returns - -`Promise`<`boolean`\> - -#### Inherited from - -[default](verida_account_web_vault._internal_.default.md).[linkStorageContextService](verida_account_web_vault._internal_.default.md#linkstoragecontextservice) - -#### Defined in - -packages/account/dist/account.d.ts:36 - -___ - -### loadFromSession - -▸ **loadFromSession**(`contextName`): `Promise`<`undefined` \| [`SecureContextConfig`](../interfaces/verida_account_web_vault._internal_.SecureContextConfig.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | - -#### Returns - -`Promise`<`undefined` \| [`SecureContextConfig`](../interfaces/verida_account_web_vault._internal_.SecureContextConfig.md)\> - -#### Defined in - -[packages/account-web-vault/src/vault-account.ts:178](https://github.com/verida/verida-js/blob/5040472/packages/account-web-vault/src/vault-account.ts#L178) - -___ - -### locateEndpointContextAuth - -▸ `Private` **locateEndpointContextAuth**(`contextName`, `endpointUri`): `any` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | -| `endpointUri` | `string` | - -#### Returns - -`any` - -#### Defined in - -[packages/account-web-vault/src/vault-account.ts:296](https://github.com/verida/verida-js/blob/5040472/packages/account-web-vault/src/vault-account.ts#L296) - -___ - -### setAccountConfig - -▸ **setAccountConfig**(`accountConfig`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `accountConfig` | [`AccountConfig`](../interfaces/verida_account_web_vault._internal_.AccountConfig.md) | - -#### Returns - -`void` - -#### Overrides - -[default](verida_account_web_vault._internal_.default.md).[setAccountConfig](verida_account_web_vault._internal_.default.md#setaccountconfig) - -#### Defined in - -[packages/account-web-vault/src/vault-account.ts:139](https://github.com/verida/verida-js/blob/5040472/packages/account-web-vault/src/vault-account.ts#L139) - -___ - -### setDid - -▸ **setDid**(`did`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did` | `string` | - -#### Returns - -`void` - -#### Defined in - -[packages/account-web-vault/src/vault-account.ts:267](https://github.com/verida/verida-js/blob/5040472/packages/account-web-vault/src/vault-account.ts#L267) - -___ - -### sign - -▸ **sign**(`message`): `Promise`<`string`\> - -Sign a string as the current user - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `message` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Overrides - -[default](verida_account_web_vault._internal_.default.md).[sign](verida_account_web_vault._internal_.default.md#sign) - -#### Defined in - -[packages/account-web-vault/src/vault-account.ts:259](https://github.com/verida/verida-js/blob/5040472/packages/account-web-vault/src/vault-account.ts#L259) - -___ - -### storageConfig - -▸ **storageConfig**(`contextName`, `forceCreate?`): `Promise`<`undefined` \| [`SecureContextConfig`](../interfaces/verida_account_web_vault._internal_.SecureContextConfig.md)\> - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `contextName` | `string` | `undefined` | -| `forceCreate` | `boolean` | `false` | - -#### Returns - -`Promise`<`undefined` \| [`SecureContextConfig`](../interfaces/verida_account_web_vault._internal_.SecureContextConfig.md)\> - -#### Overrides - -[default](verida_account_web_vault._internal_.default.md).[storageConfig](verida_account_web_vault._internal_.default.md#storageconfig) - -#### Defined in - -[packages/account-web-vault/src/vault-account.ts:245](https://github.com/verida/verida-js/blob/5040472/packages/account-web-vault/src/vault-account.ts#L245) - -___ - -### unlinkStorage - -▸ **unlinkStorage**(`contextName`): `Promise`<`boolean`\> - -Unlink storage for this user - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | - -#### Returns - -`Promise`<`boolean`\> - -#### Overrides - -[default](verida_account_web_vault._internal_.default.md).[unlinkStorage](verida_account_web_vault._internal_.default.md#unlinkstorage) - -#### Defined in - -[packages/account-web-vault/src/vault-account.ts:285](https://github.com/verida/verida-js/blob/5040472/packages/account-web-vault/src/vault-account.ts#L285) diff --git a/docs/api/verida-js/classes/verida_account_web_vault._internal_.Axios.md b/docs/api/verida-js/classes/verida_account_web_vault._internal_.Axios.md deleted file mode 100644 index 6e1d179..0000000 --- a/docs/api/verida-js/classes/verida_account_web_vault._internal_.Axios.md +++ /dev/null @@ -1,424 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account-web-vault](../modules/verida_account_web_vault.md) / [](../modules/verida_account_web_vault._internal_.md) / Axios - -# Class: Axios - -[@verida/account-web-vault](../modules/verida_account_web_vault.md).[](../modules/verida_account_web_vault._internal_.md).Axios - -## Hierarchy - -- **`Axios`** - - ↳ [`AxiosInstance`](../interfaces/verida_account_web_vault._internal_.AxiosInstance.md) - -## Table of contents - -### Constructors - -- [constructor](verida_account_web_vault._internal_.Axios.md#constructor) - -### Properties - -- [defaults](verida_account_web_vault._internal_.Axios.md#defaults) -- [interceptors](verida_account_web_vault._internal_.Axios.md#interceptors) - -### Methods - -- [delete](verida_account_web_vault._internal_.Axios.md#delete) -- [get](verida_account_web_vault._internal_.Axios.md#get) -- [getUri](verida_account_web_vault._internal_.Axios.md#geturi) -- [head](verida_account_web_vault._internal_.Axios.md#head) -- [options](verida_account_web_vault._internal_.Axios.md#options) -- [patch](verida_account_web_vault._internal_.Axios.md#patch) -- [patchForm](verida_account_web_vault._internal_.Axios.md#patchform) -- [post](verida_account_web_vault._internal_.Axios.md#post) -- [postForm](verida_account_web_vault._internal_.Axios.md#postform) -- [put](verida_account_web_vault._internal_.Axios.md#put) -- [putForm](verida_account_web_vault._internal_.Axios.md#putform) -- [request](verida_account_web_vault._internal_.Axios.md#request) - -## Constructors - -### constructor - -• **new Axios**(`config?`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config?` | [`AxiosRequestConfig`](../interfaces/verida_account_web_vault._internal_.AxiosRequestConfig.md)<`any`\> | - -#### Defined in - -node_modules/axios/index.d.ts:215 - -## Properties - -### defaults - -• **defaults**: [`AxiosDefaults`](../interfaces/verida_account_web_vault._internal_.AxiosDefaults.md)<`any`\> - -#### Defined in - -node_modules/axios/index.d.ts:216 - -___ - -### interceptors - -• **interceptors**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `request` | [`AxiosInterceptorManager`](../interfaces/verida_account_web_vault._internal_.AxiosInterceptorManager.md)<[`AxiosRequestConfig`](../interfaces/verida_account_web_vault._internal_.AxiosRequestConfig.md)<`any`\>\> | -| `response` | [`AxiosInterceptorManager`](../interfaces/verida_account_web_vault._internal_.AxiosInterceptorManager.md)<[`AxiosResponse`](../interfaces/verida_account_web_vault._internal_.AxiosResponse.md)<`any`, `any`\>\> | - -#### Defined in - -node_modules/axios/index.d.ts:217 - -## Methods - -### delete - -▸ **delete**<`T`, `R`, `D`\>(`url`, `config?`): `Promise`<`R`\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `any` | -| `R` | [`AxiosResponse`](../interfaces/verida_account_web_vault._internal_.AxiosResponse.md)<`T`, `any`\> | -| `D` | `any` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `config?` | [`AxiosRequestConfig`](../interfaces/verida_account_web_vault._internal_.AxiosRequestConfig.md)<`D`\> | - -#### Returns - -`Promise`<`R`\> - -#### Defined in - -node_modules/axios/index.d.ts:224 - -___ - -### get - -▸ **get**<`T`, `R`, `D`\>(`url`, `config?`): `Promise`<`R`\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `any` | -| `R` | [`AxiosResponse`](../interfaces/verida_account_web_vault._internal_.AxiosResponse.md)<`T`, `any`\> | -| `D` | `any` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `config?` | [`AxiosRequestConfig`](../interfaces/verida_account_web_vault._internal_.AxiosRequestConfig.md)<`D`\> | - -#### Returns - -`Promise`<`R`\> - -#### Defined in - -node_modules/axios/index.d.ts:223 - -___ - -### getUri - -▸ **getUri**(`config?`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config?` | [`AxiosRequestConfig`](../interfaces/verida_account_web_vault._internal_.AxiosRequestConfig.md)<`any`\> | - -#### Returns - -`string` - -#### Defined in - -node_modules/axios/index.d.ts:221 - -___ - -### head - -▸ **head**<`T`, `R`, `D`\>(`url`, `config?`): `Promise`<`R`\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `any` | -| `R` | [`AxiosResponse`](../interfaces/verida_account_web_vault._internal_.AxiosResponse.md)<`T`, `any`\> | -| `D` | `any` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `config?` | [`AxiosRequestConfig`](../interfaces/verida_account_web_vault._internal_.AxiosRequestConfig.md)<`D`\> | - -#### Returns - -`Promise`<`R`\> - -#### Defined in - -node_modules/axios/index.d.ts:225 - -___ - -### options - -▸ **options**<`T`, `R`, `D`\>(`url`, `config?`): `Promise`<`R`\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `any` | -| `R` | [`AxiosResponse`](../interfaces/verida_account_web_vault._internal_.AxiosResponse.md)<`T`, `any`\> | -| `D` | `any` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `config?` | [`AxiosRequestConfig`](../interfaces/verida_account_web_vault._internal_.AxiosRequestConfig.md)<`D`\> | - -#### Returns - -`Promise`<`R`\> - -#### Defined in - -node_modules/axios/index.d.ts:226 - -___ - -### patch - -▸ **patch**<`T`, `R`, `D`\>(`url`, `data?`, `config?`): `Promise`<`R`\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `any` | -| `R` | [`AxiosResponse`](../interfaces/verida_account_web_vault._internal_.AxiosResponse.md)<`T`, `any`\> | -| `D` | `any` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `data?` | `D` | -| `config?` | [`AxiosRequestConfig`](../interfaces/verida_account_web_vault._internal_.AxiosRequestConfig.md)<`D`\> | - -#### Returns - -`Promise`<`R`\> - -#### Defined in - -node_modules/axios/index.d.ts:229 - -___ - -### patchForm - -▸ **patchForm**<`T`, `R`, `D`\>(`url`, `data?`, `config?`): `Promise`<`R`\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `any` | -| `R` | [`AxiosResponse`](../interfaces/verida_account_web_vault._internal_.AxiosResponse.md)<`T`, `any`\> | -| `D` | `any` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `data?` | `D` | -| `config?` | [`AxiosRequestConfig`](../interfaces/verida_account_web_vault._internal_.AxiosRequestConfig.md)<`D`\> | - -#### Returns - -`Promise`<`R`\> - -#### Defined in - -node_modules/axios/index.d.ts:232 - -___ - -### post - -▸ **post**<`T`, `R`, `D`\>(`url`, `data?`, `config?`): `Promise`<`R`\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `any` | -| `R` | [`AxiosResponse`](../interfaces/verida_account_web_vault._internal_.AxiosResponse.md)<`T`, `any`\> | -| `D` | `any` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `data?` | `D` | -| `config?` | [`AxiosRequestConfig`](../interfaces/verida_account_web_vault._internal_.AxiosRequestConfig.md)<`D`\> | - -#### Returns - -`Promise`<`R`\> - -#### Defined in - -node_modules/axios/index.d.ts:227 - -___ - -### postForm - -▸ **postForm**<`T`, `R`, `D`\>(`url`, `data?`, `config?`): `Promise`<`R`\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `any` | -| `R` | [`AxiosResponse`](../interfaces/verida_account_web_vault._internal_.AxiosResponse.md)<`T`, `any`\> | -| `D` | `any` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `data?` | `D` | -| `config?` | [`AxiosRequestConfig`](../interfaces/verida_account_web_vault._internal_.AxiosRequestConfig.md)<`D`\> | - -#### Returns - -`Promise`<`R`\> - -#### Defined in - -node_modules/axios/index.d.ts:230 - -___ - -### put - -▸ **put**<`T`, `R`, `D`\>(`url`, `data?`, `config?`): `Promise`<`R`\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `any` | -| `R` | [`AxiosResponse`](../interfaces/verida_account_web_vault._internal_.AxiosResponse.md)<`T`, `any`\> | -| `D` | `any` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `data?` | `D` | -| `config?` | [`AxiosRequestConfig`](../interfaces/verida_account_web_vault._internal_.AxiosRequestConfig.md)<`D`\> | - -#### Returns - -`Promise`<`R`\> - -#### Defined in - -node_modules/axios/index.d.ts:228 - -___ - -### putForm - -▸ **putForm**<`T`, `R`, `D`\>(`url`, `data?`, `config?`): `Promise`<`R`\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `any` | -| `R` | [`AxiosResponse`](../interfaces/verida_account_web_vault._internal_.AxiosResponse.md)<`T`, `any`\> | -| `D` | `any` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `data?` | `D` | -| `config?` | [`AxiosRequestConfig`](../interfaces/verida_account_web_vault._internal_.AxiosRequestConfig.md)<`D`\> | - -#### Returns - -`Promise`<`R`\> - -#### Defined in - -node_modules/axios/index.d.ts:231 - -___ - -### request - -▸ **request**<`T`, `R`, `D`\>(`config`): `Promise`<`R`\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `any` | -| `R` | [`AxiosResponse`](../interfaces/verida_account_web_vault._internal_.AxiosResponse.md)<`T`, `any`\> | -| `D` | `any` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | [`AxiosRequestConfig`](../interfaces/verida_account_web_vault._internal_.AxiosRequestConfig.md)<`D`\> | - -#### Returns - -`Promise`<`R`\> - -#### Defined in - -node_modules/axios/index.d.ts:222 diff --git a/docs/api/verida-js/classes/verida_account_web_vault._internal_.default-1.md b/docs/api/verida-js/classes/verida_account_web_vault._internal_.default-1.md deleted file mode 100644 index 9a7ff8b..0000000 --- a/docs/api/verida-js/classes/verida_account_web_vault._internal_.default-1.md +++ /dev/null @@ -1,423 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account-web-vault](../modules/verida_account_web_vault.md) / [](../modules/verida_account_web_vault._internal_.md) / default - -# Class: default - -[@verida/account-web-vault](../modules/verida_account_web_vault.md).[](../modules/verida_account_web_vault._internal_.md).default - -Class that takes a signature (generated from a signed consent message) and generates a -collection of asymmetric keys, symmetric key and signing key for a given secure storage -context. - -## Implements - -- [`IKeyring`](../interfaces/verida_account_web_vault._internal_.IKeyring.md) - -## Table of contents - -### Constructors - -- [constructor](verida_account_web_vault._internal_.default-1.md#constructor) - -### Properties - -- [asymKeyPair](verida_account_web_vault._internal_.default-1.md#asymkeypair) -- [buildKey](verida_account_web_vault._internal_.default-1.md#buildkey) -- [seed](verida_account_web_vault._internal_.default-1.md#seed) -- [signKeyPair](verida_account_web_vault._internal_.default-1.md#signkeypair) -- [storageContextKeys](verida_account_web_vault._internal_.default-1.md#storagecontextkeys) -- [symKey](verida_account_web_vault._internal_.default-1.md#symkey) - -### Methods - -- [\_init](verida_account_web_vault._internal_.default-1.md#_init) -- [asymDecrypt](verida_account_web_vault._internal_.default-1.md#asymdecrypt) -- [asymEncrypt](verida_account_web_vault._internal_.default-1.md#asymencrypt) -- [buildSharedKeyEnd](verida_account_web_vault._internal_.default-1.md#buildsharedkeyend) -- [buildSharedKeyStart](verida_account_web_vault._internal_.default-1.md#buildsharedkeystart) -- [getKeys](verida_account_web_vault._internal_.default-1.md#getkeys) -- [getSeed](verida_account_web_vault._internal_.default-1.md#getseed) -- [getStorageContextKey](verida_account_web_vault._internal_.default-1.md#getstoragecontextkey) -- [publicKeys](verida_account_web_vault._internal_.default-1.md#publickeys) -- [sign](verida_account_web_vault._internal_.default-1.md#sign) -- [symDecrypt](verida_account_web_vault._internal_.default-1.md#symdecrypt) -- [symEncrypt](verida_account_web_vault._internal_.default-1.md#symencrypt) -- [verifySig](verida_account_web_vault._internal_.default-1.md#verifysig) - -## Constructors - -### constructor - -• **new default**(`seed`) - -A string used as a seed for this keyring. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `seed` | `string` | - -#### Defined in - -packages/keyring/dist/keyring.d.ts:19 - -## Properties - -### asymKeyPair - -• `Optional` **asymKeyPair**: `any` - -#### Defined in - -packages/keyring/dist/keyring.d.ts:9 - -___ - -### buildKey - -• `Private` **buildKey**: `any` - -Helper function that generates a key of the appropriate type - -**`param`** - -**`param`** - -**`returns`** - -#### Defined in - -packages/keyring/dist/keyring.d.ts:29 - -___ - -### seed - -• `Private` **seed**: `any` - -#### Defined in - -packages/keyring/dist/keyring.d.ts:12 - -___ - -### signKeyPair - -• `Optional` **signKeyPair**: `any` - -#### Defined in - -packages/keyring/dist/keyring.d.ts:10 - -___ - -### storageContextKeys - -• `Private` **storageContextKeys**: `any` - -#### Defined in - -packages/keyring/dist/keyring.d.ts:13 - -___ - -### symKey - -• `Optional` **symKey**: `Uint8Array` - -#### Defined in - -packages/keyring/dist/keyring.d.ts:11 - -## Methods - -### \_init - -▸ **_init**(): `Promise`<`void`\> - -#### Returns - -`Promise`<`void`\> - -#### Implementation of - -[IKeyring](../interfaces/verida_account_web_vault._internal_.IKeyring.md).[_init](../interfaces/verida_account_web_vault._internal_.IKeyring.md#_init) - -#### Defined in - -packages/keyring/dist/keyring.d.ts:21 - -___ - -### asymDecrypt - -▸ **asymDecrypt**(`messageWithNonce`, `secretOrSharedKey`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `messageWithNonce` | `string` | -| `secretOrSharedKey` | `Uint8Array` | - -#### Returns - -`Promise`<`any`\> - -#### Implementation of - -[IKeyring](../interfaces/verida_account_web_vault._internal_.IKeyring.md).[asymDecrypt](../interfaces/verida_account_web_vault._internal_.IKeyring.md#asymdecrypt) - -#### Defined in - -packages/keyring/dist/keyring.d.ts:41 - -___ - -### asymEncrypt - -▸ **asymEncrypt**(`data`, `secretOrSharedKey`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `string` | -| `secretOrSharedKey` | `Uint8Array` | - -#### Returns - -`Promise`<`string`\> - -#### Implementation of - -[IKeyring](../interfaces/verida_account_web_vault._internal_.IKeyring.md).[asymEncrypt](../interfaces/verida_account_web_vault._internal_.IKeyring.md#asymencrypt) - -#### Defined in - -packages/keyring/dist/keyring.d.ts:40 - -___ - -### buildSharedKeyEnd - -▸ **buildSharedKeyEnd**(`publicKey`): `Promise`<`Uint8Array`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `publicKey` | `Uint8Array` | - -#### Returns - -`Promise`<`Uint8Array`\> - -#### Implementation of - -[IKeyring](../interfaces/verida_account_web_vault._internal_.IKeyring.md).[buildSharedKeyEnd](../interfaces/verida_account_web_vault._internal_.IKeyring.md#buildsharedkeyend) - -#### Defined in - -packages/keyring/dist/keyring.d.ts:43 - -___ - -### buildSharedKeyStart - -▸ **buildSharedKeyStart**(`privateKey`): `Promise`<`Uint8Array`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `privateKey` | `Uint8Array` | - -#### Returns - -`Promise`<`Uint8Array`\> - -#### Implementation of - -[IKeyring](../interfaces/verida_account_web_vault._internal_.IKeyring.md).[buildSharedKeyStart](../interfaces/verida_account_web_vault._internal_.IKeyring.md#buildsharedkeystart) - -#### Defined in - -packages/keyring/dist/keyring.d.ts:42 - -___ - -### getKeys - -▸ **getKeys**(): `Promise`<`any`\> - -#### Returns - -`Promise`<`any`\> - -#### Implementation of - -[IKeyring](../interfaces/verida_account_web_vault._internal_.IKeyring.md).[getKeys](../interfaces/verida_account_web_vault._internal_.IKeyring.md#getkeys) - -#### Defined in - -packages/keyring/dist/keyring.d.ts:20 - -___ - -### getSeed - -▸ **getSeed**(): `string` - -#### Returns - -`string` - -#### Implementation of - -[IKeyring](../interfaces/verida_account_web_vault._internal_.IKeyring.md).[getSeed](../interfaces/verida_account_web_vault._internal_.IKeyring.md#getseed) - -#### Defined in - -packages/keyring/dist/keyring.d.ts:44 - -___ - -### getStorageContextKey - -▸ **getStorageContextKey**(`databaseName`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `databaseName` | `string` | - -#### Returns - -`Promise`<`any`\> - -#### Implementation of - -[IKeyring](../interfaces/verida_account_web_vault._internal_.IKeyring.md).[getStorageContextKey](../interfaces/verida_account_web_vault._internal_.IKeyring.md#getstoragecontextkey) - -#### Defined in - -packages/keyring/dist/keyring.d.ts:45 - -___ - -### publicKeys - -▸ **publicKeys**(): `Promise`<[`KeyringPublicKeys`](../interfaces/verida_account_web_vault._internal_.KeyringPublicKeys.md)\> - -Generate an object containing all the public keys for this Keyring - -#### Returns - -`Promise`<[`KeyringPublicKeys`](../interfaces/verida_account_web_vault._internal_.KeyringPublicKeys.md)\> - -#### Implementation of - -[IKeyring](../interfaces/verida_account_web_vault._internal_.IKeyring.md).[publicKeys](../interfaces/verida_account_web_vault._internal_.IKeyring.md#publickeys) - -#### Defined in - -packages/keyring/dist/keyring.d.ts:35 - -___ - -### sign - -▸ **sign**(`data`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `any` | - -#### Returns - -`Promise`<`string`\> - -#### Implementation of - -[IKeyring](../interfaces/verida_account_web_vault._internal_.IKeyring.md).[sign](../interfaces/verida_account_web_vault._internal_.IKeyring.md#sign) - -#### Defined in - -packages/keyring/dist/keyring.d.ts:36 - -___ - -### symDecrypt - -▸ **symDecrypt**(`data`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `string` | - -#### Returns - -`Promise`<`any`\> - -#### Implementation of - -[IKeyring](../interfaces/verida_account_web_vault._internal_.IKeyring.md).[symDecrypt](../interfaces/verida_account_web_vault._internal_.IKeyring.md#symdecrypt) - -#### Defined in - -packages/keyring/dist/keyring.d.ts:39 - -___ - -### symEncrypt - -▸ **symEncrypt**(`data`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Implementation of - -[IKeyring](../interfaces/verida_account_web_vault._internal_.IKeyring.md).[symEncrypt](../interfaces/verida_account_web_vault._internal_.IKeyring.md#symencrypt) - -#### Defined in - -packages/keyring/dist/keyring.d.ts:38 - -___ - -### verifySig - -▸ **verifySig**(`data`, `sig`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `string` | -| `sig` | `string` | - -#### Returns - -`Promise`<`boolean`\> - -#### Implementation of - -[IKeyring](../interfaces/verida_account_web_vault._internal_.IKeyring.md).[verifySig](../interfaces/verida_account_web_vault._internal_.IKeyring.md#verifysig) - -#### Defined in - -packages/keyring/dist/keyring.d.ts:37 diff --git a/docs/api/verida-js/classes/verida_account_web_vault._internal_.default.md b/docs/api/verida-js/classes/verida_account_web_vault._internal_.default.md deleted file mode 100644 index fce8fdf..0000000 --- a/docs/api/verida-js/classes/verida_account_web_vault._internal_.default.md +++ /dev/null @@ -1,352 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account-web-vault](../modules/verida_account_web_vault.md) / [](../modules/verida_account_web_vault._internal_.md) / default - -# Class: default - -[@verida/account-web-vault](../modules/verida_account_web_vault.md).[](../modules/verida_account_web_vault._internal_.md).default - -An Authenticator that automatically signs everything - -## Hierarchy - -- **`default`** - - ↳ [`VaultAccount`](verida_account_web_vault.VaultAccount.md) - -## Implements - -- [`IAccount`](../interfaces/verida_account_web_vault._internal_.IAccount.md) - -## Table of contents - -### Constructors - -- [constructor](verida_account_web_vault._internal_.default.md#constructor) - -### Methods - -- [createDidJwt](verida_account_web_vault._internal_.default.md#createdidjwt) -- [did](verida_account_web_vault._internal_.default.md#did) -- [disconnect](verida_account_web_vault._internal_.default.md#disconnect) -- [disconnectDevice](verida_account_web_vault._internal_.default.md#disconnectdevice) -- [getAuthContext](verida_account_web_vault._internal_.default.md#getauthcontext) -- [keyring](verida_account_web_vault._internal_.default.md#keyring) -- [linkStorage](verida_account_web_vault._internal_.default.md#linkstorage) -- [linkStorageContextService](verida_account_web_vault._internal_.default.md#linkstoragecontextservice) -- [setAccountConfig](verida_account_web_vault._internal_.default.md#setaccountconfig) -- [sign](verida_account_web_vault._internal_.default.md#sign) -- [storageConfig](verida_account_web_vault._internal_.default.md#storageconfig) -- [unlinkStorage](verida_account_web_vault._internal_.default.md#unlinkstorage) - -## Constructors - -### constructor - -• **new default**() - -## Methods - -### createDidJwt - -▸ **createDidJwt**(`contextName`, `data`, `config?`): `Promise`<`string`\> - -Create a DID-JWT from a data object - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | -| `data` | `object` | -| `config?` | `any` | - -#### Returns - -`Promise`<`string`\> - -#### Implementation of - -[IAccount](../interfaces/verida_account_web_vault._internal_.IAccount.md).[createDidJwt](../interfaces/verida_account_web_vault._internal_.IAccount.md#createdidjwt) - -#### Defined in - -packages/account/dist/account.d.ts:42 - -___ - -### did - -▸ **did**(): `Promise`<`string`\> - -Get the DID of the current user - -#### Returns - -`Promise`<`string`\> - -#### Implementation of - -[IAccount](../interfaces/verida_account_web_vault._internal_.IAccount.md).[did](../interfaces/verida_account_web_vault._internal_.IAccount.md#did) - -#### Defined in - -packages/account/dist/account.d.ts:22 - -___ - -### disconnect - -▸ **disconnect**(`contextName?`): `Promise`<`void`\> - -An optional method that can be used to disconnect the current user. - -For example, in a web browser context, it would remove any stored signatures from local storage. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName?` | `string` | - -#### Returns - -`Promise`<`void`\> - -#### Implementation of - -[IAccount](../interfaces/verida_account_web_vault._internal_.IAccount.md).[disconnect](../interfaces/verida_account_web_vault._internal_.IAccount.md#disconnect) - -#### Defined in - -packages/account/dist/account.d.ts:48 - -___ - -### disconnectDevice - -▸ **disconnectDevice**(`contextName`, `deviceId?`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | -| `deviceId?` | `string` | - -#### Returns - -`Promise`<`boolean`\> - -#### Implementation of - -[IAccount](../interfaces/verida_account_web_vault._internal_.IAccount.md).[disconnectDevice](../interfaces/verida_account_web_vault._internal_.IAccount.md#disconnectdevice) - -#### Defined in - -packages/account/dist/account.d.ts:50 - -___ - -### getAuthContext - -▸ **getAuthContext**(`contextName`, `contextConfig`, `authConfig?`, `authType?`): `Promise`<[`AuthContext`](../interfaces/verida_account_web_vault._internal_.AuthContext.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | -| `contextConfig` | [`SecureContextConfig`](../interfaces/verida_account_web_vault._internal_.SecureContextConfig.md) | -| `authConfig?` | [`AuthTypeConfig`](../interfaces/verida_account_web_vault._internal_.AuthTypeConfig.md) | -| `authType?` | `string` | - -#### Returns - -`Promise`<[`AuthContext`](../interfaces/verida_account_web_vault._internal_.AuthContext.md)\> - -#### Implementation of - -[IAccount](../interfaces/verida_account_web_vault._internal_.IAccount.md).[getAuthContext](../interfaces/verida_account_web_vault._internal_.IAccount.md#getauthcontext) - -#### Defined in - -packages/account/dist/account.d.ts:49 - -___ - -### keyring - -▸ **keyring**(`contextName`): `Promise`<[`default`](verida_account_web_vault._internal_.default-1.md)\> - -Generate a keyring for this user for a given storage context. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | - -#### Returns - -`Promise`<[`default`](verida_account_web_vault._internal_.default-1.md)\> - -#### Implementation of - -[IAccount](../interfaces/verida_account_web_vault._internal_.IAccount.md).[keyring](../interfaces/verida_account_web_vault._internal_.IAccount.md#keyring) - -#### Defined in - -packages/account/dist/account.d.ts:12 - -___ - -### linkStorage - -▸ **linkStorage**(`storageConfig`): `Promise`<`boolean`\> - -Link storage to this user - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `storageConfig` | [`SecureContextConfig`](../interfaces/verida_account_web_vault._internal_.SecureContextConfig.md) | - -#### Returns - -`Promise`<`boolean`\> - -#### Implementation of - -[IAccount](../interfaces/verida_account_web_vault._internal_.IAccount.md).[linkStorage](../interfaces/verida_account_web_vault._internal_.IAccount.md#linkstorage) - -#### Defined in - -packages/account/dist/account.d.ts:28 - -___ - -### linkStorageContextService - -▸ **linkStorageContextService**(`contextName`, `endpointType`, `serverType`, `endpointUris`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | -| `endpointType` | `string` | -| `serverType` | `string` | -| `endpointUris` | `string`[] | - -#### Returns - -`Promise`<`boolean`\> - -#### Implementation of - -[IAccount](../interfaces/verida_account_web_vault._internal_.IAccount.md).[linkStorageContextService](../interfaces/verida_account_web_vault._internal_.IAccount.md#linkstoragecontextservice) - -#### Defined in - -packages/account/dist/account.d.ts:36 - -___ - -### setAccountConfig - -▸ **setAccountConfig**(`accountConfig`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `accountConfig` | [`AccountConfig`](../interfaces/verida_account_web_vault._internal_.AccountConfig.md) | - -#### Returns - -`void` - -#### Implementation of - -[IAccount](../interfaces/verida_account_web_vault._internal_.IAccount.md).[setAccountConfig](../interfaces/verida_account_web_vault._internal_.IAccount.md#setaccountconfig) - -#### Defined in - -packages/account/dist/account.d.ts:37 - -___ - -### sign - -▸ **sign**(`input`): `Promise`<`string`\> - -Sign a string as the current user - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `input` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Implementation of - -[IAccount](../interfaces/verida_account_web_vault._internal_.IAccount.md).[sign](../interfaces/verida_account_web_vault._internal_.IAccount.md#sign) - -#### Defined in - -packages/account/dist/account.d.ts:18 - -___ - -### storageConfig - -▸ **storageConfig**(`contextName`, `forceCreate?`): `Promise`<`undefined` \| [`SecureContextConfig`](../interfaces/verida_account_web_vault._internal_.SecureContextConfig.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | -| `forceCreate?` | `boolean` | - -#### Returns - -`Promise`<`undefined` \| [`SecureContextConfig`](../interfaces/verida_account_web_vault._internal_.SecureContextConfig.md)\> - -#### Implementation of - -[IAccount](../interfaces/verida_account_web_vault._internal_.IAccount.md).[storageConfig](../interfaces/verida_account_web_vault._internal_.IAccount.md#storageconfig) - -#### Defined in - -packages/account/dist/account.d.ts:35 - -___ - -### unlinkStorage - -▸ **unlinkStorage**(`contextName`): `Promise`<`boolean`\> - -Unlink storage for this user - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | - -#### Returns - -`Promise`<`boolean`\> - -#### Implementation of - -[IAccount](../interfaces/verida_account_web_vault._internal_.IAccount.md).[unlinkStorage](../interfaces/verida_account_web_vault._internal_.IAccount.md#unlinkstorage) - -#### Defined in - -packages/account/dist/account.d.ts:34 diff --git a/docs/api/verida-js/classes/verida_client_ts.Client.md b/docs/api/verida-js/classes/verida_client_ts.Client.md deleted file mode 100644 index 2389462..0000000 --- a/docs/api/verida-js/classes/verida_client_ts.Client.md +++ /dev/null @@ -1,511 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / Client - -# Class: Client - -[@verida/client-ts](../modules/verida_client_ts.md).Client - -## Implements - -- [`IClient`](../interfaces/verida_client_ts._internal_.IClient.md) - -## Table of contents - -### Constructors - -- [constructor](verida_client_ts.Client.md#constructor) - -### Properties - -- [account](verida_client_ts.Client.md#account) -- [config](verida_client_ts.Client.md#config) -- [did](verida_client_ts.Client.md#did) -- [didClient](verida_client_ts.Client.md#didclient) -- [didContextManager](verida_client_ts.Client.md#didcontextmanager) -- [environment](verida_client_ts.Client.md#environment) -- [nameClient](verida_client_ts.Client.md#nameclient) - -### Methods - -- [connect](verida_client_ts.Client.md#connect) -- [destroyAccount](verida_client_ts.Client.md#destroyaccount) -- [destroyContext](verida_client_ts.Client.md#destroycontext) -- [getConfig](verida_client_ts.Client.md#getconfig) -- [getContextConfig](verida_client_ts.Client.md#getcontextconfig) -- [getContextNameFromHash](verida_client_ts.Client.md#getcontextnamefromhash) -- [getDID](verida_client_ts.Client.md#getdid) -- [getSchema](verida_client_ts.Client.md#getschema) -- [getUsernames](verida_client_ts.Client.md#getusernames) -- [getValidDataSignatures](verida_client_ts.Client.md#getvaliddatasignatures) -- [isConnected](verida_client_ts.Client.md#isconnected) -- [openContext](verida_client_ts.Client.md#opencontext) -- [openExternalContext](verida_client_ts.Client.md#openexternalcontext) -- [openPublicProfile](verida_client_ts.Client.md#openpublicprofile) -- [parseDid](verida_client_ts.Client.md#parsedid) - -## Constructors - -### constructor - -• **new Client**(`userConfig`) - -Create a client connection to the Verida network - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `userConfig` | [`ClientConfig`](../interfaces/verida_client_ts._internal_.ClientConfig.md) | ClientConfig Configuration for establishing a connection to the Verida network | - -#### Defined in - -[packages/client-ts/src/client.ts:56](https://github.com/verida/verida-js/blob/5040472/packages/client-ts/src/client.ts#L56) - -## Properties - -### account - -• `Private` `Optional` **account**: [`IAccount`](../interfaces/verida_client_ts._internal_.IAccount.md) - -Connected account instance - -#### Defined in - -[packages/client-ts/src/client.ts:32](https://github.com/verida/verida-js/blob/5040472/packages/client-ts/src/client.ts#L32) - -___ - -### config - -• `Private` **config**: [`DefaultClientConfig`](../interfaces/verida_client_ts._internal_.DefaultClientConfig.md) - -Current configuration for this client - -#### Defined in - -[packages/client-ts/src/client.ts:49](https://github.com/verida/verida-js/blob/5040472/packages/client-ts/src/client.ts#L49) - -___ - -### did - -• `Private` `Optional` **did**: `string` - -DID of connected account - -#### Defined in - -[packages/client-ts/src/client.ts:37](https://github.com/verida/verida-js/blob/5040472/packages/client-ts/src/client.ts#L37) - -___ - -### didClient - -• **didClient**: [`DIDClient`](verida_client_ts._internal_.DIDClient.md) - -Connection to the Verida DID Registry - -#### Defined in - -[packages/client-ts/src/client.ts:22](https://github.com/verida/verida-js/blob/5040472/packages/client-ts/src/client.ts#L22) - -___ - -### didContextManager - -• `Private` **didContextManager**: [`DIDContextManager`](verida_client_ts._internal_.DIDContextManager.md) - -Helper instance to manage DID contexts - -#### Defined in - -[packages/client-ts/src/client.ts:27](https://github.com/verida/verida-js/blob/5040472/packages/client-ts/src/client.ts#L27) - -___ - -### environment - -• `Private` **environment**: [`EnvironmentType`](../enums/verida_client_ts._internal_.EnvironmentType.md) - -Currently selected environment - -#### Defined in - -[packages/client-ts/src/client.ts:42](https://github.com/verida/verida-js/blob/5040472/packages/client-ts/src/client.ts#L42) - -___ - -### nameClient - -• `Private` **nameClient**: [`VeridaNameClient`](verida_client_ts._internal_.VeridaNameClient.md) - -#### Defined in - -[packages/client-ts/src/client.ts:44](https://github.com/verida/verida-js/blob/5040472/packages/client-ts/src/client.ts#L44) - -## Methods - -### connect - -▸ **connect**(`account`): `Promise`<`void`\> - -Connect an Account to this client. - -Sets the account owner who can then create storage contexts, -authenticate with databases, send messages etc. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `account` | [`IAccount`](../interfaces/verida_client_ts._internal_.IAccount.md) | AccountInterface | - -#### Returns - -`Promise`<`void`\> - -#### Implementation of - -[IClient](../interfaces/verida_client_ts._internal_.IClient.md).[connect](../interfaces/verida_client_ts._internal_.IClient.md#connect) - -#### Defined in - -[packages/client-ts/src/client.ts:95](https://github.com/verida/verida-js/blob/5040472/packages/client-ts/src/client.ts#L95) - -___ - -### destroyAccount - -▸ **destroyAccount**(): `Promise`<`void`\> - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -[packages/client-ts/src/client.ts:311](https://github.com/verida/verida-js/blob/5040472/packages/client-ts/src/client.ts#L311) - -___ - -### destroyContext - -▸ **destroyContext**(`contextName`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -[packages/client-ts/src/client.ts:361](https://github.com/verida/verida-js/blob/5040472/packages/client-ts/src/client.ts#L361) - -___ - -### getConfig - -▸ **getConfig**(): [`DefaultClientConfig`](../interfaces/verida_client_ts._internal_.DefaultClientConfig.md) - -#### Returns - -[`DefaultClientConfig`](../interfaces/verida_client_ts._internal_.DefaultClientConfig.md) - -#### Defined in - -[packages/client-ts/src/client.ts:207](https://github.com/verida/verida-js/blob/5040472/packages/client-ts/src/client.ts#L207) - -___ - -### getContextConfig - -▸ **getContextConfig**(`did`, `contextName`): `Promise`<`undefined` \| [`SecureContextConfig`](../interfaces/verida_client_ts._internal_.SecureContextConfig.md)\> - -Get the storage configuration of an application context for a given DID. - -This provides the public details about the database, storage and messaging endpoints stored on did-client/did-document for the requested `did`. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `did` | `string` | | -| `contextName` | `string` | The name of the context OR a context hash (starting with 0x) | - -#### Returns - -`Promise`<`undefined` \| [`SecureContextConfig`](../interfaces/verida_client_ts._internal_.SecureContextConfig.md)\> - -SecureContextConfig | undefined - -#### Implementation of - -[IClient](../interfaces/verida_client_ts._internal_.IClient.md).[getContextConfig](../interfaces/verida_client_ts._internal_.IClient.md#getcontextconfig) - -#### Defined in - -[packages/client-ts/src/client.ts:199](https://github.com/verida/verida-js/blob/5040472/packages/client-ts/src/client.ts#L199) - -___ - -### getContextNameFromHash - -▸ **getContextNameFromHash**(`contextHash`, `didDocument?`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextHash` | `string` | -| `didDocument?` | [`default`](verida_client_ts._internal_.default-1.md) | - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -[packages/client-ts/src/client.ts:417](https://github.com/verida/verida-js/blob/5040472/packages/client-ts/src/client.ts#L417) - -___ - -### getDID - -▸ **getDID**(`username`): `Promise`<`string`\> - -Get the DID linked to a username - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `username` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -[packages/client-ts/src/client.ts:500](https://github.com/verida/verida-js/blob/5040472/packages/client-ts/src/client.ts#L500) - -___ - -### getSchema - -▸ **getSchema**(`schemaUri`): `Promise`<[`Schema`](verida_client_ts._internal_.Schema.md)\> - -Get a Schama instance by URL. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `schemaUri` | `string` | URL of the schema | - -#### Returns - -`Promise`<[`Schema`](verida_client_ts._internal_.Schema.md)\> - -Schema A schema object - -#### Implementation of - -[IClient](../interfaces/verida_client_ts._internal_.IClient.md).[getSchema](../interfaces/verida_client_ts._internal_.IClient.md#getschema) - -#### Defined in - -[packages/client-ts/src/client.ts:473](https://github.com/verida/verida-js/blob/5040472/packages/client-ts/src/client.ts#L473) - -___ - -### getUsernames - -▸ **getUsernames**(`did`): `Promise`<`string`[]\> - -Get an array of usernames linked to a DID - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did` | `string` | - -#### Returns - -`Promise`<`string`[]\> - -#### Defined in - -[packages/client-ts/src/client.ts:510](https://github.com/verida/verida-js/blob/5040472/packages/client-ts/src/client.ts#L510) - -___ - -### getValidDataSignatures - -▸ **getValidDataSignatures**(`data`, `did?`): `Promise`<`string`[]\> - -Get the valid data signatures for a given database record. - -Iterates through all the signatures attached to a database record and validates each signature. - -Only returns the signatures that are valid. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `data` | `any` | A single database record | -| `did?` | `string` | An optional did to filter the results by | - -#### Returns - -`Promise`<`string`[]\> - -string[] Array of DIDs that have validly signed the data - -#### Implementation of - -[IClient](../interfaces/verida_client_ts._internal_.IClient.md).[getValidDataSignatures](../interfaces/verida_client_ts._internal_.IClient.md#getvaliddatasignatures) - -#### Defined in - -[packages/client-ts/src/client.ts:258](https://github.com/verida/verida-js/blob/5040472/packages/client-ts/src/client.ts#L258) - -___ - -### isConnected - -▸ **isConnected**(): `boolean` - -Check if an account is connected to this client. - -#### Returns - -`boolean` - -boolean True of an account is connected - -#### Implementation of - -[IClient](../interfaces/verida_client_ts._internal_.IClient.md).[isConnected](../interfaces/verida_client_ts._internal_.IClient.md#isconnected) - -#### Defined in - -[packages/client-ts/src/client.ts:110](https://github.com/verida/verida-js/blob/5040472/packages/client-ts/src/client.ts#L110) - -___ - -### openContext - -▸ **openContext**(`contextName`, `forceCreate?`): `Promise`<`undefined` \| [`IContext`](../interfaces/verida_client_ts._internal_.IContext.md)\> - -Open a storage context for the current account. - -#### Parameters - -| Name | Type | Default value | Description | -| :------ | :------ | :------ | :------ | -| `contextName` | `string` | `undefined` | string Name of the `context` to open. | -| `forceCreate` | `boolean` | `true` | boolean If the `context` doesn't already exist for the connected account, create it. Depending on the type of `Account` connected, this may open a prompt for the user to confirm (and sign). | - -#### Returns - -`Promise`<`undefined` \| [`IContext`](../interfaces/verida_client_ts._internal_.IContext.md)\> - -Context | undefined - -#### Implementation of - -[IClient](../interfaces/verida_client_ts._internal_.IClient.md).[openContext](../interfaces/verida_client_ts._internal_.IClient.md#opencontext) - -#### Defined in - -[packages/client-ts/src/client.ts:121](https://github.com/verida/verida-js/blob/5040472/packages/client-ts/src/client.ts#L121) - -___ - -### openExternalContext - -▸ **openExternalContext**(`contextName`, `did`): `Promise`<[`IContext`](../interfaces/verida_client_ts._internal_.IContext.md)\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `contextName` | `string` | The name of the context OR a context hash (starting with 0x) | -| `did` | `string` | | - -#### Returns - -`Promise`<[`IContext`](../interfaces/verida_client_ts._internal_.IContext.md)\> - -#### Implementation of - -[IClient](../interfaces/verida_client_ts._internal_.IClient.md).[openExternalContext](../interfaces/verida_client_ts._internal_.IClient.md#openexternalcontext) - -#### Defined in - -[packages/client-ts/src/client.ts:172](https://github.com/verida/verida-js/blob/5040472/packages/client-ts/src/client.ts#L172) - -___ - -### openPublicProfile - -▸ **openPublicProfile**(`did`, `contextName`, `profileName?`, `fallbackContext?`): `Promise`<`undefined` \| [`IProfile`](../interfaces/verida_client_ts._internal_.IProfile.md)\> - -Open the public profile of any user in read only mode. - -Every application context has the ability to have it's own public profiles. - -You most likely want to request the `Verida: Vault` context. - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `did` | `string` | `undefined` | -| `contextName` | `string` | `undefined` | -| `profileName` | `string` | `"basicProfile"` | -| `fallbackContext` | ``null`` \| `string` | `"Verida: Vault"` | - -#### Returns - -`Promise`<`undefined` \| [`IProfile`](../interfaces/verida_client_ts._internal_.IProfile.md)\> - -`` - -#### Implementation of - -[IClient](../interfaces/verida_client_ts._internal_.IClient.md).[openPublicProfile](../interfaces/verida_client_ts._internal_.IClient.md#openpublicprofile) - -#### Defined in - -[packages/client-ts/src/client.ts:222](https://github.com/verida/verida-js/blob/5040472/packages/client-ts/src/client.ts#L222) - -___ - -### parseDid - -▸ **parseDid**(`didOrUsername`): `Promise`<`string`\> - -Converts a string that may be either a valid DID or a valid Verida username into -a Verida username. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `didOrUsername` | `string` | DID string or Verida username string (ending in `.vda`) | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -[packages/client-ts/src/client.ts:484](https://github.com/verida/verida-js/blob/5040472/packages/client-ts/src/client.ts#L484) diff --git a/docs/api/verida-js/classes/verida_client_ts.Context.md b/docs/api/verida-js/classes/verida_client_ts.Context.md deleted file mode 100644 index 288ef4f..0000000 --- a/docs/api/verida-js/classes/verida_client_ts.Context.md +++ /dev/null @@ -1,1719 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / Context - -# Class: Context - -[@verida/client-ts](../modules/verida_client_ts.md).Context - -## Hierarchy - -- [`EventEmitter`](verida_client_ts._internal_.EventEmitter-1.md) - - ↳ **`Context`** - -## Implements - -- [`IContext`](../interfaces/verida_client_ts._internal_.IContext.md) - -## Table of contents - -### Constructors - -- [constructor](verida_client_ts.Context.md#constructor) - -### Properties - -- [account](verida_client_ts.Context.md#account) -- [client](verida_client_ts.Context.md#client) -- [contextName](verida_client_ts.Context.md#contextname) -- [databaseCache](verida_client_ts.Context.md#databasecache) -- [databaseEngines](verida_client_ts.Context.md#databaseengines) -- [dbRegistry](verida_client_ts.Context.md#dbregistry) -- [didContextManager](verida_client_ts.Context.md#didcontextmanager) -- [messagingEngine](verida_client_ts.Context.md#messagingengine) -- [notificationEngine](verida_client_ts.Context.md#notificationengine) -- [captureRejectionSymbol](verida_client_ts.Context.md#capturerejectionsymbol) -- [captureRejections](verida_client_ts.Context.md#capturerejections) -- [defaultMaxListeners](verida_client_ts.Context.md#defaultmaxlisteners) -- [errorMonitor](verida_client_ts.Context.md#errormonitor) - -### Methods - -- [addEndpoint](verida_client_ts.Context.md#addendpoint) -- [addListener](verida_client_ts.Context.md#addlistener) -- [clearDatabaseCache](verida_client_ts.Context.md#cleardatabasecache) -- [close](verida_client_ts.Context.md#close) -- [deleteDatabase](verida_client_ts.Context.md#deletedatabase) -- [disconnect](verida_client_ts.Context.md#disconnect) -- [emit](verida_client_ts.Context.md#emit) -- [eventNames](verida_client_ts.Context.md#eventnames) -- [getAccount](verida_client_ts.Context.md#getaccount) -- [getAuthContext](verida_client_ts.Context.md#getauthcontext) -- [getClient](verida_client_ts.Context.md#getclient) -- [getContextConfig](verida_client_ts.Context.md#getcontextconfig) -- [getContextName](verida_client_ts.Context.md#getcontextname) -- [getDatabaseEngine](verida_client_ts.Context.md#getdatabaseengine) -- [getDbRegistry](verida_client_ts.Context.md#getdbregistry) -- [getDidContextManager](verida_client_ts.Context.md#getdidcontextmanager) -- [getMaxListeners](verida_client_ts.Context.md#getmaxlisteners) -- [getMessaging](verida_client_ts.Context.md#getmessaging) -- [getNotification](verida_client_ts.Context.md#getnotification) -- [info](verida_client_ts.Context.md#info) -- [listenerCount](verida_client_ts.Context.md#listenercount) -- [listeners](verida_client_ts.Context.md#listeners) -- [off](verida_client_ts.Context.md#off) -- [on](verida_client_ts.Context.md#on) -- [once](verida_client_ts.Context.md#once) -- [openDatabase](verida_client_ts.Context.md#opendatabase) -- [openDatastore](verida_client_ts.Context.md#opendatastore) -- [openExternalDatabase](verida_client_ts.Context.md#openexternaldatabase) -- [openExternalDatastore](verida_client_ts.Context.md#openexternaldatastore) -- [openProfile](verida_client_ts.Context.md#openprofile) -- [prependListener](verida_client_ts.Context.md#prependlistener) -- [prependOnceListener](verida_client_ts.Context.md#prependoncelistener) -- [rawListeners](verida_client_ts.Context.md#rawlisteners) -- [removeAllListeners](verida_client_ts.Context.md#removealllisteners) -- [removeListener](verida_client_ts.Context.md#removelistener) -- [setMaxListeners](verida_client_ts.Context.md#setmaxlisteners) -- [getEventListeners](verida_client_ts.Context.md#geteventlisteners) -- [listenerCount](verida_client_ts.Context.md#listenercount) -- [on](verida_client_ts.Context.md#on) -- [once](verida_client_ts.Context.md#once) - -## Constructors - -### constructor - -• **new Context**(`client`, `contextName`, `didContextManager`, `account?`) - -Instantiate a new context. - -**Do not use directly**. Use `client.openContext()` or `Network.connect()`. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `client` | [`Client`](verida_client_ts.Client.md) | -| `contextName` | `string` | -| `didContextManager` | [`DIDContextManager`](verida_client_ts._internal_.DIDContextManager.md) | -| `account?` | [`IAccount`](../interfaces/verida_client_ts._internal_.IAccount.md) | - -#### Overrides - -[EventEmitter](verida_client_ts._internal_.EventEmitter-1.md).[constructor](verida_client_ts._internal_.EventEmitter-1.md#constructor) - -#### Defined in - -[packages/client-ts/src/context/context.ts:87](https://github.com/verida/verida-js/blob/5040472/packages/client-ts/src/context/context.ts#L87) - -## Properties - -### account - -• `Private` `Optional` **account**: [`default`](verida_client_ts._internal_.default.md) - -#### Defined in - -[packages/client-ts/src/context/context.ts:66](https://github.com/verida/verida-js/blob/5040472/packages/client-ts/src/context/context.ts#L66) - -___ - -### client - -• `Private` **client**: [`Client`](verida_client_ts.Client.md) - -#### Defined in - -[packages/client-ts/src/context/context.ts:65](https://github.com/verida/verida-js/blob/5040472/packages/client-ts/src/context/context.ts#L65) - -___ - -### contextName - -• `Private` **contextName**: `string` - -#### Defined in - -[packages/client-ts/src/context/context.ts:70](https://github.com/verida/verida-js/blob/5040472/packages/client-ts/src/context/context.ts#L70) - -___ - -### databaseCache - -• `Private` **databaseCache**: [`Record`](../modules/verida_client_ts._internal_.md#record)<`string`, [`IDatabase`](../interfaces/verida_client_ts._internal_.IDatabase.md)\> = `{}` - -#### Defined in - -[packages/client-ts/src/context/context.ts:75](https://github.com/verida/verida-js/blob/5040472/packages/client-ts/src/context/context.ts#L75) - -___ - -### databaseEngines - -• `Private` **databaseEngines**: [`DatabaseEngines`](../interfaces/verida_client_ts._internal_.DatabaseEngines.md) = `{}` - -#### Defined in - -[packages/client-ts/src/context/context.ts:72](https://github.com/verida/verida-js/blob/5040472/packages/client-ts/src/context/context.ts#L72) - -___ - -### dbRegistry - -• `Private` **dbRegistry**: [`DbRegistry`](verida_client_ts._internal_.DbRegistry.md) - -#### Defined in - -[packages/client-ts/src/context/context.ts:73](https://github.com/verida/verida-js/blob/5040472/packages/client-ts/src/context/context.ts#L73) - -___ - -### didContextManager - -• `Private` **didContextManager**: [`DIDContextManager`](verida_client_ts._internal_.DIDContextManager.md) - -#### Defined in - -[packages/client-ts/src/context/context.ts:71](https://github.com/verida/verida-js/blob/5040472/packages/client-ts/src/context/context.ts#L71) - -___ - -### messagingEngine - -• `Private` `Optional` **messagingEngine**: [`IMessaging`](../interfaces/verida_client_ts._internal_.IMessaging.md) - -#### Defined in - -[packages/client-ts/src/context/context.ts:67](https://github.com/verida/verida-js/blob/5040472/packages/client-ts/src/context/context.ts#L67) - -___ - -### notificationEngine - -• `Private` `Optional` **notificationEngine**: [`INotification`](../interfaces/verida_client_ts._internal_.INotification.md) - -#### Defined in - -[packages/client-ts/src/context/context.ts:68](https://github.com/verida/verida-js/blob/5040472/packages/client-ts/src/context/context.ts#L68) - -___ - -### captureRejectionSymbol - -▪ `Static` `Readonly` **captureRejectionSymbol**: typeof [`captureRejectionSymbol`](verida_client_ts.Context.md#capturerejectionsymbol) - -#### Inherited from - -[EventEmitter](verida_client_ts._internal_.EventEmitter-1.md).[captureRejectionSymbol](verida_client_ts._internal_.EventEmitter-1.md#capturerejectionsymbol) - -#### Defined in - -node_modules/@types/node/events.d.ts:273 - -___ - -### captureRejections - -▪ `Static` **captureRejections**: `boolean` - -Sets or gets the default captureRejection value for all emitters. - -#### Inherited from - -[EventEmitter](verida_client_ts._internal_.EventEmitter-1.md).[captureRejections](verida_client_ts._internal_.EventEmitter-1.md#capturerejections) - -#### Defined in - -node_modules/@types/node/events.d.ts:278 - -___ - -### defaultMaxListeners - -▪ `Static` **defaultMaxListeners**: `number` - -#### Inherited from - -[EventEmitter](verida_client_ts._internal_.EventEmitter-1.md).[defaultMaxListeners](verida_client_ts._internal_.EventEmitter-1.md#defaultmaxlisteners) - -#### Defined in - -node_modules/@types/node/events.d.ts:279 - -___ - -### errorMonitor - -▪ `Static` `Readonly` **errorMonitor**: typeof [`errorMonitor`](verida_client_ts.Context.md#errormonitor) - -This symbol shall be used to install a listener for only monitoring `'error'` -events. Listeners installed using this symbol are called before the regular -`'error'` listeners are called. - -Installing a listener using this symbol does not change the behavior once an -`'error'` event is emitted, therefore the process will still crash if no -regular `'error'` listener is installed. - -#### Inherited from - -[EventEmitter](verida_client_ts._internal_.EventEmitter-1.md).[errorMonitor](verida_client_ts._internal_.EventEmitter-1.md#errormonitor) - -#### Defined in - -node_modules/@types/node/events.d.ts:272 - -## Methods - -### addEndpoint - -▸ **addEndpoint**(`engineType`, `endpointUri`): `Promise`<`void`\> - -Emits `progress` event when adding the endpoint has progressed (ie: replicating databases to the new endpoint). - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `engineType` | [`ContextEngineType`](../enums/verida_client_ts._internal_.ContextEngineType.md) | -| `endpointUri` | `string` | - -#### Returns - -`Promise`<`void`\> - -#### Implementation of - -[IContext](../interfaces/verida_client_ts._internal_.IContext.md).[addEndpoint](../interfaces/verida_client_ts._internal_.IContext.md#addendpoint) - -#### Defined in - -[packages/client-ts/src/context/context.ts:535](https://github.com/verida/verida-js/blob/5040472/packages/client-ts/src/context/context.ts#L535) - -___ - -### addListener - -▸ **addListener**(`eventName`, `listener`): [`Context`](verida_client_ts.Context.md) - -Alias for `emitter.on(eventName, listener)`. - -**`since`** v0.1.26 - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | `string` \| `symbol` | -| `listener` | (...`args`: `any`[]) => `void` | - -#### Returns - -[`Context`](verida_client_ts.Context.md) - -#### Inherited from - -[EventEmitter](verida_client_ts._internal_.EventEmitter-1.md).[addListener](verida_client_ts._internal_.EventEmitter-1.md#addlistener) - -#### Defined in - -node_modules/@types/node/events.d.ts:299 - -___ - -### clearDatabaseCache - -▸ **clearDatabaseCache**(`did`, `databaseName`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did` | `string` | -| `databaseName` | `string` | - -#### Returns - -`Promise`<`void`\> - -#### Implementation of - -[IContext](../interfaces/verida_client_ts._internal_.IContext.md).[clearDatabaseCache](../interfaces/verida_client_ts._internal_.IContext.md#cleardatabasecache) - -#### Defined in - -[packages/client-ts/src/context/context.ts:580](https://github.com/verida/verida-js/blob/5040472/packages/client-ts/src/context/context.ts#L580) - -___ - -### close - -▸ **close**(`options?`): `Promise`<`void`\> - -Close this context. - -Closes all open database connections, returns resources, cancels event listeners - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options` | [`ContextCloseOptions`](../interfaces/verida_client_ts._internal_.ContextCloseOptions.md) | - -#### Returns - -`Promise`<`void`\> - -#### Implementation of - -[IContext](../interfaces/verida_client_ts._internal_.IContext.md).[close](../interfaces/verida_client_ts._internal_.IContext.md#close) - -#### Defined in - -[packages/client-ts/src/context/context.ts:566](https://github.com/verida/verida-js/blob/5040472/packages/client-ts/src/context/context.ts#L566) - -___ - -### deleteDatabase - -▸ **deleteDatabase**(`databaseName`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `databaseName` | `string` | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -[packages/client-ts/src/context/context.ts:431](https://github.com/verida/verida-js/blob/5040472/packages/client-ts/src/context/context.ts#L431) - -___ - -### disconnect - -▸ **disconnect**(): `Promise`<`boolean`\> - -#### Returns - -`Promise`<`boolean`\> - -#### Implementation of - -[IContext](../interfaces/verida_client_ts._internal_.IContext.md).[disconnect](../interfaces/verida_client_ts._internal_.IContext.md#disconnect) - -#### Defined in - -[packages/client-ts/src/context/context.ts:138](https://github.com/verida/verida-js/blob/5040472/packages/client-ts/src/context/context.ts#L138) - -___ - -### emit - -▸ **emit**(`eventName`, ...`args`): `boolean` - -Synchronously calls each of the listeners registered for the event named`eventName`, in the order they were registered, passing the supplied arguments -to each. - -Returns `true` if the event had listeners, `false` otherwise. - -```js -const EventEmitter = require('events'); -const myEmitter = new EventEmitter(); - -// First listener -myEmitter.on('event', function firstListener() { - console.log('Helloooo! first listener'); -}); -// Second listener -myEmitter.on('event', function secondListener(arg1, arg2) { - console.log(`event with parameters ${arg1}, ${arg2} in second listener`); -}); -// Third listener -myEmitter.on('event', function thirdListener(...args) { - const parameters = args.join(', '); - console.log(`event with parameters ${parameters} in third listener`); -}); - -console.log(myEmitter.listeners('event')); - -myEmitter.emit('event', 1, 2, 3, 4, 5); - -// Prints: -// [ -// [Function: firstListener], -// [Function: secondListener], -// [Function: thirdListener] -// ] -// Helloooo! first listener -// event with parameters 1, 2 in second listener -// event with parameters 1, 2, 3, 4, 5 in third listener -``` - -**`since`** v0.1.26 - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | `string` \| `symbol` | -| `...args` | `any`[] | - -#### Returns - -`boolean` - -#### Inherited from - -[EventEmitter](verida_client_ts._internal_.EventEmitter-1.md).[emit](verida_client_ts._internal_.EventEmitter-1.md#emit) - -#### Defined in - -node_modules/@types/node/events.d.ts:555 - -___ - -### eventNames - -▸ **eventNames**(): (`string` \| `symbol`)[] - -Returns an array listing the events for which the emitter has registered -listeners. The values in the array are strings or `Symbol`s. - -```js -const EventEmitter = require('events'); -const myEE = new EventEmitter(); -myEE.on('foo', () => {}); -myEE.on('bar', () => {}); - -const sym = Symbol('symbol'); -myEE.on(sym, () => {}); - -console.log(myEE.eventNames()); -// Prints: [ 'foo', 'bar', Symbol(symbol) ] -``` - -**`since`** v6.0.0 - -#### Returns - -(`string` \| `symbol`)[] - -#### Inherited from - -[EventEmitter](verida_client_ts._internal_.EventEmitter-1.md).[eventNames](verida_client_ts._internal_.EventEmitter-1.md#eventnames) - -#### Defined in - -node_modules/@types/node/events.d.ts:614 - -___ - -### getAccount - -▸ **getAccount**(): [`IAccount`](../interfaces/verida_client_ts._internal_.IAccount.md) - -#### Returns - -[`IAccount`](../interfaces/verida_client_ts._internal_.IAccount.md) - -#### Implementation of - -[IContext](../interfaces/verida_client_ts._internal_.IContext.md).[getAccount](../interfaces/verida_client_ts._internal_.IContext.md#getaccount) - -#### Defined in - -[packages/client-ts/src/context/context.ts:126](https://github.com/verida/verida-js/blob/5040472/packages/client-ts/src/context/context.ts#L126) - -___ - -### getAuthContext - -▸ **getAuthContext**(`authConfig?`, `authType?`): `Promise`<[`AuthContext`](../interfaces/verida_client_ts._internal_.AuthContext.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `authConfig?` | [`AuthTypeConfig`](../interfaces/verida_client_ts._internal_.AuthTypeConfig.md) | -| `authType?` | `string` | - -#### Returns - -`Promise`<[`AuthContext`](../interfaces/verida_client_ts._internal_.AuthContext.md)\> - -#### Implementation of - -[IContext](../interfaces/verida_client_ts._internal_.IContext.md).[getAuthContext](../interfaces/verida_client_ts._internal_.IContext.md#getauthcontext) - -#### Defined in - -[packages/client-ts/src/context/context.ts:514](https://github.com/verida/verida-js/blob/5040472/packages/client-ts/src/context/context.ts#L514) - -___ - -### getClient - -▸ **getClient**(): [`Client`](verida_client_ts.Client.md) - -#### Returns - -[`Client`](verida_client_ts.Client.md) - -#### Implementation of - -[IContext](../interfaces/verida_client_ts._internal_.IContext.md).[getClient](../interfaces/verida_client_ts._internal_.IContext.md#getclient) - -#### Defined in - -[packages/client-ts/src/context/context.ts:134](https://github.com/verida/verida-js/blob/5040472/packages/client-ts/src/context/context.ts#L134) - -___ - -### getContextConfig - -▸ **getContextConfig**(`did?`, `forceCreate?`, `customContextName?`): `Promise`<[`SecureContextConfig`](../interfaces/verida_client_ts._internal_.SecureContextConfig.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did?` | `string` | -| `forceCreate?` | `boolean` | -| `customContextName?` | `string` | - -#### Returns - -`Promise`<[`SecureContextConfig`](../interfaces/verida_client_ts._internal_.SecureContextConfig.md)\> - -#### Implementation of - -[IContext](../interfaces/verida_client_ts._internal_.IContext.md).[getContextConfig](../interfaces/verida_client_ts._internal_.IContext.md#getcontextconfig) - -#### Defined in - -[packages/client-ts/src/context/context.ts:102](https://github.com/verida/verida-js/blob/5040472/packages/client-ts/src/context/context.ts#L102) - -___ - -### getContextName - -▸ **getContextName**(): `string` - -#### Returns - -`string` - -#### Implementation of - -[IContext](../interfaces/verida_client_ts._internal_.IContext.md).[getContextName](../interfaces/verida_client_ts._internal_.IContext.md#getcontextname) - -#### Defined in - -[packages/client-ts/src/context/context.ts:122](https://github.com/verida/verida-js/blob/5040472/packages/client-ts/src/context/context.ts#L122) - -___ - -### getDatabaseEngine - -▸ **getDatabaseEngine**(`did`, `createContext?`): `Promise`<[`IStorageEngine`](../interfaces/verida_client_ts._internal_.IStorageEngine.md)\> - -Get a storage engine for a given DID and this contextName - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did` | `string` | -| `createContext?` | `boolean` | - -#### Returns - -`Promise`<[`IStorageEngine`](../interfaces/verida_client_ts._internal_.IStorageEngine.md)\> - -#### Implementation of - -[IContext](../interfaces/verida_client_ts._internal_.IContext.md).[getDatabaseEngine](../interfaces/verida_client_ts._internal_.IContext.md#getdatabaseengine) - -#### Defined in - -[packages/client-ts/src/context/context.ts:154](https://github.com/verida/verida-js/blob/5040472/packages/client-ts/src/context/context.ts#L154) - -___ - -### getDbRegistry - -▸ **getDbRegistry**(): [`DbRegistry`](verida_client_ts._internal_.DbRegistry.md) - -#### Returns - -[`DbRegistry`](verida_client_ts._internal_.DbRegistry.md) - -#### Implementation of - -[IContext](../interfaces/verida_client_ts._internal_.IContext.md).[getDbRegistry](../interfaces/verida_client_ts._internal_.IContext.md#getdbregistry) - -#### Defined in - -[packages/client-ts/src/context/context.ts:491](https://github.com/verida/verida-js/blob/5040472/packages/client-ts/src/context/context.ts#L491) - -___ - -### getDidContextManager - -▸ **getDidContextManager**(): [`DIDContextManager`](verida_client_ts._internal_.DIDContextManager.md) - -#### Returns - -[`DIDContextManager`](verida_client_ts._internal_.DIDContextManager.md) - -#### Implementation of - -[IContext](../interfaces/verida_client_ts._internal_.IContext.md).[getDidContextManager](../interfaces/verida_client_ts._internal_.IContext.md#getdidcontextmanager) - -#### Defined in - -[packages/client-ts/src/context/context.ts:130](https://github.com/verida/verida-js/blob/5040472/packages/client-ts/src/context/context.ts#L130) - -___ - -### getMaxListeners - -▸ **getMaxListeners**(): `number` - -Returns the current max listener value for the `EventEmitter` which is either -set by `emitter.setMaxListeners(n)` or defaults to [defaultMaxListeners](verida_client_ts.Context.md#defaultmaxlisteners). - -**`since`** v1.0.0 - -#### Returns - -`number` - -#### Inherited from - -[EventEmitter](verida_client_ts._internal_.EventEmitter-1.md).[getMaxListeners](verida_client_ts._internal_.EventEmitter-1.md#getmaxlisteners) - -#### Defined in - -node_modules/@types/node/events.d.ts:471 - -___ - -### getMessaging - -▸ **getMessaging**(`messageConfig?`): `Promise`<[`IMessaging`](../interfaces/verida_client_ts._internal_.IMessaging.md)\> - -Get a messaging instance for this application context. - -Allows you to send and receive messages as the currently connected account. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `messageConfig` | [`MessagesConfig`](../interfaces/verida_client_ts._internal_.MessagesConfig.md) | - -#### Returns - -`Promise`<[`IMessaging`](../interfaces/verida_client_ts._internal_.IMessaging.md)\> - -Messaging instance - -#### Implementation of - -[IContext](../interfaces/verida_client_ts._internal_.IContext.md).[getMessaging](../interfaces/verida_client_ts._internal_.IContext.md#getmessaging) - -#### Defined in - -[packages/client-ts/src/context/context.ts:207](https://github.com/verida/verida-js/blob/5040472/packages/client-ts/src/context/context.ts#L207) - -___ - -### getNotification - -▸ **getNotification**(`did`, `contextName`): `Promise`<`undefined` \| [`INotification`](../interfaces/verida_client_ts._internal_.INotification.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did` | `string` | -| `contextName` | `string` | - -#### Returns - -`Promise`<`undefined` \| [`INotification`](../interfaces/verida_client_ts._internal_.INotification.md)\> - -#### Implementation of - -[IContext](../interfaces/verida_client_ts._internal_.IContext.md).[getNotification](../interfaces/verida_client_ts._internal_.IContext.md#getnotification) - -#### Defined in - -[packages/client-ts/src/context/context.ts:238](https://github.com/verida/verida-js/blob/5040472/packages/client-ts/src/context/context.ts#L238) - -___ - -### info - -▸ **info**(): `Promise`<[`ContextInfo`](../interfaces/verida_client_ts._internal_.ContextInfo.md)\> - -Get the status of this context for databases, their connected endpoints and databases - -#### Returns - -`Promise`<[`ContextInfo`](../interfaces/verida_client_ts._internal_.ContextInfo.md)\> - -#### Implementation of - -[IContext](../interfaces/verida_client_ts._internal_.IContext.md).[info](../interfaces/verida_client_ts._internal_.IContext.md#info) - -#### Defined in - -[packages/client-ts/src/context/context.ts:500](https://github.com/verida/verida-js/blob/5040472/packages/client-ts/src/context/context.ts#L500) - -___ - -### listenerCount - -▸ **listenerCount**(`eventName`): `number` - -Returns the number of listeners listening to the event named `eventName`. - -**`since`** v3.2.0 - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `eventName` | `string` \| `symbol` | The name of the event being listened for | - -#### Returns - -`number` - -#### Inherited from - -[EventEmitter](verida_client_ts._internal_.EventEmitter-1.md).[listenerCount](verida_client_ts._internal_.EventEmitter-1.md#listenercount) - -#### Defined in - -node_modules/@types/node/events.d.ts:561 - -___ - -### listeners - -▸ **listeners**(`eventName`): `Function`[] - -Returns a copy of the array of listeners for the event named `eventName`. - -```js -server.on('connection', (stream) => { - console.log('someone connected!'); -}); -console.log(util.inspect(server.listeners('connection'))); -// Prints: [ [Function] ] -``` - -**`since`** v0.1.26 - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | `string` \| `symbol` | - -#### Returns - -`Function`[] - -#### Inherited from - -[EventEmitter](verida_client_ts._internal_.EventEmitter-1.md).[listeners](verida_client_ts._internal_.EventEmitter-1.md#listeners) - -#### Defined in - -node_modules/@types/node/events.d.ts:484 - -___ - -### off - -▸ **off**(`eventName`, `listener`): [`Context`](verida_client_ts.Context.md) - -Alias for `emitter.removeListener()`. - -**`since`** v10.0.0 - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | `string` \| `symbol` | -| `listener` | (...`args`: `any`[]) => `void` | - -#### Returns - -[`Context`](verida_client_ts.Context.md) - -#### Inherited from - -[EventEmitter](verida_client_ts._internal_.EventEmitter-1.md).[off](verida_client_ts._internal_.EventEmitter-1.md#off) - -#### Defined in - -node_modules/@types/node/events.d.ts:444 - -___ - -### on - -▸ **on**(`eventName`, `listener`): [`Context`](verida_client_ts.Context.md) - -Adds the `listener` function to the end of the listeners array for the -event named `eventName`. No checks are made to see if the `listener` has -already been added. Multiple calls passing the same combination of `eventName`and `listener` will result in the `listener` being added, and called, multiple -times. - -```js -server.on('connection', (stream) => { - console.log('someone connected!'); -}); -``` - -Returns a reference to the `EventEmitter`, so that calls can be chained. - -By default, event listeners are invoked in the order they are added. The`emitter.prependListener()` method can be used as an alternative to add the -event listener to the beginning of the listeners array. - -```js -const myEE = new EventEmitter(); -myEE.on('foo', () => console.log('a')); -myEE.prependListener('foo', () => console.log('b')); -myEE.emit('foo'); -// Prints: -// b -// a -``` - -**`since`** v0.1.101 - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `eventName` | `string` \| `symbol` | The name of the event. | -| `listener` | (...`args`: `any`[]) => `void` | The callback function | - -#### Returns - -[`Context`](verida_client_ts.Context.md) - -#### Inherited from - -[EventEmitter](verida_client_ts._internal_.EventEmitter-1.md).[on](verida_client_ts._internal_.EventEmitter-1.md#on) - -#### Defined in - -node_modules/@types/node/events.d.ts:330 - -___ - -### once - -▸ **once**(`eventName`, `listener`): [`Context`](verida_client_ts.Context.md) - -Adds a **one-time**`listener` function for the event named `eventName`. The -next time `eventName` is triggered, this listener is removed and then invoked. - -```js -server.once('connection', (stream) => { - console.log('Ah, we have our first user!'); -}); -``` - -Returns a reference to the `EventEmitter`, so that calls can be chained. - -By default, event listeners are invoked in the order they are added. The`emitter.prependOnceListener()` method can be used as an alternative to add the -event listener to the beginning of the listeners array. - -```js -const myEE = new EventEmitter(); -myEE.once('foo', () => console.log('a')); -myEE.prependOnceListener('foo', () => console.log('b')); -myEE.emit('foo'); -// Prints: -// b -// a -``` - -**`since`** v0.3.0 - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `eventName` | `string` \| `symbol` | The name of the event. | -| `listener` | (...`args`: `any`[]) => `void` | The callback function | - -#### Returns - -[`Context`](verida_client_ts.Context.md) - -#### Inherited from - -[EventEmitter](verida_client_ts._internal_.EventEmitter-1.md).[once](verida_client_ts._internal_.EventEmitter-1.md#once) - -#### Defined in - -node_modules/@types/node/events.d.ts:359 - -___ - -### openDatabase - -▸ **openDatabase**(`databaseName`, `config?`): `Promise`<[`IDatabase`](../interfaces/verida_client_ts._internal_.IDatabase.md)\> - -Open a database owned by this account. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `databaseName` | `string` | Name of the database to open | -| `config` | [`DatabaseOpenConfig`](../interfaces/verida_client_ts._internal_.DatabaseOpenConfig.md) | - | - -#### Returns - -`Promise`<[`IDatabase`](../interfaces/verida_client_ts._internal_.IDatabase.md)\> - -#### Implementation of - -[IContext](../interfaces/verida_client_ts._internal_.IContext.md).[openDatabase](../interfaces/verida_client_ts._internal_.IContext.md#opendatabase) - -#### Defined in - -[packages/client-ts/src/context/context.ts:310](https://github.com/verida/verida-js/blob/5040472/packages/client-ts/src/context/context.ts#L310) - -___ - -### openDatastore - -▸ **openDatastore**(`schemaUri`, `config?`): `Promise`<[`Datastore`](verida_client_ts._internal_.Datastore.md)\> - -Open a dataastore owned by this account. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `schemaUri` | `string` | URI of the schema to open (ie: https://common.schemas.verida.io/health/activity/latest/schema.json) | -| `config` | [`DatastoreOpenConfig`](../interfaces/verida_client_ts._internal_.DatastoreOpenConfig.md) | Optional datastore configuration | - -#### Returns - -`Promise`<[`Datastore`](verida_client_ts._internal_.Datastore.md)\> - -#### Implementation of - -[IContext](../interfaces/verida_client_ts._internal_.IContext.md).[openDatastore](../interfaces/verida_client_ts._internal_.IContext.md#opendatastore) - -#### Defined in - -[packages/client-ts/src/context/context.ts:453](https://github.com/verida/verida-js/blob/5040472/packages/client-ts/src/context/context.ts#L453) - -___ - -### openExternalDatabase - -▸ **openExternalDatabase**(`databaseName`, `did`, `config?`): `Promise`<[`IDatabase`](../interfaces/verida_client_ts._internal_.IDatabase.md)\> - -Open an external database owned by an account that isn't the currently connected account. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `databaseName` | `string` | Name of the database to open | -| `did` | `string` | DID of the external account that owns the database | -| `config` | [`DatabaseOpenConfig`](../interfaces/verida_client_ts._internal_.DatabaseOpenConfig.md) | - | - -#### Returns - -`Promise`<[`IDatabase`](../interfaces/verida_client_ts._internal_.IDatabase.md)\> - -#### Implementation of - -[IContext](../interfaces/verida_client_ts._internal_.IContext.md).[openExternalDatabase](../interfaces/verida_client_ts._internal_.IContext.md#openexternaldatabase) - -#### Defined in - -[packages/client-ts/src/context/context.ts:372](https://github.com/verida/verida-js/blob/5040472/packages/client-ts/src/context/context.ts#L372) - -___ - -### openExternalDatastore - -▸ **openExternalDatastore**(`schemaUri`, `did`, `options?`): `Promise`<[`Datastore`](verida_client_ts._internal_.Datastore.md)\> - -Open an external datastore owned by an account that isn't the currently connected account. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `schemaUri` | `string` | URI of the schema to open (ie: https://common.schemas.verida.io/health/activity/latest/schema.json) | -| `did` | `string` | DID of the external account that owns the database | -| `options` | [`DatastoreOpenConfig`](../interfaces/verida_client_ts._internal_.DatastoreOpenConfig.md) | Optional database configuration | - -#### Returns - -`Promise`<[`Datastore`](verida_client_ts._internal_.Datastore.md)\> - -#### Implementation of - -[IContext](../interfaces/verida_client_ts._internal_.IContext.md).[openExternalDatastore](../interfaces/verida_client_ts._internal_.IContext.md#openexternaldatastore) - -#### Defined in - -[packages/client-ts/src/context/context.ts:473](https://github.com/verida/verida-js/blob/5040472/packages/client-ts/src/context/context.ts#L473) - -___ - -### openProfile - -▸ **openProfile**(`profileName?`, `did?`): `Promise`<`undefined` \| [`Profile`](verida_client_ts._internal_.Profile.md)\> - -Get a user's profile. - -#### Parameters - -| Name | Type | Default value | Description | -| :------ | :------ | :------ | :------ | -| `profileName` | `string` | `"basicProfile"` | string Name of the Verida profile schema to load | -| `did?` | `string` | `undefined` | string DID of the profile to get. Leave blank to fetch a read/write profile for the currently authenticated user | - -#### Returns - -`Promise`<`undefined` \| [`Profile`](verida_client_ts._internal_.Profile.md)\> - -#### Implementation of - -[IContext](../interfaces/verida_client_ts._internal_.IContext.md).[openProfile](../interfaces/verida_client_ts._internal_.IContext.md#openprofile) - -#### Defined in - -[packages/client-ts/src/context/context.ts:281](https://github.com/verida/verida-js/blob/5040472/packages/client-ts/src/context/context.ts#L281) - -___ - -### prependListener - -▸ **prependListener**(`eventName`, `listener`): [`Context`](verida_client_ts.Context.md) - -Adds the `listener` function to the _beginning_ of the listeners array for the -event named `eventName`. No checks are made to see if the `listener` has -already been added. Multiple calls passing the same combination of `eventName`and `listener` will result in the `listener` being added, and called, multiple -times. - -```js -server.prependListener('connection', (stream) => { - console.log('someone connected!'); -}); -``` - -Returns a reference to the `EventEmitter`, so that calls can be chained. - -**`since`** v6.0.0 - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `eventName` | `string` \| `symbol` | The name of the event. | -| `listener` | (...`args`: `any`[]) => `void` | The callback function | - -#### Returns - -[`Context`](verida_client_ts.Context.md) - -#### Inherited from - -[EventEmitter](verida_client_ts._internal_.EventEmitter-1.md).[prependListener](verida_client_ts._internal_.EventEmitter-1.md#prependlistener) - -#### Defined in - -node_modules/@types/node/events.d.ts:579 - -___ - -### prependOnceListener - -▸ **prependOnceListener**(`eventName`, `listener`): [`Context`](verida_client_ts.Context.md) - -Adds a **one-time**`listener` function for the event named `eventName` to the_beginning_ of the listeners array. The next time `eventName` is triggered, this -listener is removed, and then invoked. - -```js -server.prependOnceListener('connection', (stream) => { - console.log('Ah, we have our first user!'); -}); -``` - -Returns a reference to the `EventEmitter`, so that calls can be chained. - -**`since`** v6.0.0 - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `eventName` | `string` \| `symbol` | The name of the event. | -| `listener` | (...`args`: `any`[]) => `void` | The callback function | - -#### Returns - -[`Context`](verida_client_ts.Context.md) - -#### Inherited from - -[EventEmitter](verida_client_ts._internal_.EventEmitter-1.md).[prependOnceListener](verida_client_ts._internal_.EventEmitter-1.md#prependoncelistener) - -#### Defined in - -node_modules/@types/node/events.d.ts:595 - -___ - -### rawListeners - -▸ **rawListeners**(`eventName`): `Function`[] - -Returns a copy of the array of listeners for the event named `eventName`, -including any wrappers (such as those created by `.once()`). - -```js -const emitter = new EventEmitter(); -emitter.once('log', () => console.log('log once')); - -// Returns a new Array with a function `onceWrapper` which has a property -// `listener` which contains the original listener bound above -const listeners = emitter.rawListeners('log'); -const logFnWrapper = listeners[0]; - -// Logs "log once" to the console and does not unbind the `once` event -logFnWrapper.listener(); - -// Logs "log once" to the console and removes the listener -logFnWrapper(); - -emitter.on('log', () => console.log('log persistently')); -// Will return a new Array with a single function bound by `.on()` above -const newListeners = emitter.rawListeners('log'); - -// Logs "log persistently" twice -newListeners[0](); -emitter.emit('log'); -``` - -**`since`** v9.4.0 - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | `string` \| `symbol` | - -#### Returns - -`Function`[] - -#### Inherited from - -[EventEmitter](verida_client_ts._internal_.EventEmitter-1.md).[rawListeners](verida_client_ts._internal_.EventEmitter-1.md#rawlisteners) - -#### Defined in - -node_modules/@types/node/events.d.ts:514 - -___ - -### removeAllListeners - -▸ **removeAllListeners**(`event?`): [`Context`](verida_client_ts.Context.md) - -Removes all listeners, or those of the specified `eventName`. - -It is bad practice to remove listeners added elsewhere in the code, -particularly when the `EventEmitter` instance was created by some other -component or module (e.g. sockets or file streams). - -Returns a reference to the `EventEmitter`, so that calls can be chained. - -**`since`** v0.1.26 - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event?` | `string` \| `symbol` | - -#### Returns - -[`Context`](verida_client_ts.Context.md) - -#### Inherited from - -[EventEmitter](verida_client_ts._internal_.EventEmitter-1.md).[removeAllListeners](verida_client_ts._internal_.EventEmitter-1.md#removealllisteners) - -#### Defined in - -node_modules/@types/node/events.d.ts:455 - -___ - -### removeListener - -▸ **removeListener**(`eventName`, `listener`): [`Context`](verida_client_ts.Context.md) - -Removes the specified `listener` from the listener array for the event named`eventName`. - -```js -const callback = (stream) => { - console.log('someone connected!'); -}; -server.on('connection', callback); -// ... -server.removeListener('connection', callback); -``` - -`removeListener()` will remove, at most, one instance of a listener from the -listener array. If any single listener has been added multiple times to the -listener array for the specified `eventName`, then `removeListener()` must be -called multiple times to remove each instance. - -Once an event is emitted, all listeners attached to it at the -time of emitting are called in order. This implies that any`removeListener()` or `removeAllListeners()` calls _after_ emitting and_before_ the last listener finishes execution will -not remove them from`emit()` in progress. Subsequent events behave as expected. - -```js -const myEmitter = new MyEmitter(); - -const callbackA = () => { - console.log('A'); - myEmitter.removeListener('event', callbackB); -}; - -const callbackB = () => { - console.log('B'); -}; - -myEmitter.on('event', callbackA); - -myEmitter.on('event', callbackB); - -// callbackA removes listener callbackB but it will still be called. -// Internal listener array at time of emit [callbackA, callbackB] -myEmitter.emit('event'); -// Prints: -// A -// B - -// callbackB is now removed. -// Internal listener array [callbackA] -myEmitter.emit('event'); -// Prints: -// A -``` - -Because listeners are managed using an internal array, calling this will -change the position indices of any listener registered _after_ the listener -being removed. This will not impact the order in which listeners are called, -but it means that any copies of the listener array as returned by -the `emitter.listeners()` method will need to be recreated. - -When a single function has been added as a handler multiple times for a single -event (as in the example below), `removeListener()` will remove the most -recently added instance. In the example the `once('ping')`listener is removed: - -```js -const ee = new EventEmitter(); - -function pong() { - console.log('pong'); -} - -ee.on('ping', pong); -ee.once('ping', pong); -ee.removeListener('ping', pong); - -ee.emit('ping'); -ee.emit('ping'); -``` - -Returns a reference to the `EventEmitter`, so that calls can be chained. - -**`since`** v0.1.26 - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | `string` \| `symbol` | -| `listener` | (...`args`: `any`[]) => `void` | - -#### Returns - -[`Context`](verida_client_ts.Context.md) - -#### Inherited from - -[EventEmitter](verida_client_ts._internal_.EventEmitter-1.md).[removeListener](verida_client_ts._internal_.EventEmitter-1.md#removelistener) - -#### Defined in - -node_modules/@types/node/events.d.ts:439 - -___ - -### setMaxListeners - -▸ **setMaxListeners**(`n`): [`Context`](verida_client_ts.Context.md) - -By default `EventEmitter`s will print a warning if more than `10` listeners are -added for a particular event. This is a useful default that helps finding -memory leaks. The `emitter.setMaxListeners()` method allows the limit to be -modified for this specific `EventEmitter` instance. The value can be set to`Infinity` (or `0`) to indicate an unlimited number of listeners. - -Returns a reference to the `EventEmitter`, so that calls can be chained. - -**`since`** v0.3.5 - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `n` | `number` | - -#### Returns - -[`Context`](verida_client_ts.Context.md) - -#### Inherited from - -[EventEmitter](verida_client_ts._internal_.EventEmitter-1.md).[setMaxListeners](verida_client_ts._internal_.EventEmitter-1.md#setmaxlisteners) - -#### Defined in - -node_modules/@types/node/events.d.ts:465 - -___ - -### getEventListeners - -▸ `Static` **getEventListeners**(`emitter`, `name`): `Function`[] - -Returns a copy of the array of listeners for the event named `eventName`. - -For `EventEmitter`s this behaves exactly the same as calling `.listeners` on -the emitter. - -For `EventTarget`s this is the only way to get the event listeners for the -event target. This is useful for debugging and diagnostic purposes. - -```js -const { getEventListeners, EventEmitter } = require('events'); - -{ - const ee = new EventEmitter(); - const listener = () => console.log('Events are fun'); - ee.on('foo', listener); - getEventListeners(ee, 'foo'); // [listener] -} -{ - const et = new EventTarget(); - const listener = () => console.log('Events are fun'); - et.addEventListener('foo', listener); - getEventListeners(et, 'foo'); // [listener] -} -``` - -**`since`** v15.2.0 - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `emitter` | [`DOMEventTarget`](../interfaces/verida_client_ts._internal_.DOMEventTarget.md) \| `EventEmitter` | -| `name` | `string` \| `symbol` | - -#### Returns - -`Function`[] - -#### Inherited from - -[EventEmitter](verida_client_ts._internal_.EventEmitter-1.md).[getEventListeners](verida_client_ts._internal_.EventEmitter-1.md#geteventlisteners) - -#### Defined in - -node_modules/@types/node/events.d.ts:262 - -___ - -### listenerCount - -▸ `Static` **listenerCount**(`emitter`, `eventName`): `number` - -A class method that returns the number of listeners for the given `eventName`registered on the given `emitter`. - -```js -const { EventEmitter, listenerCount } = require('events'); -const myEmitter = new EventEmitter(); -myEmitter.on('event', () => {}); -myEmitter.on('event', () => {}); -console.log(listenerCount(myEmitter, 'event')); -// Prints: 2 -``` - -**`since`** v0.9.12 - -**`deprecated`** Since v3.2.0 - Use `listenerCount` instead. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `emitter` | `EventEmitter` | The emitter to query | -| `eventName` | `string` \| `symbol` | The event name | - -#### Returns - -`number` - -#### Inherited from - -[EventEmitter](verida_client_ts._internal_.EventEmitter-1.md).[listenerCount](verida_client_ts._internal_.EventEmitter-1.md#listenercount) - -#### Defined in - -node_modules/@types/node/events.d.ts:234 - -___ - -### on - -▸ `Static` **on**(`emitter`, `eventName`, `options?`): [`AsyncIterableIterator`](../interfaces/verida_client_ts._internal_.AsyncIterableIterator.md)<`any`\> - -```js -const { on, EventEmitter } = require('events'); - -(async () => { - const ee = new EventEmitter(); - - // Emit later on - process.nextTick(() => { - ee.emit('foo', 'bar'); - ee.emit('foo', 42); - }); - - for await (const event of on(ee, 'foo')) { - // The execution of this inner block is synchronous and it - // processes one event at a time (even with await). Do not use - // if concurrent execution is required. - console.log(event); // prints ['bar'] [42] - } - // Unreachable here -})(); -``` - -Returns an `AsyncIterator` that iterates `eventName` events. It will throw -if the `EventEmitter` emits `'error'`. It removes all listeners when -exiting the loop. The `value` returned by each iteration is an array -composed of the emitted event arguments. - -An `AbortSignal` can be used to cancel waiting on events: - -```js -const { on, EventEmitter } = require('events'); -const ac = new AbortController(); - -(async () => { - const ee = new EventEmitter(); - - // Emit later on - process.nextTick(() => { - ee.emit('foo', 'bar'); - ee.emit('foo', 42); - }); - - for await (const event of on(ee, 'foo', { signal: ac.signal })) { - // The execution of this inner block is synchronous and it - // processes one event at a time (even with await). Do not use - // if concurrent execution is required. - console.log(event); // prints ['bar'] [42] - } - // Unreachable here -})(); - -process.nextTick(() => ac.abort()); -``` - -**`since`** v13.6.0, v12.16.0 - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `emitter` | `EventEmitter` | - | -| `eventName` | `string` | The name of the event being listened for | -| `options?` | [`StaticEventEmitterOptions`](../interfaces/verida_client_ts._internal_.StaticEventEmitterOptions.md) | - | - -#### Returns - -[`AsyncIterableIterator`](../interfaces/verida_client_ts._internal_.AsyncIterableIterator.md)<`any`\> - -that iterates `eventName` events emitted by the `emitter` - -#### Inherited from - -[EventEmitter](verida_client_ts._internal_.EventEmitter-1.md).[on](verida_client_ts._internal_.EventEmitter-1.md#on) - -#### Defined in - -node_modules/@types/node/events.d.ts:217 - -___ - -### once - -▸ `Static` **once**(`emitter`, `eventName`, `options?`): `Promise`<`any`[]\> - -Creates a `Promise` that is fulfilled when the `EventEmitter` emits the given -event or that is rejected if the `EventEmitter` emits `'error'` while waiting. -The `Promise` will resolve with an array of all the arguments emitted to the -given event. - -This method is intentionally generic and works with the web platform[EventTarget](https://dom.spec.whatwg.org/#interface-eventtarget) interface, which has no special`'error'` event -semantics and does not listen to the `'error'` event. - -```js -const { once, EventEmitter } = require('events'); - -async function run() { - const ee = new EventEmitter(); - - process.nextTick(() => { - ee.emit('myevent', 42); - }); - - const [value] = await once(ee, 'myevent'); - console.log(value); - - const err = new Error('kaboom'); - process.nextTick(() => { - ee.emit('error', err); - }); - - try { - await once(ee, 'myevent'); - } catch (err) { - console.log('error happened', err); - } -} - -run(); -``` - -The special handling of the `'error'` event is only used when `events.once()`is used to wait for another event. If `events.once()` is used to wait for the -'`error'` event itself, then it is treated as any other kind of event without -special handling: - -```js -const { EventEmitter, once } = require('events'); - -const ee = new EventEmitter(); - -once(ee, 'error') - .then(([err]) => console.log('ok', err.message)) - .catch((err) => console.log('error', err.message)); - -ee.emit('error', new Error('boom')); - -// Prints: ok boom -``` - -An `AbortSignal` can be used to cancel waiting for the event: - -```js -const { EventEmitter, once } = require('events'); - -const ee = new EventEmitter(); -const ac = new AbortController(); - -async function foo(emitter, event, signal) { - try { - await once(emitter, event, { signal }); - console.log('event emitted!'); - } catch (error) { - if (error.name === 'AbortError') { - console.error('Waiting for the event was canceled!'); - } else { - console.error('There was an error', error.message); - } - } -} - -foo(ee, 'foo', ac.signal); -ac.abort(); // Abort waiting for the event -ee.emit('foo'); // Prints: Waiting for the event was canceled! -``` - -**`since`** v11.13.0, v10.16.0 - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `emitter` | [`NodeEventTarget`](../interfaces/verida_client_ts._internal_.NodeEventTarget.md) | -| `eventName` | `string` \| `symbol` | -| `options?` | [`StaticEventEmitterOptions`](../interfaces/verida_client_ts._internal_.StaticEventEmitterOptions.md) | - -#### Returns - -`Promise`<`any`[]\> - -#### Inherited from - -[EventEmitter](verida_client_ts._internal_.EventEmitter-1.md).[once](verida_client_ts._internal_.EventEmitter-1.md#once) - -#### Defined in - -node_modules/@types/node/events.d.ts:157 - -▸ `Static` **once**(`emitter`, `eventName`, `options?`): `Promise`<`any`[]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `emitter` | [`DOMEventTarget`](../interfaces/verida_client_ts._internal_.DOMEventTarget.md) | -| `eventName` | `string` | -| `options?` | [`StaticEventEmitterOptions`](../interfaces/verida_client_ts._internal_.StaticEventEmitterOptions.md) | - -#### Returns - -`Promise`<`any`[]\> - -#### Inherited from - -[EventEmitter](verida_client_ts._internal_.EventEmitter-1.md).[once](verida_client_ts._internal_.EventEmitter-1.md#once) - -#### Defined in - -node_modules/@types/node/events.d.ts:158 diff --git a/docs/api/verida-js/classes/verida_client_ts.Datastore.md b/docs/api/verida-js/classes/verida_client_ts.Datastore.md deleted file mode 100644 index 5e2c4e5..0000000 --- a/docs/api/verida-js/classes/verida_client_ts.Datastore.md +++ /dev/null @@ -1,418 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / Datastore - -# Class: Datastore - -[@verida/client-ts](../modules/verida_client_ts.md).Datastore - -## Table of contents - -### Constructors - -- [constructor](verida_client_ts.Datastore.md#constructor) - -### Properties - -- [config](verida_client_ts.Datastore.md#config) -- [context](verida_client_ts.Datastore.md#context) -- [db](verida_client_ts.Datastore.md#db) -- [errors](verida_client_ts.Datastore.md#errors) -- [schema](verida_client_ts.Datastore.md#schema) -- [schemaName](verida_client_ts.Datastore.md#schemaname) -- [schemaPath](verida_client_ts.Datastore.md#schemapath) - -### Methods - -- [changes](verida_client_ts.Datastore.md#changes) -- [delete](verida_client_ts.Datastore.md#delete) -- [deleteAll](verida_client_ts.Datastore.md#deleteall) -- [ensureIndexes](verida_client_ts.Datastore.md#ensureindexes) -- [get](verida_client_ts.Datastore.md#get) -- [getDb](verida_client_ts.Datastore.md#getdb) -- [getMany](verida_client_ts.Datastore.md#getmany) -- [getOne](verida_client_ts.Datastore.md#getone) -- [init](verida_client_ts.Datastore.md#init) -- [save](verida_client_ts.Datastore.md#save) -- [updateUsers](verida_client_ts.Datastore.md#updateusers) - -## Constructors - -### constructor - -• **new Datastore**(`schemaName`, `context`, `config?`) - -Create a new Datastore. - -**Do not instantiate directly.** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schemaName` | `string` | -| `context` | [`Context`](verida_client_ts.Context.md) | -| `config` | [`DatastoreOpenConfig`](../interfaces/verida_client_ts.ContextInterfaces.DatastoreOpenConfig.md) | - -#### Defined in - -[packages/client-ts/src/context/datastore.ts:42](https://github.com/verida/verida-js/blob/c03b336/packages/client-ts/src/context/datastore.ts#L42) - -## Properties - -### config - -• `Protected` **config**: [`DatastoreOpenConfig`](../interfaces/verida_client_ts.ContextInterfaces.DatastoreOpenConfig.md) - -#### Defined in - -[packages/client-ts/src/context/datastore.ts:24](https://github.com/verida/verida-js/blob/c03b336/packages/client-ts/src/context/datastore.ts#L24) - -___ - -### context - -• `Protected` **context**: [`Context`](verida_client_ts.Context.md) - -#### Defined in - -[packages/client-ts/src/context/datastore.ts:23](https://github.com/verida/verida-js/blob/c03b336/packages/client-ts/src/context/datastore.ts#L23) - -___ - -### db - -• `Private` **db**: `any` - -#### Defined in - -[packages/client-ts/src/context/datastore.ts:26](https://github.com/verida/verida-js/blob/c03b336/packages/client-ts/src/context/datastore.ts#L26) - -___ - -### errors - -• **errors**: `object` = `{}` - -A list of the latest database errors. - -Any errors from saving a record will be available on this public object. - -The errors remain until they are replaced by any new errors. - -#### Defined in - -[packages/client-ts/src/context/datastore.ts:35](https://github.com/verida/verida-js/blob/c03b336/packages/client-ts/src/context/datastore.ts#L35) - -___ - -### schema - -• `Protected` `Optional` **schema**: `any` - -#### Defined in - -[packages/client-ts/src/context/datastore.ts:21](https://github.com/verida/verida-js/blob/c03b336/packages/client-ts/src/context/datastore.ts#L21) - -___ - -### schemaName - -• `Protected` **schemaName**: `string` - -#### Defined in - -[packages/client-ts/src/context/datastore.ts:19](https://github.com/verida/verida-js/blob/c03b336/packages/client-ts/src/context/datastore.ts#L19) - -___ - -### schemaPath - -• `Protected` `Optional` **schemaPath**: `string` - -#### Defined in - -[packages/client-ts/src/context/datastore.ts:20](https://github.com/verida/verida-js/blob/c03b336/packages/client-ts/src/context/datastore.ts#L20) - -## Methods - -### changes - -▸ **changes**(`cb`, `options?`): `Promise`<`any`\> - -Bind to changes to this datastore - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `cb` | `any` | Callback function that fires when new data is received | -| `options` | `any` | Options to be passed to the listener. See https://pouchdb.com/api.html#changes | - -#### Returns - -`Promise`<`any`\> - -Returns an object with a `.cancel()` method to cancel the listener - -#### Defined in - -[packages/client-ts/src/context/datastore.ts:196](https://github.com/verida/verida-js/blob/c03b336/packages/client-ts/src/context/datastore.ts#L196) - -___ - -### delete - -▸ **delete**(`docId`): `Promise`<`any`\> - -Delete a record by ID. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `docId` | `string` | Unique ID of the record to delete | - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -[packages/client-ts/src/context/datastore.ts:169](https://github.com/verida/verida-js/blob/c03b336/packages/client-ts/src/context/datastore.ts#L169) - -___ - -### deleteAll - -▸ **deleteAll**(): `Promise`<`void`\> - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -[packages/client-ts/src/context/datastore.ts:174](https://github.com/verida/verida-js/blob/c03b336/packages/client-ts/src/context/datastore.ts#L174) - -___ - -### ensureIndexes - -▸ **ensureIndexes**(`indexes`): `Promise`<`void`\> - -**`todo:`** Support removing indexes that were deleted from the spec - -**`todo:`** Validate indexes - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `indexes` | `any` | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -[packages/client-ts/src/context/datastore.ts:240](https://github.com/verida/verida-js/blob/c03b336/packages/client-ts/src/context/datastore.ts#L240) - -___ - -### get - -▸ **get**(`key`, `options?`): `Promise`<`any`\> - -Get a record by ID. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `key` | `string` | Unique ID of the record to fetch | -| `options` | `any` | - | - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -[packages/client-ts/src/context/datastore.ts:159](https://github.com/verida/verida-js/blob/c03b336/packages/client-ts/src/context/datastore.ts#L159) - -___ - -### getDb - -▸ **getDb**(): `Promise`<`any`\> - -Get the underlying database instance associated with this datastore. - -**Note: Do not use unless you know what you're doing as you can easily corrupt a database by breaking schema data.** - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -[packages/client-ts/src/context/datastore.ts:184](https://github.com/verida/verida-js/blob/c03b336/packages/client-ts/src/context/datastore.ts#L184) - -___ - -### getMany - -▸ **getMany**(`customFilter?`, `options?`): `Promise`<`object`[]\> - -Fetch a list of records from this Datastore. - -Only returns records that belong to this Datastore's schema. - -Example filters and options: - -``` -let filter = { - organization: 'Google' -}; - -let options = { - limit: 20, - skip: 0, - sort: ['firstName' -}; -``` - -**`example`** -let results = datastore.getMany({ - name: 'John' -}); - -console.log(results); - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `customFilter` | `any` | -| `options` | `any` | - -#### Returns - -`Promise`<`object`[]\> - -An array of database records. - -#### Defined in - -[packages/client-ts/src/context/datastore.ts:120](https://github.com/verida/verida-js/blob/c03b336/packages/client-ts/src/context/datastore.ts#L120) - -___ - -### getOne - -▸ **getOne**(`customFilter?`, `options?`): `Promise`<`undefined` \| `object`\> - -Get a single database record that matches. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `customFilter` | `any` | -| `options` | `any` | - -#### Returns - -`Promise`<`undefined` \| `object`\> - -A database record - -#### Defined in - -[packages/client-ts/src/context/datastore.ts:143](https://github.com/verida/verida-js/blob/c03b336/packages/client-ts/src/context/datastore.ts#L143) - -___ - -### init - -▸ `Private` **init**(): `Promise`<`void`\> - -Initialize this datastore instance before use. - -**`todo:`** move this into context.openDatastore??? - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -[packages/client-ts/src/context/datastore.ts:206](https://github.com/verida/verida-js/blob/c03b336/packages/client-ts/src/context/datastore.ts#L206) - -___ - -### save - -▸ **save**(`data`, `options?`): `Promise`<`boolean` \| `object`\> - -Save data to an application schema. - -**`fires`** Database#beforeInsert Event fired before inserting a new record - -**`fires`** Database#beforeUpdate Event fired before updating a new record - -**`fires`** Database#afterInsert Event fired after inserting a new record - -**`fires`** Database#afterUpdate Event fired after updating a new record - -**`example`** -let result = await datastore.save({ - "firstName": "John", - "lastName": "Doe" -}); - -if (!result) { - console.errors(datastore.errors); -} else { - console.log("Successfully saved"); -} - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `data` | `any` | Data to be saved. Will be validated against the schema associated with this Datastore. | -| `options` | `any` | - | - -#### Returns - -`Promise`<`boolean` \| `object`\> - -Boolean indicating if the save was successful. If not successful `this.errors` will be populated. - -#### Defined in - -[packages/client-ts/src/context/datastore.ts:76](https://github.com/verida/verida-js/blob/c03b336/packages/client-ts/src/context/datastore.ts#L76) - -___ - -### updateUsers - -▸ **updateUsers**(`readList?`, `writeList?`): `Promise`<`void`\> - -Update the list of valid users for this datastore. - -#### Parameters - -| Name | Type | Default value | Description | -| :------ | :------ | :------ | :------ | -| `readList` | `string`[] | `[]` | List of DID's that can read from this datastore. | -| `writeList` | `string`[] | `[]` | List of DID's that can wrtie to this datastore. | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -[packages/client-ts/src/context/datastore.ts:257](https://github.com/verida/verida-js/blob/c03b336/packages/client-ts/src/context/datastore.ts#L257) diff --git a/docs/api/verida-js/classes/verida_client_ts.DbRegistry.default.md b/docs/api/verida-js/classes/verida_client_ts.DbRegistry.default.md deleted file mode 100644 index 44f07ec..0000000 --- a/docs/api/verida-js/classes/verida_client_ts.DbRegistry.default.md +++ /dev/null @@ -1,160 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [DbRegistry](../modules/verida_client_ts.DbRegistry.md) / default - -# Class: default - -[@verida/client-ts](../modules/verida_client_ts.md).[DbRegistry](../modules/verida_client_ts.DbRegistry.md).default - -## Table of contents - -### Constructors - -- [constructor](verida_client_ts.DbRegistry.default.md#constructor) - -### Properties - -- [context](verida_client_ts.DbRegistry.default.md#context) -- [dbStore](verida_client_ts.DbRegistry.default.md#dbstore) - -### Methods - -- [buildDatabaseId](verida_client_ts.DbRegistry.default.md#builddatabaseid) -- [get](verida_client_ts.DbRegistry.default.md#get) -- [getMany](verida_client_ts.DbRegistry.default.md#getmany) -- [init](verida_client_ts.DbRegistry.default.md#init) -- [saveDb](verida_client_ts.DbRegistry.default.md#savedb) - -## Constructors - -### constructor - -• **new default**(`context`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `context` | [`Context`](verida_client_ts.Context.md) | - -#### Defined in - -[packages/client-ts/src/context/db-registry.ts:42](https://github.com/verida/verida-js/blob/fa48d0d/packages/client-ts/src/context/db-registry.ts#L42) - -## Properties - -### context - -• `Private` **context**: [`Context`](verida_client_ts.Context.md) - -#### Defined in - -[packages/client-ts/src/context/db-registry.ts:39](https://github.com/verida/verida-js/blob/fa48d0d/packages/client-ts/src/context/db-registry.ts#L39) - -___ - -### dbStore - -• `Private` `Optional` **dbStore**: [`Datastore`](verida_client_ts.Datastore.md) - -#### Defined in - -[packages/client-ts/src/context/db-registry.ts:40](https://github.com/verida/verida-js/blob/fa48d0d/packages/client-ts/src/context/db-registry.ts#L40) - -## Methods - -### buildDatabaseId - -▸ `Private` **buildDatabaseId**(`dbName`, `did`, `contextName`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `dbName` | `string` | -| `did` | `string` | -| `contextName` | `string` | - -#### Returns - -`string` - -#### Defined in - -[packages/client-ts/src/context/db-registry.ts:127](https://github.com/verida/verida-js/blob/fa48d0d/packages/client-ts/src/context/db-registry.ts#L127) - -___ - -### get - -▸ **get**(`dbName`, `did`, `contextName`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `dbName` | `string` | -| `did` | `string` | -| `contextName` | `string` | - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -[packages/client-ts/src/context/db-registry.ts:107](https://github.com/verida/verida-js/blob/fa48d0d/packages/client-ts/src/context/db-registry.ts#L107) - -___ - -### getMany - -▸ **getMany**(`filter`, `options`): `Promise`<`object`[]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `filter` | `any` | -| `options` | `any` | - -#### Returns - -`Promise`<`object`[]\> - -#### Defined in - -[packages/client-ts/src/context/db-registry.ts:101](https://github.com/verida/verida-js/blob/fa48d0d/packages/client-ts/src/context/db-registry.ts#L101) - -___ - -### init - -▸ **init**(): `Promise`<`void`\> - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -[packages/client-ts/src/context/db-registry.ts:142](https://github.com/verida/verida-js/blob/fa48d0d/packages/client-ts/src/context/db-registry.ts#L142) - -___ - -### saveDb - -▸ **saveDb**(`database`, `checkPermissions?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `database` | [`Database`](../interfaces/verida_client_ts.Database.md) | `undefined` | -| `checkPermissions` | `boolean` | `true` | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -[packages/client-ts/src/context/db-registry.ts:55](https://github.com/verida/verida-js/blob/fa48d0d/packages/client-ts/src/context/db-registry.ts#L55) diff --git a/docs/api/verida-js/classes/verida_client_ts.Network.md b/docs/api/verida-js/classes/verida_client_ts.Network.md deleted file mode 100644 index 5e0eea2..0000000 --- a/docs/api/verida-js/classes/verida_client_ts.Network.md +++ /dev/null @@ -1,70 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / Network - -# Class: Network - -[@verida/client-ts](../modules/verida_client_ts.md).Network - -## Table of contents - -### Constructors - -- [constructor](verida_client_ts.Network.md#constructor) - -### Methods - -- [connect](verida_client_ts.Network.md#connect) -- [getRecord](verida_client_ts.Network.md#getrecord) - -## Constructors - -### constructor - -• **new Network**() - -## Methods - -### connect - -▸ `Static` **connect**(`config`): `Promise`<`undefined` \| [`Context`](verida_client_ts.Context.md)\> - -Opens a new application context to provide encrypted storage and messaging to an application. - -This is a quicker alternative to generating a `client` connection to the Verida network -and then opening a context. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `config` | [`NetworkConnectionConfig`](../interfaces/verida_client_ts._internal_.NetworkConnectionConfig.md) | NetworkConnectionConfig Configuration | - -#### Returns - -`Promise`<`undefined` \| [`Context`](verida_client_ts.Context.md)\> - -If the user logs in a valid `Context` object is returned. If an unexpected error occurs or the user cancels the login attempt then nothing is returned. - -#### Defined in - -[packages/client-ts/src/network.ts:20](https://github.com/verida/verida-js/blob/5040472/packages/client-ts/src/network.ts#L20) - -___ - -### getRecord - -▸ `Static` **getRecord**(`veridaUri`, `encoded?`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `veridaUri` | `string` | `undefined` | -| `encoded` | `boolean` | `false` | - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -[packages/client-ts/src/network.ts:38](https://github.com/verida/verida-js/blob/5040472/packages/client-ts/src/network.ts#L38) diff --git a/docs/api/verida-js/classes/verida_client_ts.Profile.md b/docs/api/verida-js/classes/verida_client_ts.Profile.md deleted file mode 100644 index 4613f8c..0000000 --- a/docs/api/verida-js/classes/verida_client_ts.Profile.md +++ /dev/null @@ -1,345 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / Profile - -# Class: Profile - -[@verida/client-ts](../modules/verida_client_ts.md).Profile - -## Hierarchy - -- [`EventEmitter`](../modules/verida_client_ts._internal_.md#eventemitter) - - ↳ **`Profile`** - -## Table of contents - -### Constructors - -- [constructor](verida_client_ts.Profile.md#constructor) - -### Properties - -- [context](verida_client_ts.Profile.md#context) -- [did](verida_client_ts.Profile.md#did) -- [errors](verida_client_ts.Profile.md#errors) -- [isPrivate](verida_client_ts.Profile.md#isprivate) -- [profileName](verida_client_ts.Profile.md#profilename) -- [store](verida_client_ts.Profile.md#store) -- [writeAccess](verida_client_ts.Profile.md#writeaccess) - -### Methods - -- [delete](verida_client_ts.Profile.md#delete) -- [get](verida_client_ts.Profile.md#get) -- [getMany](verida_client_ts.Profile.md#getmany) -- [getRecord](verida_client_ts.Profile.md#getrecord) -- [init](verida_client_ts.Profile.md#init) -- [listen](verida_client_ts.Profile.md#listen) -- [saveRecord](verida_client_ts.Profile.md#saverecord) -- [set](verida_client_ts.Profile.md#set) -- [setMany](verida_client_ts.Profile.md#setmany) - -## Constructors - -### constructor - -• **new Profile**(`context`, `did`, `profileName`, `writeAccess`, `isPrivate?`) - -Create a new user profile. - -**Do not instantiate directly.** - -Access the current user's profile via {@link App.profile} - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `context` | [`Context`](verida_client_ts.Context.md) | `undefined` | -| `did` | `string` | `undefined` | -| `profileName` | `string` | `undefined` | -| `writeAccess` | `boolean` | `undefined` | -| `isPrivate` | `boolean` | `false` | - -#### Overrides - -EventEmitter.constructor - -#### Defined in - -[packages/client-ts/src/context/profiles/profile.ts:40](https://github.com/verida/verida-js/blob/c03b336/packages/client-ts/src/context/profiles/profile.ts#L40) - -## Properties - -### context - -• `Private` **context**: [`Context`](verida_client_ts.Context.md) - -#### Defined in - -[packages/client-ts/src/context/profiles/profile.ts:21](https://github.com/verida/verida-js/blob/c03b336/packages/client-ts/src/context/profiles/profile.ts#L21) - -___ - -### did - -• `Private` **did**: `string` - -#### Defined in - -[packages/client-ts/src/context/profiles/profile.ts:22](https://github.com/verida/verida-js/blob/c03b336/packages/client-ts/src/context/profiles/profile.ts#L22) - -___ - -### errors - -• **errors**: `object` - -#### Defined in - -[packages/client-ts/src/context/profiles/profile.ts:30](https://github.com/verida/verida-js/blob/c03b336/packages/client-ts/src/context/profiles/profile.ts#L30) - -___ - -### isPrivate - -• `Private` **isPrivate**: `boolean` - -#### Defined in - -[packages/client-ts/src/context/profiles/profile.ts:28](https://github.com/verida/verida-js/blob/c03b336/packages/client-ts/src/context/profiles/profile.ts#L28) - -___ - -### profileName - -• `Private` **profileName**: `string` - -#### Defined in - -[packages/client-ts/src/context/profiles/profile.ts:24](https://github.com/verida/verida-js/blob/c03b336/packages/client-ts/src/context/profiles/profile.ts#L24) - -___ - -### store - -• `Private` `Optional` **store**: [`Datastore`](verida_client_ts.Datastore.md) - -#### Defined in - -[packages/client-ts/src/context/profiles/profile.ts:25](https://github.com/verida/verida-js/blob/c03b336/packages/client-ts/src/context/profiles/profile.ts#L25) - -___ - -### writeAccess - -• `Private` **writeAccess**: `boolean` - -#### Defined in - -[packages/client-ts/src/context/profiles/profile.ts:27](https://github.com/verida/verida-js/blob/c03b336/packages/client-ts/src/context/profiles/profile.ts#L27) - -## Methods - -### delete - -▸ **delete**(`key`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `key` | `string` | Profile key to delete (ie: `email`) | - -#### Returns - -`Promise`<`boolean`\> - -Boolean indicating if the delete was successful - -#### Defined in - -[packages/client-ts/src/context/profiles/profile.ts:86](https://github.com/verida/verida-js/blob/c03b336/packages/client-ts/src/context/profiles/profile.ts#L86) - -___ - -### get - -▸ **get**(`key`, `options?`, `extended?`): `Promise`<`any`\> - -Get a profile value by key - -**`example`** -let emailDoc = app.wallet.profile.get('email'); - -// key = email -// value = john@doe.com -console.log(emailDoc.key, emailDoc.value); - -#### Parameters - -| Name | Type | Default value | Description | -| :------ | :------ | :------ | :------ | -| `key` | `string` | `undefined` | Profile key to get (ie: `email`) | -| `options?` | `any` | `undefined` | | -| `extended` | `boolean` | `false` | | - -#### Returns - -`Promise`<`any`\> - -Database record for this profile key. Object has keys [`key`, `value`, `_id`, `_rev`]. - -#### Defined in - -[packages/client-ts/src/context/profiles/profile.ts:70](https://github.com/verida/verida-js/blob/c03b336/packages/client-ts/src/context/profiles/profile.ts#L70) - -___ - -### getMany - -▸ **getMany**(`filter`, `options`): `Promise`<`any`\> - -Get many profile values. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `filter` | `any` | -| `options` | `any` | - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -[packages/client-ts/src/context/profiles/profile.ts:102](https://github.com/verida/verida-js/blob/c03b336/packages/client-ts/src/context/profiles/profile.ts#L102) - -___ - -### getRecord - -▸ `Private` **getRecord**(): `Promise`<[`ProfileDocument`](../interfaces/verida_client_ts._internal_.ProfileDocument.md)\> - -#### Returns - -`Promise`<[`ProfileDocument`](../interfaces/verida_client_ts._internal_.ProfileDocument.md)\> - -#### Defined in - -[packages/client-ts/src/context/profiles/profile.ts:162](https://github.com/verida/verida-js/blob/c03b336/packages/client-ts/src/context/profiles/profile.ts#L162) - -___ - -### init - -▸ `Private` **init**(): `Promise`<`void`\> - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -[packages/client-ts/src/context/profiles/profile.ts:189](https://github.com/verida/verida-js/blob/c03b336/packages/client-ts/src/context/profiles/profile.ts#L189) - -___ - -### listen - -▸ **listen**(`callback`): `Promise`<`any`\> - -Listen for changes to the public profile - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `callback` | `any` | - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -[packages/client-ts/src/context/profiles/profile.ts:148](https://github.com/verida/verida-js/blob/c03b336/packages/client-ts/src/context/profiles/profile.ts#L148) - -___ - -### saveRecord - -▸ `Private` **saveRecord**(`record`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `record` | `object` | - -#### Returns - -`Promise`<`boolean`\> - -#### Defined in - -[packages/client-ts/src/context/profiles/profile.ts:178](https://github.com/verida/verida-js/blob/c03b336/packages/client-ts/src/context/profiles/profile.ts#L178) - -___ - -### set - -▸ **set**(`key`, `value`): `Promise`<`any`\> - -Set a profile value by key - -**`example`** -// Set a profile value by key -app.wallet.profile.set('name', 'John'); - -// Update a profile value from an existing document -let emailDoc = app.wallet.profile.get('email'); -app.wallet.profile.set(emailDoc, 'john@doe.com'); - -// Update a profile profile by key -app.wallet.profile.set('email', 'john@doe.com'); - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `key` | `string` | Profile key to set (ie: `email`) | -| `value` | `any` | Value to save | - -#### Returns - -`Promise`<`any`\> - -Boolean indicating if the save was successful - -#### Defined in - -[packages/client-ts/src/context/profiles/profile.ts:123](https://github.com/verida/verida-js/blob/c03b336/packages/client-ts/src/context/profiles/profile.ts#L123) - -___ - -### setMany - -▸ **setMany**(`data`): `Promise`<`any`\> - -Set many profile key / values at once - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `any` | - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -[packages/client-ts/src/context/profiles/profile.ts:134](https://github.com/verida/verida-js/blob/c03b336/packages/client-ts/src/context/profiles/profile.ts#L134) diff --git a/docs/api/verida-js/classes/verida_client_ts.Schema.md b/docs/api/verida-js/classes/verida_client_ts.Schema.md deleted file mode 100644 index b31ff95..0000000 --- a/docs/api/verida-js/classes/verida_client_ts.Schema.md +++ /dev/null @@ -1,377 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / Schema - -# Class: Schema - -[@verida/client-ts](../modules/verida_client_ts.md).Schema - -## Table of contents - -### Constructors - -- [constructor](verida_client_ts.Schema.md#constructor) - -### Properties - -- [ajv](verida_client_ts.Schema.md#ajv) -- [errors](verida_client_ts.Schema.md#errors) -- [finalPath](verida_client_ts.Schema.md#finalpath) -- [path](verida_client_ts.Schema.md#path) -- [schemaJson](verida_client_ts.Schema.md#schemajson) -- [specification](verida_client_ts.Schema.md#specification) -- [validateFunction](verida_client_ts.Schema.md#validatefunction) -- [schemaPaths](verida_client_ts.Schema.md#schemapaths) -- [schemas](verida_client_ts.Schema.md#schemas) - -### Methods - -- [getAppearance](verida_client_ts.Schema.md#getappearance) -- [getPath](verida_client_ts.Schema.md#getpath) -- [getSchemaJson](verida_client_ts.Schema.md#getschemajson) -- [getSpecification](verida_client_ts.Schema.md#getspecification) -- [validate](verida_client_ts.Schema.md#validate) -- [getSchema](verida_client_ts.Schema.md#getschema) -- [getSchemaPaths](verida_client_ts.Schema.md#getschemapaths) -- [getVersionlessSchemaName](verida_client_ts.Schema.md#getversionlessschemaname) -- [loadJson](verida_client_ts.Schema.md#loadjson) -- [resolvePath](verida_client_ts.Schema.md#resolvepath) -- [setSchemaPaths](verida_client_ts.Schema.md#setschemapaths) - -## Constructors - -### constructor - -• **new Schema**(`path`, `options?`) - -An object representation of a JSON Schema. - -**Do not instantiate directly.** - -Access via {@link App#getSchema} - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `path` | `string` | Path to a schema in the form (http://..../schema.json, /schemas/name/schema.json, name/of/schema) | -| `options` | `any` | - | - -#### Defined in - -[packages/client-ts/src/context/schema.ts:48](https://github.com/verida/verida-js/blob/c03b336/packages/client-ts/src/context/schema.ts#L48) - -## Properties - -### ajv - -• `Protected` **ajv**: [`Ajv2020`](verida_client_ts._internal_.Ajv2020.md) - -#### Defined in - -[packages/client-ts/src/context/schema.ts:29](https://github.com/verida/verida-js/blob/c03b336/packages/client-ts/src/context/schema.ts#L29) - -___ - -### errors - -• **errors**: `any`[] - -#### Defined in - -[packages/client-ts/src/context/schema.ts:26](https://github.com/verida/verida-js/blob/c03b336/packages/client-ts/src/context/schema.ts#L26) - -___ - -### finalPath - -• `Protected` `Optional` **finalPath**: `string` - -#### Defined in - -[packages/client-ts/src/context/schema.ts:32](https://github.com/verida/verida-js/blob/c03b336/packages/client-ts/src/context/schema.ts#L32) - -___ - -### path - -• `Protected` **path**: `string` - -#### Defined in - -[packages/client-ts/src/context/schema.ts:28](https://github.com/verida/verida-js/blob/c03b336/packages/client-ts/src/context/schema.ts#L28) - -___ - -### schemaJson - -• `Protected` `Optional` **schemaJson**: `object` - -#### Defined in - -[packages/client-ts/src/context/schema.ts:31](https://github.com/verida/verida-js/blob/c03b336/packages/client-ts/src/context/schema.ts#L31) - -___ - -### specification - -• `Protected` `Optional` **specification**: `any` - -#### Defined in - -[packages/client-ts/src/context/schema.ts:33](https://github.com/verida/verida-js/blob/c03b336/packages/client-ts/src/context/schema.ts#L33) - -___ - -### validateFunction - -• `Protected` `Optional` **validateFunction**: `any` - -#### Defined in - -[packages/client-ts/src/context/schema.ts:34](https://github.com/verida/verida-js/blob/c03b336/packages/client-ts/src/context/schema.ts#L34) - -___ - -### schemaPaths - -▪ `Static` `Protected` `Optional` **schemaPaths**: [`Record`](../modules/verida_client_ts._internal_.md#record)<`string`, `string`\> - -#### Defined in - -[packages/client-ts/src/context/schema.ts:36](https://github.com/verida/verida-js/blob/c03b336/packages/client-ts/src/context/schema.ts#L36) - -___ - -### schemas - -▪ `Static` `Protected` **schemas**: `any` = `{}` - -#### Defined in - -[packages/client-ts/src/context/schema.ts:37](https://github.com/verida/verida-js/blob/c03b336/packages/client-ts/src/context/schema.ts#L37) - -## Methods - -### getAppearance - -▸ **getAppearance**(): `Promise`<`any`\> - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -[packages/client-ts/src/context/schema.ts:151](https://github.com/verida/verida-js/blob/c03b336/packages/client-ts/src/context/schema.ts#L151) - -___ - -### getPath - -▸ `Protected` **getPath**(): `Promise`<`string`\> - -Get a rully resolveable path for a URL - -Handle shortened paths: - - `health/activity` -> `https://common.schemas.verida.io/health/activity/latest/schema.json` - - `https://common/schemas.verida.io/health/activity/latest` -> `https://common.schemas.verida.io/health/activity/latest/schema.json` - - `/health/activity/test.json` -> `https://common/schemas.verida.io/health/activity/test.json` - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -[packages/client-ts/src/context/schema.ts:185](https://github.com/verida/verida-js/blob/c03b336/packages/client-ts/src/context/schema.ts#L185) - -___ - -### getSchemaJson - -▸ **getSchemaJson**(): `Promise`<`object`\> - -Fetch unresolved JSON schema - -#### Returns - -`Promise`<`object`\> - -#### Defined in - -[packages/client-ts/src/context/schema.ts:137](https://github.com/verida/verida-js/blob/c03b336/packages/client-ts/src/context/schema.ts#L137) - -___ - -### getSpecification - -▸ **getSpecification**(): `Promise`<`any`\> - -**`todo:`** Deprecate in favour of `getProperties()` -Get an object that represents the JSON Schema. Fully resolved. -Warning: This can cause issues with very large schemas. - -**`example`** -let schemaDoc = await app.getSchema("social/contact"); -let spec = schemaDoc.getSpecification(); -console.log(spec); - -#### Returns - -`Promise`<`any`\> - -JSON object representing the defereferenced schema - -#### Defined in - -[packages/client-ts/src/context/schema.ts:99](https://github.com/verida/verida-js/blob/c03b336/packages/client-ts/src/context/schema.ts#L99) - -___ - -### validate - -▸ **validate**(`data`): `Promise`<`boolean`\> - -Validate a data object with this schema, using AJV - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `any` | - -#### Returns - -`Promise`<`boolean`\> - -True if the data validates against the schema. - -#### Defined in - -[packages/client-ts/src/context/schema.ts:119](https://github.com/verida/verida-js/blob/c03b336/packages/client-ts/src/context/schema.ts#L119) - -___ - -### getSchema - -▸ `Static` **getSchema**(`schemaName`): `Promise`<[`Schema`](verida_client_ts.Schema.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schemaName` | `string` | - -#### Returns - -`Promise`<[`Schema`](verida_client_ts.Schema.md)\> - -#### Defined in - -[packages/client-ts/src/context/schema.ts:72](https://github.com/verida/verida-js/blob/c03b336/packages/client-ts/src/context/schema.ts#L72) - -___ - -### getSchemaPaths - -▸ `Static` **getSchemaPaths**(): [`Record`](../modules/verida_client_ts._internal_.md#record)<`string`, `string`\> - -#### Returns - -[`Record`](../modules/verida_client_ts._internal_.md#record)<`string`, `string`\> - -#### Defined in - -[packages/client-ts/src/context/schema.ts:84](https://github.com/verida/verida-js/blob/c03b336/packages/client-ts/src/context/schema.ts#L84) - -___ - -### getVersionlessSchemaName - -▸ `Static` **getVersionlessSchemaName**(`schemaName`): `string` - -Checks a version specified in schemaName - -SchemaName example :- https://core.schemas.verida.io/base/v0.1.0/schema.json -SchemaName format :- https://{protocol-name}/{name}/{v}{version}/name.json - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schemaName` | `string` | - -#### Returns - -`string` - -schemaName without the version - -#### Defined in - -[packages/client-ts/src/context/schema.ts:268](https://github.com/verida/verida-js/blob/c03b336/packages/client-ts/src/context/schema.ts#L268) - -___ - -### loadJson - -▸ `Static` **loadJson**(`uri`): `Promise`<`object`\> - -Load JSON from a url that is fully resolved. - -Used by AJV. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `uri` | `string` | - -#### Returns - -`Promise`<`object`\> - -#### Defined in - -[packages/client-ts/src/context/schema.ts:237](https://github.com/verida/verida-js/blob/c03b336/packages/client-ts/src/context/schema.ts#L237) - -___ - -### resolvePath - -▸ `Static` **resolvePath**(`uri`): `Promise`<`string`\> - -Force schema paths to be applied to URLs - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `uri` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -[packages/client-ts/src/context/schema.ts:217](https://github.com/verida/verida-js/blob/c03b336/packages/client-ts/src/context/schema.ts#L217) - -___ - -### setSchemaPaths - -▸ `Static` **setSchemaPaths**(`schemaPaths`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schemaPaths` | [`Record`](../modules/verida_client_ts._internal_.md#record)<`string`, `string`\> | - -#### Returns - -`void` - -#### Defined in - -[packages/client-ts/src/context/schema.ts:80](https://github.com/verida/verida-js/blob/c03b336/packages/client-ts/src/context/schema.ts#L80) diff --git a/docs/api/verida-js/classes/verida_client_ts._internal_.Ajv2020.md b/docs/api/verida-js/classes/verida_client_ts._internal_.Ajv2020.md deleted file mode 100644 index 7db2913..0000000 --- a/docs/api/verida-js/classes/verida_client_ts._internal_.Ajv2020.md +++ /dev/null @@ -1,1047 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / Ajv2020 - -# Class: Ajv2020 - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).Ajv2020 - -## Hierarchy - -- [`default`](verida_client_ts._internal_.default-3.md) - - ↳ **`Ajv2020`** - -## Table of contents - -### Constructors - -- [constructor](verida_client_ts._internal_.Ajv2020.md#constructor) - -### Properties - -- [RULES](verida_client_ts._internal_.Ajv2020.md#rules) -- [\_compilations](verida_client_ts._internal_.Ajv2020.md#_compilations) -- [errors](verida_client_ts._internal_.Ajv2020.md#errors) -- [formats](verida_client_ts._internal_.Ajv2020.md#formats) -- [logger](verida_client_ts._internal_.Ajv2020.md#logger) -- [opts](verida_client_ts._internal_.Ajv2020.md#opts) -- [refs](verida_client_ts._internal_.Ajv2020.md#refs) -- [schemas](verida_client_ts._internal_.Ajv2020.md#schemas) -- [scope](verida_client_ts._internal_.Ajv2020.md#scope) -- [MissingRefError](verida_client_ts._internal_.Ajv2020.md#missingreferror) -- [ValidationError](verida_client_ts._internal_.Ajv2020.md#validationerror) - -### Methods - -- [$dataMetaSchema](verida_client_ts._internal_.Ajv2020.md#$datametaschema) -- [\_addDefaultMetaSchema](verida_client_ts._internal_.Ajv2020.md#_adddefaultmetaschema) -- [\_addSchema](verida_client_ts._internal_.Ajv2020.md#_addschema) -- [\_addVocabularies](verida_client_ts._internal_.Ajv2020.md#_addvocabularies) -- [addFormat](verida_client_ts._internal_.Ajv2020.md#addformat) -- [addKeyword](verida_client_ts._internal_.Ajv2020.md#addkeyword) -- [addMetaSchema](verida_client_ts._internal_.Ajv2020.md#addmetaschema) -- [addSchema](verida_client_ts._internal_.Ajv2020.md#addschema) -- [addVocabulary](verida_client_ts._internal_.Ajv2020.md#addvocabulary) -- [compile](verida_client_ts._internal_.Ajv2020.md#compile) -- [compileAsync](verida_client_ts._internal_.Ajv2020.md#compileasync) -- [defaultMeta](verida_client_ts._internal_.Ajv2020.md#defaultmeta) -- [errorsText](verida_client_ts._internal_.Ajv2020.md#errorstext) -- [getKeyword](verida_client_ts._internal_.Ajv2020.md#getkeyword) -- [getSchema](verida_client_ts._internal_.Ajv2020.md#getschema) -- [removeKeyword](verida_client_ts._internal_.Ajv2020.md#removekeyword) -- [removeSchema](verida_client_ts._internal_.Ajv2020.md#removeschema) -- [validate](verida_client_ts._internal_.Ajv2020.md#validate) -- [validateSchema](verida_client_ts._internal_.Ajv2020.md#validateschema) - -## Constructors - -### constructor - -• **new Ajv2020**(`opts?`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `opts?` | [`Options`](../modules/verida_client_ts._internal_.md#options) | - -#### Overrides - -[default](verida_client_ts._internal_.default-3.md).[constructor](verida_client_ts._internal_.default-3.md#constructor) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/2020.d.ts:4 - -## Properties - -### RULES - -• `Readonly` **RULES**: [`ValidationRules`](../interfaces/verida_client_ts._internal_.ValidationRules.md) - -#### Inherited from - -[default](verida_client_ts._internal_.default-3.md).[RULES](verida_client_ts._internal_.default-3.md#rules) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:120 - -___ - -### \_compilations - -• `Readonly` **\_compilations**: `Set`<[`SchemaEnv`](verida_client_ts._internal_.SchemaEnv.md)\> - -#### Inherited from - -[default](verida_client_ts._internal_.default-3.md).[_compilations](verida_client_ts._internal_.default-3.md#_compilations) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:121 - -___ - -### errors - -• `Optional` **errors**: ``null`` \| [`ErrorObject`](../interfaces/verida_client_ts._internal_.ErrorObject.md)<`string`, [`Record`](../modules/verida_client_ts._internal_.md#record)<`string`, `any`\>, `unknown`\>[] - -#### Inherited from - -[default](verida_client_ts._internal_.default-3.md).[errors](verida_client_ts._internal_.default-3.md#errors) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:108 - -___ - -### formats - -• `Readonly` **formats**: `Object` - -#### Inherited from - -[default](verida_client_ts._internal_.default-3.md).[formats](verida_client_ts._internal_.default-3.md#formats) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:117 - -___ - -### logger - -• **logger**: [`Logger`](../interfaces/verida_client_ts._internal_.Logger.md) - -#### Inherited from - -[default](verida_client_ts._internal_.default-3.md).[logger](verida_client_ts._internal_.default-3.md#logger) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:109 - -___ - -### opts - -• **opts**: [`InstanceOptions`](../modules/verida_client_ts._internal_.md#instanceoptions) - -#### Inherited from - -[default](verida_client_ts._internal_.default-3.md).[opts](verida_client_ts._internal_.default-3.md#opts) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:107 - -___ - -### refs - -• `Readonly` **refs**: `Object` - -#### Inherited from - -[default](verida_client_ts._internal_.default-3.md).[refs](verida_client_ts._internal_.default-3.md#refs) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:114 - -___ - -### schemas - -• `Readonly` **schemas**: `Object` - -#### Inherited from - -[default](verida_client_ts._internal_.default-3.md).[schemas](verida_client_ts._internal_.default-3.md#schemas) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:111 - -___ - -### scope - -• `Readonly` **scope**: [`ValueScope`](verida_client_ts._internal_.ValueScope.md) - -#### Inherited from - -[default](verida_client_ts._internal_.default-3.md).[scope](verida_client_ts._internal_.default-3.md#scope) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:110 - -___ - -### MissingRefError - -▪ `Static` **MissingRefError**: typeof [`default`](verida_client_ts._internal_.default-5.md) - -#### Inherited from - -[default](verida_client_ts._internal_.default-3.md).[MissingRefError](verida_client_ts._internal_.default-3.md#missingreferror) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:126 - -___ - -### ValidationError - -▪ `Static` **ValidationError**: typeof [`default`](verida_client_ts._internal_.default-4.md) - -#### Inherited from - -[default](verida_client_ts._internal_.default-3.md).[ValidationError](verida_client_ts._internal_.default-3.md#validationerror) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:125 - -## Methods - -### $dataMetaSchema - -▸ **$dataMetaSchema**(`metaSchema`, `keywordsJsonPointers`): [`AnySchemaObject`](../modules/verida_client_ts._internal_.md#anyschemaobject) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `metaSchema` | [`AnySchemaObject`](../modules/verida_client_ts._internal_.md#anyschemaobject) | -| `keywordsJsonPointers` | `string`[] | - -#### Returns - -[`AnySchemaObject`](../modules/verida_client_ts._internal_.md#anyschemaobject) - -#### Inherited from - -[default](verida_client_ts._internal_.default-3.md).[$dataMetaSchema](verida_client_ts._internal_.default-3.md#$datametaschema) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:163 - -___ - -### \_addDefaultMetaSchema - -▸ **_addDefaultMetaSchema**(): `void` - -#### Returns - -`void` - -#### Overrides - -[default](verida_client_ts._internal_.default-3.md).[_addDefaultMetaSchema](verida_client_ts._internal_.default-3.md#_adddefaultmetaschema) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/2020.d.ts:6 - -___ - -### \_addSchema - -▸ **_addSchema**(`schema`, `meta?`, `baseId?`, `validateSchema?`, `addSchema?`): [`SchemaEnv`](verida_client_ts._internal_.SchemaEnv.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schema` | [`AnySchema`](../modules/verida_client_ts._internal_.md#anyschema) | -| `meta?` | `boolean` | -| `baseId?` | `string` | -| `validateSchema?` | `boolean` \| ``"log"`` | -| `addSchema?` | `boolean` | - -#### Returns - -[`SchemaEnv`](verida_client_ts._internal_.SchemaEnv.md) - -#### Inherited from - -[default](verida_client_ts._internal_.default-3.md).[_addSchema](verida_client_ts._internal_.default-3.md#_addschema) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:165 - -___ - -### \_addVocabularies - -▸ **_addVocabularies**(): `void` - -#### Returns - -`void` - -#### Overrides - -[default](verida_client_ts._internal_.default-3.md).[_addVocabularies](verida_client_ts._internal_.default-3.md#_addvocabularies) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/2020.d.ts:5 - -___ - -### addFormat - -▸ **addFormat**(`name`, `format`): [`default`](verida_client_ts._internal_.default-3.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` | -| `format` | [`Format`](../modules/verida_client_ts._internal_.md#format) | - -#### Returns - -[`default`](verida_client_ts._internal_.default-3.md) - -#### Inherited from - -[default](verida_client_ts._internal_.default-3.md).[addFormat](verida_client_ts._internal_.default-3.md#addformat) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:160 - -___ - -### addKeyword - -▸ **addKeyword**(`kwdOrDef`, `def?`): [`default`](verida_client_ts._internal_.default-3.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `kwdOrDef` | `string` \| [`KeywordDefinition`](../modules/verida_client_ts._internal_.md#keyworddefinition) | -| `def?` | [`KeywordDefinition`](../modules/verida_client_ts._internal_.md#keyworddefinition) | - -#### Returns - -[`default`](verida_client_ts._internal_.default-3.md) - -#### Inherited from - -[default](verida_client_ts._internal_.default-3.md).[addKeyword](verida_client_ts._internal_.default-3.md#addkeyword) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:157 - -___ - -### addMetaSchema - -▸ **addMetaSchema**(`schema`, `key?`, `_validateSchema?`): [`default`](verida_client_ts._internal_.default-3.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schema` | [`AnySchemaObject`](../modules/verida_client_ts._internal_.md#anyschemaobject) | -| `key?` | `string` | -| `_validateSchema?` | `boolean` \| ``"log"`` | - -#### Returns - -[`default`](verida_client_ts._internal_.default-3.md) - -#### Inherited from - -[default](verida_client_ts._internal_.default-3.md).[addMetaSchema](verida_client_ts._internal_.default-3.md#addmetaschema) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:151 - -___ - -### addSchema - -▸ **addSchema**(`schema`, `key?`, `_meta?`, `_validateSchema?`): [`default`](verida_client_ts._internal_.default-3.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schema` | [`AnySchema`](../modules/verida_client_ts._internal_.md#anyschema) \| [`AnySchema`](../modules/verida_client_ts._internal_.md#anyschema)[] | -| `key?` | `string` | -| `_meta?` | `boolean` | -| `_validateSchema?` | `boolean` \| ``"log"`` | - -#### Returns - -[`default`](verida_client_ts._internal_.default-3.md) - -#### Inherited from - -[default](verida_client_ts._internal_.default-3.md).[addSchema](verida_client_ts._internal_.default-3.md#addschema) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:147 - -___ - -### addVocabulary - -▸ **addVocabulary**(`definitions`): [`default`](verida_client_ts._internal_.default-3.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `definitions` | [`Vocabulary`](../modules/verida_client_ts._internal_.md#vocabulary) | - -#### Returns - -[`default`](verida_client_ts._internal_.default-3.md) - -#### Inherited from - -[default](verida_client_ts._internal_.default-3.md).[addVocabulary](verida_client_ts._internal_.default-3.md#addvocabulary) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:156 - -___ - -### compile - -▸ **compile**<`T`\>(`schema`, `_meta?`): [`ValidateFunction`](../interfaces/verida_client_ts._internal_.ValidateFunction.md)<`T`\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `unknown` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schema` | [`Schema`](../modules/verida_client_ts._internal_.md#schema) \| [`UncheckedJSONSchemaType`](../modules/verida_client_ts._internal_.md#uncheckedjsonschematype)<`T`, ``false``\> | -| `_meta?` | `boolean` | - -#### Returns - -[`ValidateFunction`](../interfaces/verida_client_ts._internal_.ValidateFunction.md)<`T`\> - -#### Inherited from - -[default](verida_client_ts._internal_.default-3.md).[compile](verida_client_ts._internal_.default-3.md#compile) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:138 - -▸ **compile**<`T`\>(`schema`, `_meta?`): [`ValidateFunction`](../interfaces/verida_client_ts._internal_.ValidateFunction.md)<`T`\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `unknown` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schema` | [`JTDSchemaType`](../modules/verida_client_ts._internal_.md#jtdschematype)<`T`, [`Record`](../modules/verida_client_ts._internal_.md#record)<`string`, `never`\>\> | -| `_meta?` | `boolean` | - -#### Returns - -[`ValidateFunction`](../interfaces/verida_client_ts._internal_.ValidateFunction.md)<`T`\> - -#### Inherited from - -[default](verida_client_ts._internal_.default-3.md).[compile](verida_client_ts._internal_.default-3.md#compile) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:139 - -▸ **compile**<`N`, `T`\>(`schema`, `_meta?`): [`ValidateFunction`](../interfaces/verida_client_ts._internal_.ValidateFunction.md)<[`JTDDataType`](../modules/verida_client_ts._internal_.md#jtddatatype)<`T`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `N` | extends `never` | -| `T` | extends [`SomeJTDSchemaType`](../modules/verida_client_ts._internal_.md#somejtdschematype) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schema` | `T` | -| `_meta?` | `boolean` | - -#### Returns - -[`ValidateFunction`](../interfaces/verida_client_ts._internal_.ValidateFunction.md)<[`JTDDataType`](../modules/verida_client_ts._internal_.md#jtddatatype)<`T`\>\> - -#### Inherited from - -[default](verida_client_ts._internal_.default-3.md).[compile](verida_client_ts._internal_.default-3.md#compile) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:140 - -▸ **compile**<`T`\>(`schema`, `_meta?`): [`AsyncValidateFunction`](../interfaces/verida_client_ts._internal_.AsyncValidateFunction.md)<`T`\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `unknown` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schema` | [`AsyncSchema`](../interfaces/verida_client_ts._internal_.AsyncSchema.md) | -| `_meta?` | `boolean` | - -#### Returns - -[`AsyncValidateFunction`](../interfaces/verida_client_ts._internal_.AsyncValidateFunction.md)<`T`\> - -#### Inherited from - -[default](verida_client_ts._internal_.default-3.md).[compile](verida_client_ts._internal_.default-3.md#compile) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:141 - -▸ **compile**<`T`\>(`schema`, `_meta?`): [`AnyValidateFunction`](../modules/verida_client_ts._internal_.md#anyvalidatefunction)<`T`\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `unknown` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schema` | [`AnySchema`](../modules/verida_client_ts._internal_.md#anyschema) | -| `_meta?` | `boolean` | - -#### Returns - -[`AnyValidateFunction`](../modules/verida_client_ts._internal_.md#anyvalidatefunction)<`T`\> - -#### Inherited from - -[default](verida_client_ts._internal_.default-3.md).[compile](verida_client_ts._internal_.default-3.md#compile) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:142 - -___ - -### compileAsync - -▸ **compileAsync**<`T`\>(`schema`, `_meta?`): `Promise`<[`ValidateFunction`](../interfaces/verida_client_ts._internal_.ValidateFunction.md)<`T`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `unknown` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schema` | [`SchemaObject`](../interfaces/verida_client_ts._internal_.SchemaObject.md) \| [`UncheckedJSONSchemaType`](../modules/verida_client_ts._internal_.md#uncheckedjsonschematype)<`T`, ``false``\> | -| `_meta?` | `boolean` | - -#### Returns - -`Promise`<[`ValidateFunction`](../interfaces/verida_client_ts._internal_.ValidateFunction.md)<`T`\>\> - -#### Inherited from - -[default](verida_client_ts._internal_.default-3.md).[compileAsync](verida_client_ts._internal_.default-3.md#compileasync) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:143 - -▸ **compileAsync**<`T`\>(`schema`, `_meta?`): `Promise`<[`ValidateFunction`](../interfaces/verida_client_ts._internal_.ValidateFunction.md)<`T`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `unknown` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schema` | [`JTDSchemaType`](../modules/verida_client_ts._internal_.md#jtdschematype)<`T`, [`Record`](../modules/verida_client_ts._internal_.md#record)<`string`, `never`\>\> | -| `_meta?` | `boolean` | - -#### Returns - -`Promise`<[`ValidateFunction`](../interfaces/verida_client_ts._internal_.ValidateFunction.md)<`T`\>\> - -#### Inherited from - -[default](verida_client_ts._internal_.default-3.md).[compileAsync](verida_client_ts._internal_.default-3.md#compileasync) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:144 - -▸ **compileAsync**<`T`\>(`schema`, `meta?`): `Promise`<[`AsyncValidateFunction`](../interfaces/verida_client_ts._internal_.AsyncValidateFunction.md)<`T`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `unknown` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schema` | [`AsyncSchema`](../interfaces/verida_client_ts._internal_.AsyncSchema.md) | -| `meta?` | `boolean` | - -#### Returns - -`Promise`<[`AsyncValidateFunction`](../interfaces/verida_client_ts._internal_.AsyncValidateFunction.md)<`T`\>\> - -#### Inherited from - -[default](verida_client_ts._internal_.default-3.md).[compileAsync](verida_client_ts._internal_.default-3.md#compileasync) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:145 - -▸ **compileAsync**<`T`\>(`schema`, `meta?`): `Promise`<[`AnyValidateFunction`](../modules/verida_client_ts._internal_.md#anyvalidatefunction)<`T`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `unknown` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schema` | [`AnySchemaObject`](../modules/verida_client_ts._internal_.md#anyschemaobject) | -| `meta?` | `boolean` | - -#### Returns - -`Promise`<[`AnyValidateFunction`](../modules/verida_client_ts._internal_.md#anyvalidatefunction)<`T`\>\> - -#### Inherited from - -[default](verida_client_ts._internal_.default-3.md).[compileAsync](verida_client_ts._internal_.default-3.md#compileasync) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:146 - -___ - -### defaultMeta - -▸ **defaultMeta**(): `undefined` \| `string` \| [`AnySchemaObject`](../modules/verida_client_ts._internal_.md#anyschemaobject) - -#### Returns - -`undefined` \| `string` \| [`AnySchemaObject`](../modules/verida_client_ts._internal_.md#anyschemaobject) - -#### Overrides - -[default](verida_client_ts._internal_.default-3.md).[defaultMeta](verida_client_ts._internal_.default-3.md#defaultmeta) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/2020.d.ts:7 - -___ - -### errorsText - -▸ **errorsText**(`errors?`, `__namedParameters?`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `errors?` | ``null`` \| [`ErrorObject`](../interfaces/verida_client_ts._internal_.ErrorObject.md)<`string`, [`Record`](../modules/verida_client_ts._internal_.md#record)<`string`, `any`\>, `unknown`\>[] | -| `__namedParameters?` | [`ErrorsTextOptions`](../interfaces/verida_client_ts._internal_.ErrorsTextOptions.md) | - -#### Returns - -`string` - -#### Inherited from - -[default](verida_client_ts._internal_.default-3.md).[errorsText](verida_client_ts._internal_.default-3.md#errorstext) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:161 - -___ - -### getKeyword - -▸ **getKeyword**(`keyword`): `boolean` \| [`AddedKeywordDefinition`](../modules/verida_client_ts._internal_.md#addedkeyworddefinition) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `keyword` | `string` | - -#### Returns - -`boolean` \| [`AddedKeywordDefinition`](../modules/verida_client_ts._internal_.md#addedkeyworddefinition) - -#### Inherited from - -[default](verida_client_ts._internal_.default-3.md).[getKeyword](verida_client_ts._internal_.default-3.md#getkeyword) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:158 - -___ - -### getSchema - -▸ **getSchema**<`T`\>(`keyRef`): `undefined` \| [`AnyValidateFunction`](../modules/verida_client_ts._internal_.md#anyvalidatefunction)<`T`\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `unknown` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `keyRef` | `string` | - -#### Returns - -`undefined` \| [`AnyValidateFunction`](../modules/verida_client_ts._internal_.md#anyvalidatefunction)<`T`\> - -#### Inherited from - -[default](verida_client_ts._internal_.default-3.md).[getSchema](verida_client_ts._internal_.default-3.md#getschema) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:154 - -___ - -### removeKeyword - -▸ **removeKeyword**(`keyword`): [`default`](verida_client_ts._internal_.default-3.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `keyword` | `string` | - -#### Returns - -[`default`](verida_client_ts._internal_.default-3.md) - -#### Inherited from - -[default](verida_client_ts._internal_.default-3.md).[removeKeyword](verida_client_ts._internal_.default-3.md#removekeyword) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:159 - -___ - -### removeSchema - -▸ **removeSchema**(`schemaKeyRef?`): [`default`](verida_client_ts._internal_.default-3.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schemaKeyRef?` | `string` \| `RegExp` \| [`AnySchema`](../modules/verida_client_ts._internal_.md#anyschema) | - -#### Returns - -[`default`](verida_client_ts._internal_.default-3.md) - -#### Inherited from - -[default](verida_client_ts._internal_.default-3.md).[removeSchema](verida_client_ts._internal_.default-3.md#removeschema) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:155 - -___ - -### validate - -▸ **validate**(`schema`, `data`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schema` | `string` \| [`Schema`](../modules/verida_client_ts._internal_.md#schema) | -| `data` | `unknown` | - -#### Returns - -`boolean` - -#### Inherited from - -[default](verida_client_ts._internal_.default-3.md).[validate](verida_client_ts._internal_.default-3.md#validate) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:131 - -▸ **validate**(`schemaKeyRef`, `data`): `boolean` \| `Promise`<`unknown`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schemaKeyRef` | `string` \| [`AnySchema`](../modules/verida_client_ts._internal_.md#anyschema) | -| `data` | `unknown` | - -#### Returns - -`boolean` \| `Promise`<`unknown`\> - -#### Inherited from - -[default](verida_client_ts._internal_.default-3.md).[validate](verida_client_ts._internal_.default-3.md#validate) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:132 - -▸ **validate**<`T`\>(`schema`, `data`): data is T - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schema` | `string` \| [`Schema`](../modules/verida_client_ts._internal_.md#schema) \| [`UncheckedJSONSchemaType`](../modules/verida_client_ts._internal_.md#uncheckedjsonschematype)<`T`, ``false``\> | -| `data` | `unknown` | - -#### Returns - -data is T - -#### Inherited from - -[default](verida_client_ts._internal_.default-3.md).[validate](verida_client_ts._internal_.default-3.md#validate) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:133 - -▸ **validate**<`T`\>(`schema`, `data`): data is T - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schema` | [`JTDSchemaType`](../modules/verida_client_ts._internal_.md#jtdschematype)<`T`, [`Record`](../modules/verida_client_ts._internal_.md#record)<`string`, `never`\>\> | -| `data` | `unknown` | - -#### Returns - -data is T - -#### Inherited from - -[default](verida_client_ts._internal_.default-3.md).[validate](verida_client_ts._internal_.default-3.md#validate) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:134 - -▸ **validate**<`N`, `T`\>(`schema`, `data`): data is JTDDataType - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `N` | extends `never` | -| `T` | extends [`SomeJTDSchemaType`](../modules/verida_client_ts._internal_.md#somejtdschematype) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schema` | `T` | -| `data` | `unknown` | - -#### Returns - -data is JTDDataType - -#### Inherited from - -[default](verida_client_ts._internal_.default-3.md).[validate](verida_client_ts._internal_.default-3.md#validate) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:135 - -▸ **validate**<`T`\>(`schema`, `data`): `Promise`<`T`\> - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schema` | [`AsyncSchema`](../interfaces/verida_client_ts._internal_.AsyncSchema.md) | -| `data` | `unknown` | - -#### Returns - -`Promise`<`T`\> - -#### Inherited from - -[default](verida_client_ts._internal_.default-3.md).[validate](verida_client_ts._internal_.default-3.md#validate) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:136 - -▸ **validate**<`T`\>(`schemaKeyRef`, `data`): data is T \| Promise - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schemaKeyRef` | `string` \| [`AnySchema`](../modules/verida_client_ts._internal_.md#anyschema) | -| `data` | `unknown` | - -#### Returns - -data is T \| Promise - -#### Inherited from - -[default](verida_client_ts._internal_.default-3.md).[validate](verida_client_ts._internal_.default-3.md#validate) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:137 - -___ - -### validateSchema - -▸ **validateSchema**(`schema`, `throwOrLogError?`): `boolean` \| `Promise`<`unknown`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schema` | [`AnySchema`](../modules/verida_client_ts._internal_.md#anyschema) | -| `throwOrLogError?` | `boolean` | - -#### Returns - -`boolean` \| `Promise`<`unknown`\> - -#### Inherited from - -[default](verida_client_ts._internal_.default-3.md).[validateSchema](verida_client_ts._internal_.default-3.md#validateschema) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:153 diff --git a/docs/api/verida-js/classes/verida_client_ts._internal_.BaseStorageEngine.md b/docs/api/verida-js/classes/verida_client_ts._internal_.BaseStorageEngine.md deleted file mode 100644 index da871b6..0000000 --- a/docs/api/verida-js/classes/verida_client_ts._internal_.BaseStorageEngine.md +++ /dev/null @@ -1,170 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / BaseStorageEngine - -# Class: BaseStorageEngine - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).BaseStorageEngine - -## Table of contents - -### Constructors - -- [constructor](verida_client_ts._internal_.BaseStorageEngine.md#constructor) - -### Properties - -- [account](verida_client_ts._internal_.BaseStorageEngine.md#account) -- [dbRegistry](verida_client_ts._internal_.BaseStorageEngine.md#dbregistry) -- [endpointUri](verida_client_ts._internal_.BaseStorageEngine.md#endpointuri) -- [keyring](verida_client_ts._internal_.BaseStorageEngine.md#keyring) -- [storageContext](verida_client_ts._internal_.BaseStorageEngine.md#storagecontext) - -### Methods - -- [connectAccount](verida_client_ts._internal_.BaseStorageEngine.md#connectaccount) -- [logout](verida_client_ts._internal_.BaseStorageEngine.md#logout) -- [openDatabase](verida_client_ts._internal_.BaseStorageEngine.md#opendatabase) -- [openDatastore](verida_client_ts._internal_.BaseStorageEngine.md#opendatastore) - -## Constructors - -### constructor - -• **new BaseStorageEngine**(`storageContext`, `dbRegistry`, `endpointUri`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `storageContext` | `string` | -| `dbRegistry` | [`DbRegistry`](verida_client_ts._internal_.DbRegistry.md) | -| `endpointUri` | `string` | - -#### Defined in - -[packages/client-ts/src/context/engines/base.ts:20](https://github.com/verida/verida-js/blob/c03b336/packages/client-ts/src/context/engines/base.ts#L20) - -## Properties - -### account - -• `Protected` `Optional` **account**: [`default`](verida_client_ts._internal_.default-1.md) - -#### Defined in - -[packages/client-ts/src/context/engines/base.ts:17](https://github.com/verida/verida-js/blob/c03b336/packages/client-ts/src/context/engines/base.ts#L17) - -___ - -### dbRegistry - -• `Protected` **dbRegistry**: [`DbRegistry`](verida_client_ts._internal_.DbRegistry.md) - -#### Defined in - -[packages/client-ts/src/context/engines/base.ts:14](https://github.com/verida/verida-js/blob/c03b336/packages/client-ts/src/context/engines/base.ts#L14) - -___ - -### endpointUri - -• `Protected` **endpointUri**: `string` - -#### Defined in - -[packages/client-ts/src/context/engines/base.ts:15](https://github.com/verida/verida-js/blob/c03b336/packages/client-ts/src/context/engines/base.ts#L15) - -___ - -### keyring - -• `Protected` `Optional` **keyring**: [`default`](verida_client_ts._internal_.default-5.md) - -#### Defined in - -[packages/client-ts/src/context/engines/base.ts:18](https://github.com/verida/verida-js/blob/c03b336/packages/client-ts/src/context/engines/base.ts#L18) - -___ - -### storageContext - -• `Protected` **storageContext**: `string` - -#### Defined in - -[packages/client-ts/src/context/engines/base.ts:13](https://github.com/verida/verida-js/blob/c03b336/packages/client-ts/src/context/engines/base.ts#L13) - -## Methods - -### connectAccount - -▸ **connectAccount**(`account`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `account` | [`default`](verida_client_ts._internal_.default-1.md) | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -[packages/client-ts/src/context/engines/base.ts:30](https://github.com/verida/verida-js/blob/c03b336/packages/client-ts/src/context/engines/base.ts#L30) - -___ - -### logout - -▸ **logout**(): `void` - -#### Returns - -`void` - -#### Defined in - -[packages/client-ts/src/context/engines/base.ts:49](https://github.com/verida/verida-js/blob/c03b336/packages/client-ts/src/context/engines/base.ts#L49) - -___ - -### openDatabase - -▸ **openDatabase**(`databaseName`, `config`): `Promise`<[`Database`](../interfaces/verida_client_ts.Database.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `databaseName` | `string` | -| `config` | [`DatabaseOpenConfig`](../interfaces/verida_client_ts.ContextInterfaces.DatabaseOpenConfig.md) | - -#### Returns - -`Promise`<[`Database`](../interfaces/verida_client_ts.Database.md)\> - -#### Defined in - -[packages/client-ts/src/context/engines/base.ts:35](https://github.com/verida/verida-js/blob/c03b336/packages/client-ts/src/context/engines/base.ts#L35) - -___ - -### openDatastore - -▸ **openDatastore**(`schemaName`, `config`): `Promise`<[`Datastore`](verida_client_ts.Datastore.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schemaName` | `string` | -| `config` | [`DatastoreOpenConfig`](../interfaces/verida_client_ts.ContextInterfaces.DatastoreOpenConfig.md) | - -#### Returns - -`Promise`<[`Datastore`](verida_client_ts.Datastore.md)\> - -#### Defined in - -[packages/client-ts/src/context/engines/base.ts:42](https://github.com/verida/verida-js/blob/c03b336/packages/client-ts/src/context/engines/base.ts#L42) diff --git a/docs/api/verida-js/classes/verida_client_ts._internal_.BigNumber.md b/docs/api/verida-js/classes/verida_client_ts._internal_.BigNumber.md deleted file mode 100644 index c272b97..0000000 --- a/docs/api/verida-js/classes/verida_client_ts._internal_.BigNumber.md +++ /dev/null @@ -1,631 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / BigNumber - -# Class: BigNumber - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).BigNumber - -## Implements - -- [`Hexable`](../interfaces/verida_client_ts._internal_.Hexable.md) - -## Table of contents - -### Constructors - -- [constructor](verida_client_ts._internal_.BigNumber.md#constructor) - -### Properties - -- [\_hex](verida_client_ts._internal_.BigNumber.md#_hex) -- [\_isBigNumber](verida_client_ts._internal_.BigNumber.md#_isbignumber) - -### Methods - -- [abs](verida_client_ts._internal_.BigNumber.md#abs) -- [add](verida_client_ts._internal_.BigNumber.md#add) -- [and](verida_client_ts._internal_.BigNumber.md#and) -- [div](verida_client_ts._internal_.BigNumber.md#div) -- [eq](verida_client_ts._internal_.BigNumber.md#eq) -- [fromTwos](verida_client_ts._internal_.BigNumber.md#fromtwos) -- [gt](verida_client_ts._internal_.BigNumber.md#gt) -- [gte](verida_client_ts._internal_.BigNumber.md#gte) -- [isNegative](verida_client_ts._internal_.BigNumber.md#isnegative) -- [isZero](verida_client_ts._internal_.BigNumber.md#iszero) -- [lt](verida_client_ts._internal_.BigNumber.md#lt) -- [lte](verida_client_ts._internal_.BigNumber.md#lte) -- [mask](verida_client_ts._internal_.BigNumber.md#mask) -- [mod](verida_client_ts._internal_.BigNumber.md#mod) -- [mul](verida_client_ts._internal_.BigNumber.md#mul) -- [or](verida_client_ts._internal_.BigNumber.md#or) -- [pow](verida_client_ts._internal_.BigNumber.md#pow) -- [shl](verida_client_ts._internal_.BigNumber.md#shl) -- [shr](verida_client_ts._internal_.BigNumber.md#shr) -- [sub](verida_client_ts._internal_.BigNumber.md#sub) -- [toBigInt](verida_client_ts._internal_.BigNumber.md#tobigint) -- [toHexString](verida_client_ts._internal_.BigNumber.md#tohexstring) -- [toJSON](verida_client_ts._internal_.BigNumber.md#tojson) -- [toNumber](verida_client_ts._internal_.BigNumber.md#tonumber) -- [toString](verida_client_ts._internal_.BigNumber.md#tostring) -- [toTwos](verida_client_ts._internal_.BigNumber.md#totwos) -- [xor](verida_client_ts._internal_.BigNumber.md#xor) -- [from](verida_client_ts._internal_.BigNumber.md#from) -- [isBigNumber](verida_client_ts._internal_.BigNumber.md#isbignumber) - -## Constructors - -### constructor - -• **new BigNumber**(`constructorGuard`, `hex`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `constructorGuard` | `any` | -| `hex` | `string` | - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:7 - -## Properties - -### \_hex - -• `Readonly` **\_hex**: `string` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:5 - -___ - -### \_isBigNumber - -• `Readonly` **\_isBigNumber**: `boolean` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:6 - -## Methods - -### abs - -▸ **abs**(): [`BigNumber`](verida_client_ts._internal_.BigNumber.md) - -#### Returns - -[`BigNumber`](verida_client_ts._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:10 - -___ - -### add - -▸ **add**(`other`): [`BigNumber`](verida_client_ts._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_client_ts._internal_.md#bignumberish) | - -#### Returns - -[`BigNumber`](verida_client_ts._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:11 - -___ - -### and - -▸ **and**(`other`): [`BigNumber`](verida_client_ts._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_client_ts._internal_.md#bignumberish) | - -#### Returns - -[`BigNumber`](verida_client_ts._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:17 - -___ - -### div - -▸ **div**(`other`): [`BigNumber`](verida_client_ts._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_client_ts._internal_.md#bignumberish) | - -#### Returns - -[`BigNumber`](verida_client_ts._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:13 - -___ - -### eq - -▸ **eq**(`other`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_client_ts._internal_.md#bignumberish) | - -#### Returns - -`boolean` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:23 - -___ - -### fromTwos - -▸ **fromTwos**(`value`): [`BigNumber`](verida_client_ts._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `number` | - -#### Returns - -[`BigNumber`](verida_client_ts._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:8 - -___ - -### gt - -▸ **gt**(`other`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_client_ts._internal_.md#bignumberish) | - -#### Returns - -`boolean` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:26 - -___ - -### gte - -▸ **gte**(`other`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_client_ts._internal_.md#bignumberish) | - -#### Returns - -`boolean` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:27 - -___ - -### isNegative - -▸ **isNegative**(): `boolean` - -#### Returns - -`boolean` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:28 - -___ - -### isZero - -▸ **isZero**(): `boolean` - -#### Returns - -`boolean` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:29 - -___ - -### lt - -▸ **lt**(`other`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_client_ts._internal_.md#bignumberish) | - -#### Returns - -`boolean` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:24 - -___ - -### lte - -▸ **lte**(`other`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_client_ts._internal_.md#bignumberish) | - -#### Returns - -`boolean` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:25 - -___ - -### mask - -▸ **mask**(`value`): [`BigNumber`](verida_client_ts._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `number` | - -#### Returns - -[`BigNumber`](verida_client_ts._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:20 - -___ - -### mod - -▸ **mod**(`other`): [`BigNumber`](verida_client_ts._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_client_ts._internal_.md#bignumberish) | - -#### Returns - -[`BigNumber`](verida_client_ts._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:15 - -___ - -### mul - -▸ **mul**(`other`): [`BigNumber`](verida_client_ts._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_client_ts._internal_.md#bignumberish) | - -#### Returns - -[`BigNumber`](verida_client_ts._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:14 - -___ - -### or - -▸ **or**(`other`): [`BigNumber`](verida_client_ts._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_client_ts._internal_.md#bignumberish) | - -#### Returns - -[`BigNumber`](verida_client_ts._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:18 - -___ - -### pow - -▸ **pow**(`other`): [`BigNumber`](verida_client_ts._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_client_ts._internal_.md#bignumberish) | - -#### Returns - -[`BigNumber`](verida_client_ts._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:16 - -___ - -### shl - -▸ **shl**(`value`): [`BigNumber`](verida_client_ts._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `number` | - -#### Returns - -[`BigNumber`](verida_client_ts._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:21 - -___ - -### shr - -▸ **shr**(`value`): [`BigNumber`](verida_client_ts._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `number` | - -#### Returns - -[`BigNumber`](verida_client_ts._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:22 - -___ - -### sub - -▸ **sub**(`other`): [`BigNumber`](verida_client_ts._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_client_ts._internal_.md#bignumberish) | - -#### Returns - -[`BigNumber`](verida_client_ts._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:12 - -___ - -### toBigInt - -▸ **toBigInt**(): `bigint` - -#### Returns - -`bigint` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:31 - -___ - -### toHexString - -▸ **toHexString**(): `string` - -#### Returns - -`string` - -#### Implementation of - -[Hexable](../interfaces/verida_client_ts._internal_.Hexable.md).[toHexString](../interfaces/verida_client_ts._internal_.Hexable.md#tohexstring) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:33 - -___ - -### toJSON - -▸ **toJSON**(`key?`): `any` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `key?` | `string` | - -#### Returns - -`any` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:34 - -___ - -### toNumber - -▸ **toNumber**(): `number` - -#### Returns - -`number` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:30 - -___ - -### toString - -▸ **toString**(): `string` - -#### Returns - -`string` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:32 - -___ - -### toTwos - -▸ **toTwos**(`value`): [`BigNumber`](verida_client_ts._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `number` | - -#### Returns - -[`BigNumber`](verida_client_ts._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:9 - -___ - -### xor - -▸ **xor**(`other`): [`BigNumber`](verida_client_ts._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_client_ts._internal_.md#bignumberish) | - -#### Returns - -[`BigNumber`](verida_client_ts._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:19 - -___ - -### from - -▸ `Static` **from**(`value`): [`BigNumber`](verida_client_ts._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `any` | - -#### Returns - -[`BigNumber`](verida_client_ts._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:35 - -___ - -### isBigNumber - -▸ `Static` **isBigNumber**(`value`): value is BigNumber - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `any` | - -#### Returns - -value is BigNumber - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:36 diff --git a/docs/api/verida-js/classes/verida_client_ts._internal_.CodeGen.md b/docs/api/verida-js/classes/verida_client_ts._internal_.CodeGen.md deleted file mode 100644 index da81fbc..0000000 --- a/docs/api/verida-js/classes/verida_client_ts._internal_.CodeGen.md +++ /dev/null @@ -1,913 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / CodeGen - -# Class: CodeGen - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).CodeGen - -## Table of contents - -### Constructors - -- [constructor](verida_client_ts._internal_.CodeGen.md#constructor) - -### Properties - -- [\_blockNode](verida_client_ts._internal_.CodeGen.md#_blocknode) -- [\_blockStarts](verida_client_ts._internal_.CodeGen.md#_blockstarts) -- [\_constants](verida_client_ts._internal_.CodeGen.md#_constants) -- [\_def](verida_client_ts._internal_.CodeGen.md#_def) -- [\_elseNode](verida_client_ts._internal_.CodeGen.md#_elsenode) -- [\_endBlockNode](verida_client_ts._internal_.CodeGen.md#_endblocknode) -- [\_extScope](verida_client_ts._internal_.CodeGen.md#_extscope) -- [\_for](verida_client_ts._internal_.CodeGen.md#_for) -- [\_leafNode](verida_client_ts._internal_.CodeGen.md#_leafnode) -- [\_nodes](verida_client_ts._internal_.CodeGen.md#_nodes) -- [\_scope](verida_client_ts._internal_.CodeGen.md#_scope) -- [\_values](verida_client_ts._internal_.CodeGen.md#_values) -- [opts](verida_client_ts._internal_.CodeGen.md#opts) - -### Accessors - -- [\_currNode](verida_client_ts._internal_.CodeGen.md#_currnode) -- [\_root](verida_client_ts._internal_.CodeGen.md#_root) - -### Methods - -- [add](verida_client_ts._internal_.CodeGen.md#add) -- [assign](verida_client_ts._internal_.CodeGen.md#assign) -- [block](verida_client_ts._internal_.CodeGen.md#block) -- [break](verida_client_ts._internal_.CodeGen.md#break) -- [code](verida_client_ts._internal_.CodeGen.md#code) -- [const](verida_client_ts._internal_.CodeGen.md#const) -- [else](verida_client_ts._internal_.CodeGen.md#else) -- [elseIf](verida_client_ts._internal_.CodeGen.md#elseif) -- [endBlock](verida_client_ts._internal_.CodeGen.md#endblock) -- [endFor](verida_client_ts._internal_.CodeGen.md#endfor) -- [endFunc](verida_client_ts._internal_.CodeGen.md#endfunc) -- [endIf](verida_client_ts._internal_.CodeGen.md#endif) -- [for](verida_client_ts._internal_.CodeGen.md#for) -- [forIn](verida_client_ts._internal_.CodeGen.md#forin) -- [forOf](verida_client_ts._internal_.CodeGen.md#forof) -- [forRange](verida_client_ts._internal_.CodeGen.md#forrange) -- [func](verida_client_ts._internal_.CodeGen.md#func) -- [getScopeValue](verida_client_ts._internal_.CodeGen.md#getscopevalue) -- [if](verida_client_ts._internal_.CodeGen.md#if) -- [label](verida_client_ts._internal_.CodeGen.md#label) -- [let](verida_client_ts._internal_.CodeGen.md#let) -- [name](verida_client_ts._internal_.CodeGen.md#name) -- [object](verida_client_ts._internal_.CodeGen.md#object) -- [optimize](verida_client_ts._internal_.CodeGen.md#optimize) -- [return](verida_client_ts._internal_.CodeGen.md#return) -- [scopeCode](verida_client_ts._internal_.CodeGen.md#scopecode) -- [scopeName](verida_client_ts._internal_.CodeGen.md#scopename) -- [scopeRefs](verida_client_ts._internal_.CodeGen.md#scoperefs) -- [scopeValue](verida_client_ts._internal_.CodeGen.md#scopevalue) -- [throw](verida_client_ts._internal_.CodeGen.md#throw) -- [toString](verida_client_ts._internal_.CodeGen.md#tostring) -- [try](verida_client_ts._internal_.CodeGen.md#try) -- [var](verida_client_ts._internal_.CodeGen.md#var) - -## Constructors - -### constructor - -• **new CodeGen**(`extScope`, `opts?`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `extScope` | [`ValueScope`](verida_client_ts._internal_.ValueScope.md) | -| `opts?` | [`CodeGenOptions`](../interfaces/verida_client_ts._internal_.CodeGenOptions.md) | - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/index.d.ts:33 - -## Properties - -### \_blockNode - -• `Private` **\_blockNode**: `any` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/index.d.ts:70 - -___ - -### \_blockStarts - -• `Private` `Readonly` **\_blockStarts**: `any` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/index.d.ts:30 - -___ - -### \_constants - -• `Private` `Readonly` **\_constants**: `any` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/index.d.ts:31 - -___ - -### \_def - -• `Private` **\_def**: `any` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/index.d.ts:41 - -___ - -### \_elseNode - -• `Private` **\_elseNode**: `any` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/index.d.ts:72 - -___ - -### \_endBlockNode - -• `Private` **\_endBlockNode**: `any` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/index.d.ts:71 - -___ - -### \_extScope - -• `Readonly` **\_extScope**: [`ValueScope`](verida_client_ts._internal_.ValueScope.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/index.d.ts:27 - -___ - -### \_for - -• `Private` **\_for**: `any` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/index.d.ts:53 - -___ - -### \_leafNode - -• `Private` **\_leafNode**: `any` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/index.d.ts:69 - -___ - -### \_nodes - -• `Private` `Readonly` **\_nodes**: `any` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/index.d.ts:29 - -___ - -### \_scope - -• `Readonly` **\_scope**: [`Scope`](verida_client_ts._internal_.Scope.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/index.d.ts:26 - -___ - -### \_values - -• `Readonly` **\_values**: [`ScopeValueSets`](../modules/verida_client_ts._internal_.md#scopevaluesets) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/index.d.ts:28 - -___ - -### opts - -• `Private` `Readonly` **opts**: `any` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/index.d.ts:32 - -## Accessors - -### \_currNode - -• `Private` `get` **_currNode**(): `any` - -#### Returns - -`any` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/index.d.ts:74 - -• `Private` `set` **_currNode**(`value`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `any` | - -#### Returns - -`void` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/index.d.ts:75 - -___ - -### \_root - -• `Private` `get` **_root**(): `any` - -#### Returns - -`any` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/index.d.ts:73 - -## Methods - -### add - -▸ **add**(`lhs`, `rhs`): [`CodeGen`](verida_client_ts._internal_.CodeGen.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `lhs` | [`Code`](../modules/verida_client_ts._internal_.md#code) | -| `rhs` | [`SafeExpr`](../modules/verida_client_ts._internal_.md#safeexpr) | - -#### Returns - -[`CodeGen`](verida_client_ts._internal_.CodeGen.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/index.d.ts:46 - -___ - -### assign - -▸ **assign**(`lhs`, `rhs`, `sideEffects?`): [`CodeGen`](verida_client_ts._internal_.CodeGen.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `lhs` | [`Code`](../modules/verida_client_ts._internal_.md#code) | -| `rhs` | [`SafeExpr`](../modules/verida_client_ts._internal_.md#safeexpr) | -| `sideEffects?` | `boolean` | - -#### Returns - -[`CodeGen`](verida_client_ts._internal_.CodeGen.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/index.d.ts:45 - -___ - -### block - -▸ **block**(`body?`, `nodeCount?`): [`CodeGen`](verida_client_ts._internal_.CodeGen.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `body?` | [`Block`](../modules/verida_client_ts._internal_.md#block) | -| `nodeCount?` | `number` | - -#### Returns - -[`CodeGen`](verida_client_ts._internal_.CodeGen.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/index.d.ts:64 - -___ - -### break - -▸ **break**(`label?`): [`CodeGen`](verida_client_ts._internal_.CodeGen.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `label?` | [`Code`](../modules/verida_client_ts._internal_.md#code) | - -#### Returns - -[`CodeGen`](verida_client_ts._internal_.CodeGen.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/index.d.ts:60 - -___ - -### code - -▸ **code**(`c`): [`CodeGen`](verida_client_ts._internal_.CodeGen.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `c` | ``null`` \| `number` \| `boolean` \| [`Name`](verida_client_ts._internal_.Name.md) \| [`_Code`](verida_client_ts._internal_._Code.md) \| () => `void` | - -#### Returns - -[`CodeGen`](verida_client_ts._internal_.CodeGen.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/index.d.ts:47 - -___ - -### const - -▸ **const**(`nameOrPrefix`, `rhs`, `_constant?`): [`Name`](verida_client_ts._internal_.Name.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `nameOrPrefix` | `string` \| [`Name`](verida_client_ts._internal_.Name.md) | -| `rhs` | [`SafeExpr`](../modules/verida_client_ts._internal_.md#safeexpr) | -| `_constant?` | `boolean` | - -#### Returns - -[`Name`](verida_client_ts._internal_.Name.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/index.d.ts:42 - -___ - -### else - -▸ **else**(): [`CodeGen`](verida_client_ts._internal_.CodeGen.md) - -#### Returns - -[`CodeGen`](verida_client_ts._internal_.CodeGen.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/index.d.ts:51 - -___ - -### elseIf - -▸ **elseIf**(`condition`): [`CodeGen`](verida_client_ts._internal_.CodeGen.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `condition` | `boolean` \| [`Code`](../modules/verida_client_ts._internal_.md#code) | - -#### Returns - -[`CodeGen`](verida_client_ts._internal_.CodeGen.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/index.d.ts:50 - -___ - -### endBlock - -▸ **endBlock**(`nodeCount?`): [`CodeGen`](verida_client_ts._internal_.CodeGen.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `nodeCount?` | `number` | - -#### Returns - -[`CodeGen`](verida_client_ts._internal_.CodeGen.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/index.d.ts:65 - -___ - -### endFor - -▸ **endFor**(): [`CodeGen`](verida_client_ts._internal_.CodeGen.md) - -#### Returns - -[`CodeGen`](verida_client_ts._internal_.CodeGen.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/index.d.ts:58 - -___ - -### endFunc - -▸ **endFunc**(): [`CodeGen`](verida_client_ts._internal_.CodeGen.md) - -#### Returns - -[`CodeGen`](verida_client_ts._internal_.CodeGen.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/index.d.ts:67 - -___ - -### endIf - -▸ **endIf**(): [`CodeGen`](verida_client_ts._internal_.CodeGen.md) - -#### Returns - -[`CodeGen`](verida_client_ts._internal_.CodeGen.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/index.d.ts:52 - -___ - -### for - -▸ **for**(`iteration`, `forBody?`): [`CodeGen`](verida_client_ts._internal_.CodeGen.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `iteration` | [`Code`](../modules/verida_client_ts._internal_.md#code) | -| `forBody?` | [`Block`](../modules/verida_client_ts._internal_.md#block) | - -#### Returns - -[`CodeGen`](verida_client_ts._internal_.CodeGen.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/index.d.ts:54 - -___ - -### forIn - -▸ **forIn**(`nameOrPrefix`, `obj`, `forBody`, `varKind?`): [`CodeGen`](verida_client_ts._internal_.CodeGen.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `nameOrPrefix` | `string` \| [`Name`](verida_client_ts._internal_.Name.md) | -| `obj` | [`Code`](../modules/verida_client_ts._internal_.md#code) | -| `forBody` | (`item`: [`Name`](verida_client_ts._internal_.Name.md)) => `void` | -| `varKind?` | [`Code`](../modules/verida_client_ts._internal_.md#code) | - -#### Returns - -[`CodeGen`](verida_client_ts._internal_.CodeGen.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/index.d.ts:57 - -___ - -### forOf - -▸ **forOf**(`nameOrPrefix`, `iterable`, `forBody`, `varKind?`): [`CodeGen`](verida_client_ts._internal_.CodeGen.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `nameOrPrefix` | `string` \| [`Name`](verida_client_ts._internal_.Name.md) | -| `iterable` | [`Code`](../modules/verida_client_ts._internal_.md#code) | -| `forBody` | (`item`: [`Name`](verida_client_ts._internal_.Name.md)) => `void` | -| `varKind?` | [`Code`](../modules/verida_client_ts._internal_.md#code) | - -#### Returns - -[`CodeGen`](verida_client_ts._internal_.CodeGen.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/index.d.ts:56 - -___ - -### forRange - -▸ **forRange**(`nameOrPrefix`, `from`, `to`, `forBody`, `varKind?`): [`CodeGen`](verida_client_ts._internal_.CodeGen.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `nameOrPrefix` | `string` \| [`Name`](verida_client_ts._internal_.Name.md) | -| `from` | [`SafeExpr`](../modules/verida_client_ts._internal_.md#safeexpr) | -| `to` | [`SafeExpr`](../modules/verida_client_ts._internal_.md#safeexpr) | -| `forBody` | (`index`: [`Name`](verida_client_ts._internal_.Name.md)) => `void` | -| `varKind?` | [`Code`](../modules/verida_client_ts._internal_.md#code) | - -#### Returns - -[`CodeGen`](verida_client_ts._internal_.CodeGen.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/index.d.ts:55 - -___ - -### func - -▸ **func**(`name`, `args?`, `async?`, `funcBody?`): [`CodeGen`](verida_client_ts._internal_.CodeGen.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | [`Name`](verida_client_ts._internal_.Name.md) | -| `args?` | [`Code`](../modules/verida_client_ts._internal_.md#code) | -| `async?` | `boolean` | -| `funcBody?` | [`Block`](../modules/verida_client_ts._internal_.md#block) | - -#### Returns - -[`CodeGen`](verida_client_ts._internal_.CodeGen.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/index.d.ts:66 - -___ - -### getScopeValue - -▸ **getScopeValue**(`prefix`, `keyOrRef`): `undefined` \| [`ValueScopeName`](verida_client_ts._internal_.ValueScopeName.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `prefix` | `string` | -| `keyOrRef` | `unknown` | - -#### Returns - -`undefined` \| [`ValueScopeName`](verida_client_ts._internal_.ValueScopeName.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/index.d.ts:38 - -___ - -### if - -▸ **if**(`condition`, `thenBody?`, `elseBody?`): [`CodeGen`](verida_client_ts._internal_.CodeGen.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `condition` | `boolean` \| [`Code`](../modules/verida_client_ts._internal_.md#code) | -| `thenBody?` | [`Block`](../modules/verida_client_ts._internal_.md#block) | -| `elseBody?` | [`Block`](../modules/verida_client_ts._internal_.md#block) | - -#### Returns - -[`CodeGen`](verida_client_ts._internal_.CodeGen.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/index.d.ts:49 - -___ - -### label - -▸ **label**(`label`): [`CodeGen`](verida_client_ts._internal_.CodeGen.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `label` | [`Name`](verida_client_ts._internal_.Name.md) | - -#### Returns - -[`CodeGen`](verida_client_ts._internal_.CodeGen.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/index.d.ts:59 - -___ - -### let - -▸ **let**(`nameOrPrefix`, `rhs?`, `_constant?`): [`Name`](verida_client_ts._internal_.Name.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `nameOrPrefix` | `string` \| [`Name`](verida_client_ts._internal_.Name.md) | -| `rhs?` | [`SafeExpr`](../modules/verida_client_ts._internal_.md#safeexpr) | -| `_constant?` | `boolean` | - -#### Returns - -[`Name`](verida_client_ts._internal_.Name.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/index.d.ts:43 - -___ - -### name - -▸ **name**(`prefix`): [`Name`](verida_client_ts._internal_.Name.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `prefix` | `string` | - -#### Returns - -[`Name`](verida_client_ts._internal_.Name.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/index.d.ts:35 - -___ - -### object - -▸ **object**(...`keyValues`): [`_Code`](verida_client_ts._internal_._Code.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `...keyValues` | [`string` \| [`Name`](verida_client_ts._internal_.Name.md), `string` \| [`SafeExpr`](../modules/verida_client_ts._internal_.md#safeexpr)][] | - -#### Returns - -[`_Code`](verida_client_ts._internal_._Code.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/index.d.ts:48 - -___ - -### optimize - -▸ **optimize**(`n?`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `n?` | `number` | - -#### Returns - -`void` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/index.d.ts:68 - -___ - -### return - -▸ **return**(`value`): [`CodeGen`](verida_client_ts._internal_.CodeGen.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | ``null`` \| `number` \| `boolean` \| [`Name`](verida_client_ts._internal_.Name.md) \| [`_Code`](verida_client_ts._internal_._Code.md) \| () => `void` | - -#### Returns - -[`CodeGen`](verida_client_ts._internal_.CodeGen.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/index.d.ts:61 - -___ - -### scopeCode - -▸ **scopeCode**(): [`Code`](../modules/verida_client_ts._internal_.md#code) - -#### Returns - -[`Code`](../modules/verida_client_ts._internal_.md#code) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/index.d.ts:40 - -___ - -### scopeName - -▸ **scopeName**(`prefix`): [`ValueScopeName`](verida_client_ts._internal_.ValueScopeName.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `prefix` | `string` | - -#### Returns - -[`ValueScopeName`](verida_client_ts._internal_.ValueScopeName.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/index.d.ts:36 - -___ - -### scopeRefs - -▸ **scopeRefs**(`scopeName`): [`Code`](../modules/verida_client_ts._internal_.md#code) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `scopeName` | [`Name`](verida_client_ts._internal_.Name.md) | - -#### Returns - -[`Code`](../modules/verida_client_ts._internal_.md#code) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/index.d.ts:39 - -___ - -### scopeValue - -▸ **scopeValue**(`prefixOrName`, `value`): [`Name`](verida_client_ts._internal_.Name.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `prefixOrName` | `string` \| [`ValueScopeName`](verida_client_ts._internal_.ValueScopeName.md) | -| `value` | [`NameValue`](../interfaces/verida_client_ts._internal_.NameValue.md) | - -#### Returns - -[`Name`](verida_client_ts._internal_.Name.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/index.d.ts:37 - -___ - -### throw - -▸ **throw**(`error`): [`CodeGen`](verida_client_ts._internal_.CodeGen.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `error` | [`Code`](../modules/verida_client_ts._internal_.md#code) | - -#### Returns - -[`CodeGen`](verida_client_ts._internal_.CodeGen.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/index.d.ts:63 - -___ - -### toString - -▸ **toString**(): `string` - -#### Returns - -`string` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/index.d.ts:34 - -___ - -### try - -▸ **try**(`tryBody`, `catchCode?`, `finallyCode?`): [`CodeGen`](verida_client_ts._internal_.CodeGen.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `tryBody` | [`Block`](../modules/verida_client_ts._internal_.md#block) | -| `catchCode?` | (`e`: [`Name`](verida_client_ts._internal_.Name.md)) => `void` | -| `finallyCode?` | [`Block`](../modules/verida_client_ts._internal_.md#block) | - -#### Returns - -[`CodeGen`](verida_client_ts._internal_.CodeGen.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/index.d.ts:62 - -___ - -### var - -▸ **var**(`nameOrPrefix`, `rhs?`, `_constant?`): [`Name`](verida_client_ts._internal_.Name.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `nameOrPrefix` | `string` \| [`Name`](verida_client_ts._internal_.Name.md) | -| `rhs?` | [`SafeExpr`](../modules/verida_client_ts._internal_.md#safeexpr) | -| `_constant?` | `boolean` | - -#### Returns - -[`Name`](verida_client_ts._internal_.Name.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/index.d.ts:44 diff --git a/docs/api/verida-js/classes/verida_client_ts._internal_.DIDClient.md b/docs/api/verida-js/classes/verida_client_ts._internal_.DIDClient.md deleted file mode 100644 index 291e64a..0000000 --- a/docs/api/verida-js/classes/verida_client_ts._internal_.DIDClient.md +++ /dev/null @@ -1,305 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / DIDClient - -# Class: DIDClient - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).DIDClient - -## Implements - -- [`IDIDClient`](../interfaces/verida_client_ts._internal_.IDIDClient.md) - -## Table of contents - -### Constructors - -- [constructor](verida_client_ts._internal_.DIDClient.md#constructor) - -### Properties - -- [config](verida_client_ts._internal_.DIDClient.md#config) -- [defaultEndpoints](verida_client_ts._internal_.DIDClient.md#defaultendpoints) -- [didResolver](verida_client_ts._internal_.DIDClient.md#didresolver) -- [endpointErrors](verida_client_ts._internal_.DIDClient.md#endpointerrors) -- [vdaDid](verida_client_ts._internal_.DIDClient.md#vdadid) -- [veridaWallet](verida_client_ts._internal_.DIDClient.md#veridawallet) - -### Methods - -- [authenticate](verida_client_ts._internal_.DIDClient.md#authenticate) -- [authenticated](verida_client_ts._internal_.DIDClient.md#authenticated) -- [destroy](verida_client_ts._internal_.DIDClient.md#destroy) -- [get](verida_client_ts._internal_.DIDClient.md#get) -- [getDid](verida_client_ts._internal_.DIDClient.md#getdid) -- [getLastEndpointErrors](verida_client_ts._internal_.DIDClient.md#getlastendpointerrors) -- [getPublicKey](verida_client_ts._internal_.DIDClient.md#getpublickey) -- [getRpcUrl](verida_client_ts._internal_.DIDClient.md#getrpcurl) -- [save](verida_client_ts._internal_.DIDClient.md#save) - -## Constructors - -### constructor - -• **new DIDClient**(`config`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | [`DIDClientConfig`](../interfaces/verida_client_ts._internal_.DIDClientConfig.md) | - -#### Defined in - -packages/did-client/dist/did-client.d.ts:10 - -## Properties - -### config - -• `Private` **config**: `any` - -#### Defined in - -packages/did-client/dist/did-client.d.ts:4 - -___ - -### defaultEndpoints - -• `Private` `Optional` **defaultEndpoints**: `any` - -#### Defined in - -packages/did-client/dist/did-client.d.ts:8 - -___ - -### didResolver - -• `Private` **didResolver**: `any` - -#### Defined in - -packages/did-client/dist/did-client.d.ts:5 - -___ - -### endpointErrors - -• `Private` `Optional` **endpointErrors**: `any` - -#### Defined in - -packages/did-client/dist/did-client.d.ts:9 - -___ - -### vdaDid - -• `Private` `Optional` **vdaDid**: `any` - -#### Defined in - -packages/did-client/dist/did-client.d.ts:6 - -___ - -### veridaWallet - -• `Private` **veridaWallet**: `any` - -#### Defined in - -packages/did-client/dist/did-client.d.ts:7 - -## Methods - -### authenticate - -▸ **authenticate**(`veridaPrivateKey`, `callType`, `web3Config`, `defaultEndpoints`): `void` - -Unlock save() function by providing verida signing key. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `veridaPrivateKey` | `string` | Private key of a Verida Account. Used to sign transactions in the DID Registry to verify the request originated from the DID owner / controller | -| `callType` | [`Web3CallType`](../modules/verida_client_ts._internal_.md#web3calltype) | Blockchain interaction mode. 'web3' \| 'gasless' | -| `web3Config` | [`Web3SelfTransactionConfigPart`](../interfaces/verida_client_ts._internal_.Web3SelfTransactionConfigPart.md) \| [`Web3MetaTransactionConfig`](../interfaces/verida_client_ts._internal_.Web3MetaTransactionConfig.md) | Web3 configuration. If `web3`, you must provide `privateKey` (MATIC private key that will pay for gas). If `gasless` you must specify `endpointUrl` (URL of the meta transaction server) and any appropriate `serverConfig` and `postConfig`. | -| `defaultEndpoints` | `string`[] | - | - -#### Returns - -`void` - -#### Implementation of - -[IDIDClient](../interfaces/verida_client_ts._internal_.IDIDClient.md).[authenticate](../interfaces/verida_client_ts._internal_.IDIDClient.md#authenticate) - -#### Defined in - -packages/did-client/dist/did-client.d.ts:19 - -___ - -### authenticated - -▸ **authenticated**(): `boolean` - -#### Returns - -`boolean` - -#### Implementation of - -[IDIDClient](../interfaces/verida_client_ts._internal_.IDIDClient.md).[authenticated](../interfaces/verida_client_ts._internal_.IDIDClient.md#authenticated) - -#### Defined in - -packages/did-client/dist/did-client.d.ts:20 - -___ - -### destroy - -▸ **destroy**(): `Promise`<[`VdaDidEndpointResponses`](../modules/verida_client_ts._internal_.md#vdadidendpointresponses)\> - -Destroy this DID - -Note: This can not be reversed and is written to the blockchain - -#### Returns - -`Promise`<[`VdaDidEndpointResponses`](../modules/verida_client_ts._internal_.md#vdadidendpointresponses)\> - -#### Defined in - -packages/did-client/dist/did-client.d.ts:28 - -___ - -### get - -▸ **get**(`did`): `Promise`<[`default`](verida_client_ts._internal_.default-1.md)\> - -Get original document loaded from blockchain. Creates a new document if it didn't exist - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did` | `string` | - -#### Returns - -`Promise`<[`default`](verida_client_ts._internal_.default-1.md)\> - -DID Document instance - -#### Implementation of - -[IDIDClient](../interfaces/verida_client_ts._internal_.IDIDClient.md).[get](../interfaces/verida_client_ts._internal_.IDIDClient.md#get) - -#### Defined in - -packages/did-client/dist/did-client.d.ts:42 - -___ - -### getDid - -▸ **getDid**(): `undefined` \| `string` - -#### Returns - -`undefined` \| `string` - -#### Implementation of - -[IDIDClient](../interfaces/verida_client_ts._internal_.IDIDClient.md).[getDid](../interfaces/verida_client_ts._internal_.IDIDClient.md#getdid) - -#### Defined in - -packages/did-client/dist/did-client.d.ts:21 - -___ - -### getLastEndpointErrors - -▸ **getLastEndpointErrors**(): [`VdaDidEndpointResponses`](../modules/verida_client_ts._internal_.md#vdadidendpointresponses) - -#### Returns - -[`VdaDidEndpointResponses`](../modules/verida_client_ts._internal_.md#vdadidendpointresponses) - -#### Implementation of - -[IDIDClient](../interfaces/verida_client_ts._internal_.IDIDClient.md).[getLastEndpointErrors](../interfaces/verida_client_ts._internal_.IDIDClient.md#getlastendpointerrors) - -#### Defined in - -packages/did-client/dist/did-client.d.ts:36 - -___ - -### getPublicKey - -▸ **getPublicKey**(): `undefined` \| `string` - -#### Returns - -`undefined` \| `string` - -#### Implementation of - -[IDIDClient](../interfaces/verida_client_ts._internal_.IDIDClient.md).[getPublicKey](../interfaces/verida_client_ts._internal_.IDIDClient.md#getpublickey) - -#### Defined in - -packages/did-client/dist/did-client.d.ts:22 - -___ - -### getRpcUrl - -▸ **getRpcUrl**(): `string` - -#### Returns - -`string` - -#### Implementation of - -[IDIDClient](../interfaces/verida_client_ts._internal_.IDIDClient.md).[getRpcUrl](../interfaces/verida_client_ts._internal_.IDIDClient.md#getrpcurl) - -#### Defined in - -packages/did-client/dist/did-client.d.ts:11 - -___ - -### save - -▸ **save**(`document`): `Promise`<[`VdaDidEndpointResponses`](../modules/verida_client_ts._internal_.md#vdadidendpointresponses)\> - -Save DIDDocument to the chain - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `document` | [`default`](verida_client_ts._internal_.default-1.md) | Updated DIDDocuent | - -#### Returns - -`Promise`<[`VdaDidEndpointResponses`](../modules/verida_client_ts._internal_.md#vdadidendpointresponses)\> - -true if success. - -#### Implementation of - -[IDIDClient](../interfaces/verida_client_ts._internal_.IDIDClient.md).[save](../interfaces/verida_client_ts._internal_.IDIDClient.md#save) - -#### Defined in - -packages/did-client/dist/did-client.d.ts:35 diff --git a/docs/api/verida-js/classes/verida_client_ts._internal_.DIDContextManager.md b/docs/api/verida-js/classes/verida_client_ts._internal_.DIDContextManager.md deleted file mode 100644 index 28af3b3..0000000 --- a/docs/api/verida-js/classes/verida_client_ts._internal_.DIDContextManager.md +++ /dev/null @@ -1,201 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / DIDContextManager - -# Class: DIDContextManager - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).DIDContextManager - -## Table of contents - -### Constructors - -- [constructor](verida_client_ts._internal_.DIDContextManager.md#constructor) - -### Properties - -- [account](verida_client_ts._internal_.DIDContextManager.md#account) -- [didClient](verida_client_ts._internal_.DIDContextManager.md#didclient) -- [didContexts](verida_client_ts._internal_.DIDContextManager.md#didcontexts) - -### Methods - -- [getContextDatabaseServer](verida_client_ts._internal_.DIDContextManager.md#getcontextdatabaseserver) -- [getContextMessageServer](verida_client_ts._internal_.DIDContextManager.md#getcontextmessageserver) -- [getContextStorageServer](verida_client_ts._internal_.DIDContextManager.md#getcontextstorageserver) -- [getDIDContextConfig](verida_client_ts._internal_.DIDContextManager.md#getdidcontextconfig) -- [getDIDContextHashConfig](verida_client_ts._internal_.DIDContextManager.md#getdidcontexthashconfig) -- [setAccount](verida_client_ts._internal_.DIDContextManager.md#setaccount) - -## Constructors - -### constructor - -• **new DIDContextManager**(`didClient`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `didClient` | [`DIDClient`](verida_client_ts._internal_.DIDClient.md) | - -#### Defined in - -[packages/client-ts/src/did-context-manager.ts:22](https://github.com/verida/verida-js/blob/5040472/packages/client-ts/src/did-context-manager.ts#L22) - -## Properties - -### account - -• `Private` `Optional` **account**: [`IAccount`](../interfaces/verida_client_ts._internal_.IAccount.md) - -#### Defined in - -[packages/client-ts/src/did-context-manager.ts:20](https://github.com/verida/verida-js/blob/5040472/packages/client-ts/src/did-context-manager.ts#L20) - -___ - -### didClient - -• `Private` **didClient**: [`DIDClient`](verida_client_ts._internal_.DIDClient.md) - -#### Defined in - -[packages/client-ts/src/did-context-manager.ts:19](https://github.com/verida/verida-js/blob/5040472/packages/client-ts/src/did-context-manager.ts#L19) - -___ - -### didContexts - -• `Private` **didContexts**: [`DIDContextConfigs`](../interfaces/verida_client_ts._internal_.DIDContextConfigs.md) = `{}` - -#### Defined in - -[packages/client-ts/src/did-context-manager.ts:17](https://github.com/verida/verida-js/blob/5040472/packages/client-ts/src/did-context-manager.ts#L17) - -## Methods - -### getContextDatabaseServer - -▸ **getContextDatabaseServer**(`did`, `contextName`, `forceCreate?`): `Promise`<[`SecureContextEndpoint`](../interfaces/verida_client_ts._internal_.SecureContextEndpoint.md)\> - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `did` | `string` | `undefined` | -| `contextName` | `string` | `undefined` | -| `forceCreate` | `boolean` | `true` | - -#### Returns - -`Promise`<[`SecureContextEndpoint`](../interfaces/verida_client_ts._internal_.SecureContextEndpoint.md)\> - -#### Defined in - -[packages/client-ts/src/did-context-manager.ts:30](https://github.com/verida/verida-js/blob/5040472/packages/client-ts/src/did-context-manager.ts#L30) - -___ - -### getContextMessageServer - -▸ **getContextMessageServer**(`did`, `contextName`, `forceCreate?`): `Promise`<[`SecureContextEndpoint`](../interfaces/verida_client_ts._internal_.SecureContextEndpoint.md)\> - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `did` | `string` | `undefined` | -| `contextName` | `string` | `undefined` | -| `forceCreate` | `boolean` | `true` | - -#### Returns - -`Promise`<[`SecureContextEndpoint`](../interfaces/verida_client_ts._internal_.SecureContextEndpoint.md)\> - -#### Defined in - -[packages/client-ts/src/did-context-manager.ts:60](https://github.com/verida/verida-js/blob/5040472/packages/client-ts/src/did-context-manager.ts#L60) - -___ - -### getContextStorageServer - -▸ **getContextStorageServer**(`did`, `contextName`, `forceCreate?`): `Promise`<[`SecureContextEndpoint`](../interfaces/verida_client_ts._internal_.SecureContextEndpoint.md)\> - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `did` | `string` | `undefined` | -| `contextName` | `string` | `undefined` | -| `forceCreate` | `boolean` | `true` | - -#### Returns - -`Promise`<[`SecureContextEndpoint`](../interfaces/verida_client_ts._internal_.SecureContextEndpoint.md)\> - -#### Defined in - -[packages/client-ts/src/did-context-manager.ts:43](https://github.com/verida/verida-js/blob/5040472/packages/client-ts/src/did-context-manager.ts#L43) - -___ - -### getDIDContextConfig - -▸ **getDIDContextConfig**(`did`, `contextName`, `forceCreate?`): `Promise`<[`SecureContextConfig`](../interfaces/verida_client_ts._internal_.SecureContextConfig.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did` | `string` | -| `contextName` | `string` | -| `forceCreate?` | `boolean` | - -#### Returns - -`Promise`<[`SecureContextConfig`](../interfaces/verida_client_ts._internal_.SecureContextConfig.md)\> - -#### Defined in - -[packages/client-ts/src/did-context-manager.ts:94](https://github.com/verida/verida-js/blob/5040472/packages/client-ts/src/did-context-manager.ts#L94) - -___ - -### getDIDContextHashConfig - -▸ **getDIDContextHashConfig**(`did`, `contextHash`): `Promise`<[`SecureContextConfig`](../interfaces/verida_client_ts._internal_.SecureContextConfig.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did` | `string` | -| `contextHash` | `string` | - -#### Returns - -`Promise`<[`SecureContextConfig`](../interfaces/verida_client_ts._internal_.SecureContextConfig.md)\> - -#### Defined in - -[packages/client-ts/src/did-context-manager.ts:73](https://github.com/verida/verida-js/blob/5040472/packages/client-ts/src/did-context-manager.ts#L73) - -___ - -### setAccount - -▸ **setAccount**(`account`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `account` | [`IAccount`](../interfaces/verida_client_ts._internal_.IAccount.md) | - -#### Returns - -`void` - -#### Defined in - -[packages/client-ts/src/did-context-manager.ts:26](https://github.com/verida/verida-js/blob/5040472/packages/client-ts/src/did-context-manager.ts#L26) diff --git a/docs/api/verida-js/classes/verida_client_ts._internal_.Datastore.md b/docs/api/verida-js/classes/verida_client_ts._internal_.Datastore.md deleted file mode 100644 index b4d4d22..0000000 --- a/docs/api/verida-js/classes/verida_client_ts._internal_.Datastore.md +++ /dev/null @@ -1,491 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / Datastore - -# Class: Datastore - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).Datastore - -## Implements - -- [`IDatastore`](../interfaces/verida_client_ts._internal_.IDatastore.md) - -## Table of contents - -### Constructors - -- [constructor](verida_client_ts._internal_.Datastore.md#constructor) - -### Properties - -- [config](verida_client_ts._internal_.Datastore.md#config) -- [context](verida_client_ts._internal_.Datastore.md#context) -- [db](verida_client_ts._internal_.Datastore.md#db) -- [errors](verida_client_ts._internal_.Datastore.md#errors) -- [schema](verida_client_ts._internal_.Datastore.md#schema) -- [schemaName](verida_client_ts._internal_.Datastore.md#schemaname) -- [schemaPath](verida_client_ts._internal_.Datastore.md#schemapath) - -### Methods - -- [changes](verida_client_ts._internal_.Datastore.md#changes) -- [close](verida_client_ts._internal_.Datastore.md#close) -- [delete](verida_client_ts._internal_.Datastore.md#delete) -- [deleteAll](verida_client_ts._internal_.Datastore.md#deleteall) -- [ensureIndexes](verida_client_ts._internal_.Datastore.md#ensureindexes) -- [get](verida_client_ts._internal_.Datastore.md#get) -- [getDb](verida_client_ts._internal_.Datastore.md#getdb) -- [getMany](verida_client_ts._internal_.Datastore.md#getmany) -- [getOne](verida_client_ts._internal_.Datastore.md#getone) -- [init](verida_client_ts._internal_.Datastore.md#init) -- [save](verida_client_ts._internal_.Datastore.md#save) -- [updateUsers](verida_client_ts._internal_.Datastore.md#updateusers) - -## Constructors - -### constructor - -• **new Datastore**(`schemaName`, `context`, `config?`) - -Create a new Datastore. - -**Do not instantiate directly.** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schemaName` | `string` | -| `context` | [`Context`](verida_client_ts.Context.md) | -| `config` | [`DatastoreOpenConfig`](../interfaces/verida_client_ts._internal_.DatastoreOpenConfig.md) | - -#### Defined in - -[packages/client-ts/src/context/datastore.ts:41](https://github.com/verida/verida-js/blob/5040472/packages/client-ts/src/context/datastore.ts#L41) - -## Properties - -### config - -• `Protected` **config**: [`DatastoreOpenConfig`](../interfaces/verida_client_ts._internal_.DatastoreOpenConfig.md) - -#### Defined in - -[packages/client-ts/src/context/datastore.ts:23](https://github.com/verida/verida-js/blob/5040472/packages/client-ts/src/context/datastore.ts#L23) - -___ - -### context - -• `Protected` **context**: [`Context`](verida_client_ts.Context.md) - -#### Defined in - -[packages/client-ts/src/context/datastore.ts:22](https://github.com/verida/verida-js/blob/5040472/packages/client-ts/src/context/datastore.ts#L22) - -___ - -### db - -• `Private` **db**: `any` - -#### Defined in - -[packages/client-ts/src/context/datastore.ts:25](https://github.com/verida/verida-js/blob/5040472/packages/client-ts/src/context/datastore.ts#L25) - -___ - -### errors - -• **errors**: `object` = `{}` - -A list of the latest database errors. - -Any errors from saving a record will be available on this public object. - -The errors remain until they are replaced by any new errors. - -#### Implementation of - -[IDatastore](../interfaces/verida_client_ts._internal_.IDatastore.md).[errors](../interfaces/verida_client_ts._internal_.IDatastore.md#errors) - -#### Defined in - -[packages/client-ts/src/context/datastore.ts:34](https://github.com/verida/verida-js/blob/5040472/packages/client-ts/src/context/datastore.ts#L34) - -___ - -### schema - -• `Protected` `Optional` **schema**: `any` - -#### Defined in - -[packages/client-ts/src/context/datastore.ts:20](https://github.com/verida/verida-js/blob/5040472/packages/client-ts/src/context/datastore.ts#L20) - -___ - -### schemaName - -• `Protected` **schemaName**: `string` - -#### Defined in - -[packages/client-ts/src/context/datastore.ts:18](https://github.com/verida/verida-js/blob/5040472/packages/client-ts/src/context/datastore.ts#L18) - -___ - -### schemaPath - -• `Protected` `Optional` **schemaPath**: `string` - -#### Defined in - -[packages/client-ts/src/context/datastore.ts:19](https://github.com/verida/verida-js/blob/5040472/packages/client-ts/src/context/datastore.ts#L19) - -## Methods - -### changes - -▸ **changes**(`cb`, `options?`): `Promise`<`any`\> - -Bind to changes to this datastore - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `cb` | `any` | Callback function that fires when new data is received | -| `options` | `any` | Options to be passed to the listener. See https://pouchdb.com/api.html#changes | - -#### Returns - -`Promise`<`any`\> - -Returns an object with a `.cancel()` method to cancel the listener - -#### Implementation of - -[IDatastore](../interfaces/verida_client_ts._internal_.IDatastore.md).[changes](../interfaces/verida_client_ts._internal_.IDatastore.md#changes) - -#### Defined in - -[packages/client-ts/src/context/datastore.ts:195](https://github.com/verida/verida-js/blob/5040472/packages/client-ts/src/context/datastore.ts#L195) - -___ - -### close - -▸ **close**(`options?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options` | [`DatabaseCloseOptions`](../interfaces/verida_client_ts._internal_.DatabaseCloseOptions.md) | - -#### Returns - -`Promise`<`void`\> - -#### Implementation of - -[IDatastore](../interfaces/verida_client_ts._internal_.IDatastore.md).[close](../interfaces/verida_client_ts._internal_.IDatastore.md#close) - -#### Defined in - -[packages/client-ts/src/context/datastore.ts:264](https://github.com/verida/verida-js/blob/5040472/packages/client-ts/src/context/datastore.ts#L264) - -___ - -### delete - -▸ **delete**(`docId`): `Promise`<`any`\> - -Delete a record by ID. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `docId` | `string` | Unique ID of the record to delete | - -#### Returns - -`Promise`<`any`\> - -#### Implementation of - -[IDatastore](../interfaces/verida_client_ts._internal_.IDatastore.md).[delete](../interfaces/verida_client_ts._internal_.IDatastore.md#delete) - -#### Defined in - -[packages/client-ts/src/context/datastore.ts:168](https://github.com/verida/verida-js/blob/5040472/packages/client-ts/src/context/datastore.ts#L168) - -___ - -### deleteAll - -▸ **deleteAll**(): `Promise`<`void`\> - -#### Returns - -`Promise`<`void`\> - -#### Implementation of - -[IDatastore](../interfaces/verida_client_ts._internal_.IDatastore.md).[deleteAll](../interfaces/verida_client_ts._internal_.IDatastore.md#deleteall) - -#### Defined in - -[packages/client-ts/src/context/datastore.ts:173](https://github.com/verida/verida-js/blob/5040472/packages/client-ts/src/context/datastore.ts#L173) - -___ - -### ensureIndexes - -▸ **ensureIndexes**(`indexes`): `Promise`<`void`\> - -**`todo:`** Support removing indexes that were deleted from the spec - -**`todo:`** Validate indexes - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `indexes` | `any` | - -#### Returns - -`Promise`<`void`\> - -#### Implementation of - -[IDatastore](../interfaces/verida_client_ts._internal_.IDatastore.md).[ensureIndexes](../interfaces/verida_client_ts._internal_.IDatastore.md#ensureindexes) - -#### Defined in - -[packages/client-ts/src/context/datastore.ts:239](https://github.com/verida/verida-js/blob/5040472/packages/client-ts/src/context/datastore.ts#L239) - -___ - -### get - -▸ **get**(`key`, `options?`): `Promise`<`any`\> - -Get a record by ID. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `key` | `string` | Unique ID of the record to fetch | -| `options` | `any` | - | - -#### Returns - -`Promise`<`any`\> - -#### Implementation of - -[IDatastore](../interfaces/verida_client_ts._internal_.IDatastore.md).[get](../interfaces/verida_client_ts._internal_.IDatastore.md#get) - -#### Defined in - -[packages/client-ts/src/context/datastore.ts:158](https://github.com/verida/verida-js/blob/5040472/packages/client-ts/src/context/datastore.ts#L158) - -___ - -### getDb - -▸ **getDb**(): `Promise`<`any`\> - -Get the underlying database instance associated with this datastore. - -**Note: Do not use unless you know what you're doing as you can easily corrupt a database by breaking schema data.** - -#### Returns - -`Promise`<`any`\> - -#### Implementation of - -[IDatastore](../interfaces/verida_client_ts._internal_.IDatastore.md).[getDb](../interfaces/verida_client_ts._internal_.IDatastore.md#getdb) - -#### Defined in - -[packages/client-ts/src/context/datastore.ts:183](https://github.com/verida/verida-js/blob/5040472/packages/client-ts/src/context/datastore.ts#L183) - -___ - -### getMany - -▸ **getMany**(`customFilter?`, `options?`): `Promise`<`object`[]\> - -Fetch a list of records from this Datastore. - -Only returns records that belong to this Datastore's schema. - -Example filters and options: - -``` -let filter = { - organization: 'Google' -}; - -let options = { - limit: 20, - skip: 0, - sort: ['firstName' -}; -``` - -**`example`** -let results = datastore.getMany({ - name: 'John' -}); - -console.log(results); - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `customFilter` | `any` | -| `options` | `any` | - -#### Returns - -`Promise`<`object`[]\> - -An array of database records. - -#### Implementation of - -[IDatastore](../interfaces/verida_client_ts._internal_.IDatastore.md).[getMany](../interfaces/verida_client_ts._internal_.IDatastore.md#getmany) - -#### Defined in - -[packages/client-ts/src/context/datastore.ts:119](https://github.com/verida/verida-js/blob/5040472/packages/client-ts/src/context/datastore.ts#L119) - -___ - -### getOne - -▸ **getOne**(`customFilter?`, `options?`): `Promise`<`undefined` \| `object`\> - -Get a single database record that matches. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `customFilter` | `any` | -| `options` | `any` | - -#### Returns - -`Promise`<`undefined` \| `object`\> - -A database record - -#### Implementation of - -[IDatastore](../interfaces/verida_client_ts._internal_.IDatastore.md).[getOne](../interfaces/verida_client_ts._internal_.IDatastore.md#getone) - -#### Defined in - -[packages/client-ts/src/context/datastore.ts:142](https://github.com/verida/verida-js/blob/5040472/packages/client-ts/src/context/datastore.ts#L142) - -___ - -### init - -▸ `Private` **init**(): `Promise`<`void`\> - -Initialize this datastore instance before use. - -**`todo:`** move this into context.openDatastore??? - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -[packages/client-ts/src/context/datastore.ts:205](https://github.com/verida/verida-js/blob/5040472/packages/client-ts/src/context/datastore.ts#L205) - -___ - -### save - -▸ **save**(`data`, `options?`): `Promise`<`boolean` \| `object`\> - -Save data to an application schema. - -**`fires`** Database#beforeInsert Event fired before inserting a new record - -**`fires`** Database#beforeUpdate Event fired before updating a new record - -**`fires`** Database#afterInsert Event fired after inserting a new record - -**`fires`** Database#afterUpdate Event fired after updating a new record - -**`example`** -let result = await datastore.save({ - "firstName": "John", - "lastName": "Doe" -}); - -if (!result) { - console.errors(datastore.errors); -} else { - console.log("Successfully saved"); -} - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `data` | `any` | Data to be saved. Will be validated against the schema associated with this Datastore. | -| `options` | `any` | - | - -#### Returns - -`Promise`<`boolean` \| `object`\> - -Boolean indicating if the save was successful. If not successful `this.errors` will be populated. - -#### Implementation of - -[IDatastore](../interfaces/verida_client_ts._internal_.IDatastore.md).[save](../interfaces/verida_client_ts._internal_.IDatastore.md#save) - -#### Defined in - -[packages/client-ts/src/context/datastore.ts:75](https://github.com/verida/verida-js/blob/5040472/packages/client-ts/src/context/datastore.ts#L75) - -___ - -### updateUsers - -▸ **updateUsers**(`readList?`, `writeList?`): `Promise`<`void`\> - -Update the list of valid users for this datastore. - -#### Parameters - -| Name | Type | Default value | Description | -| :------ | :------ | :------ | :------ | -| `readList` | `string`[] | `[]` | List of DID's that can read from this datastore. | -| `writeList` | `string`[] | `[]` | List of DID's that can write to this datastore. | - -#### Returns - -`Promise`<`void`\> - -#### Implementation of - -[IDatastore](../interfaces/verida_client_ts._internal_.IDatastore.md).[updateUsers](../interfaces/verida_client_ts._internal_.IDatastore.md#updateusers) - -#### Defined in - -[packages/client-ts/src/context/datastore.ts:256](https://github.com/verida/verida-js/blob/5040472/packages/client-ts/src/context/datastore.ts#L256) diff --git a/docs/api/verida-js/classes/verida_client_ts._internal_.DbRegistry.md b/docs/api/verida-js/classes/verida_client_ts._internal_.DbRegistry.md deleted file mode 100644 index c7dd713..0000000 --- a/docs/api/verida-js/classes/verida_client_ts._internal_.DbRegistry.md +++ /dev/null @@ -1,207 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / DbRegistry - -# Class: DbRegistry - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).DbRegistry - -## Implements - -- [`IDbRegistry`](../interfaces/verida_client_ts._internal_.IDbRegistry.md) - -## Table of contents - -### Constructors - -- [constructor](verida_client_ts._internal_.DbRegistry.md#constructor) - -### Properties - -- [context](verida_client_ts._internal_.DbRegistry.md#context) -- [dbStore](verida_client_ts._internal_.DbRegistry.md#dbstore) - -### Methods - -- [buildDatabaseId](verida_client_ts._internal_.DbRegistry.md#builddatabaseid) -- [get](verida_client_ts._internal_.DbRegistry.md#get) -- [getMany](verida_client_ts._internal_.DbRegistry.md#getmany) -- [init](verida_client_ts._internal_.DbRegistry.md#init) -- [removeDb](verida_client_ts._internal_.DbRegistry.md#removedb) -- [saveDb](verida_client_ts._internal_.DbRegistry.md#savedb) - -## Constructors - -### constructor - -• **new DbRegistry**(`context`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `context` | [`Context`](verida_client_ts.Context.md) | - -#### Defined in - -[packages/client-ts/src/context/db-registry.ts:20](https://github.com/verida/verida-js/blob/5040472/packages/client-ts/src/context/db-registry.ts#L20) - -## Properties - -### context - -• `Private` **context**: [`Context`](verida_client_ts.Context.md) - -#### Defined in - -[packages/client-ts/src/context/db-registry.ts:17](https://github.com/verida/verida-js/blob/5040472/packages/client-ts/src/context/db-registry.ts#L17) - -___ - -### dbStore - -• `Private` `Optional` **dbStore**: [`Datastore`](verida_client_ts._internal_.Datastore.md) - -#### Defined in - -[packages/client-ts/src/context/db-registry.ts:18](https://github.com/verida/verida-js/blob/5040472/packages/client-ts/src/context/db-registry.ts#L18) - -## Methods - -### buildDatabaseId - -▸ `Private` **buildDatabaseId**(`dbName`, `did`, `contextName`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `dbName` | `string` | -| `did` | `string` | -| `contextName` | `string` | - -#### Returns - -`string` - -#### Defined in - -[packages/client-ts/src/context/db-registry.ts:117](https://github.com/verida/verida-js/blob/5040472/packages/client-ts/src/context/db-registry.ts#L117) - -___ - -### get - -▸ **get**(`dbName`, `did`, `contextName`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `dbName` | `string` | -| `did` | `string` | -| `contextName` | `string` | - -#### Returns - -`Promise`<`any`\> - -#### Implementation of - -[IDbRegistry](../interfaces/verida_client_ts._internal_.IDbRegistry.md).[get](../interfaces/verida_client_ts._internal_.IDbRegistry.md#get) - -#### Defined in - -[packages/client-ts/src/context/db-registry.ts:97](https://github.com/verida/verida-js/blob/5040472/packages/client-ts/src/context/db-registry.ts#L97) - -___ - -### getMany - -▸ **getMany**(`filter?`, `options?`): `Promise`<`object`[]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `filter` | `any` | -| `options` | `any` | - -#### Returns - -`Promise`<`object`[]\> - -#### Implementation of - -[IDbRegistry](../interfaces/verida_client_ts._internal_.IDbRegistry.md).[getMany](../interfaces/verida_client_ts._internal_.IDbRegistry.md#getmany) - -#### Defined in - -[packages/client-ts/src/context/db-registry.ts:91](https://github.com/verida/verida-js/blob/5040472/packages/client-ts/src/context/db-registry.ts#L91) - -___ - -### init - -▸ **init**(): `Promise`<`void`\> - -#### Returns - -`Promise`<`void`\> - -#### Implementation of - -[IDbRegistry](../interfaces/verida_client_ts._internal_.IDbRegistry.md).[init](../interfaces/verida_client_ts._internal_.IDbRegistry.md#init) - -#### Defined in - -[packages/client-ts/src/context/db-registry.ts:132](https://github.com/verida/verida-js/blob/5040472/packages/client-ts/src/context/db-registry.ts#L132) - -___ - -### removeDb - -▸ **removeDb**(`databaseName`, `did`, `contextName`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `databaseName` | `string` | -| `did` | `string` | -| `contextName` | `string` | - -#### Returns - -`Promise`<`boolean`\> - -#### Implementation of - -[IDbRegistry](../interfaces/verida_client_ts._internal_.IDbRegistry.md).[removeDb](../interfaces/verida_client_ts._internal_.IDbRegistry.md#removedb) - -#### Defined in - -[packages/client-ts/src/context/db-registry.ts:79](https://github.com/verida/verida-js/blob/5040472/packages/client-ts/src/context/db-registry.ts#L79) - -___ - -### saveDb - -▸ **saveDb**(`database`, `checkPermissions?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `database` | [`IDatabase`](../interfaces/verida_client_ts._internal_.IDatabase.md) | `undefined` | -| `checkPermissions` | `boolean` | `true` | - -#### Returns - -`Promise`<`void`\> - -#### Implementation of - -[IDbRegistry](../interfaces/verida_client_ts._internal_.IDbRegistry.md).[saveDb](../interfaces/verida_client_ts._internal_.IDbRegistry.md#savedb) - -#### Defined in - -[packages/client-ts/src/context/db-registry.ts:33](https://github.com/verida/verida-js/blob/5040472/packages/client-ts/src/context/db-registry.ts#L33) diff --git a/docs/api/verida-js/classes/verida_client_ts._internal_.Description.md b/docs/api/verida-js/classes/verida_client_ts._internal_.Description.md deleted file mode 100644 index e278799..0000000 --- a/docs/api/verida-js/classes/verida_client_ts._internal_.Description.md +++ /dev/null @@ -1,45 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / Description - -# Class: Description - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).Description - -## Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `any` | - -## Hierarchy - -- **`Description`** - - ↳ [`ForkEvent`](verida_client_ts._internal_.ForkEvent.md) - -## Table of contents - -### Constructors - -- [constructor](verida_client_ts._internal_.Description.md#constructor) - -## Constructors - -### constructor - -• **new Description**<`T`\>(`info`) - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `any` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `info` | { [K in string \| number \| symbol]: T[K] } | - -#### Defined in - -node_modules/@ethersproject/properties/lib/index.d.ts:13 diff --git a/docs/api/verida-js/classes/verida_client_ts._internal_.EventEmitter-1.md b/docs/api/verida-js/classes/verida_client_ts._internal_.EventEmitter-1.md deleted file mode 100644 index 4d1296e..0000000 --- a/docs/api/verida-js/classes/verida_client_ts._internal_.EventEmitter-1.md +++ /dev/null @@ -1,1085 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / EventEmitter - -# Class: EventEmitter - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).EventEmitter - -The `EventEmitter` class is defined and exposed by the `events` module: - -```js -const EventEmitter = require('events'); -``` - -All `EventEmitter`s emit the event `'newListener'` when new listeners are -added and `'removeListener'` when existing listeners are removed. - -It supports the following option: - -**`since`** v0.1.26 - -## Hierarchy - -- `EventEmitter` - - ↳ **`EventEmitter`** - - ↳↳ [`Context`](verida_client_ts.Context.md) - -## Table of contents - -### Constructors - -- [constructor](verida_client_ts._internal_.EventEmitter-1.md#constructor) - -### Properties - -- [captureRejectionSymbol](verida_client_ts._internal_.EventEmitter-1.md#capturerejectionsymbol) -- [captureRejections](verida_client_ts._internal_.EventEmitter-1.md#capturerejections) -- [defaultMaxListeners](verida_client_ts._internal_.EventEmitter-1.md#defaultmaxlisteners) -- [errorMonitor](verida_client_ts._internal_.EventEmitter-1.md#errormonitor) - -### Methods - -- [addListener](verida_client_ts._internal_.EventEmitter-1.md#addlistener) -- [emit](verida_client_ts._internal_.EventEmitter-1.md#emit) -- [eventNames](verida_client_ts._internal_.EventEmitter-1.md#eventnames) -- [getMaxListeners](verida_client_ts._internal_.EventEmitter-1.md#getmaxlisteners) -- [listenerCount](verida_client_ts._internal_.EventEmitter-1.md#listenercount) -- [listeners](verida_client_ts._internal_.EventEmitter-1.md#listeners) -- [off](verida_client_ts._internal_.EventEmitter-1.md#off) -- [on](verida_client_ts._internal_.EventEmitter-1.md#on) -- [once](verida_client_ts._internal_.EventEmitter-1.md#once) -- [prependListener](verida_client_ts._internal_.EventEmitter-1.md#prependlistener) -- [prependOnceListener](verida_client_ts._internal_.EventEmitter-1.md#prependoncelistener) -- [rawListeners](verida_client_ts._internal_.EventEmitter-1.md#rawlisteners) -- [removeAllListeners](verida_client_ts._internal_.EventEmitter-1.md#removealllisteners) -- [removeListener](verida_client_ts._internal_.EventEmitter-1.md#removelistener) -- [setMaxListeners](verida_client_ts._internal_.EventEmitter-1.md#setmaxlisteners) -- [getEventListeners](verida_client_ts._internal_.EventEmitter-1.md#geteventlisteners) -- [listenerCount](verida_client_ts._internal_.EventEmitter-1.md#listenercount) -- [on](verida_client_ts._internal_.EventEmitter-1.md#on) -- [once](verida_client_ts._internal_.EventEmitter-1.md#once) - -## Constructors - -### constructor - -• **new EventEmitter**(`options?`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options?` | [`EventEmitterOptions`](../interfaces/verida_client_ts._internal_.EventEmitterOptions.md) | - -#### Inherited from - -NodeJS.EventEmitter.constructor - -#### Defined in - -node_modules/@types/node/events.d.ts:74 - -## Properties - -### captureRejectionSymbol - -▪ `Static` `Readonly` **captureRejectionSymbol**: typeof [`captureRejectionSymbol`](verida_client_ts.Context.md#capturerejectionsymbol) - -#### Defined in - -node_modules/@types/node/events.d.ts:273 - -___ - -### captureRejections - -▪ `Static` **captureRejections**: `boolean` - -Sets or gets the default captureRejection value for all emitters. - -#### Defined in - -node_modules/@types/node/events.d.ts:278 - -___ - -### defaultMaxListeners - -▪ `Static` **defaultMaxListeners**: `number` - -#### Defined in - -node_modules/@types/node/events.d.ts:279 - -___ - -### errorMonitor - -▪ `Static` `Readonly` **errorMonitor**: typeof [`errorMonitor`](verida_client_ts.Context.md#errormonitor) - -This symbol shall be used to install a listener for only monitoring `'error'` -events. Listeners installed using this symbol are called before the regular -`'error'` listeners are called. - -Installing a listener using this symbol does not change the behavior once an -`'error'` event is emitted, therefore the process will still crash if no -regular `'error'` listener is installed. - -#### Defined in - -node_modules/@types/node/events.d.ts:272 - -## Methods - -### addListener - -▸ **addListener**(`eventName`, `listener`): [`EventEmitter`](verida_client_ts._internal_.EventEmitter-1.md) - -Alias for `emitter.on(eventName, listener)`. - -**`since`** v0.1.26 - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | `string` \| `symbol` | -| `listener` | (...`args`: `any`[]) => `void` | - -#### Returns - -[`EventEmitter`](verida_client_ts._internal_.EventEmitter-1.md) - -#### Inherited from - -NodeJS.EventEmitter.addListener - -#### Defined in - -node_modules/@types/node/events.d.ts:299 - -___ - -### emit - -▸ **emit**(`eventName`, ...`args`): `boolean` - -Synchronously calls each of the listeners registered for the event named`eventName`, in the order they were registered, passing the supplied arguments -to each. - -Returns `true` if the event had listeners, `false` otherwise. - -```js -const EventEmitter = require('events'); -const myEmitter = new EventEmitter(); - -// First listener -myEmitter.on('event', function firstListener() { - console.log('Helloooo! first listener'); -}); -// Second listener -myEmitter.on('event', function secondListener(arg1, arg2) { - console.log(`event with parameters ${arg1}, ${arg2} in second listener`); -}); -// Third listener -myEmitter.on('event', function thirdListener(...args) { - const parameters = args.join(', '); - console.log(`event with parameters ${parameters} in third listener`); -}); - -console.log(myEmitter.listeners('event')); - -myEmitter.emit('event', 1, 2, 3, 4, 5); - -// Prints: -// [ -// [Function: firstListener], -// [Function: secondListener], -// [Function: thirdListener] -// ] -// Helloooo! first listener -// event with parameters 1, 2 in second listener -// event with parameters 1, 2, 3, 4, 5 in third listener -``` - -**`since`** v0.1.26 - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | `string` \| `symbol` | -| `...args` | `any`[] | - -#### Returns - -`boolean` - -#### Inherited from - -NodeJS.EventEmitter.emit - -#### Defined in - -node_modules/@types/node/events.d.ts:555 - -___ - -### eventNames - -▸ **eventNames**(): (`string` \| `symbol`)[] - -Returns an array listing the events for which the emitter has registered -listeners. The values in the array are strings or `Symbol`s. - -```js -const EventEmitter = require('events'); -const myEE = new EventEmitter(); -myEE.on('foo', () => {}); -myEE.on('bar', () => {}); - -const sym = Symbol('symbol'); -myEE.on(sym, () => {}); - -console.log(myEE.eventNames()); -// Prints: [ 'foo', 'bar', Symbol(symbol) ] -``` - -**`since`** v6.0.0 - -#### Returns - -(`string` \| `symbol`)[] - -#### Inherited from - -NodeJS.EventEmitter.eventNames - -#### Defined in - -node_modules/@types/node/events.d.ts:614 - -___ - -### getMaxListeners - -▸ **getMaxListeners**(): `number` - -Returns the current max listener value for the `EventEmitter` which is either -set by `emitter.setMaxListeners(n)` or defaults to [defaultMaxListeners](verida_client_ts._internal_.EventEmitter-1.md#defaultmaxlisteners). - -**`since`** v1.0.0 - -#### Returns - -`number` - -#### Inherited from - -NodeJS.EventEmitter.getMaxListeners - -#### Defined in - -node_modules/@types/node/events.d.ts:471 - -___ - -### listenerCount - -▸ **listenerCount**(`eventName`): `number` - -Returns the number of listeners listening to the event named `eventName`. - -**`since`** v3.2.0 - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `eventName` | `string` \| `symbol` | The name of the event being listened for | - -#### Returns - -`number` - -#### Inherited from - -NodeJS.EventEmitter.listenerCount - -#### Defined in - -node_modules/@types/node/events.d.ts:561 - -___ - -### listeners - -▸ **listeners**(`eventName`): `Function`[] - -Returns a copy of the array of listeners for the event named `eventName`. - -```js -server.on('connection', (stream) => { - console.log('someone connected!'); -}); -console.log(util.inspect(server.listeners('connection'))); -// Prints: [ [Function] ] -``` - -**`since`** v0.1.26 - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | `string` \| `symbol` | - -#### Returns - -`Function`[] - -#### Inherited from - -NodeJS.EventEmitter.listeners - -#### Defined in - -node_modules/@types/node/events.d.ts:484 - -___ - -### off - -▸ **off**(`eventName`, `listener`): [`EventEmitter`](verida_client_ts._internal_.EventEmitter-1.md) - -Alias for `emitter.removeListener()`. - -**`since`** v10.0.0 - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | `string` \| `symbol` | -| `listener` | (...`args`: `any`[]) => `void` | - -#### Returns - -[`EventEmitter`](verida_client_ts._internal_.EventEmitter-1.md) - -#### Inherited from - -NodeJS.EventEmitter.off - -#### Defined in - -node_modules/@types/node/events.d.ts:444 - -___ - -### on - -▸ **on**(`eventName`, `listener`): [`EventEmitter`](verida_client_ts._internal_.EventEmitter-1.md) - -Adds the `listener` function to the end of the listeners array for the -event named `eventName`. No checks are made to see if the `listener` has -already been added. Multiple calls passing the same combination of `eventName`and `listener` will result in the `listener` being added, and called, multiple -times. - -```js -server.on('connection', (stream) => { - console.log('someone connected!'); -}); -``` - -Returns a reference to the `EventEmitter`, so that calls can be chained. - -By default, event listeners are invoked in the order they are added. The`emitter.prependListener()` method can be used as an alternative to add the -event listener to the beginning of the listeners array. - -```js -const myEE = new EventEmitter(); -myEE.on('foo', () => console.log('a')); -myEE.prependListener('foo', () => console.log('b')); -myEE.emit('foo'); -// Prints: -// b -// a -``` - -**`since`** v0.1.101 - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `eventName` | `string` \| `symbol` | The name of the event. | -| `listener` | (...`args`: `any`[]) => `void` | The callback function | - -#### Returns - -[`EventEmitter`](verida_client_ts._internal_.EventEmitter-1.md) - -#### Inherited from - -NodeJS.EventEmitter.on - -#### Defined in - -node_modules/@types/node/events.d.ts:330 - -___ - -### once - -▸ **once**(`eventName`, `listener`): [`EventEmitter`](verida_client_ts._internal_.EventEmitter-1.md) - -Adds a **one-time**`listener` function for the event named `eventName`. The -next time `eventName` is triggered, this listener is removed and then invoked. - -```js -server.once('connection', (stream) => { - console.log('Ah, we have our first user!'); -}); -``` - -Returns a reference to the `EventEmitter`, so that calls can be chained. - -By default, event listeners are invoked in the order they are added. The`emitter.prependOnceListener()` method can be used as an alternative to add the -event listener to the beginning of the listeners array. - -```js -const myEE = new EventEmitter(); -myEE.once('foo', () => console.log('a')); -myEE.prependOnceListener('foo', () => console.log('b')); -myEE.emit('foo'); -// Prints: -// b -// a -``` - -**`since`** v0.3.0 - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `eventName` | `string` \| `symbol` | The name of the event. | -| `listener` | (...`args`: `any`[]) => `void` | The callback function | - -#### Returns - -[`EventEmitter`](verida_client_ts._internal_.EventEmitter-1.md) - -#### Inherited from - -NodeJS.EventEmitter.once - -#### Defined in - -node_modules/@types/node/events.d.ts:359 - -___ - -### prependListener - -▸ **prependListener**(`eventName`, `listener`): [`EventEmitter`](verida_client_ts._internal_.EventEmitter-1.md) - -Adds the `listener` function to the _beginning_ of the listeners array for the -event named `eventName`. No checks are made to see if the `listener` has -already been added. Multiple calls passing the same combination of `eventName`and `listener` will result in the `listener` being added, and called, multiple -times. - -```js -server.prependListener('connection', (stream) => { - console.log('someone connected!'); -}); -``` - -Returns a reference to the `EventEmitter`, so that calls can be chained. - -**`since`** v6.0.0 - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `eventName` | `string` \| `symbol` | The name of the event. | -| `listener` | (...`args`: `any`[]) => `void` | The callback function | - -#### Returns - -[`EventEmitter`](verida_client_ts._internal_.EventEmitter-1.md) - -#### Inherited from - -NodeJS.EventEmitter.prependListener - -#### Defined in - -node_modules/@types/node/events.d.ts:579 - -___ - -### prependOnceListener - -▸ **prependOnceListener**(`eventName`, `listener`): [`EventEmitter`](verida_client_ts._internal_.EventEmitter-1.md) - -Adds a **one-time**`listener` function for the event named `eventName` to the_beginning_ of the listeners array. The next time `eventName` is triggered, this -listener is removed, and then invoked. - -```js -server.prependOnceListener('connection', (stream) => { - console.log('Ah, we have our first user!'); -}); -``` - -Returns a reference to the `EventEmitter`, so that calls can be chained. - -**`since`** v6.0.0 - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `eventName` | `string` \| `symbol` | The name of the event. | -| `listener` | (...`args`: `any`[]) => `void` | The callback function | - -#### Returns - -[`EventEmitter`](verida_client_ts._internal_.EventEmitter-1.md) - -#### Inherited from - -NodeJS.EventEmitter.prependOnceListener - -#### Defined in - -node_modules/@types/node/events.d.ts:595 - -___ - -### rawListeners - -▸ **rawListeners**(`eventName`): `Function`[] - -Returns a copy of the array of listeners for the event named `eventName`, -including any wrappers (such as those created by `.once()`). - -```js -const emitter = new EventEmitter(); -emitter.once('log', () => console.log('log once')); - -// Returns a new Array with a function `onceWrapper` which has a property -// `listener` which contains the original listener bound above -const listeners = emitter.rawListeners('log'); -const logFnWrapper = listeners[0]; - -// Logs "log once" to the console and does not unbind the `once` event -logFnWrapper.listener(); - -// Logs "log once" to the console and removes the listener -logFnWrapper(); - -emitter.on('log', () => console.log('log persistently')); -// Will return a new Array with a single function bound by `.on()` above -const newListeners = emitter.rawListeners('log'); - -// Logs "log persistently" twice -newListeners[0](); -emitter.emit('log'); -``` - -**`since`** v9.4.0 - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | `string` \| `symbol` | - -#### Returns - -`Function`[] - -#### Inherited from - -NodeJS.EventEmitter.rawListeners - -#### Defined in - -node_modules/@types/node/events.d.ts:514 - -___ - -### removeAllListeners - -▸ **removeAllListeners**(`event?`): [`EventEmitter`](verida_client_ts._internal_.EventEmitter-1.md) - -Removes all listeners, or those of the specified `eventName`. - -It is bad practice to remove listeners added elsewhere in the code, -particularly when the `EventEmitter` instance was created by some other -component or module (e.g. sockets or file streams). - -Returns a reference to the `EventEmitter`, so that calls can be chained. - -**`since`** v0.1.26 - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event?` | `string` \| `symbol` | - -#### Returns - -[`EventEmitter`](verida_client_ts._internal_.EventEmitter-1.md) - -#### Inherited from - -NodeJS.EventEmitter.removeAllListeners - -#### Defined in - -node_modules/@types/node/events.d.ts:455 - -___ - -### removeListener - -▸ **removeListener**(`eventName`, `listener`): [`EventEmitter`](verida_client_ts._internal_.EventEmitter-1.md) - -Removes the specified `listener` from the listener array for the event named`eventName`. - -```js -const callback = (stream) => { - console.log('someone connected!'); -}; -server.on('connection', callback); -// ... -server.removeListener('connection', callback); -``` - -`removeListener()` will remove, at most, one instance of a listener from the -listener array. If any single listener has been added multiple times to the -listener array for the specified `eventName`, then `removeListener()` must be -called multiple times to remove each instance. - -Once an event is emitted, all listeners attached to it at the -time of emitting are called in order. This implies that any`removeListener()` or `removeAllListeners()` calls _after_ emitting and_before_ the last listener finishes execution will -not remove them from`emit()` in progress. Subsequent events behave as expected. - -```js -const myEmitter = new MyEmitter(); - -const callbackA = () => { - console.log('A'); - myEmitter.removeListener('event', callbackB); -}; - -const callbackB = () => { - console.log('B'); -}; - -myEmitter.on('event', callbackA); - -myEmitter.on('event', callbackB); - -// callbackA removes listener callbackB but it will still be called. -// Internal listener array at time of emit [callbackA, callbackB] -myEmitter.emit('event'); -// Prints: -// A -// B - -// callbackB is now removed. -// Internal listener array [callbackA] -myEmitter.emit('event'); -// Prints: -// A -``` - -Because listeners are managed using an internal array, calling this will -change the position indices of any listener registered _after_ the listener -being removed. This will not impact the order in which listeners are called, -but it means that any copies of the listener array as returned by -the `emitter.listeners()` method will need to be recreated. - -When a single function has been added as a handler multiple times for a single -event (as in the example below), `removeListener()` will remove the most -recently added instance. In the example the `once('ping')`listener is removed: - -```js -const ee = new EventEmitter(); - -function pong() { - console.log('pong'); -} - -ee.on('ping', pong); -ee.once('ping', pong); -ee.removeListener('ping', pong); - -ee.emit('ping'); -ee.emit('ping'); -``` - -Returns a reference to the `EventEmitter`, so that calls can be chained. - -**`since`** v0.1.26 - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | `string` \| `symbol` | -| `listener` | (...`args`: `any`[]) => `void` | - -#### Returns - -[`EventEmitter`](verida_client_ts._internal_.EventEmitter-1.md) - -#### Inherited from - -NodeJS.EventEmitter.removeListener - -#### Defined in - -node_modules/@types/node/events.d.ts:439 - -___ - -### setMaxListeners - -▸ **setMaxListeners**(`n`): [`EventEmitter`](verida_client_ts._internal_.EventEmitter-1.md) - -By default `EventEmitter`s will print a warning if more than `10` listeners are -added for a particular event. This is a useful default that helps finding -memory leaks. The `emitter.setMaxListeners()` method allows the limit to be -modified for this specific `EventEmitter` instance. The value can be set to`Infinity` (or `0`) to indicate an unlimited number of listeners. - -Returns a reference to the `EventEmitter`, so that calls can be chained. - -**`since`** v0.3.5 - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `n` | `number` | - -#### Returns - -[`EventEmitter`](verida_client_ts._internal_.EventEmitter-1.md) - -#### Inherited from - -NodeJS.EventEmitter.setMaxListeners - -#### Defined in - -node_modules/@types/node/events.d.ts:465 - -___ - -### getEventListeners - -▸ `Static` **getEventListeners**(`emitter`, `name`): `Function`[] - -Returns a copy of the array of listeners for the event named `eventName`. - -For `EventEmitter`s this behaves exactly the same as calling `.listeners` on -the emitter. - -For `EventTarget`s this is the only way to get the event listeners for the -event target. This is useful for debugging and diagnostic purposes. - -```js -const { getEventListeners, EventEmitter } = require('events'); - -{ - const ee = new EventEmitter(); - const listener = () => console.log('Events are fun'); - ee.on('foo', listener); - getEventListeners(ee, 'foo'); // [listener] -} -{ - const et = new EventTarget(); - const listener = () => console.log('Events are fun'); - et.addEventListener('foo', listener); - getEventListeners(et, 'foo'); // [listener] -} -``` - -**`since`** v15.2.0 - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `emitter` | [`DOMEventTarget`](../interfaces/verida_client_ts._internal_.DOMEventTarget.md) \| `EventEmitter` | -| `name` | `string` \| `symbol` | - -#### Returns - -`Function`[] - -#### Defined in - -node_modules/@types/node/events.d.ts:262 - -___ - -### listenerCount - -▸ `Static` **listenerCount**(`emitter`, `eventName`): `number` - -A class method that returns the number of listeners for the given `eventName`registered on the given `emitter`. - -```js -const { EventEmitter, listenerCount } = require('events'); -const myEmitter = new EventEmitter(); -myEmitter.on('event', () => {}); -myEmitter.on('event', () => {}); -console.log(listenerCount(myEmitter, 'event')); -// Prints: 2 -``` - -**`since`** v0.9.12 - -**`deprecated`** Since v3.2.0 - Use `listenerCount` instead. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `emitter` | `EventEmitter` | The emitter to query | -| `eventName` | `string` \| `symbol` | The event name | - -#### Returns - -`number` - -#### Inherited from - -NodeJS.EventEmitter.listenerCount - -#### Defined in - -node_modules/@types/node/events.d.ts:234 - -___ - -### on - -▸ `Static` **on**(`emitter`, `eventName`, `options?`): [`AsyncIterableIterator`](../interfaces/verida_client_ts._internal_.AsyncIterableIterator.md)<`any`\> - -```js -const { on, EventEmitter } = require('events'); - -(async () => { - const ee = new EventEmitter(); - - // Emit later on - process.nextTick(() => { - ee.emit('foo', 'bar'); - ee.emit('foo', 42); - }); - - for await (const event of on(ee, 'foo')) { - // The execution of this inner block is synchronous and it - // processes one event at a time (even with await). Do not use - // if concurrent execution is required. - console.log(event); // prints ['bar'] [42] - } - // Unreachable here -})(); -``` - -Returns an `AsyncIterator` that iterates `eventName` events. It will throw -if the `EventEmitter` emits `'error'`. It removes all listeners when -exiting the loop. The `value` returned by each iteration is an array -composed of the emitted event arguments. - -An `AbortSignal` can be used to cancel waiting on events: - -```js -const { on, EventEmitter } = require('events'); -const ac = new AbortController(); - -(async () => { - const ee = new EventEmitter(); - - // Emit later on - process.nextTick(() => { - ee.emit('foo', 'bar'); - ee.emit('foo', 42); - }); - - for await (const event of on(ee, 'foo', { signal: ac.signal })) { - // The execution of this inner block is synchronous and it - // processes one event at a time (even with await). Do not use - // if concurrent execution is required. - console.log(event); // prints ['bar'] [42] - } - // Unreachable here -})(); - -process.nextTick(() => ac.abort()); -``` - -**`since`** v13.6.0, v12.16.0 - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `emitter` | `EventEmitter` | - | -| `eventName` | `string` | The name of the event being listened for | -| `options?` | [`StaticEventEmitterOptions`](../interfaces/verida_client_ts._internal_.StaticEventEmitterOptions.md) | - | - -#### Returns - -[`AsyncIterableIterator`](../interfaces/verida_client_ts._internal_.AsyncIterableIterator.md)<`any`\> - -that iterates `eventName` events emitted by the `emitter` - -#### Inherited from - -NodeJS.EventEmitter.on - -#### Defined in - -node_modules/@types/node/events.d.ts:217 - -___ - -### once - -▸ `Static` **once**(`emitter`, `eventName`, `options?`): `Promise`<`any`[]\> - -Creates a `Promise` that is fulfilled when the `EventEmitter` emits the given -event or that is rejected if the `EventEmitter` emits `'error'` while waiting. -The `Promise` will resolve with an array of all the arguments emitted to the -given event. - -This method is intentionally generic and works with the web platform[EventTarget](https://dom.spec.whatwg.org/#interface-eventtarget) interface, which has no special`'error'` event -semantics and does not listen to the `'error'` event. - -```js -const { once, EventEmitter } = require('events'); - -async function run() { - const ee = new EventEmitter(); - - process.nextTick(() => { - ee.emit('myevent', 42); - }); - - const [value] = await once(ee, 'myevent'); - console.log(value); - - const err = new Error('kaboom'); - process.nextTick(() => { - ee.emit('error', err); - }); - - try { - await once(ee, 'myevent'); - } catch (err) { - console.log('error happened', err); - } -} - -run(); -``` - -The special handling of the `'error'` event is only used when `events.once()`is used to wait for another event. If `events.once()` is used to wait for the -'`error'` event itself, then it is treated as any other kind of event without -special handling: - -```js -const { EventEmitter, once } = require('events'); - -const ee = new EventEmitter(); - -once(ee, 'error') - .then(([err]) => console.log('ok', err.message)) - .catch((err) => console.log('error', err.message)); - -ee.emit('error', new Error('boom')); - -// Prints: ok boom -``` - -An `AbortSignal` can be used to cancel waiting for the event: - -```js -const { EventEmitter, once } = require('events'); - -const ee = new EventEmitter(); -const ac = new AbortController(); - -async function foo(emitter, event, signal) { - try { - await once(emitter, event, { signal }); - console.log('event emitted!'); - } catch (error) { - if (error.name === 'AbortError') { - console.error('Waiting for the event was canceled!'); - } else { - console.error('There was an error', error.message); - } - } -} - -foo(ee, 'foo', ac.signal); -ac.abort(); // Abort waiting for the event -ee.emit('foo'); // Prints: Waiting for the event was canceled! -``` - -**`since`** v11.13.0, v10.16.0 - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `emitter` | [`NodeEventTarget`](../interfaces/verida_client_ts._internal_.NodeEventTarget.md) | -| `eventName` | `string` \| `symbol` | -| `options?` | [`StaticEventEmitterOptions`](../interfaces/verida_client_ts._internal_.StaticEventEmitterOptions.md) | - -#### Returns - -`Promise`<`any`[]\> - -#### Inherited from - -NodeJS.EventEmitter.once - -#### Defined in - -node_modules/@types/node/events.d.ts:157 - -▸ `Static` **once**(`emitter`, `eventName`, `options?`): `Promise`<`any`[]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `emitter` | [`DOMEventTarget`](../interfaces/verida_client_ts._internal_.DOMEventTarget.md) | -| `eventName` | `string` | -| `options?` | [`StaticEventEmitterOptions`](../interfaces/verida_client_ts._internal_.StaticEventEmitterOptions.md) | - -#### Returns - -`Promise`<`any`[]\> - -#### Inherited from - -NodeJS.EventEmitter.once - -#### Defined in - -node_modules/@types/node/events.d.ts:158 diff --git a/docs/api/verida-js/classes/verida_client_ts._internal_.ForkEvent.md b/docs/api/verida-js/classes/verida_client_ts._internal_.ForkEvent.md deleted file mode 100644 index f34875a..0000000 --- a/docs/api/verida-js/classes/verida_client_ts._internal_.ForkEvent.md +++ /dev/null @@ -1,86 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / ForkEvent - -# Class: ForkEvent - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).ForkEvent - -## Hierarchy - -- [`Description`](verida_client_ts._internal_.Description.md) - - ↳ **`ForkEvent`** - -## Table of contents - -### Constructors - -- [constructor](verida_client_ts._internal_.ForkEvent.md#constructor) - -### Properties - -- [\_isForkEvent](verida_client_ts._internal_.ForkEvent.md#_isforkevent) -- [expiry](verida_client_ts._internal_.ForkEvent.md#expiry) - -### Methods - -- [isForkEvent](verida_client_ts._internal_.ForkEvent.md#isforkevent) - -## Constructors - -### constructor - -• **new ForkEvent**(`info`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `info` | `Object` | - -#### Inherited from - -[Description](verida_client_ts._internal_.Description.md).[constructor](verida_client_ts._internal_.Description.md#constructor) - -#### Defined in - -node_modules/@ethersproject/properties/lib/index.d.ts:13 - -## Properties - -### \_isForkEvent - -• `Optional` `Readonly` **\_isForkEvent**: `boolean` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:103 - -___ - -### expiry - -• `Readonly` **expiry**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:102 - -## Methods - -### isForkEvent - -▸ `Static` **isForkEvent**(`value`): value is ForkEvent - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `any` | - -#### Returns - -value is ForkEvent - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:104 diff --git a/docs/api/verida-js/classes/verida_client_ts._internal_.KeywordCxt.md b/docs/api/verida-js/classes/verida_client_ts._internal_.KeywordCxt.md deleted file mode 100644 index d7273aa..0000000 --- a/docs/api/verida-js/classes/verida_client_ts._internal_.KeywordCxt.md +++ /dev/null @@ -1,584 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / KeywordCxt - -# Class: KeywordCxt - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).KeywordCxt - -## Implements - -- [`KeywordErrorCxt`](../interfaces/verida_client_ts._internal_.KeywordErrorCxt.md) - -## Table of contents - -### Constructors - -- [constructor](verida_client_ts._internal_.KeywordCxt.md#constructor) - -### Properties - -- [$data](verida_client_ts._internal_.KeywordCxt.md#$data) -- [\_error](verida_client_ts._internal_.KeywordCxt.md#_error) -- [allErrors](verida_client_ts._internal_.KeywordCxt.md#allerrors) -- [data](verida_client_ts._internal_.KeywordCxt.md#data) -- [def](verida_client_ts._internal_.KeywordCxt.md#def) -- [errsCount](verida_client_ts._internal_.KeywordCxt.md#errscount) -- [gen](verida_client_ts._internal_.KeywordCxt.md#gen) -- [it](verida_client_ts._internal_.KeywordCxt.md#it) -- [keyword](verida_client_ts._internal_.KeywordCxt.md#keyword) -- [params](verida_client_ts._internal_.KeywordCxt.md#params) -- [parentSchema](verida_client_ts._internal_.KeywordCxt.md#parentschema) -- [schema](verida_client_ts._internal_.KeywordCxt.md#schema) -- [schemaCode](verida_client_ts._internal_.KeywordCxt.md#schemacode) -- [schemaType](verida_client_ts._internal_.KeywordCxt.md#schematype) -- [schemaValue](verida_client_ts._internal_.KeywordCxt.md#schemavalue) - -### Methods - -- [$dataError](verida_client_ts._internal_.KeywordCxt.md#$dataerror) -- [block$data](verida_client_ts._internal_.KeywordCxt.md#block$data) -- [check$data](verida_client_ts._internal_.KeywordCxt.md#check$data) -- [error](verida_client_ts._internal_.KeywordCxt.md#error) -- [fail](verida_client_ts._internal_.KeywordCxt.md#fail) -- [fail$data](verida_client_ts._internal_.KeywordCxt.md#fail$data) -- [failResult](verida_client_ts._internal_.KeywordCxt.md#failresult) -- [invalid$data](verida_client_ts._internal_.KeywordCxt.md#invalid$data) -- [mergeEvaluated](verida_client_ts._internal_.KeywordCxt.md#mergeevaluated) -- [mergeValidEvaluated](verida_client_ts._internal_.KeywordCxt.md#mergevalidevaluated) -- [ok](verida_client_ts._internal_.KeywordCxt.md#ok) -- [pass](verida_client_ts._internal_.KeywordCxt.md#pass) -- [reset](verida_client_ts._internal_.KeywordCxt.md#reset) -- [result](verida_client_ts._internal_.KeywordCxt.md#result) -- [setParams](verida_client_ts._internal_.KeywordCxt.md#setparams) -- [subschema](verida_client_ts._internal_.KeywordCxt.md#subschema) - -## Constructors - -### constructor - -• **new KeywordCxt**(`it`, `def`, `keyword`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `it` | [`SchemaObjCxt`](../interfaces/verida_client_ts._internal_.SchemaObjCxt.md) | -| `def` | [`AddedKeywordDefinition`](../modules/verida_client_ts._internal_.md#addedkeyworddefinition) | -| `keyword` | `string` | - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/validate/index.d.ts:23 - -## Properties - -### $data - -• `Optional` `Readonly` **$data**: `string` \| ``false`` - -#### Implementation of - -[KeywordErrorCxt](../interfaces/verida_client_ts._internal_.KeywordErrorCxt.md).[$data](../interfaces/verida_client_ts._internal_.KeywordErrorCxt.md#$data) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/validate/index.d.ts:13 - -___ - -### \_error - -• `Private` **\_error**: `any` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/validate/index.d.ts:30 - -___ - -### allErrors - -• `Optional` `Readonly` **allErrors**: `boolean` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/validate/index.d.ts:10 - -___ - -### data - -• `Readonly` **data**: [`Name`](verida_client_ts._internal_.Name.md) - -#### Implementation of - -[KeywordErrorCxt](../interfaces/verida_client_ts._internal_.KeywordErrorCxt.md).[data](../interfaces/verida_client_ts._internal_.KeywordErrorCxt.md#data) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/validate/index.d.ts:12 - -___ - -### def - -• `Readonly` **def**: [`AddedKeywordDefinition`](../modules/verida_client_ts._internal_.md#addedkeyworddefinition) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/validate/index.d.ts:22 - -___ - -### errsCount - -• `Optional` `Readonly` **errsCount**: [`Name`](verida_client_ts._internal_.Name.md) - -#### Implementation of - -[KeywordErrorCxt](../interfaces/verida_client_ts._internal_.KeywordErrorCxt.md).[errsCount](../interfaces/verida_client_ts._internal_.KeywordErrorCxt.md#errscount) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/validate/index.d.ts:19 - -___ - -### gen - -• `Readonly` **gen**: [`CodeGen`](verida_client_ts._internal_.CodeGen.md) - -#### Implementation of - -[KeywordErrorCxt](../interfaces/verida_client_ts._internal_.KeywordErrorCxt.md).[gen](../interfaces/verida_client_ts._internal_.KeywordErrorCxt.md#gen) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/validate/index.d.ts:9 - -___ - -### it - -• `Readonly` **it**: [`SchemaObjCxt`](../interfaces/verida_client_ts._internal_.SchemaObjCxt.md) - -#### Implementation of - -[KeywordErrorCxt](../interfaces/verida_client_ts._internal_.KeywordErrorCxt.md).[it](../interfaces/verida_client_ts._internal_.KeywordErrorCxt.md#it) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/validate/index.d.ts:21 - -___ - -### keyword - -• `Readonly` **keyword**: `string` - -#### Implementation of - -[KeywordErrorCxt](../interfaces/verida_client_ts._internal_.KeywordErrorCxt.md).[keyword](../interfaces/verida_client_ts._internal_.KeywordErrorCxt.md#keyword) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/validate/index.d.ts:11 - -___ - -### params - -• **params**: [`KeywordCxtParams`](../modules/verida_client_ts._internal_.md#keywordcxtparams) - -#### Implementation of - -[KeywordErrorCxt](../interfaces/verida_client_ts._internal_.KeywordErrorCxt.md).[params](../interfaces/verida_client_ts._internal_.KeywordErrorCxt.md#params) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/validate/index.d.ts:20 - -___ - -### parentSchema - -• `Readonly` **parentSchema**: [`AnySchemaObject`](../modules/verida_client_ts._internal_.md#anyschemaobject) - -#### Implementation of - -[KeywordErrorCxt](../interfaces/verida_client_ts._internal_.KeywordErrorCxt.md).[parentSchema](../interfaces/verida_client_ts._internal_.KeywordErrorCxt.md#parentschema) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/validate/index.d.ts:18 - -___ - -### schema - -• **schema**: `any` - -#### Implementation of - -[KeywordErrorCxt](../interfaces/verida_client_ts._internal_.KeywordErrorCxt.md).[schema](../interfaces/verida_client_ts._internal_.KeywordErrorCxt.md#schema) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/validate/index.d.ts:14 - -___ - -### schemaCode - -• `Readonly` **schemaCode**: `number` \| `boolean` \| [`Code`](../modules/verida_client_ts._internal_.md#code) - -#### Implementation of - -[KeywordErrorCxt](../interfaces/verida_client_ts._internal_.KeywordErrorCxt.md).[schemaCode](../interfaces/verida_client_ts._internal_.KeywordErrorCxt.md#schemacode) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/validate/index.d.ts:16 - -___ - -### schemaType - -• `Readonly` **schemaType**: (``"string"`` \| ``"number"`` \| ``"boolean"`` \| ``"object"`` \| ``"integer"`` \| ``"array"`` \| ``"null"``)[] - -#### Implementation of - -[KeywordErrorCxt](../interfaces/verida_client_ts._internal_.KeywordErrorCxt.md).[schemaType](../interfaces/verida_client_ts._internal_.KeywordErrorCxt.md#schematype) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/validate/index.d.ts:17 - -___ - -### schemaValue - -• `Readonly` **schemaValue**: `number` \| `boolean` \| [`Code`](../modules/verida_client_ts._internal_.md#code) - -#### Implementation of - -[KeywordErrorCxt](../interfaces/verida_client_ts._internal_.KeywordErrorCxt.md).[schemaValue](../interfaces/verida_client_ts._internal_.KeywordErrorCxt.md#schemavalue) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/validate/index.d.ts:15 - -## Methods - -### $dataError - -▸ **$dataError**(): `void` - -#### Returns - -`void` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/validate/index.d.ts:31 - -___ - -### block$data - -▸ **block$data**(`valid`, `codeBlock`, `$dataValid?`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `valid` | [`Name`](verida_client_ts._internal_.Name.md) | -| `codeBlock` | () => `void` | -| `$dataValid?` | [`Code`](../modules/verida_client_ts._internal_.md#code) | - -#### Returns - -`void` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/validate/index.d.ts:35 - -___ - -### check$data - -▸ **check$data**(`valid?`, `$dataValid?`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `valid?` | [`Name`](verida_client_ts._internal_.Name.md) | -| `$dataValid?` | [`Code`](../modules/verida_client_ts._internal_.md#code) | - -#### Returns - -`void` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/validate/index.d.ts:36 - -___ - -### error - -▸ **error**(`append?`, `errorParams?`, `errorPaths?`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `append?` | `boolean` | -| `errorParams?` | [`KeywordCxtParams`](../modules/verida_client_ts._internal_.md#keywordcxtparams) | -| `errorPaths?` | [`ErrorPaths`](../interfaces/verida_client_ts._internal_.ErrorPaths.md) | - -#### Returns - -`void` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/validate/index.d.ts:29 - -___ - -### fail - -▸ **fail**(`condition?`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `condition?` | [`Code`](../modules/verida_client_ts._internal_.md#code) | - -#### Returns - -`void` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/validate/index.d.ts:27 - -___ - -### fail$data - -▸ **fail$data**(`condition`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `condition` | [`Code`](../modules/verida_client_ts._internal_.md#code) | - -#### Returns - -`void` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/validate/index.d.ts:28 - -___ - -### failResult - -▸ **failResult**(`condition`, `successAction?`, `failAction?`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `condition` | [`Code`](../modules/verida_client_ts._internal_.md#code) | -| `successAction?` | () => `void` | -| `failAction?` | () => `void` | - -#### Returns - -`void` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/validate/index.d.ts:25 - -___ - -### invalid$data - -▸ **invalid$data**(): [`Code`](../modules/verida_client_ts._internal_.md#code) - -#### Returns - -[`Code`](../modules/verida_client_ts._internal_.md#code) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/validate/index.d.ts:37 - -___ - -### mergeEvaluated - -▸ **mergeEvaluated**(`schemaCxt`, `toName?`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schemaCxt` | [`SchemaCxt`](../interfaces/verida_client_ts._internal_.SchemaCxt.md) | -| `toName?` | typeof [`Name`](verida_client_ts._internal_.Name.md) | - -#### Returns - -`void` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/validate/index.d.ts:39 - -___ - -### mergeValidEvaluated - -▸ **mergeValidEvaluated**(`schemaCxt`, `valid`): `boolean` \| `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schemaCxt` | [`SchemaCxt`](../interfaces/verida_client_ts._internal_.SchemaCxt.md) | -| `valid` | [`Name`](verida_client_ts._internal_.Name.md) | - -#### Returns - -`boolean` \| `void` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/validate/index.d.ts:40 - -___ - -### ok - -▸ **ok**(`cond`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `cond` | `boolean` \| [`Code`](../modules/verida_client_ts._internal_.md#code) | - -#### Returns - -`void` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/validate/index.d.ts:33 - -___ - -### pass - -▸ **pass**(`condition`, `failAction?`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `condition` | [`Code`](../modules/verida_client_ts._internal_.md#code) | -| `failAction?` | () => `void` | - -#### Returns - -`void` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/validate/index.d.ts:26 - -___ - -### reset - -▸ **reset**(): `void` - -#### Returns - -`void` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/validate/index.d.ts:32 - -___ - -### result - -▸ **result**(`condition`, `successAction?`, `failAction?`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `condition` | [`Code`](../modules/verida_client_ts._internal_.md#code) | -| `successAction?` | () => `void` | -| `failAction?` | () => `void` | - -#### Returns - -`void` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/validate/index.d.ts:24 - -___ - -### setParams - -▸ **setParams**(`obj`, `assign?`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `obj` | [`KeywordCxtParams`](../modules/verida_client_ts._internal_.md#keywordcxtparams) | -| `assign?` | ``true`` | - -#### Returns - -`void` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/validate/index.d.ts:34 - -___ - -### subschema - -▸ **subschema**(`appl`, `valid`): [`SchemaCxt`](../interfaces/verida_client_ts._internal_.SchemaCxt.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `appl` | [`Partial`](../modules/verida_client_ts._internal_.md#partial)<{ `allErrors`: `boolean` ; `compositeRule`: ``true`` ; `createErrors`: `boolean` ; `data`: [`Code`](../modules/verida_client_ts._internal_.md#code) ; `dataProp`: `string` \| `number` \| [`Code`](../modules/verida_client_ts._internal_.md#code) ; `dataPropType`: [`Type`](../enums/verida_client_ts._internal_.Type.md) ; `dataTypes`: (``"string"`` \| ``"number"`` \| ``"boolean"`` \| ``"object"`` \| ``"integer"`` \| ``"array"`` \| ``"null"``)[] ; `definedProperties`: `Set`<`string`\> ; `errSchemaPath`: `string` ; `jtdDiscriminator`: `string` ; `jtdMetadata`: `boolean` ; `keyword`: `string` ; `propertyName`: [`Name`](verida_client_ts._internal_.Name.md) ; `schema`: [`AnySchema`](../modules/verida_client_ts._internal_.md#anyschema) ; `schemaPath`: [`Code`](../modules/verida_client_ts._internal_.md#code) ; `schemaProp`: `string` \| `number` ; `topSchemaRef`: [`Code`](../modules/verida_client_ts._internal_.md#code) }\> | -| `valid` | [`Name`](verida_client_ts._internal_.Name.md) | - -#### Returns - -[`SchemaCxt`](../interfaces/verida_client_ts._internal_.SchemaCxt.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/validate/index.d.ts:38 diff --git a/docs/api/verida-js/classes/verida_client_ts._internal_.Name.md b/docs/api/verida-js/classes/verida_client_ts._internal_.Name.md deleted file mode 100644 index e2e9cd4..0000000 --- a/docs/api/verida-js/classes/verida_client_ts._internal_.Name.md +++ /dev/null @@ -1,120 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / Name - -# Class: Name - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).Name - -## Hierarchy - -- [`_CodeOrName`](verida_client_ts._internal_._CodeOrName.md) - - ↳ **`Name`** - - ↳↳ [`ValueScopeName`](verida_client_ts._internal_.ValueScopeName.md) - -## Table of contents - -### Constructors - -- [constructor](verida_client_ts._internal_.Name.md#constructor) - -### Properties - -- [str](verida_client_ts._internal_.Name.md#str) - -### Accessors - -- [names](verida_client_ts._internal_.Name.md#names) - -### Methods - -- [emptyStr](verida_client_ts._internal_.Name.md#emptystr) -- [toString](verida_client_ts._internal_.Name.md#tostring) - -## Constructors - -### constructor - -• **new Name**(`s`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `s` | `string` | - -#### Overrides - -[_CodeOrName](verida_client_ts._internal_._CodeOrName.md).[constructor](verida_client_ts._internal_._CodeOrName.md#constructor) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/code.d.ts:10 - -## Properties - -### str - -• `Readonly` **str**: `string` - -#### Overrides - -[_CodeOrName](verida_client_ts._internal_._CodeOrName.md).[str](verida_client_ts._internal_._CodeOrName.md#str) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/code.d.ts:9 - -## Accessors - -### names - -• `get` **names**(): [`UsedNames`](../modules/verida_client_ts._internal_.md#usednames) - -#### Returns - -[`UsedNames`](../modules/verida_client_ts._internal_.md#usednames) - -#### Overrides - -\_CodeOrName.names - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/code.d.ts:13 - -## Methods - -### emptyStr - -▸ **emptyStr**(): `boolean` - -#### Returns - -`boolean` - -#### Overrides - -[_CodeOrName](verida_client_ts._internal_._CodeOrName.md).[emptyStr](verida_client_ts._internal_._CodeOrName.md#emptystr) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/code.d.ts:12 - -___ - -### toString - -▸ **toString**(): `string` - -#### Returns - -`string` - -#### Overrides - -[_CodeOrName](verida_client_ts._internal_._CodeOrName.md).[toString](verida_client_ts._internal_._CodeOrName.md#tostring) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/code.d.ts:11 diff --git a/docs/api/verida-js/classes/verida_client_ts._internal_.Profile.md b/docs/api/verida-js/classes/verida_client_ts._internal_.Profile.md deleted file mode 100644 index 28bfbe1..0000000 --- a/docs/api/verida-js/classes/verida_client_ts._internal_.Profile.md +++ /dev/null @@ -1,388 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / Profile - -# Class: Profile - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).Profile - -## Hierarchy - -- [`EventEmitter`](../modules/verida_client_ts._internal_.md#eventemitter) - - ↳ **`Profile`** - -## Implements - -- [`IProfile`](../interfaces/verida_client_ts._internal_.IProfile.md) - -## Table of contents - -### Constructors - -- [constructor](verida_client_ts._internal_.Profile.md#constructor) - -### Properties - -- [context](verida_client_ts._internal_.Profile.md#context) -- [did](verida_client_ts._internal_.Profile.md#did) -- [errors](verida_client_ts._internal_.Profile.md#errors) -- [isPrivate](verida_client_ts._internal_.Profile.md#isprivate) -- [profileName](verida_client_ts._internal_.Profile.md#profilename) -- [store](verida_client_ts._internal_.Profile.md#store) -- [writeAccess](verida_client_ts._internal_.Profile.md#writeaccess) - -### Methods - -- [delete](verida_client_ts._internal_.Profile.md#delete) -- [get](verida_client_ts._internal_.Profile.md#get) -- [getMany](verida_client_ts._internal_.Profile.md#getmany) -- [getRecord](verida_client_ts._internal_.Profile.md#getrecord) -- [init](verida_client_ts._internal_.Profile.md#init) -- [listen](verida_client_ts._internal_.Profile.md#listen) -- [saveRecord](verida_client_ts._internal_.Profile.md#saverecord) -- [set](verida_client_ts._internal_.Profile.md#set) -- [setMany](verida_client_ts._internal_.Profile.md#setmany) -- [verifyWebsite](verida_client_ts._internal_.Profile.md#verifywebsite) - -## Constructors - -### constructor - -• **new Profile**(`context`, `did`, `profileName`, `writeAccess`, `isPrivate?`) - -Create a new user profile. - -**Do not instantiate directly.** - -Access the current user's profile via {@link App.profile} - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `context` | [`Context`](verida_client_ts.Context.md) | `undefined` | -| `did` | `string` | `undefined` | -| `profileName` | `string` | `undefined` | -| `writeAccess` | `boolean` | `undefined` | -| `isPrivate` | `boolean` | `false` | - -#### Overrides - -EventEmitter.constructor - -#### Defined in - -[packages/client-ts/src/context/profiles/profile.ts:41](https://github.com/verida/verida-js/blob/5040472/packages/client-ts/src/context/profiles/profile.ts#L41) - -## Properties - -### context - -• `Private` **context**: [`Context`](verida_client_ts.Context.md) - -#### Defined in - -[packages/client-ts/src/context/profiles/profile.ts:22](https://github.com/verida/verida-js/blob/5040472/packages/client-ts/src/context/profiles/profile.ts#L22) - -___ - -### did - -• `Private` **did**: `string` - -#### Defined in - -[packages/client-ts/src/context/profiles/profile.ts:23](https://github.com/verida/verida-js/blob/5040472/packages/client-ts/src/context/profiles/profile.ts#L23) - -___ - -### errors - -• **errors**: `object` - -#### Defined in - -[packages/client-ts/src/context/profiles/profile.ts:31](https://github.com/verida/verida-js/blob/5040472/packages/client-ts/src/context/profiles/profile.ts#L31) - -___ - -### isPrivate - -• `Private` **isPrivate**: `boolean` - -#### Defined in - -[packages/client-ts/src/context/profiles/profile.ts:29](https://github.com/verida/verida-js/blob/5040472/packages/client-ts/src/context/profiles/profile.ts#L29) - -___ - -### profileName - -• `Private` **profileName**: `string` - -#### Defined in - -[packages/client-ts/src/context/profiles/profile.ts:25](https://github.com/verida/verida-js/blob/5040472/packages/client-ts/src/context/profiles/profile.ts#L25) - -___ - -### store - -• `Private` `Optional` **store**: [`Datastore`](verida_client_ts._internal_.Datastore.md) - -#### Defined in - -[packages/client-ts/src/context/profiles/profile.ts:26](https://github.com/verida/verida-js/blob/5040472/packages/client-ts/src/context/profiles/profile.ts#L26) - -___ - -### writeAccess - -• `Private` **writeAccess**: `boolean` - -#### Defined in - -[packages/client-ts/src/context/profiles/profile.ts:28](https://github.com/verida/verida-js/blob/5040472/packages/client-ts/src/context/profiles/profile.ts#L28) - -## Methods - -### delete - -▸ **delete**(`key`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `key` | `string` | Profile key to delete (ie: `email`) | - -#### Returns - -`Promise`<`boolean`\> - -Boolean indicating if the delete was successful - -#### Implementation of - -[IProfile](../interfaces/verida_client_ts._internal_.IProfile.md).[delete](../interfaces/verida_client_ts._internal_.IProfile.md#delete) - -#### Defined in - -[packages/client-ts/src/context/profiles/profile.ts:87](https://github.com/verida/verida-js/blob/5040472/packages/client-ts/src/context/profiles/profile.ts#L87) - -___ - -### get - -▸ **get**(`key`, `options?`, `extended?`): `Promise`<`any`\> - -Get a profile value by key - -**`example`** -let emailDoc = app.wallet.profile.get('email'); - -// key = email -// value = john@doe.com -console.log(emailDoc.key, emailDoc.value); - -#### Parameters - -| Name | Type | Default value | Description | -| :------ | :------ | :------ | :------ | -| `key` | `string` | `undefined` | Profile key to get (ie: `email`) | -| `options?` | `any` | `undefined` | | -| `extended` | `boolean` | `false` | | - -#### Returns - -`Promise`<`any`\> - -Database record for this profile key. Object has keys [`key`, `value`, `_id`, `_rev`]. - -#### Implementation of - -[IProfile](../interfaces/verida_client_ts._internal_.IProfile.md).[get](../interfaces/verida_client_ts._internal_.IProfile.md#get) - -#### Defined in - -[packages/client-ts/src/context/profiles/profile.ts:71](https://github.com/verida/verida-js/blob/5040472/packages/client-ts/src/context/profiles/profile.ts#L71) - -___ - -### getMany - -▸ **getMany**(`filter`, `options`): `Promise`<`any`\> - -Get many profile values. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `filter` | `any` | -| `options` | `any` | - -#### Returns - -`Promise`<`any`\> - -#### Implementation of - -[IProfile](../interfaces/verida_client_ts._internal_.IProfile.md).[getMany](../interfaces/verida_client_ts._internal_.IProfile.md#getmany) - -#### Defined in - -[packages/client-ts/src/context/profiles/profile.ts:103](https://github.com/verida/verida-js/blob/5040472/packages/client-ts/src/context/profiles/profile.ts#L103) - -___ - -### getRecord - -▸ `Private` **getRecord**(): `Promise`<[`ProfileDocument`](../interfaces/verida_client_ts._internal_.ProfileDocument.md)\> - -#### Returns - -`Promise`<[`ProfileDocument`](../interfaces/verida_client_ts._internal_.ProfileDocument.md)\> - -#### Defined in - -[packages/client-ts/src/context/profiles/profile.ts:172](https://github.com/verida/verida-js/blob/5040472/packages/client-ts/src/context/profiles/profile.ts#L172) - -___ - -### init - -▸ `Private` **init**(): `Promise`<`void`\> - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -[packages/client-ts/src/context/profiles/profile.ts:206](https://github.com/verida/verida-js/blob/5040472/packages/client-ts/src/context/profiles/profile.ts#L206) - -___ - -### listen - -▸ **listen**(`callback`): `Promise`<`any`\> - -Listen for changes to the public profile - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `callback` | `any` | - -#### Returns - -`Promise`<`any`\> - -#### Implementation of - -[IProfile](../interfaces/verida_client_ts._internal_.IProfile.md).[listen](../interfaces/verida_client_ts._internal_.IProfile.md#listen) - -#### Defined in - -[packages/client-ts/src/context/profiles/profile.ts:149](https://github.com/verida/verida-js/blob/5040472/packages/client-ts/src/context/profiles/profile.ts#L149) - -___ - -### saveRecord - -▸ `Private` **saveRecord**(`record`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `record` | `object` | - -#### Returns - -`Promise`<`boolean`\> - -#### Defined in - -[packages/client-ts/src/context/profiles/profile.ts:195](https://github.com/verida/verida-js/blob/5040472/packages/client-ts/src/context/profiles/profile.ts#L195) - -___ - -### set - -▸ **set**(`key`, `value`): `Promise`<`any`\> - -Set a profile value by key - -**`example`** -// Set a profile value by key -app.wallet.profile.set('name', 'John'); - -// Update a profile value from an existing document -let emailDoc = app.wallet.profile.get('email'); -app.wallet.profile.set(emailDoc, 'john@doe.com'); - -// Update a profile profile by key -app.wallet.profile.set('email', 'john@doe.com'); - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `key` | `string` | Profile key to set (ie: `email`) | -| `value` | `any` | Value to save | - -#### Returns - -`Promise`<`any`\> - -Boolean indicating if the save was successful - -#### Implementation of - -[IProfile](../interfaces/verida_client_ts._internal_.IProfile.md).[set](../interfaces/verida_client_ts._internal_.IProfile.md#set) - -#### Defined in - -[packages/client-ts/src/context/profiles/profile.ts:124](https://github.com/verida/verida-js/blob/5040472/packages/client-ts/src/context/profiles/profile.ts#L124) - -___ - -### setMany - -▸ **setMany**(`data`): `Promise`<`any`\> - -Set many profile key / values at once - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `any` | - -#### Returns - -`Promise`<`any`\> - -#### Implementation of - -[IProfile](../interfaces/verida_client_ts._internal_.IProfile.md).[setMany](../interfaces/verida_client_ts._internal_.IProfile.md#setmany) - -#### Defined in - -[packages/client-ts/src/context/profiles/profile.ts:135](https://github.com/verida/verida-js/blob/5040472/packages/client-ts/src/context/profiles/profile.ts#L135) - -___ - -### verifyWebsite - -▸ **verifyWebsite**(): `Promise`<`boolean`\> - -#### Returns - -`Promise`<`boolean`\> - -#### Defined in - -[packages/client-ts/src/context/profiles/profile.ts:163](https://github.com/verida/verida-js/blob/5040472/packages/client-ts/src/context/profiles/profile.ts#L163) diff --git a/docs/api/verida-js/classes/verida_client_ts._internal_.Provider.md b/docs/api/verida-js/classes/verida_client_ts._internal_.Provider.md deleted file mode 100644 index a490518..0000000 --- a/docs/api/verida-js/classes/verida_client_ts._internal_.Provider.md +++ /dev/null @@ -1,645 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / Provider - -# Class: Provider - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).Provider - -## Implements - -- [`OnceBlockable`](../interfaces/verida_client_ts._internal_.OnceBlockable.md) - -## Table of contents - -### Constructors - -- [constructor](verida_client_ts._internal_.Provider.md#constructor) - -### Properties - -- [\_isProvider](verida_client_ts._internal_.Provider.md#_isprovider) - -### Methods - -- [addListener](verida_client_ts._internal_.Provider.md#addlistener) -- [call](verida_client_ts._internal_.Provider.md#call) -- [emit](verida_client_ts._internal_.Provider.md#emit) -- [estimateGas](verida_client_ts._internal_.Provider.md#estimategas) -- [getBalance](verida_client_ts._internal_.Provider.md#getbalance) -- [getBlock](verida_client_ts._internal_.Provider.md#getblock) -- [getBlockNumber](verida_client_ts._internal_.Provider.md#getblocknumber) -- [getBlockWithTransactions](verida_client_ts._internal_.Provider.md#getblockwithtransactions) -- [getCode](verida_client_ts._internal_.Provider.md#getcode) -- [getFeeData](verida_client_ts._internal_.Provider.md#getfeedata) -- [getGasPrice](verida_client_ts._internal_.Provider.md#getgasprice) -- [getLogs](verida_client_ts._internal_.Provider.md#getlogs) -- [getNetwork](verida_client_ts._internal_.Provider.md#getnetwork) -- [getStorageAt](verida_client_ts._internal_.Provider.md#getstorageat) -- [getTransaction](verida_client_ts._internal_.Provider.md#gettransaction) -- [getTransactionCount](verida_client_ts._internal_.Provider.md#gettransactioncount) -- [getTransactionReceipt](verida_client_ts._internal_.Provider.md#gettransactionreceipt) -- [listenerCount](verida_client_ts._internal_.Provider.md#listenercount) -- [listeners](verida_client_ts._internal_.Provider.md#listeners) -- [lookupAddress](verida_client_ts._internal_.Provider.md#lookupaddress) -- [off](verida_client_ts._internal_.Provider.md#off) -- [on](verida_client_ts._internal_.Provider.md#on) -- [once](verida_client_ts._internal_.Provider.md#once) -- [removeAllListeners](verida_client_ts._internal_.Provider.md#removealllisteners) -- [removeListener](verida_client_ts._internal_.Provider.md#removelistener) -- [resolveName](verida_client_ts._internal_.Provider.md#resolvename) -- [sendTransaction](verida_client_ts._internal_.Provider.md#sendtransaction) -- [waitForTransaction](verida_client_ts._internal_.Provider.md#waitfortransaction) -- [isProvider](verida_client_ts._internal_.Provider.md#isprovider) - -## Constructors - -### constructor - -• **new Provider**() - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:153 - -## Properties - -### \_isProvider - -• `Readonly` **\_isProvider**: `boolean` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:152 - -## Methods - -### addListener - -▸ **addListener**(`eventName`, `listener`): [`Provider`](verida_client_ts._internal_.Provider.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | [`EventType`](../modules/verida_client_ts._internal_.md#eventtype) | -| `listener` | [`Listener`](../modules/verida_client_ts._internal_.md#listener) | - -#### Returns - -[`Provider`](verida_client_ts._internal_.Provider.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:149 - -___ - -### call - -▸ `Abstract` **call**(`transaction`, `blockTag?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transaction` | [`Deferrable`](../modules/verida_client_ts._internal_.md#deferrable)<[`TransactionRequest`](../modules/verida_client_ts._internal_.md#transactionrequest)\> | -| `blockTag?` | [`BlockTag`](../modules/verida_client_ts._internal_.md#blocktag) \| `Promise`<[`BlockTag`](../modules/verida_client_ts._internal_.md#blocktag)\> | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:133 - -___ - -### emit - -▸ `Abstract` **emit**(`eventName`, ...`args`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | [`EventType`](../modules/verida_client_ts._internal_.md#eventtype) | -| `...args` | `any`[] | - -#### Returns - -`boolean` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:144 - -___ - -### estimateGas - -▸ `Abstract` **estimateGas**(`transaction`): `Promise`<[`BigNumber`](verida_client_ts._internal_.BigNumber.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transaction` | [`Deferrable`](../modules/verida_client_ts._internal_.md#deferrable)<[`TransactionRequest`](../modules/verida_client_ts._internal_.md#transactionrequest)\> | - -#### Returns - -`Promise`<[`BigNumber`](verida_client_ts._internal_.BigNumber.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:134 - -___ - -### getBalance - -▸ `Abstract` **getBalance**(`addressOrName`, `blockTag?`): `Promise`<[`BigNumber`](verida_client_ts._internal_.BigNumber.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `addressOrName` | `string` \| `Promise`<`string`\> | -| `blockTag?` | [`BlockTag`](../modules/verida_client_ts._internal_.md#blocktag) \| `Promise`<[`BlockTag`](../modules/verida_client_ts._internal_.md#blocktag)\> | - -#### Returns - -`Promise`<[`BigNumber`](verida_client_ts._internal_.BigNumber.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:128 - -___ - -### getBlock - -▸ `Abstract` **getBlock**(`blockHashOrBlockTag`): `Promise`<[`Block`](../interfaces/verida_client_ts._internal_.Block.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `blockHashOrBlockTag` | [`BlockTag`](../modules/verida_client_ts._internal_.md#blocktag) \| `Promise`<[`BlockTag`](../modules/verida_client_ts._internal_.md#blocktag)\> | - -#### Returns - -`Promise`<[`Block`](../interfaces/verida_client_ts._internal_.Block.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:135 - -___ - -### getBlockNumber - -▸ `Abstract` **getBlockNumber**(): `Promise`<`number`\> - -#### Returns - -`Promise`<`number`\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:125 - -___ - -### getBlockWithTransactions - -▸ `Abstract` **getBlockWithTransactions**(`blockHashOrBlockTag`): `Promise`<[`BlockWithTransactions`](../interfaces/verida_client_ts._internal_.BlockWithTransactions.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `blockHashOrBlockTag` | [`BlockTag`](../modules/verida_client_ts._internal_.md#blocktag) \| `Promise`<[`BlockTag`](../modules/verida_client_ts._internal_.md#blocktag)\> | - -#### Returns - -`Promise`<[`BlockWithTransactions`](../interfaces/verida_client_ts._internal_.BlockWithTransactions.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:136 - -___ - -### getCode - -▸ `Abstract` **getCode**(`addressOrName`, `blockTag?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `addressOrName` | `string` \| `Promise`<`string`\> | -| `blockTag?` | [`BlockTag`](../modules/verida_client_ts._internal_.md#blocktag) \| `Promise`<[`BlockTag`](../modules/verida_client_ts._internal_.md#blocktag)\> | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:130 - -___ - -### getFeeData - -▸ **getFeeData**(): `Promise`<[`FeeData`](../interfaces/verida_client_ts._internal_.FeeData.md)\> - -#### Returns - -`Promise`<[`FeeData`](../interfaces/verida_client_ts._internal_.FeeData.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:127 - -___ - -### getGasPrice - -▸ `Abstract` **getGasPrice**(): `Promise`<[`BigNumber`](verida_client_ts._internal_.BigNumber.md)\> - -#### Returns - -`Promise`<[`BigNumber`](verida_client_ts._internal_.BigNumber.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:126 - -___ - -### getLogs - -▸ `Abstract` **getLogs**(`filter`): `Promise`<[`Log`](../interfaces/verida_client_ts._internal_.Log.md)[]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `filter` | [`Filter`](../interfaces/verida_client_ts._internal_.Filter.md) | - -#### Returns - -`Promise`<[`Log`](../interfaces/verida_client_ts._internal_.Log.md)[]\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:139 - -___ - -### getNetwork - -▸ `Abstract` **getNetwork**(): `Promise`<[`Network`](../modules/verida_client_ts._internal_.md#network)\> - -#### Returns - -`Promise`<[`Network`](../modules/verida_client_ts._internal_.md#network)\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:124 - -___ - -### getStorageAt - -▸ `Abstract` **getStorageAt**(`addressOrName`, `position`, `blockTag?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `addressOrName` | `string` \| `Promise`<`string`\> | -| `position` | [`BigNumberish`](../modules/verida_client_ts._internal_.md#bignumberish) \| `Promise`<[`BigNumberish`](../modules/verida_client_ts._internal_.md#bignumberish)\> | -| `blockTag?` | [`BlockTag`](../modules/verida_client_ts._internal_.md#blocktag) \| `Promise`<[`BlockTag`](../modules/verida_client_ts._internal_.md#blocktag)\> | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:131 - -___ - -### getTransaction - -▸ `Abstract` **getTransaction**(`transactionHash`): `Promise`<[`TransactionResponse`](../interfaces/verida_client_ts._internal_.TransactionResponse.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transactionHash` | `string` | - -#### Returns - -`Promise`<[`TransactionResponse`](../interfaces/verida_client_ts._internal_.TransactionResponse.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:137 - -___ - -### getTransactionCount - -▸ `Abstract` **getTransactionCount**(`addressOrName`, `blockTag?`): `Promise`<`number`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `addressOrName` | `string` \| `Promise`<`string`\> | -| `blockTag?` | [`BlockTag`](../modules/verida_client_ts._internal_.md#blocktag) \| `Promise`<[`BlockTag`](../modules/verida_client_ts._internal_.md#blocktag)\> | - -#### Returns - -`Promise`<`number`\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:129 - -___ - -### getTransactionReceipt - -▸ `Abstract` **getTransactionReceipt**(`transactionHash`): `Promise`<[`TransactionReceipt`](../interfaces/verida_client_ts._internal_.TransactionReceipt.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transactionHash` | `string` | - -#### Returns - -`Promise`<[`TransactionReceipt`](../interfaces/verida_client_ts._internal_.TransactionReceipt.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:138 - -___ - -### listenerCount - -▸ `Abstract` **listenerCount**(`eventName?`): `number` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName?` | [`EventType`](../modules/verida_client_ts._internal_.md#eventtype) | - -#### Returns - -`number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:145 - -___ - -### listeners - -▸ `Abstract` **listeners**(`eventName?`): [`Listener`](../modules/verida_client_ts._internal_.md#listener)[] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName?` | [`EventType`](../modules/verida_client_ts._internal_.md#eventtype) | - -#### Returns - -[`Listener`](../modules/verida_client_ts._internal_.md#listener)[] - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:146 - -___ - -### lookupAddress - -▸ `Abstract` **lookupAddress**(`address`): `Promise`<``null`` \| `string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `address` | `string` \| `Promise`<`string`\> | - -#### Returns - -`Promise`<``null`` \| `string`\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:141 - -___ - -### off - -▸ `Abstract` **off**(`eventName`, `listener?`): [`Provider`](verida_client_ts._internal_.Provider.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | [`EventType`](../modules/verida_client_ts._internal_.md#eventtype) | -| `listener?` | [`Listener`](../modules/verida_client_ts._internal_.md#listener) | - -#### Returns - -[`Provider`](verida_client_ts._internal_.Provider.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:147 - -___ - -### on - -▸ `Abstract` **on**(`eventName`, `listener`): [`Provider`](verida_client_ts._internal_.Provider.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | [`EventType`](../modules/verida_client_ts._internal_.md#eventtype) | -| `listener` | [`Listener`](../modules/verida_client_ts._internal_.md#listener) | - -#### Returns - -[`Provider`](verida_client_ts._internal_.Provider.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:142 - -___ - -### once - -▸ `Abstract` **once**(`eventName`, `listener`): [`Provider`](verida_client_ts._internal_.Provider.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | [`EventType`](../modules/verida_client_ts._internal_.md#eventtype) | -| `listener` | [`Listener`](../modules/verida_client_ts._internal_.md#listener) | - -#### Returns - -[`Provider`](verida_client_ts._internal_.Provider.md) - -#### Implementation of - -[OnceBlockable](../interfaces/verida_client_ts._internal_.OnceBlockable.md).[once](../interfaces/verida_client_ts._internal_.OnceBlockable.md#once) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:143 - -___ - -### removeAllListeners - -▸ `Abstract` **removeAllListeners**(`eventName?`): [`Provider`](verida_client_ts._internal_.Provider.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName?` | [`EventType`](../modules/verida_client_ts._internal_.md#eventtype) | - -#### Returns - -[`Provider`](verida_client_ts._internal_.Provider.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:148 - -___ - -### removeListener - -▸ **removeListener**(`eventName`, `listener`): [`Provider`](verida_client_ts._internal_.Provider.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | [`EventType`](../modules/verida_client_ts._internal_.md#eventtype) | -| `listener` | [`Listener`](../modules/verida_client_ts._internal_.md#listener) | - -#### Returns - -[`Provider`](verida_client_ts._internal_.Provider.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:150 - -___ - -### resolveName - -▸ `Abstract` **resolveName**(`name`): `Promise`<``null`` \| `string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` \| `Promise`<`string`\> | - -#### Returns - -`Promise`<``null`` \| `string`\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:140 - -___ - -### sendTransaction - -▸ `Abstract` **sendTransaction**(`signedTransaction`): `Promise`<[`TransactionResponse`](../interfaces/verida_client_ts._internal_.TransactionResponse.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `signedTransaction` | `string` \| `Promise`<`string`\> | - -#### Returns - -`Promise`<[`TransactionResponse`](../interfaces/verida_client_ts._internal_.TransactionResponse.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:132 - -___ - -### waitForTransaction - -▸ `Abstract` **waitForTransaction**(`transactionHash`, `confirmations?`, `timeout?`): `Promise`<[`TransactionReceipt`](../interfaces/verida_client_ts._internal_.TransactionReceipt.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transactionHash` | `string` | -| `confirmations?` | `number` | -| `timeout?` | `number` | - -#### Returns - -`Promise`<[`TransactionReceipt`](../interfaces/verida_client_ts._internal_.TransactionReceipt.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:151 - -___ - -### isProvider - -▸ `Static` **isProvider**(`value`): value is Provider - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `any` | - -#### Returns - -value is Provider - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:154 diff --git a/docs/api/verida-js/classes/verida_client_ts._internal_.Schema.md b/docs/api/verida-js/classes/verida_client_ts._internal_.Schema.md deleted file mode 100644 index c09b6b6..0000000 --- a/docs/api/verida-js/classes/verida_client_ts._internal_.Schema.md +++ /dev/null @@ -1,401 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / Schema - -# Class: Schema - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).Schema - -## Implements - -- [`ISchema`](../interfaces/verida_client_ts._internal_.ISchema.md) - -## Table of contents - -### Constructors - -- [constructor](verida_client_ts._internal_.Schema.md#constructor) - -### Properties - -- [ajv](verida_client_ts._internal_.Schema.md#ajv) -- [errors](verida_client_ts._internal_.Schema.md#errors) -- [finalPath](verida_client_ts._internal_.Schema.md#finalpath) -- [path](verida_client_ts._internal_.Schema.md#path) -- [schemaJson](verida_client_ts._internal_.Schema.md#schemajson) -- [specification](verida_client_ts._internal_.Schema.md#specification) -- [validateFunction](verida_client_ts._internal_.Schema.md#validatefunction) -- [schemaPaths](verida_client_ts._internal_.Schema.md#schemapaths) -- [schemas](verida_client_ts._internal_.Schema.md#schemas) - -### Methods - -- [getAppearance](verida_client_ts._internal_.Schema.md#getappearance) -- [getPath](verida_client_ts._internal_.Schema.md#getpath) -- [getSchemaJson](verida_client_ts._internal_.Schema.md#getschemajson) -- [getSpecification](verida_client_ts._internal_.Schema.md#getspecification) -- [validate](verida_client_ts._internal_.Schema.md#validate) -- [getSchema](verida_client_ts._internal_.Schema.md#getschema) -- [getSchemaPaths](verida_client_ts._internal_.Schema.md#getschemapaths) -- [getVersionlessSchemaName](verida_client_ts._internal_.Schema.md#getversionlessschemaname) -- [loadJson](verida_client_ts._internal_.Schema.md#loadjson) -- [resolvePath](verida_client_ts._internal_.Schema.md#resolvepath) -- [setSchemaPaths](verida_client_ts._internal_.Schema.md#setschemapaths) - -## Constructors - -### constructor - -• **new Schema**(`path`, `options?`) - -An object representation of a JSON Schema. - -**Do not instantiate directly.** - -Access via {@link App#getSchema} - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `path` | `string` | Path to a schema in the form (http://..../schema.json, /schemas/name/schema.json, name/of/schema) | -| `options` | `any` | - | - -#### Defined in - -[packages/client-ts/src/context/schema.ts:51](https://github.com/verida/verida-js/blob/5040472/packages/client-ts/src/context/schema.ts#L51) - -## Properties - -### ajv - -• `Protected` **ajv**: [`Ajv2020`](verida_client_ts._internal_.Ajv2020.md) - -#### Defined in - -[packages/client-ts/src/context/schema.ts:32](https://github.com/verida/verida-js/blob/5040472/packages/client-ts/src/context/schema.ts#L32) - -___ - -### errors - -• **errors**: `string`[] - -#### Implementation of - -[ISchema](../interfaces/verida_client_ts._internal_.ISchema.md).[errors](../interfaces/verida_client_ts._internal_.ISchema.md#errors) - -#### Defined in - -[packages/client-ts/src/context/schema.ts:29](https://github.com/verida/verida-js/blob/5040472/packages/client-ts/src/context/schema.ts#L29) - -___ - -### finalPath - -• `Protected` `Optional` **finalPath**: `string` - -#### Defined in - -[packages/client-ts/src/context/schema.ts:35](https://github.com/verida/verida-js/blob/5040472/packages/client-ts/src/context/schema.ts#L35) - -___ - -### path - -• `Protected` **path**: `string` - -#### Defined in - -[packages/client-ts/src/context/schema.ts:31](https://github.com/verida/verida-js/blob/5040472/packages/client-ts/src/context/schema.ts#L31) - -___ - -### schemaJson - -• `Protected` `Optional` **schemaJson**: `object` - -#### Defined in - -[packages/client-ts/src/context/schema.ts:34](https://github.com/verida/verida-js/blob/5040472/packages/client-ts/src/context/schema.ts#L34) - -___ - -### specification - -• `Protected` `Optional` **specification**: `any` - -#### Defined in - -[packages/client-ts/src/context/schema.ts:36](https://github.com/verida/verida-js/blob/5040472/packages/client-ts/src/context/schema.ts#L36) - -___ - -### validateFunction - -• `Protected` `Optional` **validateFunction**: `any` - -#### Defined in - -[packages/client-ts/src/context/schema.ts:37](https://github.com/verida/verida-js/blob/5040472/packages/client-ts/src/context/schema.ts#L37) - -___ - -### schemaPaths - -▪ `Static` `Protected` `Optional` **schemaPaths**: [`Record`](../modules/verida_client_ts._internal_.md#record)<`string`, `string`\> - -#### Defined in - -[packages/client-ts/src/context/schema.ts:39](https://github.com/verida/verida-js/blob/5040472/packages/client-ts/src/context/schema.ts#L39) - -___ - -### schemas - -▪ `Static` `Protected` **schemas**: `any` = `{}` - -#### Defined in - -[packages/client-ts/src/context/schema.ts:40](https://github.com/verida/verida-js/blob/5040472/packages/client-ts/src/context/schema.ts#L40) - -## Methods - -### getAppearance - -▸ **getAppearance**(): `Promise`<`any`\> - -#### Returns - -`Promise`<`any`\> - -#### Implementation of - -[ISchema](../interfaces/verida_client_ts._internal_.ISchema.md).[getAppearance](../interfaces/verida_client_ts._internal_.ISchema.md#getappearance) - -#### Defined in - -[packages/client-ts/src/context/schema.ts:155](https://github.com/verida/verida-js/blob/5040472/packages/client-ts/src/context/schema.ts#L155) - -___ - -### getPath - -▸ `Protected` **getPath**(): `Promise`<`string`\> - -Get a rully resolveable path for a URL - -Handle shortened paths: - - `health/activity` -> `https://common.schemas.verida.io/health/activity/latest/schema.json` - - `https://common/schemas.verida.io/health/activity/latest` -> `https://common.schemas.verida.io/health/activity/latest/schema.json` - - `/health/activity/test.json` -> `https://common/schemas.verida.io/health/activity/test.json` - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -[packages/client-ts/src/context/schema.ts:189](https://github.com/verida/verida-js/blob/5040472/packages/client-ts/src/context/schema.ts#L189) - -___ - -### getSchemaJson - -▸ **getSchemaJson**(): `Promise`<`object`\> - -Fetch unresolved JSON schema - -#### Returns - -`Promise`<`object`\> - -#### Implementation of - -[ISchema](../interfaces/verida_client_ts._internal_.ISchema.md).[getSchemaJson](../interfaces/verida_client_ts._internal_.ISchema.md#getschemajson) - -#### Defined in - -[packages/client-ts/src/context/schema.ts:141](https://github.com/verida/verida-js/blob/5040472/packages/client-ts/src/context/schema.ts#L141) - -___ - -### getSpecification - -▸ **getSpecification**(): `Promise`<`any`\> - -**`todo:`** Deprecate in favour of `getProperties()` -Get an object that represents the JSON Schema. Fully resolved. -Warning: This can cause issues with very large schemas. - -**`example`** -let schemaDoc = await app.getSchema("social/contact"); -let spec = schemaDoc.getSpecification(); -console.log(spec); - -#### Returns - -`Promise`<`any`\> - -JSON object representing the defereferenced schema - -#### Implementation of - -[ISchema](../interfaces/verida_client_ts._internal_.ISchema.md).[getSpecification](../interfaces/verida_client_ts._internal_.ISchema.md#getspecification) - -#### Defined in - -[packages/client-ts/src/context/schema.ts:103](https://github.com/verida/verida-js/blob/5040472/packages/client-ts/src/context/schema.ts#L103) - -___ - -### validate - -▸ **validate**(`data`): `Promise`<`boolean`\> - -Validate a data object with this schema, using AJV - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `any` | - -#### Returns - -`Promise`<`boolean`\> - -True if the data validates against the schema. - -#### Implementation of - -[ISchema](../interfaces/verida_client_ts._internal_.ISchema.md).[validate](../interfaces/verida_client_ts._internal_.ISchema.md#validate) - -#### Defined in - -[packages/client-ts/src/context/schema.ts:123](https://github.com/verida/verida-js/blob/5040472/packages/client-ts/src/context/schema.ts#L123) - -___ - -### getSchema - -▸ `Static` **getSchema**(`schemaName`): `Promise`<[`Schema`](verida_client_ts._internal_.Schema.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schemaName` | `string` | - -#### Returns - -`Promise`<[`Schema`](verida_client_ts._internal_.Schema.md)\> - -#### Defined in - -[packages/client-ts/src/context/schema.ts:76](https://github.com/verida/verida-js/blob/5040472/packages/client-ts/src/context/schema.ts#L76) - -___ - -### getSchemaPaths - -▸ `Static` **getSchemaPaths**(): [`Record`](../modules/verida_client_ts._internal_.md#record)<`string`, `string`\> - -#### Returns - -[`Record`](../modules/verida_client_ts._internal_.md#record)<`string`, `string`\> - -#### Defined in - -[packages/client-ts/src/context/schema.ts:88](https://github.com/verida/verida-js/blob/5040472/packages/client-ts/src/context/schema.ts#L88) - -___ - -### getVersionlessSchemaName - -▸ `Static` **getVersionlessSchemaName**(`schemaName`): `string` - -Checks a version specified in schemaName - -SchemaName example :- https://core.schemas.verida.io/base/v0.1.0/schema.json -SchemaName format :- https://{protocol-name}/{name}/{v}{version}/name.json - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schemaName` | `string` | - -#### Returns - -`string` - -schemaName without the version - -#### Defined in - -[packages/client-ts/src/context/schema.ts:272](https://github.com/verida/verida-js/blob/5040472/packages/client-ts/src/context/schema.ts#L272) - -___ - -### loadJson - -▸ `Static` **loadJson**(`uri`): `Promise`<`object`\> - -Load JSON from a url that is fully resolved. - -Used by AJV. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `uri` | `string` | - -#### Returns - -`Promise`<`object`\> - -#### Defined in - -[packages/client-ts/src/context/schema.ts:241](https://github.com/verida/verida-js/blob/5040472/packages/client-ts/src/context/schema.ts#L241) - -___ - -### resolvePath - -▸ `Static` **resolvePath**(`uri`): `Promise`<`string`\> - -Force schema paths to be applied to URLs - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `uri` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -[packages/client-ts/src/context/schema.ts:221](https://github.com/verida/verida-js/blob/5040472/packages/client-ts/src/context/schema.ts#L221) - -___ - -### setSchemaPaths - -▸ `Static` **setSchemaPaths**(`schemaPaths`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schemaPaths` | [`Record`](../modules/verida_client_ts._internal_.md#record)<`string`, `string`\> | - -#### Returns - -`void` - -#### Defined in - -[packages/client-ts/src/context/schema.ts:84](https://github.com/verida/verida-js/blob/5040472/packages/client-ts/src/context/schema.ts#L84) diff --git a/docs/api/verida-js/classes/verida_client_ts._internal_.SchemaEnv.md b/docs/api/verida-js/classes/verida_client_ts._internal_.SchemaEnv.md deleted file mode 100644 index e229a13..0000000 --- a/docs/api/verida-js/classes/verida_client_ts._internal_.SchemaEnv.md +++ /dev/null @@ -1,266 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / SchemaEnv - -# Class: SchemaEnv - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).SchemaEnv - -## Implements - -- [`SchemaEnvArgs`](../interfaces/verida_client_ts._internal_.SchemaEnvArgs.md) - -## Table of contents - -### Constructors - -- [constructor](verida_client_ts._internal_.SchemaEnv.md#constructor) - -### Properties - -- [$async](verida_client_ts._internal_.SchemaEnv.md#$async) -- [baseId](verida_client_ts._internal_.SchemaEnv.md#baseid) -- [dynamicAnchors](verida_client_ts._internal_.SchemaEnv.md#dynamicanchors) -- [localRefs](verida_client_ts._internal_.SchemaEnv.md#localrefs) -- [meta](verida_client_ts._internal_.SchemaEnv.md#meta) -- [parse](verida_client_ts._internal_.SchemaEnv.md#parse) -- [parseName](verida_client_ts._internal_.SchemaEnv.md#parsename) -- [refs](verida_client_ts._internal_.SchemaEnv.md#refs) -- [root](verida_client_ts._internal_.SchemaEnv.md#root) -- [schema](verida_client_ts._internal_.SchemaEnv.md#schema) -- [schemaId](verida_client_ts._internal_.SchemaEnv.md#schemaid) -- [schemaPath](verida_client_ts._internal_.SchemaEnv.md#schemapath) -- [serialize](verida_client_ts._internal_.SchemaEnv.md#serialize) -- [serializeName](verida_client_ts._internal_.SchemaEnv.md#serializename) -- [validate](verida_client_ts._internal_.SchemaEnv.md#validate) -- [validateName](verida_client_ts._internal_.SchemaEnv.md#validatename) - -## Constructors - -### constructor - -• **new SchemaEnv**(`env`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `env` | [`SchemaEnvArgs`](../interfaces/verida_client_ts._internal_.SchemaEnvArgs.md) | - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:73 - -## Properties - -### $async - -• `Optional` `Readonly` **$async**: `boolean` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:62 - -___ - -### baseId - -• **baseId**: `string` - -#### Implementation of - -[SchemaEnvArgs](../interfaces/verida_client_ts._internal_.SchemaEnvArgs.md).[baseId](../interfaces/verida_client_ts._internal_.SchemaEnvArgs.md#baseid) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:58 - -___ - -### dynamicAnchors - -• `Readonly` **dynamicAnchors**: `Object` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:64 - -___ - -### localRefs - -• `Optional` **localRefs**: [`LocalRefs`](../modules/verida_client_ts._internal_.md#localrefs) - -#### Implementation of - -[SchemaEnvArgs](../interfaces/verida_client_ts._internal_.SchemaEnvArgs.md).[localRefs](../interfaces/verida_client_ts._internal_.SchemaEnvArgs.md#localrefs) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:60 - -___ - -### meta - -• `Optional` `Readonly` **meta**: `boolean` - -#### Implementation of - -[SchemaEnvArgs](../interfaces/verida_client_ts._internal_.SchemaEnvArgs.md).[meta](../interfaces/verida_client_ts._internal_.SchemaEnvArgs.md#meta) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:61 - -___ - -### parse - -• `Optional` **parse**: (`data`: `string`) => `unknown` - -#### Type declaration - -▸ (`data`): `unknown` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `string` | - -##### Returns - -`unknown` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:71 - -___ - -### parseName - -• `Optional` **parseName**: [`ValueScopeName`](verida_client_ts._internal_.ValueScopeName.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:72 - -___ - -### refs - -• `Readonly` **refs**: [`SchemaRefs`](../modules/verida_client_ts._internal_.md#schemarefs) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:63 - -___ - -### root - -• `Readonly` **root**: [`SchemaEnv`](verida_client_ts._internal_.SchemaEnv.md) - -#### Implementation of - -[SchemaEnvArgs](../interfaces/verida_client_ts._internal_.SchemaEnvArgs.md).[root](../interfaces/verida_client_ts._internal_.SchemaEnvArgs.md#root) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:57 - -___ - -### schema - -• `Readonly` **schema**: [`AnySchema`](../modules/verida_client_ts._internal_.md#anyschema) - -#### Implementation of - -[SchemaEnvArgs](../interfaces/verida_client_ts._internal_.SchemaEnvArgs.md).[schema](../interfaces/verida_client_ts._internal_.SchemaEnvArgs.md#schema) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:55 - -___ - -### schemaId - -• `Optional` `Readonly` **schemaId**: ``"id"`` \| ``"$id"`` - -#### Implementation of - -[SchemaEnvArgs](../interfaces/verida_client_ts._internal_.SchemaEnvArgs.md).[schemaId](../interfaces/verida_client_ts._internal_.SchemaEnvArgs.md#schemaid) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:56 - -___ - -### schemaPath - -• `Optional` **schemaPath**: `string` - -#### Implementation of - -[SchemaEnvArgs](../interfaces/verida_client_ts._internal_.SchemaEnvArgs.md).[schemaPath](../interfaces/verida_client_ts._internal_.SchemaEnvArgs.md#schemapath) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:59 - -___ - -### serialize - -• `Optional` **serialize**: (`data`: `unknown`) => `string` - -#### Type declaration - -▸ (`data`): `string` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `unknown` | - -##### Returns - -`string` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:69 - -___ - -### serializeName - -• `Optional` **serializeName**: [`ValueScopeName`](verida_client_ts._internal_.ValueScopeName.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:70 - -___ - -### validate - -• `Optional` **validate**: [`AnyValidateFunction`](../modules/verida_client_ts._internal_.md#anyvalidatefunction)<`any`\> - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:67 - -___ - -### validateName - -• `Optional` **validateName**: [`ValueScopeName`](verida_client_ts._internal_.ValueScopeName.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:68 diff --git a/docs/api/verida-js/classes/verida_client_ts._internal_.Scope.md b/docs/api/verida-js/classes/verida_client_ts._internal_.Scope.md deleted file mode 100644 index b4a120e..0000000 --- a/docs/api/verida-js/classes/verida_client_ts._internal_.Scope.md +++ /dev/null @@ -1,146 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / Scope - -# Class: Scope - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).Scope - -## Hierarchy - -- **`Scope`** - - ↳ [`ValueScope`](verida_client_ts._internal_.ValueScope.md) - -## Table of contents - -### Constructors - -- [constructor](verida_client_ts._internal_.Scope.md#constructor) - -### Properties - -- [\_nameGroup](verida_client_ts._internal_.Scope.md#_namegroup) -- [\_names](verida_client_ts._internal_.Scope.md#_names) -- [\_parent](verida_client_ts._internal_.Scope.md#_parent) -- [\_prefixes](verida_client_ts._internal_.Scope.md#_prefixes) - -### Methods - -- [\_newName](verida_client_ts._internal_.Scope.md#_newname) -- [name](verida_client_ts._internal_.Scope.md#name) -- [toName](verida_client_ts._internal_.Scope.md#toname) - -## Constructors - -### constructor - -• **new Scope**(`__namedParameters?`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `__namedParameters?` | [`ScopeOptions`](../interfaces/verida_client_ts._internal_.ScopeOptions.md) | - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/scope.d.ts:46 - -## Properties - -### \_nameGroup - -• `Private` **\_nameGroup**: `any` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/scope.d.ts:50 - -___ - -### \_names - -• `Protected` `Readonly` **\_names**: `Object` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/scope.d.ts:41 - -___ - -### \_parent - -• `Protected` `Optional` `Readonly` **\_parent**: [`Scope`](verida_client_ts._internal_.Scope.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/scope.d.ts:45 - -___ - -### \_prefixes - -• `Protected` `Optional` `Readonly` **\_prefixes**: `Set`<`string`\> - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/scope.d.ts:44 - -## Methods - -### \_newName - -▸ `Protected` **_newName**(`prefix`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `prefix` | `string` | - -#### Returns - -`string` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/scope.d.ts:49 - -___ - -### name - -▸ **name**(`prefix`): [`Name`](verida_client_ts._internal_.Name.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `prefix` | `string` | - -#### Returns - -[`Name`](verida_client_ts._internal_.Name.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/scope.d.ts:48 - -___ - -### toName - -▸ **toName**(`nameOrPrefix`): [`Name`](verida_client_ts._internal_.Name.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `nameOrPrefix` | `string` \| [`Name`](verida_client_ts._internal_.Name.md) | - -#### Returns - -[`Name`](verida_client_ts._internal_.Name.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/scope.d.ts:47 diff --git a/docs/api/verida-js/classes/verida_client_ts._internal_.Signer.md b/docs/api/verida-js/classes/verida_client_ts._internal_.Signer.md deleted file mode 100644 index 24fd8ef..0000000 --- a/docs/api/verida-js/classes/verida_client_ts._internal_.Signer.md +++ /dev/null @@ -1,383 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / Signer - -# Class: Signer - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).Signer - -## Table of contents - -### Constructors - -- [constructor](verida_client_ts._internal_.Signer.md#constructor) - -### Properties - -- [\_isSigner](verida_client_ts._internal_.Signer.md#_issigner) -- [provider](verida_client_ts._internal_.Signer.md#provider) - -### Methods - -- [\_checkProvider](verida_client_ts._internal_.Signer.md#_checkprovider) -- [call](verida_client_ts._internal_.Signer.md#call) -- [checkTransaction](verida_client_ts._internal_.Signer.md#checktransaction) -- [connect](verida_client_ts._internal_.Signer.md#connect) -- [estimateGas](verida_client_ts._internal_.Signer.md#estimategas) -- [getAddress](verida_client_ts._internal_.Signer.md#getaddress) -- [getBalance](verida_client_ts._internal_.Signer.md#getbalance) -- [getChainId](verida_client_ts._internal_.Signer.md#getchainid) -- [getFeeData](verida_client_ts._internal_.Signer.md#getfeedata) -- [getGasPrice](verida_client_ts._internal_.Signer.md#getgasprice) -- [getTransactionCount](verida_client_ts._internal_.Signer.md#gettransactioncount) -- [populateTransaction](verida_client_ts._internal_.Signer.md#populatetransaction) -- [resolveName](verida_client_ts._internal_.Signer.md#resolvename) -- [sendTransaction](verida_client_ts._internal_.Signer.md#sendtransaction) -- [signMessage](verida_client_ts._internal_.Signer.md#signmessage) -- [signTransaction](verida_client_ts._internal_.Signer.md#signtransaction) -- [isSigner](verida_client_ts._internal_.Signer.md#issigner) - -## Constructors - -### constructor - -• **new Signer**() - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:30 - -## Properties - -### \_isSigner - -• `Readonly` **\_isSigner**: `boolean` - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:29 - -___ - -### provider - -• `Optional` `Readonly` **provider**: [`Provider`](verida_client_ts._internal_.Provider.md) - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:24 - -## Methods - -### \_checkProvider - -▸ **_checkProvider**(`operation?`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `operation?` | `string` | - -#### Returns - -`void` - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:42 - -___ - -### call - -▸ **call**(`transaction`, `blockTag?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transaction` | [`Deferrable`](../modules/verida_client_ts._internal_.md#deferrable)<[`TransactionRequest`](../modules/verida_client_ts._internal_.md#transactionrequest)\> | -| `blockTag?` | [`BlockTag`](../modules/verida_client_ts._internal_.md#blocktag) | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:34 - -___ - -### checkTransaction - -▸ **checkTransaction**(`transaction`): [`Deferrable`](../modules/verida_client_ts._internal_.md#deferrable)<[`TransactionRequest`](../modules/verida_client_ts._internal_.md#transactionrequest)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transaction` | [`Deferrable`](../modules/verida_client_ts._internal_.md#deferrable)<[`TransactionRequest`](../modules/verida_client_ts._internal_.md#transactionrequest)\> | - -#### Returns - -[`Deferrable`](../modules/verida_client_ts._internal_.md#deferrable)<[`TransactionRequest`](../modules/verida_client_ts._internal_.md#transactionrequest)\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:40 - -___ - -### connect - -▸ `Abstract` **connect**(`provider`): [`Signer`](verida_client_ts._internal_.Signer.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `provider` | [`Provider`](verida_client_ts._internal_.Provider.md) | - -#### Returns - -[`Signer`](verida_client_ts._internal_.Signer.md) - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:28 - -___ - -### estimateGas - -▸ **estimateGas**(`transaction`): `Promise`<[`BigNumber`](verida_client_ts._internal_.BigNumber.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transaction` | [`Deferrable`](../modules/verida_client_ts._internal_.md#deferrable)<[`TransactionRequest`](../modules/verida_client_ts._internal_.md#transactionrequest)\> | - -#### Returns - -`Promise`<[`BigNumber`](verida_client_ts._internal_.BigNumber.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:33 - -___ - -### getAddress - -▸ `Abstract` **getAddress**(): `Promise`<`string`\> - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:25 - -___ - -### getBalance - -▸ **getBalance**(`blockTag?`): `Promise`<[`BigNumber`](verida_client_ts._internal_.BigNumber.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `blockTag?` | [`BlockTag`](../modules/verida_client_ts._internal_.md#blocktag) | - -#### Returns - -`Promise`<[`BigNumber`](verida_client_ts._internal_.BigNumber.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:31 - -___ - -### getChainId - -▸ **getChainId**(): `Promise`<`number`\> - -#### Returns - -`Promise`<`number`\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:36 - -___ - -### getFeeData - -▸ **getFeeData**(): `Promise`<[`FeeData`](../interfaces/verida_client_ts._internal_.FeeData.md)\> - -#### Returns - -`Promise`<[`FeeData`](../interfaces/verida_client_ts._internal_.FeeData.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:38 - -___ - -### getGasPrice - -▸ **getGasPrice**(): `Promise`<[`BigNumber`](verida_client_ts._internal_.BigNumber.md)\> - -#### Returns - -`Promise`<[`BigNumber`](verida_client_ts._internal_.BigNumber.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:37 - -___ - -### getTransactionCount - -▸ **getTransactionCount**(`blockTag?`): `Promise`<`number`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `blockTag?` | [`BlockTag`](../modules/verida_client_ts._internal_.md#blocktag) | - -#### Returns - -`Promise`<`number`\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:32 - -___ - -### populateTransaction - -▸ **populateTransaction**(`transaction`): `Promise`<[`TransactionRequest`](../modules/verida_client_ts._internal_.md#transactionrequest)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transaction` | [`Deferrable`](../modules/verida_client_ts._internal_.md#deferrable)<[`TransactionRequest`](../modules/verida_client_ts._internal_.md#transactionrequest)\> | - -#### Returns - -`Promise`<[`TransactionRequest`](../modules/verida_client_ts._internal_.md#transactionrequest)\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:41 - -___ - -### resolveName - -▸ **resolveName**(`name`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:39 - -___ - -### sendTransaction - -▸ **sendTransaction**(`transaction`): `Promise`<[`TransactionResponse`](../interfaces/verida_client_ts._internal_.TransactionResponse.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transaction` | [`Deferrable`](../modules/verida_client_ts._internal_.md#deferrable)<[`TransactionRequest`](../modules/verida_client_ts._internal_.md#transactionrequest)\> | - -#### Returns - -`Promise`<[`TransactionResponse`](../interfaces/verida_client_ts._internal_.TransactionResponse.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:35 - -___ - -### signMessage - -▸ `Abstract` **signMessage**(`message`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `message` | `string` \| [`Bytes`](../modules/verida_client_ts._internal_.md#bytes) | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:26 - -___ - -### signTransaction - -▸ `Abstract` **signTransaction**(`transaction`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transaction` | [`Deferrable`](../modules/verida_client_ts._internal_.md#deferrable)<[`TransactionRequest`](../modules/verida_client_ts._internal_.md#transactionrequest)\> | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:27 - -___ - -### isSigner - -▸ `Static` **isSigner**(`value`): value is Signer - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `any` | - -#### Returns - -value is Signer - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:43 diff --git a/docs/api/verida-js/classes/verida_client_ts._internal_.ValueScope.md b/docs/api/verida-js/classes/verida_client_ts._internal_.ValueScope.md deleted file mode 100644 index 9f43ecb..0000000 --- a/docs/api/verida-js/classes/verida_client_ts._internal_.ValueScope.md +++ /dev/null @@ -1,311 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / ValueScope - -# Class: ValueScope - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).ValueScope - -## Hierarchy - -- [`Scope`](verida_client_ts._internal_.Scope.md) - - ↳ **`ValueScope`** - -## Table of contents - -### Constructors - -- [constructor](verida_client_ts._internal_.ValueScope.md#constructor) - -### Properties - -- [\_names](verida_client_ts._internal_.ValueScope.md#_names) -- [\_parent](verida_client_ts._internal_.ValueScope.md#_parent) -- [\_prefixes](verida_client_ts._internal_.ValueScope.md#_prefixes) -- [\_reduceValues](verida_client_ts._internal_.ValueScope.md#_reducevalues) -- [\_scope](verida_client_ts._internal_.ValueScope.md#_scope) -- [\_values](verida_client_ts._internal_.ValueScope.md#_values) -- [opts](verida_client_ts._internal_.ValueScope.md#opts) - -### Methods - -- [\_newName](verida_client_ts._internal_.ValueScope.md#_newname) -- [get](verida_client_ts._internal_.ValueScope.md#get) -- [getValue](verida_client_ts._internal_.ValueScope.md#getvalue) -- [name](verida_client_ts._internal_.ValueScope.md#name) -- [scopeCode](verida_client_ts._internal_.ValueScope.md#scopecode) -- [scopeRefs](verida_client_ts._internal_.ValueScope.md#scoperefs) -- [toName](verida_client_ts._internal_.ValueScope.md#toname) -- [value](verida_client_ts._internal_.ValueScope.md#value) - -## Constructors - -### constructor - -• **new ValueScope**(`opts`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `opts` | [`ValueScopeOptions`](../interfaces/verida_client_ts._internal_.ValueScopeOptions.md) | - -#### Overrides - -[Scope](verida_client_ts._internal_.Scope.md).[constructor](verida_client_ts._internal_.Scope.md#constructor) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/scope.d.ts:70 - -## Properties - -### \_names - -• `Protected` `Readonly` **\_names**: `Object` - -#### Inherited from - -[Scope](verida_client_ts._internal_.Scope.md).[_names](verida_client_ts._internal_.Scope.md#_names) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/scope.d.ts:41 - -___ - -### \_parent - -• `Protected` `Optional` `Readonly` **\_parent**: [`Scope`](verida_client_ts._internal_.Scope.md) - -#### Inherited from - -[Scope](verida_client_ts._internal_.Scope.md).[_parent](verida_client_ts._internal_.Scope.md#_parent) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/scope.d.ts:45 - -___ - -### \_prefixes - -• `Protected` `Optional` `Readonly` **\_prefixes**: `Set`<`string`\> - -#### Inherited from - -[Scope](verida_client_ts._internal_.Scope.md).[_prefixes](verida_client_ts._internal_.Scope.md#_prefixes) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/scope.d.ts:44 - -___ - -### \_reduceValues - -• `Private` **\_reduceValues**: `any` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/scope.d.ts:77 - -___ - -### \_scope - -• `Protected` `Readonly` **\_scope**: [`ScopeStore`](../modules/verida_client_ts._internal_.md#scopestore) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/scope.d.ts:68 - -___ - -### \_values - -• `Protected` `Readonly` **\_values**: [`ScopeValues`](../modules/verida_client_ts._internal_.md#scopevalues) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/scope.d.ts:67 - -___ - -### opts - -• `Readonly` **opts**: [`VSOptions`](../interfaces/verida_client_ts._internal_.VSOptions.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/scope.d.ts:69 - -## Methods - -### \_newName - -▸ `Protected` **_newName**(`prefix`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `prefix` | `string` | - -#### Returns - -`string` - -#### Inherited from - -[Scope](verida_client_ts._internal_.Scope.md).[_newName](verida_client_ts._internal_.Scope.md#_newname) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/scope.d.ts:49 - -___ - -### get - -▸ **get**(): [`ScopeStore`](../modules/verida_client_ts._internal_.md#scopestore) - -#### Returns - -[`ScopeStore`](../modules/verida_client_ts._internal_.md#scopestore) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/scope.d.ts:71 - -___ - -### getValue - -▸ **getValue**(`prefix`, `keyOrRef`): `undefined` \| [`ValueScopeName`](verida_client_ts._internal_.ValueScopeName.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `prefix` | `string` | -| `keyOrRef` | `unknown` | - -#### Returns - -`undefined` \| [`ValueScopeName`](verida_client_ts._internal_.ValueScopeName.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/scope.d.ts:74 - -___ - -### name - -▸ **name**(`prefix`): [`ValueScopeName`](verida_client_ts._internal_.ValueScopeName.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `prefix` | `string` | - -#### Returns - -[`ValueScopeName`](verida_client_ts._internal_.ValueScopeName.md) - -#### Overrides - -[Scope](verida_client_ts._internal_.Scope.md).[name](verida_client_ts._internal_.Scope.md#name) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/scope.d.ts:72 - -___ - -### scopeCode - -▸ **scopeCode**(`values?`, `usedValues?`, `getCode?`): [`Code`](../modules/verida_client_ts._internal_.md#code) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `values?` | [`ScopeValues`](../modules/verida_client_ts._internal_.md#scopevalues) \| [`ScopeValueSets`](../modules/verida_client_ts._internal_.md#scopevaluesets) | -| `usedValues?` | [`UsedScopeValues`](../modules/verida_client_ts._internal_.md#usedscopevalues) | -| `getCode?` | (`n`: [`ValueScopeName`](verida_client_ts._internal_.ValueScopeName.md)) => `undefined` \| [`Code`](../modules/verida_client_ts._internal_.md#code) | - -#### Returns - -[`Code`](../modules/verida_client_ts._internal_.md#code) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/scope.d.ts:76 - -___ - -### scopeRefs - -▸ **scopeRefs**(`scopeName`, `values?`): [`Code`](../modules/verida_client_ts._internal_.md#code) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `scopeName` | [`Name`](verida_client_ts._internal_.Name.md) | -| `values?` | [`ScopeValues`](../modules/verida_client_ts._internal_.md#scopevalues) \| [`ScopeValueSets`](../modules/verida_client_ts._internal_.md#scopevaluesets) | - -#### Returns - -[`Code`](../modules/verida_client_ts._internal_.md#code) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/scope.d.ts:75 - -___ - -### toName - -▸ **toName**(`nameOrPrefix`): [`Name`](verida_client_ts._internal_.Name.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `nameOrPrefix` | `string` \| [`Name`](verida_client_ts._internal_.Name.md) | - -#### Returns - -[`Name`](verida_client_ts._internal_.Name.md) - -#### Inherited from - -[Scope](verida_client_ts._internal_.Scope.md).[toName](verida_client_ts._internal_.Scope.md#toname) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/scope.d.ts:47 - -___ - -### value - -▸ **value**(`nameOrPrefix`, `value`): [`ValueScopeName`](verida_client_ts._internal_.ValueScopeName.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `nameOrPrefix` | `string` \| [`ValueScopeName`](verida_client_ts._internal_.ValueScopeName.md) | -| `value` | [`NameValue`](../interfaces/verida_client_ts._internal_.NameValue.md) | - -#### Returns - -[`ValueScopeName`](verida_client_ts._internal_.ValueScopeName.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/scope.d.ts:73 diff --git a/docs/api/verida-js/classes/verida_client_ts._internal_.ValueScopeName.md b/docs/api/verida-js/classes/verida_client_ts._internal_.ValueScopeName.md deleted file mode 100644 index f2bc3dc..0000000 --- a/docs/api/verida-js/classes/verida_client_ts._internal_.ValueScopeName.md +++ /dev/null @@ -1,174 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / ValueScopeName - -# Class: ValueScopeName - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).ValueScopeName - -## Hierarchy - -- [`Name`](verida_client_ts._internal_.Name.md) - - ↳ **`ValueScopeName`** - -## Table of contents - -### Constructors - -- [constructor](verida_client_ts._internal_.ValueScopeName.md#constructor) - -### Properties - -- [prefix](verida_client_ts._internal_.ValueScopeName.md#prefix) -- [scopePath](verida_client_ts._internal_.ValueScopeName.md#scopepath) -- [str](verida_client_ts._internal_.ValueScopeName.md#str) -- [value](verida_client_ts._internal_.ValueScopeName.md#value) - -### Accessors - -- [names](verida_client_ts._internal_.ValueScopeName.md#names) - -### Methods - -- [emptyStr](verida_client_ts._internal_.ValueScopeName.md#emptystr) -- [setValue](verida_client_ts._internal_.ValueScopeName.md#setvalue) -- [toString](verida_client_ts._internal_.ValueScopeName.md#tostring) - -## Constructors - -### constructor - -• **new ValueScopeName**(`prefix`, `nameStr`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `prefix` | `string` | -| `nameStr` | `string` | - -#### Overrides - -[Name](verida_client_ts._internal_.Name.md).[constructor](verida_client_ts._internal_.Name.md#constructor) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/scope.d.ts:60 - -## Properties - -### prefix - -• `Readonly` **prefix**: `string` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/scope.d.ts:57 - -___ - -### scopePath - -• `Optional` **scopePath**: [`Code`](../modules/verida_client_ts._internal_.md#code) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/scope.d.ts:59 - -___ - -### str - -• `Readonly` **str**: `string` - -#### Inherited from - -[Name](verida_client_ts._internal_.Name.md).[str](verida_client_ts._internal_.Name.md#str) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/code.d.ts:9 - -___ - -### value - -• `Optional` **value**: [`NameValue`](../interfaces/verida_client_ts._internal_.NameValue.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/scope.d.ts:58 - -## Accessors - -### names - -• `get` **names**(): [`UsedNames`](../modules/verida_client_ts._internal_.md#usednames) - -#### Returns - -[`UsedNames`](../modules/verida_client_ts._internal_.md#usednames) - -#### Inherited from - -Name.names - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/code.d.ts:13 - -## Methods - -### emptyStr - -▸ **emptyStr**(): `boolean` - -#### Returns - -`boolean` - -#### Inherited from - -[Name](verida_client_ts._internal_.Name.md).[emptyStr](verida_client_ts._internal_.Name.md#emptystr) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/code.d.ts:12 - -___ - -### setValue - -▸ **setValue**(`value`, `__namedParameters`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | [`NameValue`](../interfaces/verida_client_ts._internal_.NameValue.md) | -| `__namedParameters` | [`ScopePath`](../interfaces/verida_client_ts._internal_.ScopePath.md) | - -#### Returns - -`void` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/scope.d.ts:61 - -___ - -### toString - -▸ **toString**(): `string` - -#### Returns - -`string` - -#### Inherited from - -[Name](verida_client_ts._internal_.Name.md).[toString](verida_client_ts._internal_.Name.md#tostring) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/code.d.ts:11 diff --git a/docs/api/verida-js/classes/verida_client_ts._internal_.VeridaNameClient.md b/docs/api/verida-js/classes/verida_client_ts._internal_.VeridaNameClient.md deleted file mode 100644 index 636a9dc..0000000 --- a/docs/api/verida-js/classes/verida_client_ts._internal_.VeridaNameClient.md +++ /dev/null @@ -1,246 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / VeridaNameClient - -# Class: VeridaNameClient - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).VeridaNameClient - -## Table of contents - -### Constructors - -- [constructor](verida_client_ts._internal_.VeridaNameClient.md#constructor) - -### Properties - -- [config](verida_client_ts._internal_.VeridaNameClient.md#config) -- [contract](verida_client_ts._internal_.VeridaNameClient.md#contract) -- [didAddress](verida_client_ts._internal_.VeridaNameClient.md#didaddress) -- [getRegisterSignature](verida_client_ts._internal_.VeridaNameClient.md#getregistersignature) -- [network](verida_client_ts._internal_.VeridaNameClient.md#network) -- [readOnly](verida_client_ts._internal_.VeridaNameClient.md#readonly) -- [usernameCache](verida_client_ts._internal_.VeridaNameClient.md#usernamecache) -- [vdaWeb3Client](verida_client_ts._internal_.VeridaNameClient.md#vdaweb3client) - -### Methods - -- [getDID](verida_client_ts._internal_.VeridaNameClient.md#getdid) -- [getUsernames](verida_client_ts._internal_.VeridaNameClient.md#getusernames) -- [nonceFN](verida_client_ts._internal_.VeridaNameClient.md#noncefn) -- [register](verida_client_ts._internal_.VeridaNameClient.md#register) -- [unregister](verida_client_ts._internal_.VeridaNameClient.md#unregister) - -## Constructors - -### constructor - -• **new VeridaNameClient**(`config`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | [`VdaClientConfig`](../interfaces/verida_client_ts._internal_.VdaClientConfig.md) | - -#### Defined in - -packages/vda-name-client/build/src/blockchain/blockchainApi.d.ts:10 - -## Properties - -### config - -• `Private` **config**: `any` - -#### Defined in - -packages/vda-name-client/build/src/blockchain/blockchainApi.d.ts:3 - -___ - -### contract - -• `Private` `Optional` **contract**: `any` - -#### Defined in - -packages/vda-name-client/build/src/blockchain/blockchainApi.d.ts:8 - -___ - -### didAddress - -• `Private` `Optional` **didAddress**: `any` - -#### Defined in - -packages/vda-name-client/build/src/blockchain/blockchainApi.d.ts:5 - -___ - -### getRegisterSignature - -• `Private` **getRegisterSignature**: `any` - -Get a signature for {@link BlockchainApi#register} function - -**`param`** Name to register - -**`param`** DID address - -**`param`** Verida account key to generate signature - -**`returns`** Signature - -#### Defined in - -packages/vda-name-client/build/src/blockchain/blockchainApi.d.ts:23 - -___ - -### network - -• `Private` **network**: `any` - -#### Defined in - -packages/vda-name-client/build/src/blockchain/blockchainApi.d.ts:4 - -___ - -### readOnly - -• `Private` **readOnly**: `any` - -#### Defined in - -packages/vda-name-client/build/src/blockchain/blockchainApi.d.ts:7 - -___ - -### usernameCache - -• `Private` **usernameCache**: `any` - -#### Defined in - -packages/vda-name-client/build/src/blockchain/blockchainApi.d.ts:9 - -___ - -### vdaWeb3Client - -• `Private` `Optional` **vdaWeb3Client**: `any` - -#### Defined in - -packages/vda-name-client/build/src/blockchain/blockchainApi.d.ts:6 - -## Methods - -### getDID - -▸ **getDID**(`username`): `Promise`<`string`\> - -Return the DID address for a given username - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `username` | `string` | username registered by [register](verida_client_ts._internal_.VeridaNameClient.md#register) | - -#### Returns - -`Promise`<`string`\> - -DID address - -#### Defined in - -packages/vda-name-client/build/src/blockchain/blockchainApi.d.ts:47 - -___ - -### getUsernames - -▸ **getUsernames**(`did`): `Promise`<`string`[]\> - -Get the username list of a DID address - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `did` | `string` | DID to lookup the username for | - -#### Returns - -`Promise`<`string`[]\> - -username list - -#### Defined in - -packages/vda-name-client/build/src/blockchain/blockchainApi.d.ts:40 - -___ - -### nonceFN - -▸ **nonceFN**(): `Promise`<`any`\> - -Get a nonce from DIDRegistry contract - -#### Returns - -`Promise`<`any`\> - -nonce of DID - -#### Defined in - -packages/vda-name-client/build/src/blockchain/blockchainApi.d.ts:15 - -___ - -### register - -▸ **register**(`username`): `Promise`<`void`\> - -Register a username to the did address - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `username` | `string` | Name to register | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -packages/vda-name-client/build/src/blockchain/blockchainApi.d.ts:28 - -___ - -### unregister - -▸ **unregister**(`username`): `Promise`<`void`\> - -Unregister a username from the did address - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `username` | `string` | Name to be unregistered | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -packages/vda-name-client/build/src/blockchain/blockchainApi.d.ts:33 diff --git a/docs/api/verida-js/classes/verida_client_ts._internal_._Code.md b/docs/api/verida-js/classes/verida_client_ts._internal_._Code.md deleted file mode 100644 index 86a7167..0000000 --- a/docs/api/verida-js/classes/verida_client_ts._internal_._Code.md +++ /dev/null @@ -1,155 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / \_Code - -# Class: \_Code - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md)._Code - -## Hierarchy - -- [`_CodeOrName`](verida_client_ts._internal_._CodeOrName.md) - - ↳ **`_Code`** - -## Table of contents - -### Constructors - -- [constructor](verida_client_ts._internal_._Code.md#constructor) - -### Properties - -- [\_items](verida_client_ts._internal_._Code.md#_items) -- [\_names](verida_client_ts._internal_._Code.md#_names) -- [\_str](verida_client_ts._internal_._Code.md#_str) - -### Accessors - -- [names](verida_client_ts._internal_._Code.md#names) -- [str](verida_client_ts._internal_._Code.md#str) - -### Methods - -- [emptyStr](verida_client_ts._internal_._Code.md#emptystr) -- [toString](verida_client_ts._internal_._Code.md#tostring) - -## Constructors - -### constructor - -• **new _Code**(`code`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `code` | `string` \| readonly [`CodeItem`](../modules/verida_client_ts._internal_.md#codeitem)[] | - -#### Overrides - -[_CodeOrName](verida_client_ts._internal_._CodeOrName.md).[constructor](verida_client_ts._internal_._CodeOrName.md#constructor) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/code.d.ts:19 - -## Properties - -### \_items - -• `Readonly` **\_items**: readonly [`CodeItem`](../modules/verida_client_ts._internal_.md#codeitem)[] - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/code.d.ts:16 - -___ - -### \_names - -• `Private` `Optional` **\_names**: `any` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/code.d.ts:18 - -___ - -### \_str - -• `Private` `Optional` **\_str**: `any` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/code.d.ts:17 - -## Accessors - -### names - -• `get` **names**(): [`UsedNames`](../modules/verida_client_ts._internal_.md#usednames) - -#### Returns - -[`UsedNames`](../modules/verida_client_ts._internal_.md#usednames) - -#### Overrides - -\_CodeOrName.names - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/code.d.ts:23 - -___ - -### str - -• `get` **str**(): `string` - -#### Returns - -`string` - -#### Overrides - -\_CodeOrName.str - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/code.d.ts:22 - -## Methods - -### emptyStr - -▸ **emptyStr**(): `boolean` - -#### Returns - -`boolean` - -#### Overrides - -[_CodeOrName](verida_client_ts._internal_._CodeOrName.md).[emptyStr](verida_client_ts._internal_._CodeOrName.md#emptystr) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/code.d.ts:21 - -___ - -### toString - -▸ **toString**(): `string` - -#### Returns - -`string` - -#### Overrides - -[_CodeOrName](verida_client_ts._internal_._CodeOrName.md).[toString](verida_client_ts._internal_._CodeOrName.md#tostring) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/code.d.ts:20 diff --git a/docs/api/verida-js/classes/verida_client_ts._internal_._CodeOrName.md b/docs/api/verida-js/classes/verida_client_ts._internal_._CodeOrName.md deleted file mode 100644 index 9d78869..0000000 --- a/docs/api/verida-js/classes/verida_client_ts._internal_._CodeOrName.md +++ /dev/null @@ -1,83 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / \_CodeOrName - -# Class: \_CodeOrName - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md)._CodeOrName - -## Hierarchy - -- **`_CodeOrName`** - - ↳ [`Name`](verida_client_ts._internal_.Name.md) - - ↳ [`_Code`](verida_client_ts._internal_._Code.md) - -## Table of contents - -### Constructors - -- [constructor](verida_client_ts._internal_._CodeOrName.md#constructor) - -### Properties - -- [names](verida_client_ts._internal_._CodeOrName.md#names) -- [str](verida_client_ts._internal_._CodeOrName.md#str) - -### Methods - -- [emptyStr](verida_client_ts._internal_._CodeOrName.md#emptystr) -- [toString](verida_client_ts._internal_._CodeOrName.md#tostring) - -## Constructors - -### constructor - -• **new _CodeOrName**() - -## Properties - -### names - -• `Readonly` `Abstract` **names**: [`UsedNames`](../modules/verida_client_ts._internal_.md#usednames) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/code.d.ts:3 - -___ - -### str - -• `Readonly` `Abstract` **str**: `string` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/code.d.ts:2 - -## Methods - -### emptyStr - -▸ `Abstract` **emptyStr**(): `boolean` - -#### Returns - -`boolean` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/code.d.ts:5 - -___ - -### toString - -▸ `Abstract` **toString**(): `string` - -#### Returns - -`string` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/code.d.ts:4 diff --git a/docs/api/verida-js/classes/verida_client_ts._internal_.default-1.md b/docs/api/verida-js/classes/verida_client_ts._internal_.default-1.md deleted file mode 100644 index a3fcec3..0000000 --- a/docs/api/verida-js/classes/verida_client_ts._internal_.default-1.md +++ /dev/null @@ -1,515 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / default - -# Class: default - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).default - -## Implements - -- [`IDIDDocument`](../interfaces/verida_client_ts._internal_.IDIDDocument.md) - -## Table of contents - -### Constructors - -- [constructor](verida_client_ts._internal_.default-1.md#constructor) - -### Properties - -- [doc](verida_client_ts._internal_.default-1.md#doc) -- [errors](verida_client_ts._internal_.default-1.md#errors) -- [getProofData](verida_client_ts._internal_.default-1.md#getproofdata) - -### Accessors - -- [id](verida_client_ts._internal_.default-1.md#id) - -### Methods - -- [addContext](verida_client_ts._internal_.default-1.md#addcontext) -- [addContextAsymKey](verida_client_ts._internal_.default-1.md#addcontextasymkey) -- [addContextService](verida_client_ts._internal_.default-1.md#addcontextservice) -- [addContextSignKey](verida_client_ts._internal_.default-1.md#addcontextsignkey) -- [buildTimestamp](verida_client_ts._internal_.default-1.md#buildtimestamp) -- [export](verida_client_ts._internal_.default-1.md#export) -- [getErrors](verida_client_ts._internal_.default-1.md#geterrors) -- [import](verida_client_ts._internal_.default-1.md#import) -- [locateContextProof](verida_client_ts._internal_.default-1.md#locatecontextproof) -- [locateServiceEndpoint](verida_client_ts._internal_.default-1.md#locateserviceendpoint) -- [removeContext](verida_client_ts._internal_.default-1.md#removecontext) -- [setAttributes](verida_client_ts._internal_.default-1.md#setattributes) -- [signProof](verida_client_ts._internal_.default-1.md#signproof) -- [verifyContextSignature](verida_client_ts._internal_.default-1.md#verifycontextsignature) -- [verifyProof](verida_client_ts._internal_.default-1.md#verifyproof) -- [verifySig](verida_client_ts._internal_.default-1.md#verifysig) -- [generateContextHash](verida_client_ts._internal_.default-1.md#generatecontexthash) - -## Constructors - -### constructor - -• **new default**(`doc`, `publicKeyHex?`) - -Force lower case DID as we can't guarantee the DID will always be provided with checksum - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `doc` | `string` \| [`VeridaDocInterface`](../interfaces/verida_client_ts._internal_.VeridaDocInterface.md) | this value can be a DocInterface or DID. | -| `publicKeyHex?` | `string` | - | - -#### Defined in - -packages/did-document/dist/did-document.d.ts:11 - -## Properties - -### doc - -• `Private` **doc**: `any` - -#### Defined in - -packages/did-document/dist/did-document.d.ts:4 - -___ - -### errors - -• `Protected` **errors**: `string`[] - -#### Defined in - -packages/did-document/dist/did-document.d.ts:5 - -___ - -### getProofData - -• `Private` **getProofData**: `any` - -#### Defined in - -packages/did-document/dist/did-document.d.ts:37 - -## Accessors - -### id - -• `get` **id**(): `string` - -#### Returns - -`string` - -#### Implementation of - -IDIDDocument.id - -#### Defined in - -packages/did-document/dist/did-document.d.ts:12 - -## Methods - -### addContext - -▸ **addContext**(`contextName`, `keyring`, `privateKey`, `endpoints`): `Promise`<`void`\> - -Not used directly, used for testing - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `contextName` | `string` | string | -| `keyring` | [`IKeyring`](../interfaces/verida_client_ts._internal_.IKeyring.md) | Keyring | -| `privateKey` | `string` | Private key of the DID that controls this DID Document | -| `endpoints` | [`SecureContextEndpoints`](../interfaces/verida_client_ts._internal_.SecureContextEndpoints.md) | Endpoints | - -#### Returns - -`Promise`<`void`\> - -#### Implementation of - -[IDIDDocument](../interfaces/verida_client_ts._internal_.IDIDDocument.md).[addContext](../interfaces/verida_client_ts._internal_.IDIDDocument.md#addcontext) - -#### Defined in - -packages/did-document/dist/did-document.d.ts:22 - -___ - -### addContextAsymKey - -▸ **addContextAsymKey**(`contextHash`, `publicKeyHex`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextHash` | `string` | -| `publicKeyHex` | `string` | - -#### Returns - -`void` - -#### Implementation of - -[IDIDDocument](../interfaces/verida_client_ts._internal_.IDIDDocument.md).[addContextAsymKey](../interfaces/verida_client_ts._internal_.IDIDDocument.md#addcontextasymkey) - -#### Defined in - -packages/did-document/dist/did-document.d.ts:29 - -___ - -### addContextService - -▸ **addContextService**(`contextHash`, `endpointType`, `serviceType`, `endpointUris`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextHash` | `string` | -| `endpointType` | [`SecureContextEndpointType`](../enums/verida_client_ts._internal_.SecureContextEndpointType.md) | -| `serviceType` | `string` | -| `endpointUris` | [`ServiceEndpoint`](../modules/verida_client_ts._internal_.md#serviceendpoint)[] | - -#### Returns - -`void` - -#### Implementation of - -[IDIDDocument](../interfaces/verida_client_ts._internal_.IDIDDocument.md).[addContextService](../interfaces/verida_client_ts._internal_.IDIDDocument.md#addcontextservice) - -#### Defined in - -packages/did-document/dist/did-document.d.ts:27 - -___ - -### addContextSignKey - -▸ **addContextSignKey**(`contextHash`, `publicKeyHex`, `proof`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextHash` | `string` | -| `publicKeyHex` | `string` | -| `proof` | `string` | - -#### Returns - -`void` - -#### Implementation of - -[IDIDDocument](../interfaces/verida_client_ts._internal_.IDIDDocument.md).[addContextSignKey](../interfaces/verida_client_ts._internal_.IDIDDocument.md#addcontextsignkey) - -#### Defined in - -packages/did-document/dist/did-document.d.ts:28 - -___ - -### buildTimestamp - -▸ **buildTimestamp**(`date`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `date` | `Date` | - -#### Returns - -`string` - -#### Implementation of - -[IDIDDocument](../interfaces/verida_client_ts._internal_.IDIDDocument.md).[buildTimestamp](../interfaces/verida_client_ts._internal_.IDIDDocument.md#buildtimestamp) - -#### Defined in - -packages/did-document/dist/did-document.d.ts:38 - -___ - -### export - -▸ **export**(): [`VeridaDocInterface`](../interfaces/verida_client_ts._internal_.VeridaDocInterface.md) - -#### Returns - -[`VeridaDocInterface`](../interfaces/verida_client_ts._internal_.VeridaDocInterface.md) - -#### Implementation of - -[IDIDDocument](../interfaces/verida_client_ts._internal_.IDIDDocument.md).[export](../interfaces/verida_client_ts._internal_.IDIDDocument.md#export) - -#### Defined in - -packages/did-document/dist/did-document.d.ts:26 - -___ - -### getErrors - -▸ **getErrors**(): `string`[] - -#### Returns - -`string`[] - -#### Implementation of - -[IDIDDocument](../interfaces/verida_client_ts._internal_.IDIDDocument.md).[getErrors](../interfaces/verida_client_ts._internal_.IDIDDocument.md#geterrors) - -#### Defined in - -packages/did-document/dist/did-document.d.ts:13 - -___ - -### import - -▸ **import**(`doc`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `doc` | [`VeridaDocInterface`](../interfaces/verida_client_ts._internal_.VeridaDocInterface.md) | - -#### Returns - -`void` - -#### Implementation of - -[IDIDDocument](../interfaces/verida_client_ts._internal_.IDIDDocument.md).[import](../interfaces/verida_client_ts._internal_.IDIDDocument.md#import) - -#### Defined in - -packages/did-document/dist/did-document.d.ts:25 - -___ - -### locateContextProof - -▸ **locateContextProof**(`contextName`): `undefined` \| `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | - -#### Returns - -`undefined` \| `string` - -#### Implementation of - -[IDIDDocument](../interfaces/verida_client_ts._internal_.IDIDDocument.md).[locateContextProof](../interfaces/verida_client_ts._internal_.IDIDDocument.md#locatecontextproof) - -#### Defined in - -packages/did-document/dist/did-document.d.ts:34 - -___ - -### locateServiceEndpoint - -▸ **locateServiceEndpoint**(`contextName`, `endpointType`): `undefined` \| [`Service`](../interfaces/verida_client_ts._internal_.Service.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | -| `endpointType` | [`SecureContextEndpointType`](../enums/verida_client_ts._internal_.SecureContextEndpointType.md) | - -#### Returns - -`undefined` \| [`Service`](../interfaces/verida_client_ts._internal_.Service.md) - -#### Implementation of - -[IDIDDocument](../interfaces/verida_client_ts._internal_.IDIDDocument.md).[locateServiceEndpoint](../interfaces/verida_client_ts._internal_.IDIDDocument.md#locateserviceendpoint) - -#### Defined in - -packages/did-document/dist/did-document.d.ts:33 - -___ - -### removeContext - -▸ **removeContext**(`contextName`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | - -#### Returns - -`boolean` - -#### Implementation of - -[IDIDDocument](../interfaces/verida_client_ts._internal_.IDIDDocument.md).[removeContext](../interfaces/verida_client_ts._internal_.IDIDDocument.md#removecontext) - -#### Defined in - -packages/did-document/dist/did-document.d.ts:23 - -___ - -### setAttributes - -▸ **setAttributes**(`attributes`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `attributes` | [`Record`](../modules/verida_client_ts._internal_.md#record)<`string`, `any`\> | - -#### Returns - -`void` - -#### Implementation of - -[IDIDDocument](../interfaces/verida_client_ts._internal_.IDIDDocument.md).[setAttributes](../interfaces/verida_client_ts._internal_.IDIDDocument.md#setattributes) - -#### Defined in - -packages/did-document/dist/did-document.d.ts:24 - -___ - -### signProof - -▸ **signProof**(`privateKey`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `privateKey` | `string` \| `Uint8Array` | - -#### Returns - -`void` - -#### Implementation of - -[IDIDDocument](../interfaces/verida_client_ts._internal_.IDIDDocument.md).[signProof](../interfaces/verida_client_ts._internal_.IDIDDocument.md#signproof) - -#### Defined in - -packages/did-document/dist/did-document.d.ts:35 - -___ - -### verifyContextSignature - -▸ **verifyContextSignature**(`data`, `contextName`, `signature`, `contextIsHash?`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `any` | -| `contextName` | `string` | -| `signature` | `string` | -| `contextIsHash?` | `boolean` | - -#### Returns - -`boolean` - -#### Implementation of - -[IDIDDocument](../interfaces/verida_client_ts._internal_.IDIDDocument.md).[verifyContextSignature](../interfaces/verida_client_ts._internal_.IDIDDocument.md#verifycontextsignature) - -#### Defined in - -packages/did-document/dist/did-document.d.ts:31 - -___ - -### verifyProof - -▸ **verifyProof**(): `boolean` - -#### Returns - -`boolean` - -#### Implementation of - -[IDIDDocument](../interfaces/verida_client_ts._internal_.IDIDDocument.md).[verifyProof](../interfaces/verida_client_ts._internal_.IDIDDocument.md#verifyproof) - -#### Defined in - -packages/did-document/dist/did-document.d.ts:36 - -___ - -### verifySig - -▸ **verifySig**(`data`, `signature`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `any` | -| `signature` | `string` | - -#### Returns - -`boolean` - -#### Implementation of - -[IDIDDocument](../interfaces/verida_client_ts._internal_.IDIDDocument.md).[verifySig](../interfaces/verida_client_ts._internal_.IDIDDocument.md#verifysig) - -#### Defined in - -packages/did-document/dist/did-document.d.ts:30 - -___ - -### generateContextHash - -▸ `Static` **generateContextHash**(`did`, `contextName`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did` | `string` | -| `contextName` | `string` | - -#### Returns - -`string` - -#### Defined in - -packages/did-document/dist/did-document.d.ts:32 diff --git a/docs/api/verida-js/classes/verida_client_ts._internal_.default-2.md b/docs/api/verida-js/classes/verida_client_ts._internal_.default-2.md deleted file mode 100644 index 45fe1d3..0000000 --- a/docs/api/verida-js/classes/verida_client_ts._internal_.default-2.md +++ /dev/null @@ -1,423 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / default - -# Class: default - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).default - -Class that takes a signature (generated from a signed consent message) and generates a -collection of asymmetric keys, symmetric key and signing key for a given secure storage -context. - -## Implements - -- [`IKeyring`](../interfaces/verida_client_ts._internal_.IKeyring.md) - -## Table of contents - -### Constructors - -- [constructor](verida_client_ts._internal_.default-2.md#constructor) - -### Properties - -- [asymKeyPair](verida_client_ts._internal_.default-2.md#asymkeypair) -- [buildKey](verida_client_ts._internal_.default-2.md#buildkey) -- [seed](verida_client_ts._internal_.default-2.md#seed) -- [signKeyPair](verida_client_ts._internal_.default-2.md#signkeypair) -- [storageContextKeys](verida_client_ts._internal_.default-2.md#storagecontextkeys) -- [symKey](verida_client_ts._internal_.default-2.md#symkey) - -### Methods - -- [\_init](verida_client_ts._internal_.default-2.md#_init) -- [asymDecrypt](verida_client_ts._internal_.default-2.md#asymdecrypt) -- [asymEncrypt](verida_client_ts._internal_.default-2.md#asymencrypt) -- [buildSharedKeyEnd](verida_client_ts._internal_.default-2.md#buildsharedkeyend) -- [buildSharedKeyStart](verida_client_ts._internal_.default-2.md#buildsharedkeystart) -- [getKeys](verida_client_ts._internal_.default-2.md#getkeys) -- [getSeed](verida_client_ts._internal_.default-2.md#getseed) -- [getStorageContextKey](verida_client_ts._internal_.default-2.md#getstoragecontextkey) -- [publicKeys](verida_client_ts._internal_.default-2.md#publickeys) -- [sign](verida_client_ts._internal_.default-2.md#sign) -- [symDecrypt](verida_client_ts._internal_.default-2.md#symdecrypt) -- [symEncrypt](verida_client_ts._internal_.default-2.md#symencrypt) -- [verifySig](verida_client_ts._internal_.default-2.md#verifysig) - -## Constructors - -### constructor - -• **new default**(`seed`) - -A string used as a seed for this keyring. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `seed` | `string` | - -#### Defined in - -packages/keyring/dist/keyring.d.ts:19 - -## Properties - -### asymKeyPair - -• `Optional` **asymKeyPair**: [`BoxKeyPair`](../interfaces/verida_client_ts._internal_.BoxKeyPair.md) - -#### Defined in - -packages/keyring/dist/keyring.d.ts:9 - -___ - -### buildKey - -• `Private` **buildKey**: `any` - -Helper function that generates a key of the appropriate type - -**`param`** - -**`param`** - -**`returns`** - -#### Defined in - -packages/keyring/dist/keyring.d.ts:29 - -___ - -### seed - -• `Private` **seed**: `any` - -#### Defined in - -packages/keyring/dist/keyring.d.ts:12 - -___ - -### signKeyPair - -• `Optional` **signKeyPair**: [`SignKeyPair`](../interfaces/verida_client_ts._internal_.SignKeyPair.md) - -#### Defined in - -packages/keyring/dist/keyring.d.ts:10 - -___ - -### storageContextKeys - -• `Private` **storageContextKeys**: `any` - -#### Defined in - -packages/keyring/dist/keyring.d.ts:13 - -___ - -### symKey - -• `Optional` **symKey**: `Uint8Array` - -#### Defined in - -packages/keyring/dist/keyring.d.ts:11 - -## Methods - -### \_init - -▸ **_init**(): `Promise`<`void`\> - -#### Returns - -`Promise`<`void`\> - -#### Implementation of - -[IKeyring](../interfaces/verida_client_ts._internal_.IKeyring.md).[_init](../interfaces/verida_client_ts._internal_.IKeyring.md#_init) - -#### Defined in - -packages/keyring/dist/keyring.d.ts:21 - -___ - -### asymDecrypt - -▸ **asymDecrypt**(`messageWithNonce`, `secretOrSharedKey`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `messageWithNonce` | `string` | -| `secretOrSharedKey` | `Uint8Array` | - -#### Returns - -`Promise`<`any`\> - -#### Implementation of - -[IKeyring](../interfaces/verida_client_ts._internal_.IKeyring.md).[asymDecrypt](../interfaces/verida_client_ts._internal_.IKeyring.md#asymdecrypt) - -#### Defined in - -packages/keyring/dist/keyring.d.ts:41 - -___ - -### asymEncrypt - -▸ **asymEncrypt**(`data`, `secretOrSharedKey`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `string` | -| `secretOrSharedKey` | `Uint8Array` | - -#### Returns - -`Promise`<`string`\> - -#### Implementation of - -[IKeyring](../interfaces/verida_client_ts._internal_.IKeyring.md).[asymEncrypt](../interfaces/verida_client_ts._internal_.IKeyring.md#asymencrypt) - -#### Defined in - -packages/keyring/dist/keyring.d.ts:40 - -___ - -### buildSharedKeyEnd - -▸ **buildSharedKeyEnd**(`publicKey`): `Promise`<`Uint8Array`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `publicKey` | `Uint8Array` | - -#### Returns - -`Promise`<`Uint8Array`\> - -#### Implementation of - -[IKeyring](../interfaces/verida_client_ts._internal_.IKeyring.md).[buildSharedKeyEnd](../interfaces/verida_client_ts._internal_.IKeyring.md#buildsharedkeyend) - -#### Defined in - -packages/keyring/dist/keyring.d.ts:43 - -___ - -### buildSharedKeyStart - -▸ **buildSharedKeyStart**(`privateKey`): `Promise`<`Uint8Array`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `privateKey` | `Uint8Array` | - -#### Returns - -`Promise`<`Uint8Array`\> - -#### Implementation of - -[IKeyring](../interfaces/verida_client_ts._internal_.IKeyring.md).[buildSharedKeyStart](../interfaces/verida_client_ts._internal_.IKeyring.md#buildsharedkeystart) - -#### Defined in - -packages/keyring/dist/keyring.d.ts:42 - -___ - -### getKeys - -▸ **getKeys**(): `Promise`<`any`\> - -#### Returns - -`Promise`<`any`\> - -#### Implementation of - -[IKeyring](../interfaces/verida_client_ts._internal_.IKeyring.md).[getKeys](../interfaces/verida_client_ts._internal_.IKeyring.md#getkeys) - -#### Defined in - -packages/keyring/dist/keyring.d.ts:20 - -___ - -### getSeed - -▸ **getSeed**(): `string` - -#### Returns - -`string` - -#### Implementation of - -[IKeyring](../interfaces/verida_client_ts._internal_.IKeyring.md).[getSeed](../interfaces/verida_client_ts._internal_.IKeyring.md#getseed) - -#### Defined in - -packages/keyring/dist/keyring.d.ts:44 - -___ - -### getStorageContextKey - -▸ **getStorageContextKey**(`databaseName`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `databaseName` | `string` | - -#### Returns - -`Promise`<`any`\> - -#### Implementation of - -[IKeyring](../interfaces/verida_client_ts._internal_.IKeyring.md).[getStorageContextKey](../interfaces/verida_client_ts._internal_.IKeyring.md#getstoragecontextkey) - -#### Defined in - -packages/keyring/dist/keyring.d.ts:45 - -___ - -### publicKeys - -▸ **publicKeys**(): `Promise`<[`KeyringPublicKeys`](../interfaces/verida_client_ts._internal_.KeyringPublicKeys.md)\> - -Generate an object containing all the public keys for this Keyring - -#### Returns - -`Promise`<[`KeyringPublicKeys`](../interfaces/verida_client_ts._internal_.KeyringPublicKeys.md)\> - -#### Implementation of - -[IKeyring](../interfaces/verida_client_ts._internal_.IKeyring.md).[publicKeys](../interfaces/verida_client_ts._internal_.IKeyring.md#publickeys) - -#### Defined in - -packages/keyring/dist/keyring.d.ts:35 - -___ - -### sign - -▸ **sign**(`data`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `any` | - -#### Returns - -`Promise`<`string`\> - -#### Implementation of - -[IKeyring](../interfaces/verida_client_ts._internal_.IKeyring.md).[sign](../interfaces/verida_client_ts._internal_.IKeyring.md#sign) - -#### Defined in - -packages/keyring/dist/keyring.d.ts:36 - -___ - -### symDecrypt - -▸ **symDecrypt**(`data`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `string` | - -#### Returns - -`Promise`<`any`\> - -#### Implementation of - -[IKeyring](../interfaces/verida_client_ts._internal_.IKeyring.md).[symDecrypt](../interfaces/verida_client_ts._internal_.IKeyring.md#symdecrypt) - -#### Defined in - -packages/keyring/dist/keyring.d.ts:39 - -___ - -### symEncrypt - -▸ **symEncrypt**(`data`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Implementation of - -[IKeyring](../interfaces/verida_client_ts._internal_.IKeyring.md).[symEncrypt](../interfaces/verida_client_ts._internal_.IKeyring.md#symencrypt) - -#### Defined in - -packages/keyring/dist/keyring.d.ts:38 - -___ - -### verifySig - -▸ **verifySig**(`data`, `sig`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `string` | -| `sig` | `string` | - -#### Returns - -`Promise`<`boolean`\> - -#### Implementation of - -[IKeyring](../interfaces/verida_client_ts._internal_.IKeyring.md).[verifySig](../interfaces/verida_client_ts._internal_.IKeyring.md#verifysig) - -#### Defined in - -packages/keyring/dist/keyring.d.ts:37 diff --git a/docs/api/verida-js/classes/verida_client_ts._internal_.default-3.md b/docs/api/verida-js/classes/verida_client_ts._internal_.default-3.md deleted file mode 100644 index b15997a..0000000 --- a/docs/api/verida-js/classes/verida_client_ts._internal_.default-3.md +++ /dev/null @@ -1,948 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / default - -# Class: default - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).default - -## Hierarchy - -- **`default`** - - ↳ [`Ajv2020`](verida_client_ts._internal_.Ajv2020.md) - -## Table of contents - -### Constructors - -- [constructor](verida_client_ts._internal_.default-3.md#constructor) - -### Properties - -- [RULES](verida_client_ts._internal_.default-3.md#rules) -- [\_cache](verida_client_ts._internal_.default-3.md#_cache) -- [\_checkUnique](verida_client_ts._internal_.default-3.md#_checkunique) -- [\_compilations](verida_client_ts._internal_.default-3.md#_compilations) -- [\_compileMetaSchema](verida_client_ts._internal_.default-3.md#_compilemetaschema) -- [\_compileSchemaEnv](verida_client_ts._internal_.default-3.md#_compileschemaenv) -- [\_loading](verida_client_ts._internal_.default-3.md#_loading) -- [\_metaOpts](verida_client_ts._internal_.default-3.md#_metaopts) -- [\_removeAllSchemas](verida_client_ts._internal_.default-3.md#_removeallschemas) -- [errors](verida_client_ts._internal_.default-3.md#errors) -- [formats](verida_client_ts._internal_.default-3.md#formats) -- [logger](verida_client_ts._internal_.default-3.md#logger) -- [opts](verida_client_ts._internal_.default-3.md#opts) -- [refs](verida_client_ts._internal_.default-3.md#refs) -- [schemas](verida_client_ts._internal_.default-3.md#schemas) -- [scope](verida_client_ts._internal_.default-3.md#scope) -- [MissingRefError](verida_client_ts._internal_.default-3.md#missingreferror) -- [ValidationError](verida_client_ts._internal_.default-3.md#validationerror) - -### Methods - -- [$dataMetaSchema](verida_client_ts._internal_.default-3.md#$datametaschema) -- [\_addDefaultMetaSchema](verida_client_ts._internal_.default-3.md#_adddefaultmetaschema) -- [\_addSchema](verida_client_ts._internal_.default-3.md#_addschema) -- [\_addVocabularies](verida_client_ts._internal_.default-3.md#_addvocabularies) -- [addFormat](verida_client_ts._internal_.default-3.md#addformat) -- [addKeyword](verida_client_ts._internal_.default-3.md#addkeyword) -- [addMetaSchema](verida_client_ts._internal_.default-3.md#addmetaschema) -- [addSchema](verida_client_ts._internal_.default-3.md#addschema) -- [addVocabulary](verida_client_ts._internal_.default-3.md#addvocabulary) -- [compile](verida_client_ts._internal_.default-3.md#compile) -- [compileAsync](verida_client_ts._internal_.default-3.md#compileasync) -- [defaultMeta](verida_client_ts._internal_.default-3.md#defaultmeta) -- [errorsText](verida_client_ts._internal_.default-3.md#errorstext) -- [getKeyword](verida_client_ts._internal_.default-3.md#getkeyword) -- [getSchema](verida_client_ts._internal_.default-3.md#getschema) -- [removeKeyword](verida_client_ts._internal_.default-3.md#removekeyword) -- [removeSchema](verida_client_ts._internal_.default-3.md#removeschema) -- [validate](verida_client_ts._internal_.default-3.md#validate) -- [validateSchema](verida_client_ts._internal_.default-3.md#validateschema) - -## Constructors - -### constructor - -• **new default**(`opts?`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `opts?` | [`Options`](../modules/verida_client_ts._internal_.md#options) | - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:127 - -## Properties - -### RULES - -• `Readonly` **RULES**: [`ValidationRules`](../interfaces/verida_client_ts._internal_.ValidationRules.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:120 - -___ - -### \_cache - -• `Private` `Readonly` **\_cache**: `any` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:123 - -___ - -### \_checkUnique - -• `Private` **\_checkUnique**: `any` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:166 - -___ - -### \_compilations - -• `Readonly` **\_compilations**: `Set`<[`SchemaEnv`](verida_client_ts._internal_.SchemaEnv.md)\> - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:121 - -___ - -### \_compileMetaSchema - -• `Private` **\_compileMetaSchema**: `any` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:168 - -___ - -### \_compileSchemaEnv - -• `Private` **\_compileSchemaEnv**: `any` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:167 - -___ - -### \_loading - -• `Private` `Readonly` **\_loading**: `any` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:122 - -___ - -### \_metaOpts - -• `Private` `Readonly` **\_metaOpts**: `any` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:124 - -___ - -### \_removeAllSchemas - -• `Private` **\_removeAllSchemas**: `any` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:164 - -___ - -### errors - -• `Optional` **errors**: ``null`` \| [`ErrorObject`](../interfaces/verida_client_ts._internal_.ErrorObject.md)<`string`, [`Record`](../modules/verida_client_ts._internal_.md#record)<`string`, `any`\>, `unknown`\>[] - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:108 - -___ - -### formats - -• `Readonly` **formats**: `Object` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:117 - -___ - -### logger - -• **logger**: [`Logger`](../interfaces/verida_client_ts._internal_.Logger.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:109 - -___ - -### opts - -• **opts**: [`InstanceOptions`](../modules/verida_client_ts._internal_.md#instanceoptions) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:107 - -___ - -### refs - -• `Readonly` **refs**: `Object` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:114 - -___ - -### schemas - -• `Readonly` **schemas**: `Object` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:111 - -___ - -### scope - -• `Readonly` **scope**: [`ValueScope`](verida_client_ts._internal_.ValueScope.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:110 - -___ - -### MissingRefError - -▪ `Static` **MissingRefError**: typeof [`default`](verida_client_ts._internal_.default-5.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:126 - -___ - -### ValidationError - -▪ `Static` **ValidationError**: typeof [`default`](verida_client_ts._internal_.default-4.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:125 - -## Methods - -### $dataMetaSchema - -▸ **$dataMetaSchema**(`metaSchema`, `keywordsJsonPointers`): [`AnySchemaObject`](../modules/verida_client_ts._internal_.md#anyschemaobject) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `metaSchema` | [`AnySchemaObject`](../modules/verida_client_ts._internal_.md#anyschemaobject) | -| `keywordsJsonPointers` | `string`[] | - -#### Returns - -[`AnySchemaObject`](../modules/verida_client_ts._internal_.md#anyschemaobject) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:163 - -___ - -### \_addDefaultMetaSchema - -▸ **_addDefaultMetaSchema**(): `void` - -#### Returns - -`void` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:129 - -___ - -### \_addSchema - -▸ **_addSchema**(`schema`, `meta?`, `baseId?`, `validateSchema?`, `addSchema?`): [`SchemaEnv`](verida_client_ts._internal_.SchemaEnv.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schema` | [`AnySchema`](../modules/verida_client_ts._internal_.md#anyschema) | -| `meta?` | `boolean` | -| `baseId?` | `string` | -| `validateSchema?` | `boolean` \| ``"log"`` | -| `addSchema?` | `boolean` | - -#### Returns - -[`SchemaEnv`](verida_client_ts._internal_.SchemaEnv.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:165 - -___ - -### \_addVocabularies - -▸ **_addVocabularies**(): `void` - -#### Returns - -`void` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:128 - -___ - -### addFormat - -▸ **addFormat**(`name`, `format`): [`default`](verida_client_ts._internal_.default-3.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` | -| `format` | [`Format`](../modules/verida_client_ts._internal_.md#format) | - -#### Returns - -[`default`](verida_client_ts._internal_.default-3.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:160 - -___ - -### addKeyword - -▸ **addKeyword**(`kwdOrDef`, `def?`): [`default`](verida_client_ts._internal_.default-3.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `kwdOrDef` | `string` \| [`KeywordDefinition`](../modules/verida_client_ts._internal_.md#keyworddefinition) | -| `def?` | [`KeywordDefinition`](../modules/verida_client_ts._internal_.md#keyworddefinition) | - -#### Returns - -[`default`](verida_client_ts._internal_.default-3.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:157 - -___ - -### addMetaSchema - -▸ **addMetaSchema**(`schema`, `key?`, `_validateSchema?`): [`default`](verida_client_ts._internal_.default-3.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schema` | [`AnySchemaObject`](../modules/verida_client_ts._internal_.md#anyschemaobject) | -| `key?` | `string` | -| `_validateSchema?` | `boolean` \| ``"log"`` | - -#### Returns - -[`default`](verida_client_ts._internal_.default-3.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:151 - -___ - -### addSchema - -▸ **addSchema**(`schema`, `key?`, `_meta?`, `_validateSchema?`): [`default`](verida_client_ts._internal_.default-3.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schema` | [`AnySchema`](../modules/verida_client_ts._internal_.md#anyschema) \| [`AnySchema`](../modules/verida_client_ts._internal_.md#anyschema)[] | -| `key?` | `string` | -| `_meta?` | `boolean` | -| `_validateSchema?` | `boolean` \| ``"log"`` | - -#### Returns - -[`default`](verida_client_ts._internal_.default-3.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:147 - -___ - -### addVocabulary - -▸ **addVocabulary**(`definitions`): [`default`](verida_client_ts._internal_.default-3.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `definitions` | [`Vocabulary`](../modules/verida_client_ts._internal_.md#vocabulary) | - -#### Returns - -[`default`](verida_client_ts._internal_.default-3.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:156 - -___ - -### compile - -▸ **compile**<`T`\>(`schema`, `_meta?`): [`ValidateFunction`](../interfaces/verida_client_ts._internal_.ValidateFunction.md)<`T`\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `unknown` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schema` | [`Schema`](../modules/verida_client_ts._internal_.md#schema) \| [`UncheckedJSONSchemaType`](../modules/verida_client_ts._internal_.md#uncheckedjsonschematype)<`T`, ``false``\> | -| `_meta?` | `boolean` | - -#### Returns - -[`ValidateFunction`](../interfaces/verida_client_ts._internal_.ValidateFunction.md)<`T`\> - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:138 - -▸ **compile**<`T`\>(`schema`, `_meta?`): [`ValidateFunction`](../interfaces/verida_client_ts._internal_.ValidateFunction.md)<`T`\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `unknown` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schema` | [`JTDSchemaType`](../modules/verida_client_ts._internal_.md#jtdschematype)<`T`, [`Record`](../modules/verida_client_ts._internal_.md#record)<`string`, `never`\>\> | -| `_meta?` | `boolean` | - -#### Returns - -[`ValidateFunction`](../interfaces/verida_client_ts._internal_.ValidateFunction.md)<`T`\> - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:139 - -▸ **compile**<`N`, `T`\>(`schema`, `_meta?`): [`ValidateFunction`](../interfaces/verida_client_ts._internal_.ValidateFunction.md)<[`JTDDataType`](../modules/verida_client_ts._internal_.md#jtddatatype)<`T`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `N` | extends `never` | -| `T` | extends [`SomeJTDSchemaType`](../modules/verida_client_ts._internal_.md#somejtdschematype) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schema` | `T` | -| `_meta?` | `boolean` | - -#### Returns - -[`ValidateFunction`](../interfaces/verida_client_ts._internal_.ValidateFunction.md)<[`JTDDataType`](../modules/verida_client_ts._internal_.md#jtddatatype)<`T`\>\> - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:140 - -▸ **compile**<`T`\>(`schema`, `_meta?`): [`AsyncValidateFunction`](../interfaces/verida_client_ts._internal_.AsyncValidateFunction.md)<`T`\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `unknown` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schema` | [`AsyncSchema`](../interfaces/verida_client_ts._internal_.AsyncSchema.md) | -| `_meta?` | `boolean` | - -#### Returns - -[`AsyncValidateFunction`](../interfaces/verida_client_ts._internal_.AsyncValidateFunction.md)<`T`\> - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:141 - -▸ **compile**<`T`\>(`schema`, `_meta?`): [`AnyValidateFunction`](../modules/verida_client_ts._internal_.md#anyvalidatefunction)<`T`\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `unknown` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schema` | [`AnySchema`](../modules/verida_client_ts._internal_.md#anyschema) | -| `_meta?` | `boolean` | - -#### Returns - -[`AnyValidateFunction`](../modules/verida_client_ts._internal_.md#anyvalidatefunction)<`T`\> - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:142 - -___ - -### compileAsync - -▸ **compileAsync**<`T`\>(`schema`, `_meta?`): `Promise`<[`ValidateFunction`](../interfaces/verida_client_ts._internal_.ValidateFunction.md)<`T`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `unknown` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schema` | [`SchemaObject`](../interfaces/verida_client_ts._internal_.SchemaObject.md) \| [`UncheckedJSONSchemaType`](../modules/verida_client_ts._internal_.md#uncheckedjsonschematype)<`T`, ``false``\> | -| `_meta?` | `boolean` | - -#### Returns - -`Promise`<[`ValidateFunction`](../interfaces/verida_client_ts._internal_.ValidateFunction.md)<`T`\>\> - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:143 - -▸ **compileAsync**<`T`\>(`schema`, `_meta?`): `Promise`<[`ValidateFunction`](../interfaces/verida_client_ts._internal_.ValidateFunction.md)<`T`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `unknown` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schema` | [`JTDSchemaType`](../modules/verida_client_ts._internal_.md#jtdschematype)<`T`, [`Record`](../modules/verida_client_ts._internal_.md#record)<`string`, `never`\>\> | -| `_meta?` | `boolean` | - -#### Returns - -`Promise`<[`ValidateFunction`](../interfaces/verida_client_ts._internal_.ValidateFunction.md)<`T`\>\> - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:144 - -▸ **compileAsync**<`T`\>(`schema`, `meta?`): `Promise`<[`AsyncValidateFunction`](../interfaces/verida_client_ts._internal_.AsyncValidateFunction.md)<`T`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `unknown` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schema` | [`AsyncSchema`](../interfaces/verida_client_ts._internal_.AsyncSchema.md) | -| `meta?` | `boolean` | - -#### Returns - -`Promise`<[`AsyncValidateFunction`](../interfaces/verida_client_ts._internal_.AsyncValidateFunction.md)<`T`\>\> - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:145 - -▸ **compileAsync**<`T`\>(`schema`, `meta?`): `Promise`<[`AnyValidateFunction`](../modules/verida_client_ts._internal_.md#anyvalidatefunction)<`T`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `unknown` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schema` | [`AnySchemaObject`](../modules/verida_client_ts._internal_.md#anyschemaobject) | -| `meta?` | `boolean` | - -#### Returns - -`Promise`<[`AnyValidateFunction`](../modules/verida_client_ts._internal_.md#anyvalidatefunction)<`T`\>\> - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:146 - -___ - -### defaultMeta - -▸ **defaultMeta**(): `undefined` \| `string` \| [`AnySchemaObject`](../modules/verida_client_ts._internal_.md#anyschemaobject) - -#### Returns - -`undefined` \| `string` \| [`AnySchemaObject`](../modules/verida_client_ts._internal_.md#anyschemaobject) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:130 - -___ - -### errorsText - -▸ **errorsText**(`errors?`, `__namedParameters?`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `errors?` | ``null`` \| [`ErrorObject`](../interfaces/verida_client_ts._internal_.ErrorObject.md)<`string`, [`Record`](../modules/verida_client_ts._internal_.md#record)<`string`, `any`\>, `unknown`\>[] | -| `__namedParameters?` | [`ErrorsTextOptions`](../interfaces/verida_client_ts._internal_.ErrorsTextOptions.md) | - -#### Returns - -`string` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:161 - -___ - -### getKeyword - -▸ **getKeyword**(`keyword`): `boolean` \| [`AddedKeywordDefinition`](../modules/verida_client_ts._internal_.md#addedkeyworddefinition) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `keyword` | `string` | - -#### Returns - -`boolean` \| [`AddedKeywordDefinition`](../modules/verida_client_ts._internal_.md#addedkeyworddefinition) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:158 - -___ - -### getSchema - -▸ **getSchema**<`T`\>(`keyRef`): `undefined` \| [`AnyValidateFunction`](../modules/verida_client_ts._internal_.md#anyvalidatefunction)<`T`\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `unknown` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `keyRef` | `string` | - -#### Returns - -`undefined` \| [`AnyValidateFunction`](../modules/verida_client_ts._internal_.md#anyvalidatefunction)<`T`\> - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:154 - -___ - -### removeKeyword - -▸ **removeKeyword**(`keyword`): [`default`](verida_client_ts._internal_.default-3.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `keyword` | `string` | - -#### Returns - -[`default`](verida_client_ts._internal_.default-3.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:159 - -___ - -### removeSchema - -▸ **removeSchema**(`schemaKeyRef?`): [`default`](verida_client_ts._internal_.default-3.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schemaKeyRef?` | `string` \| `RegExp` \| [`AnySchema`](../modules/verida_client_ts._internal_.md#anyschema) | - -#### Returns - -[`default`](verida_client_ts._internal_.default-3.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:155 - -___ - -### validate - -▸ **validate**(`schema`, `data`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schema` | `string` \| [`Schema`](../modules/verida_client_ts._internal_.md#schema) | -| `data` | `unknown` | - -#### Returns - -`boolean` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:131 - -▸ **validate**(`schemaKeyRef`, `data`): `boolean` \| `Promise`<`unknown`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schemaKeyRef` | `string` \| [`AnySchema`](../modules/verida_client_ts._internal_.md#anyschema) | -| `data` | `unknown` | - -#### Returns - -`boolean` \| `Promise`<`unknown`\> - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:132 - -▸ **validate**<`T`\>(`schema`, `data`): data is T - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schema` | `string` \| [`Schema`](../modules/verida_client_ts._internal_.md#schema) \| [`UncheckedJSONSchemaType`](../modules/verida_client_ts._internal_.md#uncheckedjsonschematype)<`T`, ``false``\> | -| `data` | `unknown` | - -#### Returns - -data is T - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:133 - -▸ **validate**<`T`\>(`schema`, `data`): data is T - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schema` | [`JTDSchemaType`](../modules/verida_client_ts._internal_.md#jtdschematype)<`T`, [`Record`](../modules/verida_client_ts._internal_.md#record)<`string`, `never`\>\> | -| `data` | `unknown` | - -#### Returns - -data is T - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:134 - -▸ **validate**<`N`, `T`\>(`schema`, `data`): data is JTDDataType - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `N` | extends `never` | -| `T` | extends [`SomeJTDSchemaType`](../modules/verida_client_ts._internal_.md#somejtdschematype) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schema` | `T` | -| `data` | `unknown` | - -#### Returns - -data is JTDDataType - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:135 - -▸ **validate**<`T`\>(`schema`, `data`): `Promise`<`T`\> - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schema` | [`AsyncSchema`](../interfaces/verida_client_ts._internal_.AsyncSchema.md) | -| `data` | `unknown` | - -#### Returns - -`Promise`<`T`\> - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:136 - -▸ **validate**<`T`\>(`schemaKeyRef`, `data`): data is T \| Promise - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schemaKeyRef` | `string` \| [`AnySchema`](../modules/verida_client_ts._internal_.md#anyschema) | -| `data` | `unknown` | - -#### Returns - -data is T \| Promise - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:137 - -___ - -### validateSchema - -▸ **validateSchema**(`schema`, `throwOrLogError?`): `boolean` \| `Promise`<`unknown`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schema` | [`AnySchema`](../modules/verida_client_ts._internal_.md#anyschema) | -| `throwOrLogError?` | `boolean` | - -#### Returns - -`boolean` \| `Promise`<`unknown`\> - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:153 diff --git a/docs/api/verida-js/classes/verida_client_ts._internal_.default-4.md b/docs/api/verida-js/classes/verida_client_ts._internal_.default-4.md deleted file mode 100644 index aafc191..0000000 --- a/docs/api/verida-js/classes/verida_client_ts._internal_.default-4.md +++ /dev/null @@ -1,198 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / default - -# Class: default - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).default - -## Hierarchy - -- [`Error`](../modules/verida_client_ts._internal_.md#error) - - ↳ **`default`** - -## Table of contents - -### Constructors - -- [constructor](verida_client_ts._internal_.default-4.md#constructor) - -### Properties - -- [ajv](verida_client_ts._internal_.default-4.md#ajv) -- [errors](verida_client_ts._internal_.default-4.md#errors) -- [message](verida_client_ts._internal_.default-4.md#message) -- [name](verida_client_ts._internal_.default-4.md#name) -- [stack](verida_client_ts._internal_.default-4.md#stack) -- [validation](verida_client_ts._internal_.default-4.md#validation) -- [prepareStackTrace](verida_client_ts._internal_.default-4.md#preparestacktrace) -- [stackTraceLimit](verida_client_ts._internal_.default-4.md#stacktracelimit) - -### Methods - -- [captureStackTrace](verida_client_ts._internal_.default-4.md#capturestacktrace) - -## Constructors - -### constructor - -• **new default**(`errors`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `errors` | [`Partial`](../modules/verida_client_ts._internal_.md#partial)<[`ErrorObject`](../interfaces/verida_client_ts._internal_.ErrorObject.md)<`string`, [`Record`](../modules/verida_client_ts._internal_.md#record)<`string`, `any`\>, `unknown`\>\>[] | - -#### Overrides - -Error.constructor - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/runtime/validation_error.d.ts:6 - -## Properties - -### ajv - -• `Readonly` **ajv**: ``true`` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/runtime/validation_error.d.ts:4 - -___ - -### errors - -• `Readonly` **errors**: [`Partial`](../modules/verida_client_ts._internal_.md#partial)<[`ErrorObject`](../interfaces/verida_client_ts._internal_.ErrorObject.md)<`string`, [`Record`](../modules/verida_client_ts._internal_.md#record)<`string`, `any`\>, `unknown`\>\>[] - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/runtime/validation_error.d.ts:3 - -___ - -### message - -• **message**: `string` - -#### Inherited from - -Error.message - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:974 - -___ - -### name - -• **name**: `string` - -#### Inherited from - -Error.name - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:973 - -___ - -### stack - -• `Optional` **stack**: `string` - -#### Inherited from - -Error.stack - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:975 - -___ - -### validation - -• `Readonly` **validation**: ``true`` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/runtime/validation_error.d.ts:5 - -___ - -### prepareStackTrace - -▪ `Static` `Optional` **prepareStackTrace**: (`err`: [`Error`](../modules/verida_client_ts._internal_.md#error), `stackTraces`: [`CallSite`](../interfaces/verida_client_ts._internal_.CallSite.md)[]) => `any` - -#### Type declaration - -▸ (`err`, `stackTraces`): `any` - -Optional override for formatting stack traces - -**`see`** https://v8.dev/docs/stack-trace-api#customizing-stack-traces - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `err` | [`Error`](../modules/verida_client_ts._internal_.md#error) | -| `stackTraces` | [`CallSite`](../interfaces/verida_client_ts._internal_.CallSite.md)[] | - -##### Returns - -`any` - -#### Inherited from - -Error.prepareStackTrace - -#### Defined in - -node_modules/@types/node/globals.d.ts:11 - -___ - -### stackTraceLimit - -▪ `Static` **stackTraceLimit**: `number` - -#### Inherited from - -Error.stackTraceLimit - -#### Defined in - -node_modules/@types/node/globals.d.ts:13 - -## Methods - -### captureStackTrace - -▸ `Static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` - -Create .stack property on a target object - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `targetObject` | `object` | -| `constructorOpt?` | `Function` | - -#### Returns - -`void` - -#### Inherited from - -Error.captureStackTrace - -#### Defined in - -node_modules/@types/node/globals.d.ts:4 diff --git a/docs/api/verida-js/classes/verida_client_ts._internal_.default-5.md b/docs/api/verida-js/classes/verida_client_ts._internal_.default-5.md deleted file mode 100644 index ebd9db7..0000000 --- a/docs/api/verida-js/classes/verida_client_ts._internal_.default-5.md +++ /dev/null @@ -1,190 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / default - -# Class: default - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).default - -## Hierarchy - -- [`Error`](../modules/verida_client_ts._internal_.md#error) - - ↳ **`default`** - -## Table of contents - -### Constructors - -- [constructor](verida_client_ts._internal_.default-5.md#constructor) - -### Properties - -- [message](verida_client_ts._internal_.default-5.md#message) -- [missingRef](verida_client_ts._internal_.default-5.md#missingref) -- [missingSchema](verida_client_ts._internal_.default-5.md#missingschema) -- [name](verida_client_ts._internal_.default-5.md#name) -- [stack](verida_client_ts._internal_.default-5.md#stack) -- [prepareStackTrace](verida_client_ts._internal_.default-5.md#preparestacktrace) -- [stackTraceLimit](verida_client_ts._internal_.default-5.md#stacktracelimit) - -### Methods - -- [captureStackTrace](verida_client_ts._internal_.default-5.md#capturestacktrace) - -## Constructors - -### constructor - -• **new default**(`resolver`, `baseId`, `ref`, `msg?`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `resolver` | [`UriResolver`](../interfaces/verida_client_ts._internal_.UriResolver.md) | -| `baseId` | `string` | -| `ref` | `string` | -| `msg?` | `string` | - -#### Overrides - -Error.constructor - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/ref_error.d.ts:5 - -## Properties - -### message - -• **message**: `string` - -#### Inherited from - -Error.message - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:974 - -___ - -### missingRef - -• `Readonly` **missingRef**: `string` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/ref_error.d.ts:3 - -___ - -### missingSchema - -• `Readonly` **missingSchema**: `string` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/ref_error.d.ts:4 - -___ - -### name - -• **name**: `string` - -#### Inherited from - -Error.name - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:973 - -___ - -### stack - -• `Optional` **stack**: `string` - -#### Inherited from - -Error.stack - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:975 - -___ - -### prepareStackTrace - -▪ `Static` `Optional` **prepareStackTrace**: (`err`: [`Error`](../modules/verida_client_ts._internal_.md#error), `stackTraces`: [`CallSite`](../interfaces/verida_client_ts._internal_.CallSite.md)[]) => `any` - -#### Type declaration - -▸ (`err`, `stackTraces`): `any` - -Optional override for formatting stack traces - -**`see`** https://v8.dev/docs/stack-trace-api#customizing-stack-traces - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `err` | [`Error`](../modules/verida_client_ts._internal_.md#error) | -| `stackTraces` | [`CallSite`](../interfaces/verida_client_ts._internal_.CallSite.md)[] | - -##### Returns - -`any` - -#### Inherited from - -Error.prepareStackTrace - -#### Defined in - -node_modules/@types/node/globals.d.ts:11 - -___ - -### stackTraceLimit - -▪ `Static` **stackTraceLimit**: `number` - -#### Inherited from - -Error.stackTraceLimit - -#### Defined in - -node_modules/@types/node/globals.d.ts:13 - -## Methods - -### captureStackTrace - -▸ `Static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` - -Create .stack property on a target object - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `targetObject` | `object` | -| `constructorOpt?` | `Function` | - -#### Returns - -`void` - -#### Inherited from - -Error.captureStackTrace - -#### Defined in - -node_modules/@types/node/globals.d.ts:4 diff --git a/docs/api/verida-js/classes/verida_client_ts._internal_.default-6.md b/docs/api/verida-js/classes/verida_client_ts._internal_.default-6.md deleted file mode 100644 index 597a854..0000000 --- a/docs/api/verida-js/classes/verida_client_ts._internal_.default-6.md +++ /dev/null @@ -1,378 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / default - -# Class: default - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).default - -## Table of contents - -### Constructors - -- [constructor](verida_client_ts._internal_.default-6.md#constructor) - -### Properties - -- [doc](verida_client_ts._internal_.default-6.md#doc) -- [errors](verida_client_ts._internal_.default-6.md#errors) -- [getProofData](verida_client_ts._internal_.default-6.md#getproofdata) - -### Accessors - -- [id](verida_client_ts._internal_.default-6.md#id) - -### Methods - -- [addContext](verida_client_ts._internal_.default-6.md#addcontext) -- [addContextAsymKey](verida_client_ts._internal_.default-6.md#addcontextasymkey) -- [addContextService](verida_client_ts._internal_.default-6.md#addcontextservice) -- [addContextSignKey](verida_client_ts._internal_.default-6.md#addcontextsignkey) -- [export](verida_client_ts._internal_.default-6.md#export) -- [getErrors](verida_client_ts._internal_.default-6.md#geterrors) -- [import](verida_client_ts._internal_.default-6.md#import) -- [locateServiceEndpoint](verida_client_ts._internal_.default-6.md#locateserviceendpoint) -- [removeContext](verida_client_ts._internal_.default-6.md#removecontext) -- [signProof](verida_client_ts._internal_.default-6.md#signproof) -- [verifyContextSignature](verida_client_ts._internal_.default-6.md#verifycontextsignature) -- [verifyProof](verida_client_ts._internal_.default-6.md#verifyproof) -- [verifySig](verida_client_ts._internal_.default-6.md#verifysig) -- [generateContextHash](verida_client_ts._internal_.default-6.md#generatecontexthash) - -## Constructors - -### constructor - -• **new default**(`doc`, `publicKeyHex?`) - -Force lower case DID as we can't guarantee the DID will always be provided with checksum - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `doc` | `string` \| [`DIDDocumentStruct`](../interfaces/verida_client_ts._internal_.DIDDocumentStruct.md) | -| `publicKeyHex?` | `string` | - -#### Defined in - -packages/did-document/dist/did-document.d.ts:12 - -## Properties - -### doc - -• `Private` **doc**: `any` - -#### Defined in - -packages/did-document/dist/did-document.d.ts:5 - -___ - -### errors - -• `Protected` **errors**: `string`[] - -#### Defined in - -packages/did-document/dist/did-document.d.ts:6 - -___ - -### getProofData - -• `Private` **getProofData**: `any` - -#### Defined in - -packages/did-document/dist/did-document.d.ts:33 - -## Accessors - -### id - -• `get` **id**(): `string` - -#### Returns - -`string` - -#### Defined in - -packages/did-document/dist/did-document.d.ts:13 - -## Methods - -### addContext - -▸ **addContext**(`contextName`, `keyring`, `endpoints`): `Promise`<`void`\> - -Not used directly, used for testing - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | -| `keyring` | [`default`](verida_client_ts._internal_.default-5.md) | -| `endpoints` | [`Endpoints`](../interfaces/verida_client_ts._internal_.Endpoints.md) | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -packages/did-document/dist/did-document.d.ts:22 - -___ - -### addContextAsymKey - -▸ **addContextAsymKey**(`contextHash`, `publicKeyHex`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextHash` | `string` | -| `publicKeyHex` | `string` | - -#### Returns - -`void` - -#### Defined in - -packages/did-document/dist/did-document.d.ts:28 - -___ - -### addContextService - -▸ **addContextService**(`contextHash`, `endpointType`, `serviceType`, `endpointUri`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextHash` | `string` | -| `endpointType` | [`EndpointType`](../enums/verida_client_ts._internal_.EndpointType.md) | -| `serviceType` | `string` | -| `endpointUri` | `string` | - -#### Returns - -`void` - -#### Defined in - -packages/did-document/dist/did-document.d.ts:26 - -___ - -### addContextSignKey - -▸ **addContextSignKey**(`contextHash`, `publicKeyHex`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextHash` | `string` | -| `publicKeyHex` | `string` | - -#### Returns - -`void` - -#### Defined in - -packages/did-document/dist/did-document.d.ts:27 - -___ - -### export - -▸ **export**(): [`DIDDocumentStruct`](../interfaces/verida_client_ts._internal_.DIDDocumentStruct.md) - -#### Returns - -[`DIDDocumentStruct`](../interfaces/verida_client_ts._internal_.DIDDocumentStruct.md) - -#### Defined in - -packages/did-document/dist/did-document.d.ts:25 - -___ - -### getErrors - -▸ **getErrors**(): `string`[] - -#### Returns - -`string`[] - -#### Defined in - -packages/did-document/dist/did-document.d.ts:14 - -___ - -### import - -▸ **import**(`doc`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `doc` | [`DIDDocumentStruct`](../interfaces/verida_client_ts._internal_.DIDDocumentStruct.md) | - -#### Returns - -`void` - -#### Defined in - -packages/did-document/dist/did-document.d.ts:24 - -___ - -### locateServiceEndpoint - -▸ **locateServiceEndpoint**(`contextName`, `endpointType`): `undefined` \| [`ServiceEndpoint`](../interfaces/verida_client_ts._internal_.ServiceEndpoint.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | -| `endpointType` | [`EndpointType`](../enums/verida_client_ts._internal_.EndpointType.md) | - -#### Returns - -`undefined` \| [`ServiceEndpoint`](../interfaces/verida_client_ts._internal_.ServiceEndpoint.md) - -#### Defined in - -packages/did-document/dist/did-document.d.ts:35 - -___ - -### removeContext - -▸ **removeContext**(`contextName`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | - -#### Returns - -`boolean` - -#### Defined in - -packages/did-document/dist/did-document.d.ts:23 - -___ - -### signProof - -▸ **signProof**(`privateKey`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `privateKey` | `string` \| `Uint8Array` | - -#### Returns - -`void` - -#### Defined in - -packages/did-document/dist/did-document.d.ts:29 - -___ - -### verifyContextSignature - -▸ **verifyContextSignature**(`data`, `contextName`, `signature`, `contextIsHash?`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `any` | -| `contextName` | `string` | -| `signature` | `string` | -| `contextIsHash?` | `boolean` | - -#### Returns - -`boolean` - -#### Defined in - -packages/did-document/dist/did-document.d.ts:32 - -___ - -### verifyProof - -▸ **verifyProof**(): `boolean` - -#### Returns - -`boolean` - -#### Defined in - -packages/did-document/dist/did-document.d.ts:30 - -___ - -### verifySig - -▸ **verifySig**(`data`, `signature`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `any` | -| `signature` | `string` | - -#### Returns - -`boolean` - -#### Defined in - -packages/did-document/dist/did-document.d.ts:31 - -___ - -### generateContextHash - -▸ `Static` **generateContextHash**(`did`, `contextName`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did` | `string` | -| `contextName` | `string` | - -#### Returns - -`string` - -#### Defined in - -packages/did-document/dist/did-document.d.ts:34 diff --git a/docs/api/verida-js/classes/verida_client_ts._internal_.default.md b/docs/api/verida-js/classes/verida_client_ts._internal_.default.md deleted file mode 100644 index 263b7a0..0000000 --- a/docs/api/verida-js/classes/verida_client_ts._internal_.default.md +++ /dev/null @@ -1,346 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / default - -# Class: default - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).default - -An Authenticator that automatically signs everything - -## Implements - -- [`IAccount`](../interfaces/verida_client_ts._internal_.IAccount.md) - -## Table of contents - -### Constructors - -- [constructor](verida_client_ts._internal_.default.md#constructor) - -### Methods - -- [createDidJwt](verida_client_ts._internal_.default.md#createdidjwt) -- [did](verida_client_ts._internal_.default.md#did) -- [disconnect](verida_client_ts._internal_.default.md#disconnect) -- [disconnectDevice](verida_client_ts._internal_.default.md#disconnectdevice) -- [getAuthContext](verida_client_ts._internal_.default.md#getauthcontext) -- [keyring](verida_client_ts._internal_.default.md#keyring) -- [linkStorage](verida_client_ts._internal_.default.md#linkstorage) -- [linkStorageContextService](verida_client_ts._internal_.default.md#linkstoragecontextservice) -- [setAccountConfig](verida_client_ts._internal_.default.md#setaccountconfig) -- [sign](verida_client_ts._internal_.default.md#sign) -- [storageConfig](verida_client_ts._internal_.default.md#storageconfig) -- [unlinkStorage](verida_client_ts._internal_.default.md#unlinkstorage) - -## Constructors - -### constructor - -• **new default**() - -## Methods - -### createDidJwt - -▸ **createDidJwt**(`contextName`, `data`, `config?`): `Promise`<`string`\> - -Create a DID-JWT from a data object - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | -| `data` | `object` | -| `config?` | `any` | - -#### Returns - -`Promise`<`string`\> - -#### Implementation of - -[IAccount](../interfaces/verida_client_ts._internal_.IAccount.md).[createDidJwt](../interfaces/verida_client_ts._internal_.IAccount.md#createdidjwt) - -#### Defined in - -packages/account/dist/account.d.ts:42 - -___ - -### did - -▸ **did**(): `Promise`<`string`\> - -Get the DID of the current user - -#### Returns - -`Promise`<`string`\> - -#### Implementation of - -[IAccount](../interfaces/verida_client_ts._internal_.IAccount.md).[did](../interfaces/verida_client_ts._internal_.IAccount.md#did) - -#### Defined in - -packages/account/dist/account.d.ts:22 - -___ - -### disconnect - -▸ **disconnect**(`contextName?`): `Promise`<`void`\> - -An optional method that can be used to disconnect the current user. - -For example, in a web browser context, it would remove any stored signatures from local storage. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName?` | `string` | - -#### Returns - -`Promise`<`void`\> - -#### Implementation of - -[IAccount](../interfaces/verida_client_ts._internal_.IAccount.md).[disconnect](../interfaces/verida_client_ts._internal_.IAccount.md#disconnect) - -#### Defined in - -packages/account/dist/account.d.ts:48 - -___ - -### disconnectDevice - -▸ **disconnectDevice**(`contextName`, `deviceId?`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | -| `deviceId?` | `string` | - -#### Returns - -`Promise`<`boolean`\> - -#### Implementation of - -[IAccount](../interfaces/verida_client_ts._internal_.IAccount.md).[disconnectDevice](../interfaces/verida_client_ts._internal_.IAccount.md#disconnectdevice) - -#### Defined in - -packages/account/dist/account.d.ts:50 - -___ - -### getAuthContext - -▸ **getAuthContext**(`contextName`, `contextConfig`, `authConfig?`, `authType?`): `Promise`<[`AuthContext`](../interfaces/verida_client_ts._internal_.AuthContext.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | -| `contextConfig` | [`SecureContextConfig`](../interfaces/verida_client_ts._internal_.SecureContextConfig.md) | -| `authConfig?` | [`AuthTypeConfig`](../interfaces/verida_client_ts._internal_.AuthTypeConfig.md) | -| `authType?` | `string` | - -#### Returns - -`Promise`<[`AuthContext`](../interfaces/verida_client_ts._internal_.AuthContext.md)\> - -#### Implementation of - -[IAccount](../interfaces/verida_client_ts._internal_.IAccount.md).[getAuthContext](../interfaces/verida_client_ts._internal_.IAccount.md#getauthcontext) - -#### Defined in - -packages/account/dist/account.d.ts:49 - -___ - -### keyring - -▸ **keyring**(`contextName`): `Promise`<[`default`](verida_client_ts._internal_.default-2.md)\> - -Generate a keyring for this user for a given storage context. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | - -#### Returns - -`Promise`<[`default`](verida_client_ts._internal_.default-2.md)\> - -#### Implementation of - -[IAccount](../interfaces/verida_client_ts._internal_.IAccount.md).[keyring](../interfaces/verida_client_ts._internal_.IAccount.md#keyring) - -#### Defined in - -packages/account/dist/account.d.ts:12 - -___ - -### linkStorage - -▸ **linkStorage**(`storageConfig`): `Promise`<`boolean`\> - -Link storage to this user - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `storageConfig` | [`SecureContextConfig`](../interfaces/verida_client_ts._internal_.SecureContextConfig.md) | - -#### Returns - -`Promise`<`boolean`\> - -#### Implementation of - -[IAccount](../interfaces/verida_client_ts._internal_.IAccount.md).[linkStorage](../interfaces/verida_client_ts._internal_.IAccount.md#linkstorage) - -#### Defined in - -packages/account/dist/account.d.ts:28 - -___ - -### linkStorageContextService - -▸ **linkStorageContextService**(`contextName`, `endpointType`, `serverType`, `endpointUris`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | -| `endpointType` | `string` | -| `serverType` | `string` | -| `endpointUris` | `string`[] | - -#### Returns - -`Promise`<`boolean`\> - -#### Implementation of - -[IAccount](../interfaces/verida_client_ts._internal_.IAccount.md).[linkStorageContextService](../interfaces/verida_client_ts._internal_.IAccount.md#linkstoragecontextservice) - -#### Defined in - -packages/account/dist/account.d.ts:36 - -___ - -### setAccountConfig - -▸ **setAccountConfig**(`accountConfig`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `accountConfig` | [`AccountConfig`](../interfaces/verida_client_ts._internal_.AccountConfig.md) | - -#### Returns - -`void` - -#### Implementation of - -[IAccount](../interfaces/verida_client_ts._internal_.IAccount.md).[setAccountConfig](../interfaces/verida_client_ts._internal_.IAccount.md#setaccountconfig) - -#### Defined in - -packages/account/dist/account.d.ts:37 - -___ - -### sign - -▸ **sign**(`input`): `Promise`<`string`\> - -Sign a string as the current user - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `input` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Implementation of - -[IAccount](../interfaces/verida_client_ts._internal_.IAccount.md).[sign](../interfaces/verida_client_ts._internal_.IAccount.md#sign) - -#### Defined in - -packages/account/dist/account.d.ts:18 - -___ - -### storageConfig - -▸ **storageConfig**(`contextName`, `forceCreate?`): `Promise`<`undefined` \| [`SecureContextConfig`](../interfaces/verida_client_ts._internal_.SecureContextConfig.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | -| `forceCreate?` | `boolean` | - -#### Returns - -`Promise`<`undefined` \| [`SecureContextConfig`](../interfaces/verida_client_ts._internal_.SecureContextConfig.md)\> - -#### Implementation of - -[IAccount](../interfaces/verida_client_ts._internal_.IAccount.md).[storageConfig](../interfaces/verida_client_ts._internal_.IAccount.md#storageconfig) - -#### Defined in - -packages/account/dist/account.d.ts:35 - -___ - -### unlinkStorage - -▸ **unlinkStorage**(`contextName`): `Promise`<`boolean`\> - -Unlink storage for this user - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | - -#### Returns - -`Promise`<`boolean`\> - -#### Implementation of - -[IAccount](../interfaces/verida_client_ts._internal_.IAccount.md).[unlinkStorage](../interfaces/verida_client_ts._internal_.IAccount.md#unlinkstorage) - -#### Defined in - -packages/account/dist/account.d.ts:34 diff --git a/docs/api/verida-js/classes/verida_did_client.DIDClient.md b/docs/api/verida-js/classes/verida_did_client.DIDClient.md deleted file mode 100644 index 6de4358..0000000 --- a/docs/api/verida-js/classes/verida_did_client.DIDClient.md +++ /dev/null @@ -1,305 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/did-client](../modules/verida_did_client.md) / DIDClient - -# Class: DIDClient - -[@verida/did-client](../modules/verida_did_client.md).DIDClient - -## Implements - -- [`IDIDClient`](../interfaces/verida_did_client._internal_.IDIDClient.md) - -## Table of contents - -### Constructors - -- [constructor](verida_did_client.DIDClient.md#constructor) - -### Properties - -- [config](verida_did_client.DIDClient.md#config) -- [defaultEndpoints](verida_did_client.DIDClient.md#defaultendpoints) -- [didResolver](verida_did_client.DIDClient.md#didresolver) -- [endpointErrors](verida_did_client.DIDClient.md#endpointerrors) -- [vdaDid](verida_did_client.DIDClient.md#vdadid) -- [veridaWallet](verida_did_client.DIDClient.md#veridawallet) - -### Methods - -- [authenticate](verida_did_client.DIDClient.md#authenticate) -- [authenticated](verida_did_client.DIDClient.md#authenticated) -- [destroy](verida_did_client.DIDClient.md#destroy) -- [get](verida_did_client.DIDClient.md#get) -- [getDid](verida_did_client.DIDClient.md#getdid) -- [getLastEndpointErrors](verida_did_client.DIDClient.md#getlastendpointerrors) -- [getPublicKey](verida_did_client.DIDClient.md#getpublickey) -- [getRpcUrl](verida_did_client.DIDClient.md#getrpcurl) -- [save](verida_did_client.DIDClient.md#save) - -## Constructors - -### constructor - -• **new DIDClient**(`config`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | [`DIDClientConfig`](../interfaces/verida_did_client._internal_.DIDClientConfig.md) | - -#### Defined in - -[packages/did-client/src/did-client.ts:26](https://github.com/verida/verida-js/blob/5040472/packages/did-client/src/did-client.ts#L26) - -## Properties - -### config - -• `Private` **config**: [`DIDClientConfig`](../interfaces/verida_did_client._internal_.DIDClientConfig.md) - -#### Defined in - -[packages/did-client/src/did-client.ts:12](https://github.com/verida/verida-js/blob/5040472/packages/did-client/src/did-client.ts#L12) - -___ - -### defaultEndpoints - -• `Private` `Optional` **defaultEndpoints**: `string`[] - -#### Defined in - -[packages/did-client/src/did-client.ts:22](https://github.com/verida/verida-js/blob/5040472/packages/did-client/src/did-client.ts#L22) - -___ - -### didResolver - -• `Private` **didResolver**: [`Resolver`](verida_did_client._internal_.Resolver.md) - -#### Defined in - -[packages/did-client/src/did-client.ts:15](https://github.com/verida/verida-js/blob/5040472/packages/did-client/src/did-client.ts#L15) - -___ - -### endpointErrors - -• `Private` `Optional` **endpointErrors**: [`VdaDidEndpointResponses`](../modules/verida_did_client._internal_.md#vdadidendpointresponses) - -#### Defined in - -[packages/did-client/src/did-client.ts:24](https://github.com/verida/verida-js/blob/5040472/packages/did-client/src/did-client.ts#L24) - -___ - -### vdaDid - -• `Private` `Optional` **vdaDid**: [`default`](verida_did_client._internal_.default.md) - -#### Defined in - -[packages/did-client/src/did-client.ts:17](https://github.com/verida/verida-js/blob/5040472/packages/did-client/src/did-client.ts#L17) - -___ - -### veridaWallet - -• `Private` **veridaWallet**: `undefined` \| [`Wallet`](verida_did_client.Wallet.md) - -#### Defined in - -[packages/did-client/src/did-client.ts:20](https://github.com/verida/verida-js/blob/5040472/packages/did-client/src/did-client.ts#L20) - -## Methods - -### authenticate - -▸ **authenticate**(`veridaPrivateKey`, `callType`, `web3Config`, `defaultEndpoints`): `void` - -Unlock save() function by providing verida signing key. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `veridaPrivateKey` | `string` | Private key of a Verida Account. Used to sign transactions in the DID Registry to verify the request originated from the DID owner / controller | -| `callType` | [`Web3CallType`](../modules/verida_did_client._internal_.md#web3calltype) | Blockchain interaction mode. 'web3' \| 'gasless' | -| `web3Config` | [`Web3SelfTransactionConfigPart`](../interfaces/verida_did_client._internal_.Web3SelfTransactionConfigPart.md) \| [`Web3MetaTransactionConfig`](../interfaces/verida_did_client._internal_.Web3MetaTransactionConfig.md) | Web3 configuration. If `web3`, you must provide `privateKey` (MATIC private key that will pay for gas). If `gasless` you must specify `endpointUrl` (URL of the meta transaction server) and any appropriate `serverConfig` and `postConfig`. | -| `defaultEndpoints` | `string`[] | - | - -#### Returns - -`void` - -#### Implementation of - -[IDIDClient](../interfaces/verida_did_client._internal_.IDIDClient.md).[authenticate](../interfaces/verida_did_client._internal_.IDIDClient.md#authenticate) - -#### Defined in - -[packages/did-client/src/did-client.ts:56](https://github.com/verida/verida-js/blob/5040472/packages/did-client/src/did-client.ts#L56) - -___ - -### authenticated - -▸ **authenticated**(): `boolean` - -#### Returns - -`boolean` - -#### Implementation of - -[IDIDClient](../interfaces/verida_did_client._internal_.IDIDClient.md).[authenticated](../interfaces/verida_did_client._internal_.IDIDClient.md#authenticated) - -#### Defined in - -[packages/did-client/src/did-client.ts:103](https://github.com/verida/verida-js/blob/5040472/packages/did-client/src/did-client.ts#L103) - -___ - -### destroy - -▸ **destroy**(): `Promise`<[`VdaDidEndpointResponses`](../modules/verida_did_client._internal_.md#vdadidendpointresponses)\> - -Destroy this DID - -Note: This can not be reversed and is written to the blockchain - -#### Returns - -`Promise`<[`VdaDidEndpointResponses`](../modules/verida_did_client._internal_.md#vdadidendpointresponses)\> - -#### Defined in - -[packages/did-client/src/did-client.ts:133](https://github.com/verida/verida-js/blob/5040472/packages/did-client/src/did-client.ts#L133) - -___ - -### get - -▸ **get**(`did`): `Promise`<[`default`](verida_did_client._internal_.default-1.md)\> - -Get original document loaded from blockchain. Creates a new document if it didn't exist - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did` | `string` | - -#### Returns - -`Promise`<[`default`](verida_did_client._internal_.default-1.md)\> - -DID Document instance - -#### Implementation of - -[IDIDClient](../interfaces/verida_did_client._internal_.IDIDClient.md).[get](../interfaces/verida_did_client._internal_.IDIDClient.md#get) - -#### Defined in - -[packages/did-client/src/did-client.ts:216](https://github.com/verida/verida-js/blob/5040472/packages/did-client/src/did-client.ts#L216) - -___ - -### getDid - -▸ **getDid**(): `undefined` \| `string` - -#### Returns - -`undefined` \| `string` - -#### Implementation of - -[IDIDClient](../interfaces/verida_did_client._internal_.IDIDClient.md).[getDid](../interfaces/verida_did_client._internal_.IDIDClient.md#getdid) - -#### Defined in - -[packages/did-client/src/did-client.ts:107](https://github.com/verida/verida-js/blob/5040472/packages/did-client/src/did-client.ts#L107) - -___ - -### getLastEndpointErrors - -▸ **getLastEndpointErrors**(): [`VdaDidEndpointResponses`](../modules/verida_did_client._internal_.md#vdadidendpointresponses) - -#### Returns - -[`VdaDidEndpointResponses`](../modules/verida_did_client._internal_.md#vdadidendpointresponses) - -#### Implementation of - -[IDIDClient](../interfaces/verida_did_client._internal_.IDIDClient.md).[getLastEndpointErrors](../interfaces/verida_did_client._internal_.IDIDClient.md#getlastendpointerrors) - -#### Defined in - -[packages/did-client/src/did-client.ts:207](https://github.com/verida/verida-js/blob/5040472/packages/did-client/src/did-client.ts#L207) - -___ - -### getPublicKey - -▸ **getPublicKey**(): `undefined` \| `string` - -#### Returns - -`undefined` \| `string` - -#### Implementation of - -[IDIDClient](../interfaces/verida_did_client._internal_.IDIDClient.md).[getPublicKey](../interfaces/verida_did_client._internal_.IDIDClient.md#getpublickey) - -#### Defined in - -[packages/did-client/src/did-client.ts:120](https://github.com/verida/verida-js/blob/5040472/packages/did-client/src/did-client.ts#L120) - -___ - -### getRpcUrl - -▸ **getRpcUrl**(): `string` - -#### Returns - -`string` - -#### Implementation of - -[IDIDClient](../interfaces/verida_did_client._internal_.IDIDClient.md).[getRpcUrl](../interfaces/verida_did_client._internal_.IDIDClient.md#getrpcurl) - -#### Defined in - -[packages/did-client/src/did-client.ts:40](https://github.com/verida/verida-js/blob/5040472/packages/did-client/src/did-client.ts#L40) - -___ - -### save - -▸ **save**(`document`): `Promise`<[`VdaDidEndpointResponses`](../modules/verida_did_client._internal_.md#vdadidendpointresponses)\> - -Save DIDDocument to the chain - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `document` | [`default`](verida_did_client._internal_.default-1.md) | Updated DIDDocuent | - -#### Returns - -`Promise`<[`VdaDidEndpointResponses`](../modules/verida_did_client._internal_.md#vdadidendpointresponses)\> - -true if success. - -#### Implementation of - -[IDIDClient](../interfaces/verida_did_client._internal_.IDIDClient.md).[save](../interfaces/verida_did_client._internal_.IDIDClient.md#save) - -#### Defined in - -[packages/did-client/src/did-client.ts:147](https://github.com/verida/verida-js/blob/5040472/packages/did-client/src/did-client.ts#L147) diff --git a/docs/api/verida-js/classes/verida_did_client.Wallet.md b/docs/api/verida-js/classes/verida_did_client.Wallet.md deleted file mode 100644 index b260043..0000000 --- a/docs/api/verida-js/classes/verida_did_client.Wallet.md +++ /dev/null @@ -1,228 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/did-client](../modules/verida_did_client.md) / Wallet - -# Class: Wallet - -[@verida/did-client](../modules/verida_did_client.md).Wallet - -## Table of contents - -### Constructors - -- [constructor](verida_did_client.Wallet.md#constructor) - -### Properties - -- [\_did](verida_did_client.Wallet.md#_did) -- [\_network](verida_did_client.Wallet.md#_network) -- [\_privateKey](verida_did_client.Wallet.md#_privatekey) -- [\_publicKey](verida_did_client.Wallet.md#_publickey) - -### Accessors - -- [did](verida_did_client.Wallet.md#did) -- [privateKey](verida_did_client.Wallet.md#privatekey) -- [privateKeyBase58](verida_did_client.Wallet.md#privatekeybase58) -- [privateKeyBuffer](verida_did_client.Wallet.md#privatekeybuffer) -- [publicKey](verida_did_client.Wallet.md#publickey) -- [publicKeyBase58](verida_did_client.Wallet.md#publickeybase58) -- [publicKeyBuffer](verida_did_client.Wallet.md#publickeybuffer) - -### Methods - -- [load](verida_did_client.Wallet.md#load) -- [createRandom](verida_did_client.Wallet.md#createrandom) - -## Constructors - -### constructor - -• **new Wallet**(`privateKey`, `network`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `privateKey` | `string` | -| `network` | `string` | - -#### Defined in - -[packages/did-client/src/wallet.ts:14](https://github.com/verida/verida-js/blob/5040472/packages/did-client/src/wallet.ts#L14) - -## Properties - -### \_did - -• `Private` **\_did**: `string` - -#### Defined in - -[packages/did-client/src/wallet.ts:6](https://github.com/verida/verida-js/blob/5040472/packages/did-client/src/wallet.ts#L6) - -___ - -### \_network - -• `Private` **\_network**: `string` - -#### Defined in - -[packages/did-client/src/wallet.ts:12](https://github.com/verida/verida-js/blob/5040472/packages/did-client/src/wallet.ts#L12) - -___ - -### \_privateKey - -• `Private` **\_privateKey**: `string` - -#### Defined in - -[packages/did-client/src/wallet.ts:10](https://github.com/verida/verida-js/blob/5040472/packages/did-client/src/wallet.ts#L10) - -___ - -### \_publicKey - -• `Private` **\_publicKey**: `string` - -#### Defined in - -[packages/did-client/src/wallet.ts:8](https://github.com/verida/verida-js/blob/5040472/packages/did-client/src/wallet.ts#L8) - -## Accessors - -### did - -• `get` **did**(): `string` - -#### Returns - -`string` - -#### Defined in - -[packages/did-client/src/wallet.ts:37](https://github.com/verida/verida-js/blob/5040472/packages/did-client/src/wallet.ts#L37) - -___ - -### privateKey - -• `get` **privateKey**(): `string` - -#### Returns - -`string` - -#### Defined in - -[packages/did-client/src/wallet.ts:41](https://github.com/verida/verida-js/blob/5040472/packages/did-client/src/wallet.ts#L41) - -___ - -### privateKeyBase58 - -• `get` **privateKeyBase58**(): `string` - -#### Returns - -`string` - -#### Defined in - -[packages/did-client/src/wallet.ts:57](https://github.com/verida/verida-js/blob/5040472/packages/did-client/src/wallet.ts#L57) - -___ - -### privateKeyBuffer - -• `get` **privateKeyBuffer**(): `Uint8Array` - -#### Returns - -`Uint8Array` - -#### Defined in - -[packages/did-client/src/wallet.ts:49](https://github.com/verida/verida-js/blob/5040472/packages/did-client/src/wallet.ts#L49) - -___ - -### publicKey - -• `get` **publicKey**(): `string` - -#### Returns - -`string` - -#### Defined in - -[packages/did-client/src/wallet.ts:45](https://github.com/verida/verida-js/blob/5040472/packages/did-client/src/wallet.ts#L45) - -___ - -### publicKeyBase58 - -• `get` **publicKeyBase58**(): `string` - -#### Returns - -`string` - -#### Defined in - -[packages/did-client/src/wallet.ts:61](https://github.com/verida/verida-js/blob/5040472/packages/did-client/src/wallet.ts#L61) - -___ - -### publicKeyBuffer - -• `get` **publicKeyBuffer**(): `Uint8Array` - -#### Returns - -`Uint8Array` - -#### Defined in - -[packages/did-client/src/wallet.ts:53](https://github.com/verida/verida-js/blob/5040472/packages/did-client/src/wallet.ts#L53) - -## Methods - -### load - -▸ `Private` **load**(`privateKey`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `privateKey` | `string` | - -#### Returns - -`void` - -#### Defined in - -[packages/did-client/src/wallet.ts:24](https://github.com/verida/verida-js/blob/5040472/packages/did-client/src/wallet.ts#L24) - -___ - -### createRandom - -▸ `Static` **createRandom**(`network?`): [`Wallet`](verida_did_client.Wallet.md) - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `network` | `string` | `'testnet'` | - -#### Returns - -[`Wallet`](verida_did_client.Wallet.md) - -#### Defined in - -[packages/did-client/src/wallet.ts:19](https://github.com/verida/verida-js/blob/5040472/packages/did-client/src/wallet.ts#L19) diff --git a/docs/api/verida-js/classes/verida_did_client._internal_.BigNumber.md b/docs/api/verida-js/classes/verida_did_client._internal_.BigNumber.md deleted file mode 100644 index 853e0f8..0000000 --- a/docs/api/verida-js/classes/verida_did_client._internal_.BigNumber.md +++ /dev/null @@ -1,631 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/did-client](../modules/verida_did_client.md) / [](../modules/verida_did_client._internal_.md) / BigNumber - -# Class: BigNumber - -[@verida/did-client](../modules/verida_did_client.md).[](../modules/verida_did_client._internal_.md).BigNumber - -## Implements - -- [`Hexable`](../interfaces/verida_did_client._internal_.Hexable.md) - -## Table of contents - -### Constructors - -- [constructor](verida_did_client._internal_.BigNumber.md#constructor) - -### Properties - -- [\_hex](verida_did_client._internal_.BigNumber.md#_hex) -- [\_isBigNumber](verida_did_client._internal_.BigNumber.md#_isbignumber) - -### Methods - -- [abs](verida_did_client._internal_.BigNumber.md#abs) -- [add](verida_did_client._internal_.BigNumber.md#add) -- [and](verida_did_client._internal_.BigNumber.md#and) -- [div](verida_did_client._internal_.BigNumber.md#div) -- [eq](verida_did_client._internal_.BigNumber.md#eq) -- [fromTwos](verida_did_client._internal_.BigNumber.md#fromtwos) -- [gt](verida_did_client._internal_.BigNumber.md#gt) -- [gte](verida_did_client._internal_.BigNumber.md#gte) -- [isNegative](verida_did_client._internal_.BigNumber.md#isnegative) -- [isZero](verida_did_client._internal_.BigNumber.md#iszero) -- [lt](verida_did_client._internal_.BigNumber.md#lt) -- [lte](verida_did_client._internal_.BigNumber.md#lte) -- [mask](verida_did_client._internal_.BigNumber.md#mask) -- [mod](verida_did_client._internal_.BigNumber.md#mod) -- [mul](verida_did_client._internal_.BigNumber.md#mul) -- [or](verida_did_client._internal_.BigNumber.md#or) -- [pow](verida_did_client._internal_.BigNumber.md#pow) -- [shl](verida_did_client._internal_.BigNumber.md#shl) -- [shr](verida_did_client._internal_.BigNumber.md#shr) -- [sub](verida_did_client._internal_.BigNumber.md#sub) -- [toBigInt](verida_did_client._internal_.BigNumber.md#tobigint) -- [toHexString](verida_did_client._internal_.BigNumber.md#tohexstring) -- [toJSON](verida_did_client._internal_.BigNumber.md#tojson) -- [toNumber](verida_did_client._internal_.BigNumber.md#tonumber) -- [toString](verida_did_client._internal_.BigNumber.md#tostring) -- [toTwos](verida_did_client._internal_.BigNumber.md#totwos) -- [xor](verida_did_client._internal_.BigNumber.md#xor) -- [from](verida_did_client._internal_.BigNumber.md#from) -- [isBigNumber](verida_did_client._internal_.BigNumber.md#isbignumber) - -## Constructors - -### constructor - -• **new BigNumber**(`constructorGuard`, `hex`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `constructorGuard` | `any` | -| `hex` | `string` | - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:7 - -## Properties - -### \_hex - -• `Readonly` **\_hex**: `string` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:5 - -___ - -### \_isBigNumber - -• `Readonly` **\_isBigNumber**: `boolean` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:6 - -## Methods - -### abs - -▸ **abs**(): [`BigNumber`](verida_did_client._internal_.BigNumber.md) - -#### Returns - -[`BigNumber`](verida_did_client._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:10 - -___ - -### add - -▸ **add**(`other`): [`BigNumber`](verida_did_client._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_did_client._internal_.md#bignumberish) | - -#### Returns - -[`BigNumber`](verida_did_client._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:11 - -___ - -### and - -▸ **and**(`other`): [`BigNumber`](verida_did_client._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_did_client._internal_.md#bignumberish) | - -#### Returns - -[`BigNumber`](verida_did_client._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:17 - -___ - -### div - -▸ **div**(`other`): [`BigNumber`](verida_did_client._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_did_client._internal_.md#bignumberish) | - -#### Returns - -[`BigNumber`](verida_did_client._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:13 - -___ - -### eq - -▸ **eq**(`other`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_did_client._internal_.md#bignumberish) | - -#### Returns - -`boolean` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:23 - -___ - -### fromTwos - -▸ **fromTwos**(`value`): [`BigNumber`](verida_did_client._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `number` | - -#### Returns - -[`BigNumber`](verida_did_client._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:8 - -___ - -### gt - -▸ **gt**(`other`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_did_client._internal_.md#bignumberish) | - -#### Returns - -`boolean` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:26 - -___ - -### gte - -▸ **gte**(`other`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_did_client._internal_.md#bignumberish) | - -#### Returns - -`boolean` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:27 - -___ - -### isNegative - -▸ **isNegative**(): `boolean` - -#### Returns - -`boolean` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:28 - -___ - -### isZero - -▸ **isZero**(): `boolean` - -#### Returns - -`boolean` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:29 - -___ - -### lt - -▸ **lt**(`other`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_did_client._internal_.md#bignumberish) | - -#### Returns - -`boolean` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:24 - -___ - -### lte - -▸ **lte**(`other`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_did_client._internal_.md#bignumberish) | - -#### Returns - -`boolean` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:25 - -___ - -### mask - -▸ **mask**(`value`): [`BigNumber`](verida_did_client._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `number` | - -#### Returns - -[`BigNumber`](verida_did_client._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:20 - -___ - -### mod - -▸ **mod**(`other`): [`BigNumber`](verida_did_client._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_did_client._internal_.md#bignumberish) | - -#### Returns - -[`BigNumber`](verida_did_client._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:15 - -___ - -### mul - -▸ **mul**(`other`): [`BigNumber`](verida_did_client._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_did_client._internal_.md#bignumberish) | - -#### Returns - -[`BigNumber`](verida_did_client._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:14 - -___ - -### or - -▸ **or**(`other`): [`BigNumber`](verida_did_client._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_did_client._internal_.md#bignumberish) | - -#### Returns - -[`BigNumber`](verida_did_client._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:18 - -___ - -### pow - -▸ **pow**(`other`): [`BigNumber`](verida_did_client._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_did_client._internal_.md#bignumberish) | - -#### Returns - -[`BigNumber`](verida_did_client._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:16 - -___ - -### shl - -▸ **shl**(`value`): [`BigNumber`](verida_did_client._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `number` | - -#### Returns - -[`BigNumber`](verida_did_client._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:21 - -___ - -### shr - -▸ **shr**(`value`): [`BigNumber`](verida_did_client._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `number` | - -#### Returns - -[`BigNumber`](verida_did_client._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:22 - -___ - -### sub - -▸ **sub**(`other`): [`BigNumber`](verida_did_client._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_did_client._internal_.md#bignumberish) | - -#### Returns - -[`BigNumber`](verida_did_client._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:12 - -___ - -### toBigInt - -▸ **toBigInt**(): `bigint` - -#### Returns - -`bigint` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:31 - -___ - -### toHexString - -▸ **toHexString**(): `string` - -#### Returns - -`string` - -#### Implementation of - -[Hexable](../interfaces/verida_did_client._internal_.Hexable.md).[toHexString](../interfaces/verida_did_client._internal_.Hexable.md#tohexstring) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:33 - -___ - -### toJSON - -▸ **toJSON**(`key?`): `any` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `key?` | `string` | - -#### Returns - -`any` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:34 - -___ - -### toNumber - -▸ **toNumber**(): `number` - -#### Returns - -`number` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:30 - -___ - -### toString - -▸ **toString**(): `string` - -#### Returns - -`string` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:32 - -___ - -### toTwos - -▸ **toTwos**(`value`): [`BigNumber`](verida_did_client._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `number` | - -#### Returns - -[`BigNumber`](verida_did_client._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:9 - -___ - -### xor - -▸ **xor**(`other`): [`BigNumber`](verida_did_client._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_did_client._internal_.md#bignumberish) | - -#### Returns - -[`BigNumber`](verida_did_client._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:19 - -___ - -### from - -▸ `Static` **from**(`value`): [`BigNumber`](verida_did_client._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `any` | - -#### Returns - -[`BigNumber`](verida_did_client._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:35 - -___ - -### isBigNumber - -▸ `Static` **isBigNumber**(`value`): value is BigNumber - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `any` | - -#### Returns - -value is BigNumber - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:36 diff --git a/docs/api/verida-js/classes/verida_did_client._internal_.Description.md b/docs/api/verida-js/classes/verida_did_client._internal_.Description.md deleted file mode 100644 index b5d7b85..0000000 --- a/docs/api/verida-js/classes/verida_did_client._internal_.Description.md +++ /dev/null @@ -1,45 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/did-client](../modules/verida_did_client.md) / [](../modules/verida_did_client._internal_.md) / Description - -# Class: Description - -[@verida/did-client](../modules/verida_did_client.md).[](../modules/verida_did_client._internal_.md).Description - -## Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `any` | - -## Hierarchy - -- **`Description`** - - ↳ [`ForkEvent`](verida_did_client._internal_.ForkEvent.md) - -## Table of contents - -### Constructors - -- [constructor](verida_did_client._internal_.Description.md#constructor) - -## Constructors - -### constructor - -• **new Description**<`T`\>(`info`) - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `any` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `info` | { [K in string \| number \| symbol]: T[K] } | - -#### Defined in - -node_modules/@ethersproject/properties/lib/index.d.ts:13 diff --git a/docs/api/verida-js/classes/verida_did_client._internal_.ForkEvent.md b/docs/api/verida-js/classes/verida_did_client._internal_.ForkEvent.md deleted file mode 100644 index 8da7ce0..0000000 --- a/docs/api/verida-js/classes/verida_did_client._internal_.ForkEvent.md +++ /dev/null @@ -1,86 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/did-client](../modules/verida_did_client.md) / [](../modules/verida_did_client._internal_.md) / ForkEvent - -# Class: ForkEvent - -[@verida/did-client](../modules/verida_did_client.md).[](../modules/verida_did_client._internal_.md).ForkEvent - -## Hierarchy - -- [`Description`](verida_did_client._internal_.Description.md) - - ↳ **`ForkEvent`** - -## Table of contents - -### Constructors - -- [constructor](verida_did_client._internal_.ForkEvent.md#constructor) - -### Properties - -- [\_isForkEvent](verida_did_client._internal_.ForkEvent.md#_isforkevent) -- [expiry](verida_did_client._internal_.ForkEvent.md#expiry) - -### Methods - -- [isForkEvent](verida_did_client._internal_.ForkEvent.md#isforkevent) - -## Constructors - -### constructor - -• **new ForkEvent**(`info`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `info` | `Object` | - -#### Inherited from - -[Description](verida_did_client._internal_.Description.md).[constructor](verida_did_client._internal_.Description.md#constructor) - -#### Defined in - -node_modules/@ethersproject/properties/lib/index.d.ts:13 - -## Properties - -### \_isForkEvent - -• `Optional` `Readonly` **\_isForkEvent**: `boolean` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:103 - -___ - -### expiry - -• `Readonly` **expiry**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:102 - -## Methods - -### isForkEvent - -▸ `Static` **isForkEvent**(`value`): value is ForkEvent - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `any` | - -#### Returns - -value is ForkEvent - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:104 diff --git a/docs/api/verida-js/classes/verida_did_client._internal_.Provider.md b/docs/api/verida-js/classes/verida_did_client._internal_.Provider.md deleted file mode 100644 index f4e9dbf..0000000 --- a/docs/api/verida-js/classes/verida_did_client._internal_.Provider.md +++ /dev/null @@ -1,645 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/did-client](../modules/verida_did_client.md) / [](../modules/verida_did_client._internal_.md) / Provider - -# Class: Provider - -[@verida/did-client](../modules/verida_did_client.md).[](../modules/verida_did_client._internal_.md).Provider - -## Implements - -- [`OnceBlockable`](../interfaces/verida_did_client._internal_.OnceBlockable.md) - -## Table of contents - -### Constructors - -- [constructor](verida_did_client._internal_.Provider.md#constructor) - -### Properties - -- [\_isProvider](verida_did_client._internal_.Provider.md#_isprovider) - -### Methods - -- [addListener](verida_did_client._internal_.Provider.md#addlistener) -- [call](verida_did_client._internal_.Provider.md#call) -- [emit](verida_did_client._internal_.Provider.md#emit) -- [estimateGas](verida_did_client._internal_.Provider.md#estimategas) -- [getBalance](verida_did_client._internal_.Provider.md#getbalance) -- [getBlock](verida_did_client._internal_.Provider.md#getblock) -- [getBlockNumber](verida_did_client._internal_.Provider.md#getblocknumber) -- [getBlockWithTransactions](verida_did_client._internal_.Provider.md#getblockwithtransactions) -- [getCode](verida_did_client._internal_.Provider.md#getcode) -- [getFeeData](verida_did_client._internal_.Provider.md#getfeedata) -- [getGasPrice](verida_did_client._internal_.Provider.md#getgasprice) -- [getLogs](verida_did_client._internal_.Provider.md#getlogs) -- [getNetwork](verida_did_client._internal_.Provider.md#getnetwork) -- [getStorageAt](verida_did_client._internal_.Provider.md#getstorageat) -- [getTransaction](verida_did_client._internal_.Provider.md#gettransaction) -- [getTransactionCount](verida_did_client._internal_.Provider.md#gettransactioncount) -- [getTransactionReceipt](verida_did_client._internal_.Provider.md#gettransactionreceipt) -- [listenerCount](verida_did_client._internal_.Provider.md#listenercount) -- [listeners](verida_did_client._internal_.Provider.md#listeners) -- [lookupAddress](verida_did_client._internal_.Provider.md#lookupaddress) -- [off](verida_did_client._internal_.Provider.md#off) -- [on](verida_did_client._internal_.Provider.md#on) -- [once](verida_did_client._internal_.Provider.md#once) -- [removeAllListeners](verida_did_client._internal_.Provider.md#removealllisteners) -- [removeListener](verida_did_client._internal_.Provider.md#removelistener) -- [resolveName](verida_did_client._internal_.Provider.md#resolvename) -- [sendTransaction](verida_did_client._internal_.Provider.md#sendtransaction) -- [waitForTransaction](verida_did_client._internal_.Provider.md#waitfortransaction) -- [isProvider](verida_did_client._internal_.Provider.md#isprovider) - -## Constructors - -### constructor - -• **new Provider**() - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:153 - -## Properties - -### \_isProvider - -• `Readonly` **\_isProvider**: `boolean` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:152 - -## Methods - -### addListener - -▸ **addListener**(`eventName`, `listener`): [`Provider`](verida_did_client._internal_.Provider.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | [`EventType`](../modules/verida_did_client._internal_.md#eventtype) | -| `listener` | [`Listener`](../modules/verida_did_client._internal_.md#listener) | - -#### Returns - -[`Provider`](verida_did_client._internal_.Provider.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:149 - -___ - -### call - -▸ `Abstract` **call**(`transaction`, `blockTag?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transaction` | [`Deferrable`](../modules/verida_did_client._internal_.md#deferrable)<[`TransactionRequest`](../modules/verida_did_client._internal_.md#transactionrequest)\> | -| `blockTag?` | [`BlockTag`](../modules/verida_did_client._internal_.md#blocktag) \| `Promise`<[`BlockTag`](../modules/verida_did_client._internal_.md#blocktag)\> | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:133 - -___ - -### emit - -▸ `Abstract` **emit**(`eventName`, ...`args`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | [`EventType`](../modules/verida_did_client._internal_.md#eventtype) | -| `...args` | `any`[] | - -#### Returns - -`boolean` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:144 - -___ - -### estimateGas - -▸ `Abstract` **estimateGas**(`transaction`): `Promise`<[`BigNumber`](verida_did_client._internal_.BigNumber.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transaction` | [`Deferrable`](../modules/verida_did_client._internal_.md#deferrable)<[`TransactionRequest`](../modules/verida_did_client._internal_.md#transactionrequest)\> | - -#### Returns - -`Promise`<[`BigNumber`](verida_did_client._internal_.BigNumber.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:134 - -___ - -### getBalance - -▸ `Abstract` **getBalance**(`addressOrName`, `blockTag?`): `Promise`<[`BigNumber`](verida_did_client._internal_.BigNumber.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `addressOrName` | `string` \| `Promise`<`string`\> | -| `blockTag?` | [`BlockTag`](../modules/verida_did_client._internal_.md#blocktag) \| `Promise`<[`BlockTag`](../modules/verida_did_client._internal_.md#blocktag)\> | - -#### Returns - -`Promise`<[`BigNumber`](verida_did_client._internal_.BigNumber.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:128 - -___ - -### getBlock - -▸ `Abstract` **getBlock**(`blockHashOrBlockTag`): `Promise`<[`Block`](../interfaces/verida_did_client._internal_.Block.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `blockHashOrBlockTag` | [`BlockTag`](../modules/verida_did_client._internal_.md#blocktag) \| `Promise`<[`BlockTag`](../modules/verida_did_client._internal_.md#blocktag)\> | - -#### Returns - -`Promise`<[`Block`](../interfaces/verida_did_client._internal_.Block.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:135 - -___ - -### getBlockNumber - -▸ `Abstract` **getBlockNumber**(): `Promise`<`number`\> - -#### Returns - -`Promise`<`number`\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:125 - -___ - -### getBlockWithTransactions - -▸ `Abstract` **getBlockWithTransactions**(`blockHashOrBlockTag`): `Promise`<[`BlockWithTransactions`](../interfaces/verida_did_client._internal_.BlockWithTransactions.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `blockHashOrBlockTag` | [`BlockTag`](../modules/verida_did_client._internal_.md#blocktag) \| `Promise`<[`BlockTag`](../modules/verida_did_client._internal_.md#blocktag)\> | - -#### Returns - -`Promise`<[`BlockWithTransactions`](../interfaces/verida_did_client._internal_.BlockWithTransactions.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:136 - -___ - -### getCode - -▸ `Abstract` **getCode**(`addressOrName`, `blockTag?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `addressOrName` | `string` \| `Promise`<`string`\> | -| `blockTag?` | [`BlockTag`](../modules/verida_did_client._internal_.md#blocktag) \| `Promise`<[`BlockTag`](../modules/verida_did_client._internal_.md#blocktag)\> | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:130 - -___ - -### getFeeData - -▸ **getFeeData**(): `Promise`<[`FeeData`](../interfaces/verida_did_client._internal_.FeeData.md)\> - -#### Returns - -`Promise`<[`FeeData`](../interfaces/verida_did_client._internal_.FeeData.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:127 - -___ - -### getGasPrice - -▸ `Abstract` **getGasPrice**(): `Promise`<[`BigNumber`](verida_did_client._internal_.BigNumber.md)\> - -#### Returns - -`Promise`<[`BigNumber`](verida_did_client._internal_.BigNumber.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:126 - -___ - -### getLogs - -▸ `Abstract` **getLogs**(`filter`): `Promise`<[`Log`](../interfaces/verida_did_client._internal_.Log.md)[]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `filter` | [`Filter`](../interfaces/verida_did_client._internal_.Filter.md) | - -#### Returns - -`Promise`<[`Log`](../interfaces/verida_did_client._internal_.Log.md)[]\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:139 - -___ - -### getNetwork - -▸ `Abstract` **getNetwork**(): `Promise`<[`Network`](../modules/verida_did_client._internal_.md#network)\> - -#### Returns - -`Promise`<[`Network`](../modules/verida_did_client._internal_.md#network)\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:124 - -___ - -### getStorageAt - -▸ `Abstract` **getStorageAt**(`addressOrName`, `position`, `blockTag?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `addressOrName` | `string` \| `Promise`<`string`\> | -| `position` | [`BigNumberish`](../modules/verida_did_client._internal_.md#bignumberish) \| `Promise`<[`BigNumberish`](../modules/verida_did_client._internal_.md#bignumberish)\> | -| `blockTag?` | [`BlockTag`](../modules/verida_did_client._internal_.md#blocktag) \| `Promise`<[`BlockTag`](../modules/verida_did_client._internal_.md#blocktag)\> | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:131 - -___ - -### getTransaction - -▸ `Abstract` **getTransaction**(`transactionHash`): `Promise`<[`TransactionResponse`](../interfaces/verida_did_client._internal_.TransactionResponse.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transactionHash` | `string` | - -#### Returns - -`Promise`<[`TransactionResponse`](../interfaces/verida_did_client._internal_.TransactionResponse.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:137 - -___ - -### getTransactionCount - -▸ `Abstract` **getTransactionCount**(`addressOrName`, `blockTag?`): `Promise`<`number`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `addressOrName` | `string` \| `Promise`<`string`\> | -| `blockTag?` | [`BlockTag`](../modules/verida_did_client._internal_.md#blocktag) \| `Promise`<[`BlockTag`](../modules/verida_did_client._internal_.md#blocktag)\> | - -#### Returns - -`Promise`<`number`\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:129 - -___ - -### getTransactionReceipt - -▸ `Abstract` **getTransactionReceipt**(`transactionHash`): `Promise`<[`TransactionReceipt`](../interfaces/verida_did_client._internal_.TransactionReceipt.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transactionHash` | `string` | - -#### Returns - -`Promise`<[`TransactionReceipt`](../interfaces/verida_did_client._internal_.TransactionReceipt.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:138 - -___ - -### listenerCount - -▸ `Abstract` **listenerCount**(`eventName?`): `number` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName?` | [`EventType`](../modules/verida_did_client._internal_.md#eventtype) | - -#### Returns - -`number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:145 - -___ - -### listeners - -▸ `Abstract` **listeners**(`eventName?`): [`Listener`](../modules/verida_did_client._internal_.md#listener)[] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName?` | [`EventType`](../modules/verida_did_client._internal_.md#eventtype) | - -#### Returns - -[`Listener`](../modules/verida_did_client._internal_.md#listener)[] - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:146 - -___ - -### lookupAddress - -▸ `Abstract` **lookupAddress**(`address`): `Promise`<``null`` \| `string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `address` | `string` \| `Promise`<`string`\> | - -#### Returns - -`Promise`<``null`` \| `string`\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:141 - -___ - -### off - -▸ `Abstract` **off**(`eventName`, `listener?`): [`Provider`](verida_did_client._internal_.Provider.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | [`EventType`](../modules/verida_did_client._internal_.md#eventtype) | -| `listener?` | [`Listener`](../modules/verida_did_client._internal_.md#listener) | - -#### Returns - -[`Provider`](verida_did_client._internal_.Provider.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:147 - -___ - -### on - -▸ `Abstract` **on**(`eventName`, `listener`): [`Provider`](verida_did_client._internal_.Provider.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | [`EventType`](../modules/verida_did_client._internal_.md#eventtype) | -| `listener` | [`Listener`](../modules/verida_did_client._internal_.md#listener) | - -#### Returns - -[`Provider`](verida_did_client._internal_.Provider.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:142 - -___ - -### once - -▸ `Abstract` **once**(`eventName`, `listener`): [`Provider`](verida_did_client._internal_.Provider.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | [`EventType`](../modules/verida_did_client._internal_.md#eventtype) | -| `listener` | [`Listener`](../modules/verida_did_client._internal_.md#listener) | - -#### Returns - -[`Provider`](verida_did_client._internal_.Provider.md) - -#### Implementation of - -[OnceBlockable](../interfaces/verida_did_client._internal_.OnceBlockable.md).[once](../interfaces/verida_did_client._internal_.OnceBlockable.md#once) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:143 - -___ - -### removeAllListeners - -▸ `Abstract` **removeAllListeners**(`eventName?`): [`Provider`](verida_did_client._internal_.Provider.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName?` | [`EventType`](../modules/verida_did_client._internal_.md#eventtype) | - -#### Returns - -[`Provider`](verida_did_client._internal_.Provider.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:148 - -___ - -### removeListener - -▸ **removeListener**(`eventName`, `listener`): [`Provider`](verida_did_client._internal_.Provider.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | [`EventType`](../modules/verida_did_client._internal_.md#eventtype) | -| `listener` | [`Listener`](../modules/verida_did_client._internal_.md#listener) | - -#### Returns - -[`Provider`](verida_did_client._internal_.Provider.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:150 - -___ - -### resolveName - -▸ `Abstract` **resolveName**(`name`): `Promise`<``null`` \| `string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` \| `Promise`<`string`\> | - -#### Returns - -`Promise`<``null`` \| `string`\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:140 - -___ - -### sendTransaction - -▸ `Abstract` **sendTransaction**(`signedTransaction`): `Promise`<[`TransactionResponse`](../interfaces/verida_did_client._internal_.TransactionResponse.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `signedTransaction` | `string` \| `Promise`<`string`\> | - -#### Returns - -`Promise`<[`TransactionResponse`](../interfaces/verida_did_client._internal_.TransactionResponse.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:132 - -___ - -### waitForTransaction - -▸ `Abstract` **waitForTransaction**(`transactionHash`, `confirmations?`, `timeout?`): `Promise`<[`TransactionReceipt`](../interfaces/verida_did_client._internal_.TransactionReceipt.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transactionHash` | `string` | -| `confirmations?` | `number` | -| `timeout?` | `number` | - -#### Returns - -`Promise`<[`TransactionReceipt`](../interfaces/verida_did_client._internal_.TransactionReceipt.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:151 - -___ - -### isProvider - -▸ `Static` **isProvider**(`value`): value is Provider - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `any` | - -#### Returns - -value is Provider - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:154 diff --git a/docs/api/verida-js/classes/verida_did_client._internal_.Resolver.md b/docs/api/verida-js/classes/verida_did_client._internal_.Resolver.md deleted file mode 100644 index 83c098f..0000000 --- a/docs/api/verida-js/classes/verida_did_client._internal_.Resolver.md +++ /dev/null @@ -1,89 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/did-client](../modules/verida_did_client.md) / [](../modules/verida_did_client._internal_.md) / Resolver - -# Class: Resolver - -[@verida/did-client](../modules/verida_did_client.md).[](../modules/verida_did_client._internal_.md).Resolver - -This implementation of [Resolvable](../interfaces/verida_did_client._internal_.Resolvable.md) bundles together multiple implementations of [DIDResolver](../modules/verida_did_client._internal_.md#didresolver) and -presents a single function call to users. - -## Implements - -- [`Resolvable`](../interfaces/verida_did_client._internal_.Resolvable.md) - -## Table of contents - -### Constructors - -- [constructor](verida_did_client._internal_.Resolver.md#constructor) - -### Properties - -- [cache](verida_did_client._internal_.Resolver.md#cache) -- [registry](verida_did_client._internal_.Resolver.md#registry) - -### Methods - -- [resolve](verida_did_client._internal_.Resolver.md#resolve) - -## Constructors - -### constructor - -• **new Resolver**(`registry?`, `options?`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `registry?` | [`ResolverRegistry`](../modules/verida_did_client._internal_.md#resolverregistry) | -| `options?` | [`ResolverOptions`](../interfaces/verida_did_client._internal_.ResolverOptions.md) | - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:198 - -## Properties - -### cache - -• `Private` `Readonly` **cache**: `any` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:197 - -___ - -### registry - -• `Private` `Readonly` **registry**: `any` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:196 - -## Methods - -### resolve - -▸ **resolve**(`didUrl`, `options?`): `Promise`<[`DIDResolutionResult`](../interfaces/verida_did_client._internal_.DIDResolutionResult.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `didUrl` | `string` | -| `options?` | [`DIDResolutionOptions`](../interfaces/verida_did_client._internal_.DIDResolutionOptions.md) | - -#### Returns - -`Promise`<[`DIDResolutionResult`](../interfaces/verida_did_client._internal_.DIDResolutionResult.md)\> - -#### Implementation of - -[Resolvable](../interfaces/verida_did_client._internal_.Resolvable.md).[resolve](../interfaces/verida_did_client._internal_.Resolvable.md#resolve) - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:199 diff --git a/docs/api/verida-js/classes/verida_did_client._internal_.Signer.md b/docs/api/verida-js/classes/verida_did_client._internal_.Signer.md deleted file mode 100644 index 0c4a361..0000000 --- a/docs/api/verida-js/classes/verida_did_client._internal_.Signer.md +++ /dev/null @@ -1,383 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/did-client](../modules/verida_did_client.md) / [](../modules/verida_did_client._internal_.md) / Signer - -# Class: Signer - -[@verida/did-client](../modules/verida_did_client.md).[](../modules/verida_did_client._internal_.md).Signer - -## Table of contents - -### Constructors - -- [constructor](verida_did_client._internal_.Signer.md#constructor) - -### Properties - -- [\_isSigner](verida_did_client._internal_.Signer.md#_issigner) -- [provider](verida_did_client._internal_.Signer.md#provider) - -### Methods - -- [\_checkProvider](verida_did_client._internal_.Signer.md#_checkprovider) -- [call](verida_did_client._internal_.Signer.md#call) -- [checkTransaction](verida_did_client._internal_.Signer.md#checktransaction) -- [connect](verida_did_client._internal_.Signer.md#connect) -- [estimateGas](verida_did_client._internal_.Signer.md#estimategas) -- [getAddress](verida_did_client._internal_.Signer.md#getaddress) -- [getBalance](verida_did_client._internal_.Signer.md#getbalance) -- [getChainId](verida_did_client._internal_.Signer.md#getchainid) -- [getFeeData](verida_did_client._internal_.Signer.md#getfeedata) -- [getGasPrice](verida_did_client._internal_.Signer.md#getgasprice) -- [getTransactionCount](verida_did_client._internal_.Signer.md#gettransactioncount) -- [populateTransaction](verida_did_client._internal_.Signer.md#populatetransaction) -- [resolveName](verida_did_client._internal_.Signer.md#resolvename) -- [sendTransaction](verida_did_client._internal_.Signer.md#sendtransaction) -- [signMessage](verida_did_client._internal_.Signer.md#signmessage) -- [signTransaction](verida_did_client._internal_.Signer.md#signtransaction) -- [isSigner](verida_did_client._internal_.Signer.md#issigner) - -## Constructors - -### constructor - -• **new Signer**() - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:30 - -## Properties - -### \_isSigner - -• `Readonly` **\_isSigner**: `boolean` - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:29 - -___ - -### provider - -• `Optional` `Readonly` **provider**: [`Provider`](verida_did_client._internal_.Provider.md) - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:24 - -## Methods - -### \_checkProvider - -▸ **_checkProvider**(`operation?`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `operation?` | `string` | - -#### Returns - -`void` - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:42 - -___ - -### call - -▸ **call**(`transaction`, `blockTag?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transaction` | [`Deferrable`](../modules/verida_did_client._internal_.md#deferrable)<[`TransactionRequest`](../modules/verida_did_client._internal_.md#transactionrequest)\> | -| `blockTag?` | [`BlockTag`](../modules/verida_did_client._internal_.md#blocktag) | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:34 - -___ - -### checkTransaction - -▸ **checkTransaction**(`transaction`): [`Deferrable`](../modules/verida_did_client._internal_.md#deferrable)<[`TransactionRequest`](../modules/verida_did_client._internal_.md#transactionrequest)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transaction` | [`Deferrable`](../modules/verida_did_client._internal_.md#deferrable)<[`TransactionRequest`](../modules/verida_did_client._internal_.md#transactionrequest)\> | - -#### Returns - -[`Deferrable`](../modules/verida_did_client._internal_.md#deferrable)<[`TransactionRequest`](../modules/verida_did_client._internal_.md#transactionrequest)\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:40 - -___ - -### connect - -▸ `Abstract` **connect**(`provider`): [`Signer`](verida_did_client._internal_.Signer.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `provider` | [`Provider`](verida_did_client._internal_.Provider.md) | - -#### Returns - -[`Signer`](verida_did_client._internal_.Signer.md) - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:28 - -___ - -### estimateGas - -▸ **estimateGas**(`transaction`): `Promise`<[`BigNumber`](verida_did_client._internal_.BigNumber.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transaction` | [`Deferrable`](../modules/verida_did_client._internal_.md#deferrable)<[`TransactionRequest`](../modules/verida_did_client._internal_.md#transactionrequest)\> | - -#### Returns - -`Promise`<[`BigNumber`](verida_did_client._internal_.BigNumber.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:33 - -___ - -### getAddress - -▸ `Abstract` **getAddress**(): `Promise`<`string`\> - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:25 - -___ - -### getBalance - -▸ **getBalance**(`blockTag?`): `Promise`<[`BigNumber`](verida_did_client._internal_.BigNumber.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `blockTag?` | [`BlockTag`](../modules/verida_did_client._internal_.md#blocktag) | - -#### Returns - -`Promise`<[`BigNumber`](verida_did_client._internal_.BigNumber.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:31 - -___ - -### getChainId - -▸ **getChainId**(): `Promise`<`number`\> - -#### Returns - -`Promise`<`number`\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:36 - -___ - -### getFeeData - -▸ **getFeeData**(): `Promise`<[`FeeData`](../interfaces/verida_did_client._internal_.FeeData.md)\> - -#### Returns - -`Promise`<[`FeeData`](../interfaces/verida_did_client._internal_.FeeData.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:38 - -___ - -### getGasPrice - -▸ **getGasPrice**(): `Promise`<[`BigNumber`](verida_did_client._internal_.BigNumber.md)\> - -#### Returns - -`Promise`<[`BigNumber`](verida_did_client._internal_.BigNumber.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:37 - -___ - -### getTransactionCount - -▸ **getTransactionCount**(`blockTag?`): `Promise`<`number`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `blockTag?` | [`BlockTag`](../modules/verida_did_client._internal_.md#blocktag) | - -#### Returns - -`Promise`<`number`\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:32 - -___ - -### populateTransaction - -▸ **populateTransaction**(`transaction`): `Promise`<[`TransactionRequest`](../modules/verida_did_client._internal_.md#transactionrequest)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transaction` | [`Deferrable`](../modules/verida_did_client._internal_.md#deferrable)<[`TransactionRequest`](../modules/verida_did_client._internal_.md#transactionrequest)\> | - -#### Returns - -`Promise`<[`TransactionRequest`](../modules/verida_did_client._internal_.md#transactionrequest)\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:41 - -___ - -### resolveName - -▸ **resolveName**(`name`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:39 - -___ - -### sendTransaction - -▸ **sendTransaction**(`transaction`): `Promise`<[`TransactionResponse`](../interfaces/verida_did_client._internal_.TransactionResponse.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transaction` | [`Deferrable`](../modules/verida_did_client._internal_.md#deferrable)<[`TransactionRequest`](../modules/verida_did_client._internal_.md#transactionrequest)\> | - -#### Returns - -`Promise`<[`TransactionResponse`](../interfaces/verida_did_client._internal_.TransactionResponse.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:35 - -___ - -### signMessage - -▸ `Abstract` **signMessage**(`message`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `message` | `string` \| [`Bytes`](../modules/verida_did_client._internal_.md#bytes) | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:26 - -___ - -### signTransaction - -▸ `Abstract` **signTransaction**(`transaction`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transaction` | [`Deferrable`](../modules/verida_did_client._internal_.md#deferrable)<[`TransactionRequest`](../modules/verida_did_client._internal_.md#transactionrequest)\> | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:27 - -___ - -### isSigner - -▸ `Static` **isSigner**(`value`): value is Signer - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `any` | - -#### Returns - -value is Signer - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:43 diff --git a/docs/api/verida-js/classes/verida_did_client._internal_.default-1.md b/docs/api/verida-js/classes/verida_did_client._internal_.default-1.md deleted file mode 100644 index ce0ae69..0000000 --- a/docs/api/verida-js/classes/verida_did_client._internal_.default-1.md +++ /dev/null @@ -1,515 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/did-client](../modules/verida_did_client.md) / [](../modules/verida_did_client._internal_.md) / default - -# Class: default - -[@verida/did-client](../modules/verida_did_client.md).[](../modules/verida_did_client._internal_.md).default - -## Implements - -- [`IDIDDocument`](../interfaces/verida_did_client._internal_.IDIDDocument.md) - -## Table of contents - -### Constructors - -- [constructor](verida_did_client._internal_.default-1.md#constructor) - -### Properties - -- [doc](verida_did_client._internal_.default-1.md#doc) -- [errors](verida_did_client._internal_.default-1.md#errors) -- [getProofData](verida_did_client._internal_.default-1.md#getproofdata) - -### Accessors - -- [id](verida_did_client._internal_.default-1.md#id) - -### Methods - -- [addContext](verida_did_client._internal_.default-1.md#addcontext) -- [addContextAsymKey](verida_did_client._internal_.default-1.md#addcontextasymkey) -- [addContextService](verida_did_client._internal_.default-1.md#addcontextservice) -- [addContextSignKey](verida_did_client._internal_.default-1.md#addcontextsignkey) -- [buildTimestamp](verida_did_client._internal_.default-1.md#buildtimestamp) -- [export](verida_did_client._internal_.default-1.md#export) -- [getErrors](verida_did_client._internal_.default-1.md#geterrors) -- [import](verida_did_client._internal_.default-1.md#import) -- [locateContextProof](verida_did_client._internal_.default-1.md#locatecontextproof) -- [locateServiceEndpoint](verida_did_client._internal_.default-1.md#locateserviceendpoint) -- [removeContext](verida_did_client._internal_.default-1.md#removecontext) -- [setAttributes](verida_did_client._internal_.default-1.md#setattributes) -- [signProof](verida_did_client._internal_.default-1.md#signproof) -- [verifyContextSignature](verida_did_client._internal_.default-1.md#verifycontextsignature) -- [verifyProof](verida_did_client._internal_.default-1.md#verifyproof) -- [verifySig](verida_did_client._internal_.default-1.md#verifysig) -- [generateContextHash](verida_did_client._internal_.default-1.md#generatecontexthash) - -## Constructors - -### constructor - -• **new default**(`doc`, `publicKeyHex?`) - -Force lower case DID as we can't guarantee the DID will always be provided with checksum - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `doc` | `string` \| [`VeridaDocInterface`](../interfaces/verida_did_client._internal_.VeridaDocInterface.md) | this value can be a DocInterface or DID. | -| `publicKeyHex?` | `string` | - | - -#### Defined in - -packages/did-document/dist/did-document.d.ts:11 - -## Properties - -### doc - -• `Private` **doc**: `any` - -#### Defined in - -packages/did-document/dist/did-document.d.ts:4 - -___ - -### errors - -• `Protected` **errors**: `string`[] - -#### Defined in - -packages/did-document/dist/did-document.d.ts:5 - -___ - -### getProofData - -• `Private` **getProofData**: `any` - -#### Defined in - -packages/did-document/dist/did-document.d.ts:37 - -## Accessors - -### id - -• `get` **id**(): `string` - -#### Returns - -`string` - -#### Implementation of - -IDIDDocument.id - -#### Defined in - -packages/did-document/dist/did-document.d.ts:12 - -## Methods - -### addContext - -▸ **addContext**(`contextName`, `keyring`, `privateKey`, `endpoints`): `Promise`<`void`\> - -Not used directly, used for testing - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `contextName` | `string` | string | -| `keyring` | [`IKeyring`](../interfaces/verida_did_client._internal_.IKeyring.md) | Keyring | -| `privateKey` | `string` | Private key of the DID that controls this DID Document | -| `endpoints` | [`SecureContextEndpoints`](../interfaces/verida_did_client._internal_.SecureContextEndpoints.md) | Endpoints | - -#### Returns - -`Promise`<`void`\> - -#### Implementation of - -[IDIDDocument](../interfaces/verida_did_client._internal_.IDIDDocument.md).[addContext](../interfaces/verida_did_client._internal_.IDIDDocument.md#addcontext) - -#### Defined in - -packages/did-document/dist/did-document.d.ts:22 - -___ - -### addContextAsymKey - -▸ **addContextAsymKey**(`contextHash`, `publicKeyHex`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextHash` | `string` | -| `publicKeyHex` | `string` | - -#### Returns - -`void` - -#### Implementation of - -[IDIDDocument](../interfaces/verida_did_client._internal_.IDIDDocument.md).[addContextAsymKey](../interfaces/verida_did_client._internal_.IDIDDocument.md#addcontextasymkey) - -#### Defined in - -packages/did-document/dist/did-document.d.ts:29 - -___ - -### addContextService - -▸ **addContextService**(`contextHash`, `endpointType`, `serviceType`, `endpointUris`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextHash` | `string` | -| `endpointType` | [`SecureContextEndpointType`](../enums/verida_did_client._internal_.SecureContextEndpointType.md) | -| `serviceType` | `string` | -| `endpointUris` | [`ServiceEndpoint`](../modules/verida_did_client._internal_.md#serviceendpoint)[] | - -#### Returns - -`void` - -#### Implementation of - -[IDIDDocument](../interfaces/verida_did_client._internal_.IDIDDocument.md).[addContextService](../interfaces/verida_did_client._internal_.IDIDDocument.md#addcontextservice) - -#### Defined in - -packages/did-document/dist/did-document.d.ts:27 - -___ - -### addContextSignKey - -▸ **addContextSignKey**(`contextHash`, `publicKeyHex`, `proof`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextHash` | `string` | -| `publicKeyHex` | `string` | -| `proof` | `string` | - -#### Returns - -`void` - -#### Implementation of - -[IDIDDocument](../interfaces/verida_did_client._internal_.IDIDDocument.md).[addContextSignKey](../interfaces/verida_did_client._internal_.IDIDDocument.md#addcontextsignkey) - -#### Defined in - -packages/did-document/dist/did-document.d.ts:28 - -___ - -### buildTimestamp - -▸ **buildTimestamp**(`date`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `date` | `Date` | - -#### Returns - -`string` - -#### Implementation of - -[IDIDDocument](../interfaces/verida_did_client._internal_.IDIDDocument.md).[buildTimestamp](../interfaces/verida_did_client._internal_.IDIDDocument.md#buildtimestamp) - -#### Defined in - -packages/did-document/dist/did-document.d.ts:38 - -___ - -### export - -▸ **export**(): [`VeridaDocInterface`](../interfaces/verida_did_client._internal_.VeridaDocInterface.md) - -#### Returns - -[`VeridaDocInterface`](../interfaces/verida_did_client._internal_.VeridaDocInterface.md) - -#### Implementation of - -[IDIDDocument](../interfaces/verida_did_client._internal_.IDIDDocument.md).[export](../interfaces/verida_did_client._internal_.IDIDDocument.md#export) - -#### Defined in - -packages/did-document/dist/did-document.d.ts:26 - -___ - -### getErrors - -▸ **getErrors**(): `string`[] - -#### Returns - -`string`[] - -#### Implementation of - -[IDIDDocument](../interfaces/verida_did_client._internal_.IDIDDocument.md).[getErrors](../interfaces/verida_did_client._internal_.IDIDDocument.md#geterrors) - -#### Defined in - -packages/did-document/dist/did-document.d.ts:13 - -___ - -### import - -▸ **import**(`doc`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `doc` | [`VeridaDocInterface`](../interfaces/verida_did_client._internal_.VeridaDocInterface.md) | - -#### Returns - -`void` - -#### Implementation of - -[IDIDDocument](../interfaces/verida_did_client._internal_.IDIDDocument.md).[import](../interfaces/verida_did_client._internal_.IDIDDocument.md#import) - -#### Defined in - -packages/did-document/dist/did-document.d.ts:25 - -___ - -### locateContextProof - -▸ **locateContextProof**(`contextName`): `undefined` \| `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | - -#### Returns - -`undefined` \| `string` - -#### Implementation of - -[IDIDDocument](../interfaces/verida_did_client._internal_.IDIDDocument.md).[locateContextProof](../interfaces/verida_did_client._internal_.IDIDDocument.md#locatecontextproof) - -#### Defined in - -packages/did-document/dist/did-document.d.ts:34 - -___ - -### locateServiceEndpoint - -▸ **locateServiceEndpoint**(`contextName`, `endpointType`): `undefined` \| [`Service`](../interfaces/verida_did_client._internal_.Service.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | -| `endpointType` | [`SecureContextEndpointType`](../enums/verida_did_client._internal_.SecureContextEndpointType.md) | - -#### Returns - -`undefined` \| [`Service`](../interfaces/verida_did_client._internal_.Service.md) - -#### Implementation of - -[IDIDDocument](../interfaces/verida_did_client._internal_.IDIDDocument.md).[locateServiceEndpoint](../interfaces/verida_did_client._internal_.IDIDDocument.md#locateserviceendpoint) - -#### Defined in - -packages/did-document/dist/did-document.d.ts:33 - -___ - -### removeContext - -▸ **removeContext**(`contextName`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | - -#### Returns - -`boolean` - -#### Implementation of - -[IDIDDocument](../interfaces/verida_did_client._internal_.IDIDDocument.md).[removeContext](../interfaces/verida_did_client._internal_.IDIDDocument.md#removecontext) - -#### Defined in - -packages/did-document/dist/did-document.d.ts:23 - -___ - -### setAttributes - -▸ **setAttributes**(`attributes`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `attributes` | [`Record`](../modules/verida_did_client._internal_.md#record)<`string`, `any`\> | - -#### Returns - -`void` - -#### Implementation of - -[IDIDDocument](../interfaces/verida_did_client._internal_.IDIDDocument.md).[setAttributes](../interfaces/verida_did_client._internal_.IDIDDocument.md#setattributes) - -#### Defined in - -packages/did-document/dist/did-document.d.ts:24 - -___ - -### signProof - -▸ **signProof**(`privateKey`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `privateKey` | `string` \| `Uint8Array` | - -#### Returns - -`void` - -#### Implementation of - -[IDIDDocument](../interfaces/verida_did_client._internal_.IDIDDocument.md).[signProof](../interfaces/verida_did_client._internal_.IDIDDocument.md#signproof) - -#### Defined in - -packages/did-document/dist/did-document.d.ts:35 - -___ - -### verifyContextSignature - -▸ **verifyContextSignature**(`data`, `contextName`, `signature`, `contextIsHash?`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `any` | -| `contextName` | `string` | -| `signature` | `string` | -| `contextIsHash?` | `boolean` | - -#### Returns - -`boolean` - -#### Implementation of - -[IDIDDocument](../interfaces/verida_did_client._internal_.IDIDDocument.md).[verifyContextSignature](../interfaces/verida_did_client._internal_.IDIDDocument.md#verifycontextsignature) - -#### Defined in - -packages/did-document/dist/did-document.d.ts:31 - -___ - -### verifyProof - -▸ **verifyProof**(): `boolean` - -#### Returns - -`boolean` - -#### Implementation of - -[IDIDDocument](../interfaces/verida_did_client._internal_.IDIDDocument.md).[verifyProof](../interfaces/verida_did_client._internal_.IDIDDocument.md#verifyproof) - -#### Defined in - -packages/did-document/dist/did-document.d.ts:36 - -___ - -### verifySig - -▸ **verifySig**(`data`, `signature`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `any` | -| `signature` | `string` | - -#### Returns - -`boolean` - -#### Implementation of - -[IDIDDocument](../interfaces/verida_did_client._internal_.IDIDDocument.md).[verifySig](../interfaces/verida_did_client._internal_.IDIDDocument.md#verifysig) - -#### Defined in - -packages/did-document/dist/did-document.d.ts:30 - -___ - -### generateContextHash - -▸ `Static` **generateContextHash**(`did`, `contextName`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did` | `string` | -| `contextName` | `string` | - -#### Returns - -`string` - -#### Defined in - -packages/did-document/dist/did-document.d.ts:32 diff --git a/docs/api/verida-js/classes/verida_did_client._internal_.default.md b/docs/api/verida-js/classes/verida_did_client._internal_.default.md deleted file mode 100644 index fba783f..0000000 --- a/docs/api/verida-js/classes/verida_did_client._internal_.default.md +++ /dev/null @@ -1,224 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/did-client](../modules/verida_did_client.md) / [](../modules/verida_did_client._internal_.md) / default - -# Class: default - -[@verida/did-client](../modules/verida_did_client.md).[](../modules/verida_did_client._internal_.md).default - -## Table of contents - -### Constructors - -- [constructor](verida_did_client._internal_.default.md#constructor) - -### Properties - -- [blockchain](verida_did_client._internal_.default.md#blockchain) -- [deleteFromEndpoints](verida_did_client._internal_.default.md#deletefromendpoints) -- [fetchDocumentHistory](verida_did_client._internal_.default.md#fetchdocumenthistory) -- [lastEndpointErrors](verida_did_client._internal_.default.md#lastendpointerrors) -- [options](verida_did_client._internal_.default.md#options) - -### Methods - -- [addEndpoint](verida_did_client._internal_.default.md#addendpoint) -- [create](verida_did_client._internal_.default.md#create) -- [delete](verida_did_client._internal_.default.md#delete) -- [getLastEndpointErrors](verida_did_client._internal_.default.md#getlastendpointerrors) -- [removeEndpoint](verida_did_client._internal_.default.md#removeendpoint) -- [update](verida_did_client._internal_.default.md#update) - -## Constructors - -### constructor - -• **new default**(`options`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options` | [`VdaDidConfigurationOptions`](../interfaces/verida_did_client._internal_.VdaDidConfigurationOptions.md) | - -#### Defined in - -packages/vda-did/dist/vdaDid.d.ts:7 - -## Properties - -### blockchain - -• `Private` **blockchain**: `any` - -#### Defined in - -packages/vda-did/dist/vdaDid.d.ts:5 - -___ - -### deleteFromEndpoints - -• `Private` **deleteFromEndpoints**: `any` - -#### Defined in - -packages/vda-did/dist/vdaDid.d.ts:30 - -___ - -### fetchDocumentHistory - -• `Private` **fetchDocumentHistory**: `any` - -#### Defined in - -packages/vda-did/dist/vdaDid.d.ts:41 - -___ - -### lastEndpointErrors - -• `Private` `Optional` **lastEndpointErrors**: `any` - -#### Defined in - -packages/vda-did/dist/vdaDid.d.ts:6 - -___ - -### options - -• `Private` **options**: `any` - -#### Defined in - -packages/vda-did/dist/vdaDid.d.ts:4 - -## Methods - -### addEndpoint - -▸ **addEndpoint**(`endpointUri`, `verifyAllVersions?`): `Promise`<`void`\> - -Add a new to an existing DID - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `endpointUri` | `string` | -| `verifyAllVersions?` | `boolean` | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -packages/vda-did/dist/vdaDid.d.ts:38 - -___ - -### create - -▸ **create**(`didDocument`, `endpoints`, `retries?`): `Promise`<[`VdaDidEndpointResponses`](../modules/verida_did_client._internal_.md#vdadidendpointresponses)\> - -Publish the first version of a DIDDocument to a list of endpoints. - -If an endpoint fails to accept the DID Document, that endpoint will be ignored and won't be included in the -list of valid endpoints on chain. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `didDocument` | [`default`](verida_did_client._internal_.default-1.md) | -| `endpoints` | `string`[] | -| `retries?` | `number` | - -#### Returns - -`Promise`<[`VdaDidEndpointResponses`](../modules/verida_did_client._internal_.md#vdadidendpointresponses)\> - -VdaDidEndpointResponses Map of endpoints where the DID Document was successfully published - -#### Defined in - -packages/vda-did/dist/vdaDid.d.ts:18 - -___ - -### delete - -▸ **delete**(): `Promise`<[`VdaDidEndpointResponses`](../modules/verida_did_client._internal_.md#vdadidendpointresponses)\> - -#### Returns - -`Promise`<[`VdaDidEndpointResponses`](../modules/verida_did_client._internal_.md#vdadidendpointresponses)\> - -#### Defined in - -packages/vda-did/dist/vdaDid.d.ts:31 - -___ - -### getLastEndpointErrors - -▸ **getLastEndpointErrors**(): `undefined` \| [`VdaDidEndpointResponses`](../modules/verida_did_client._internal_.md#vdadidendpointresponses) - -#### Returns - -`undefined` \| [`VdaDidEndpointResponses`](../modules/verida_did_client._internal_.md#vdadidendpointresponses) - -#### Defined in - -packages/vda-did/dist/vdaDid.d.ts:40 - -___ - -### removeEndpoint - -▸ **removeEndpoint**(`did`, `endpoint`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did` | `string` | -| `endpoint` | `string` | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -packages/vda-did/dist/vdaDid.d.ts:39 - -___ - -### update - -▸ **update**(`didDocument`, `controllerPrivateKey?`): `Promise`<[`VdaDidEndpointResponses`](../modules/verida_did_client._internal_.md#vdadidendpointresponses)\> - -Publish an updated version of a DIDDocument to a list of endpoints. - -If an endpoint fails to accept the DID Document, that will be reflected in the response. - -Note: Any failed endpoints will remain on-chain and will need to have the update re-attempted or remove the endpoint from the DID Registry - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `didDocument` | [`default`](verida_did_client._internal_.default-1.md) | -| `controllerPrivateKey?` | `string` | - -#### Returns - -`Promise`<[`VdaDidEndpointResponses`](../modules/verida_did_client._internal_.md#vdadidendpointresponses)\> - -VdaDidEndpointResponses Map of endpoints where the DID Document was successfully published - -#### Defined in - -packages/vda-did/dist/vdaDid.d.ts:29 diff --git a/docs/api/verida-js/classes/verida_did_document.DIDDocument.md b/docs/api/verida-js/classes/verida_did_document.DIDDocument.md deleted file mode 100644 index b4f99c0..0000000 --- a/docs/api/verida-js/classes/verida_did_document.DIDDocument.md +++ /dev/null @@ -1,519 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/did-document](../modules/verida_did_document.md) / DIDDocument - -# Class: DIDDocument - -[@verida/did-document](../modules/verida_did_document.md).DIDDocument - -## Implements - -- [`IDIDDocument`](../interfaces/verida_did_document._internal_.IDIDDocument.md) - -## Table of contents - -### Constructors - -- [constructor](verida_did_document.DIDDocument.md#constructor) - -### Properties - -- [doc](verida_did_document.DIDDocument.md#doc) -- [errors](verida_did_document.DIDDocument.md#errors) - -### Accessors - -- [id](verida_did_document.DIDDocument.md#id) - -### Methods - -- [addContext](verida_did_document.DIDDocument.md#addcontext) -- [addContextAsymKey](verida_did_document.DIDDocument.md#addcontextasymkey) -- [addContextService](verida_did_document.DIDDocument.md#addcontextservice) -- [addContextSignKey](verida_did_document.DIDDocument.md#addcontextsignkey) -- [buildTimestamp](verida_did_document.DIDDocument.md#buildtimestamp) -- [export](verida_did_document.DIDDocument.md#export) -- [getErrors](verida_did_document.DIDDocument.md#geterrors) -- [getProofData](verida_did_document.DIDDocument.md#getproofdata) -- [import](verida_did_document.DIDDocument.md#import) -- [locateContextProof](verida_did_document.DIDDocument.md#locatecontextproof) -- [locateServiceEndpoint](verida_did_document.DIDDocument.md#locateserviceendpoint) -- [removeContext](verida_did_document.DIDDocument.md#removecontext) -- [setAttributes](verida_did_document.DIDDocument.md#setattributes) -- [signProof](verida_did_document.DIDDocument.md#signproof) -- [verifyContextSignature](verida_did_document.DIDDocument.md#verifycontextsignature) -- [verifyProof](verida_did_document.DIDDocument.md#verifyproof) -- [verifySig](verida_did_document.DIDDocument.md#verifysig) -- [generateContextHash](verida_did_document.DIDDocument.md#generatecontexthash) - -## Constructors - -### constructor - -• **new DIDDocument**(`doc`, `publicKeyHex?`) - -Force lower case DID as we can't guarantee the DID will always be provided with checksum - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `doc` | `string` \| [`VeridaDocInterface`](../interfaces/verida_did_document._internal_.VeridaDocInterface.md) | this value can be a DocInterface or DID. | -| `publicKeyHex?` | `string` | - | - -#### Defined in - -[packages/did-document/src/did-document.ts:44](https://github.com/verida/verida-js/blob/5040472/packages/did-document/src/did-document.ts#L44) - -## Properties - -### doc - -• `Private` **doc**: [`VeridaDocInterface`](../interfaces/verida_did_document._internal_.VeridaDocInterface.md) - -#### Defined in - -[packages/did-document/src/did-document.ts:36](https://github.com/verida/verida-js/blob/5040472/packages/did-document/src/did-document.ts#L36) - -___ - -### errors - -• `Protected` **errors**: `string`[] = `[]` - -#### Defined in - -[packages/did-document/src/did-document.ts:37](https://github.com/verida/verida-js/blob/5040472/packages/did-document/src/did-document.ts#L37) - -## Accessors - -### id - -• `get` **id**(): `string` - -#### Returns - -`string` - -#### Implementation of - -IDIDDocument.id - -#### Defined in - -[packages/did-document/src/did-document.ts:100](https://github.com/verida/verida-js/blob/5040472/packages/did-document/src/did-document.ts#L100) - -## Methods - -### addContext - -▸ **addContext**(`contextName`, `keyring`, `privateKey`, `endpoints`): `Promise`<`void`\> - -Not used directly, used for testing - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `contextName` | `string` | string | -| `keyring` | [`IKeyring`](../interfaces/verida_did_document._internal_.IKeyring.md) | Keyring | -| `privateKey` | `string` | Private key of the DID that controls this DID Document | -| `endpoints` | [`SecureContextEndpoints`](../interfaces/verida_did_document._internal_.SecureContextEndpoints.md) | Endpoints | - -#### Returns - -`Promise`<`void`\> - -#### Implementation of - -[IDIDDocument](../interfaces/verida_did_document._internal_.IDIDDocument.md).[addContext](../interfaces/verida_did_document._internal_.IDIDDocument.md#addcontext) - -#### Defined in - -[packages/did-document/src/did-document.ts:116](https://github.com/verida/verida-js/blob/5040472/packages/did-document/src/did-document.ts#L116) - -___ - -### addContextAsymKey - -▸ **addContextAsymKey**(`contextHash`, `publicKeyHex`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextHash` | `string` | -| `publicKeyHex` | `string` | - -#### Returns - -`void` - -#### Implementation of - -[IDIDDocument](../interfaces/verida_did_document._internal_.IDIDDocument.md).[addContextAsymKey](../interfaces/verida_did_document._internal_.IDIDDocument.md#addcontextasymkey) - -#### Defined in - -[packages/did-document/src/did-document.ts:243](https://github.com/verida/verida-js/blob/5040472/packages/did-document/src/did-document.ts#L243) - -___ - -### addContextService - -▸ **addContextService**(`contextHash`, `endpointType`, `serviceType`, `endpointUris`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextHash` | `string` | -| `endpointType` | [`SecureContextEndpointType`](../enums/verida_did_document._internal_.SecureContextEndpointType.md) | -| `serviceType` | `string` | -| `endpointUris` | [`ServiceEndpoint`](../modules/verida_did_document._internal_.md#serviceendpoint)[] | - -#### Returns - -`void` - -#### Implementation of - -[IDIDDocument](../interfaces/verida_did_document._internal_.IDIDDocument.md).[addContextService](../interfaces/verida_did_document._internal_.IDIDDocument.md#addcontextservice) - -#### Defined in - -[packages/did-document/src/did-document.ts:206](https://github.com/verida/verida-js/blob/5040472/packages/did-document/src/did-document.ts#L206) - -___ - -### addContextSignKey - -▸ **addContextSignKey**(`contextHash`, `publicKeyHex`, `proof`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextHash` | `string` | -| `publicKeyHex` | `string` | -| `proof` | `string` | - -#### Returns - -`void` - -#### Implementation of - -[IDIDDocument](../interfaces/verida_did_document._internal_.IDIDDocument.md).[addContextSignKey](../interfaces/verida_did_document._internal_.IDIDDocument.md#addcontextsignkey) - -#### Defined in - -[packages/did-document/src/did-document.ts:219](https://github.com/verida/verida-js/blob/5040472/packages/did-document/src/did-document.ts#L219) - -___ - -### buildTimestamp - -▸ **buildTimestamp**(`date`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `date` | `Date` | - -#### Returns - -`string` - -#### Implementation of - -[IDIDDocument](../interfaces/verida_did_document._internal_.IDIDDocument.md).[buildTimestamp](../interfaces/verida_did_document._internal_.IDIDDocument.md#buildtimestamp) - -#### Defined in - -[packages/did-document/src/did-document.ts:361](https://github.com/verida/verida-js/blob/5040472/packages/did-document/src/did-document.ts#L361) - -___ - -### export - -▸ **export**(): [`VeridaDocInterface`](../interfaces/verida_did_document._internal_.VeridaDocInterface.md) - -#### Returns - -[`VeridaDocInterface`](../interfaces/verida_did_document._internal_.VeridaDocInterface.md) - -#### Implementation of - -[IDIDDocument](../interfaces/verida_did_document._internal_.IDIDDocument.md).[export](../interfaces/verida_did_document._internal_.IDIDDocument.md#export) - -#### Defined in - -[packages/did-document/src/did-document.ts:202](https://github.com/verida/verida-js/blob/5040472/packages/did-document/src/did-document.ts#L202) - -___ - -### getErrors - -▸ **getErrors**(): `string`[] - -#### Returns - -`string`[] - -#### Implementation of - -[IDIDDocument](../interfaces/verida_did_document._internal_.IDIDDocument.md).[getErrors](../interfaces/verida_did_document._internal_.IDIDDocument.md#geterrors) - -#### Defined in - -[packages/did-document/src/did-document.ts:104](https://github.com/verida/verida-js/blob/5040472/packages/did-document/src/did-document.ts#L104) - -___ - -### getProofData - -▸ `Private` **getProofData**(): `any` - -#### Returns - -`any` - -#### Defined in - -[packages/did-document/src/did-document.ts:355](https://github.com/verida/verida-js/blob/5040472/packages/did-document/src/did-document.ts#L355) - -___ - -### import - -▸ **import**(`doc`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `doc` | [`VeridaDocInterface`](../interfaces/verida_did_document._internal_.VeridaDocInterface.md) | - -#### Returns - -`void` - -#### Implementation of - -[IDIDDocument](../interfaces/verida_did_document._internal_.IDIDDocument.md).[import](../interfaces/verida_did_document._internal_.IDIDDocument.md#import) - -#### Defined in - -[packages/did-document/src/did-document.ts:197](https://github.com/verida/verida-js/blob/5040472/packages/did-document/src/did-document.ts#L197) - -___ - -### locateContextProof - -▸ **locateContextProof**(`contextName`): `undefined` \| `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | - -#### Returns - -`undefined` \| `string` - -#### Implementation of - -[IDIDDocument](../interfaces/verida_did_document._internal_.IDIDDocument.md).[locateContextProof](../interfaces/verida_did_document._internal_.IDIDDocument.md#locatecontextproof) - -#### Defined in - -[packages/did-document/src/did-document.ts:314](https://github.com/verida/verida-js/blob/5040472/packages/did-document/src/did-document.ts#L314) - -___ - -### locateServiceEndpoint - -▸ **locateServiceEndpoint**(`contextName`, `endpointType`): `undefined` \| [`Service`](../interfaces/verida_did_document._internal_.Service.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | -| `endpointType` | [`SecureContextEndpointType`](../enums/verida_did_document._internal_.SecureContextEndpointType.md) | - -#### Returns - -`undefined` \| [`Service`](../interfaces/verida_did_document._internal_.Service.md) - -#### Implementation of - -[IDIDDocument](../interfaces/verida_did_document._internal_.IDIDDocument.md).[locateServiceEndpoint](../interfaces/verida_did_document._internal_.IDIDDocument.md#locateserviceendpoint) - -#### Defined in - -[packages/did-document/src/did-document.ts:307](https://github.com/verida/verida-js/blob/5040472/packages/did-document/src/did-document.ts#L307) - -___ - -### removeContext - -▸ **removeContext**(`contextName`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | - -#### Returns - -`boolean` - -#### Implementation of - -[IDIDDocument](../interfaces/verida_did_document._internal_.IDIDDocument.md).[removeContext](../interfaces/verida_did_document._internal_.IDIDDocument.md#removecontext) - -#### Defined in - -[packages/did-document/src/did-document.ts:154](https://github.com/verida/verida-js/blob/5040472/packages/did-document/src/did-document.ts#L154) - -___ - -### setAttributes - -▸ **setAttributes**(`attributes`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `attributes` | [`Record`](../modules/verida_did_document._internal_.md#record)<`string`, `any`\> | - -#### Returns - -`void` - -#### Implementation of - -[IDIDDocument](../interfaces/verida_did_document._internal_.IDIDDocument.md).[setAttributes](../interfaces/verida_did_document._internal_.IDIDDocument.md#setattributes) - -#### Defined in - -[packages/did-document/src/did-document.ts:190](https://github.com/verida/verida-js/blob/5040472/packages/did-document/src/did-document.ts#L190) - -___ - -### signProof - -▸ **signProof**(`privateKey`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `privateKey` | `string` \| `Uint8Array` | - -#### Returns - -`void` - -#### Implementation of - -[IDIDDocument](../interfaces/verida_did_document._internal_.IDIDDocument.md).[signProof](../interfaces/verida_did_document._internal_.IDIDDocument.md#signproof) - -#### Defined in - -[packages/did-document/src/did-document.ts:328](https://github.com/verida/verida-js/blob/5040472/packages/did-document/src/did-document.ts#L328) - -___ - -### verifyContextSignature - -▸ **verifyContextSignature**(`data`, `contextName`, `signature`, `contextIsHash?`): `boolean` - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `data` | `any` | `undefined` | -| `contextName` | `string` | `undefined` | -| `signature` | `string` | `undefined` | -| `contextIsHash` | `boolean` | `false` | - -#### Returns - -`boolean` - -#### Implementation of - -[IDIDDocument](../interfaces/verida_did_document._internal_.IDIDDocument.md).[verifyContextSignature](../interfaces/verida_did_document._internal_.IDIDDocument.md#verifycontextsignature) - -#### Defined in - -[packages/did-document/src/did-document.ts:285](https://github.com/verida/verida-js/blob/5040472/packages/did-document/src/did-document.ts#L285) - -___ - -### verifyProof - -▸ **verifyProof**(): `boolean` - -#### Returns - -`boolean` - -#### Implementation of - -[IDIDDocument](../interfaces/verida_did_document._internal_.IDIDDocument.md).[verifyProof](../interfaces/verida_did_document._internal_.IDIDDocument.md#verifyproof) - -#### Defined in - -[packages/did-document/src/did-document.ts:344](https://github.com/verida/verida-js/blob/5040472/packages/did-document/src/did-document.ts#L344) - -___ - -### verifySig - -▸ **verifySig**(`data`, `signature`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `any` | -| `signature` | `string` | - -#### Returns - -`boolean` - -#### Implementation of - -[IDIDDocument](../interfaces/verida_did_document._internal_.IDIDDocument.md).[verifySig](../interfaces/verida_did_document._internal_.IDIDDocument.md#verifysig) - -#### Defined in - -[packages/did-document/src/did-document.ts:273](https://github.com/verida/verida-js/blob/5040472/packages/did-document/src/did-document.ts#L273) - -___ - -### generateContextHash - -▸ `Static` **generateContextHash**(`did`, `contextName`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did` | `string` | -| `contextName` | `string` | - -#### Returns - -`string` - -#### Defined in - -[packages/did-document/src/did-document.ts:302](https://github.com/verida/verida-js/blob/5040472/packages/did-document/src/did-document.ts#L302) diff --git a/docs/api/verida-js/classes/verida_did_document._internal_.default.md b/docs/api/verida-js/classes/verida_did_document._internal_.default.md deleted file mode 100644 index 02659d8..0000000 --- a/docs/api/verida-js/classes/verida_did_document._internal_.default.md +++ /dev/null @@ -1,368 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/did-document](../modules/verida_did_document.md) / [](../modules/verida_did_document._internal_.md) / default - -# Class: default - -[@verida/did-document](../modules/verida_did_document.md).[](../modules/verida_did_document._internal_.md).default - -Class that takes a signature (generated from a signed consent message) and generates a -collection of asymmetric keys, symmetric key and signing key for a given secure storage -context. - -## Table of contents - -### Constructors - -- [constructor](verida_did_document._internal_.default.md#constructor) - -### Properties - -- [asymKeyPair](verida_did_document._internal_.default.md#asymkeypair) -- [buildKey](verida_did_document._internal_.default.md#buildkey) -- [seed](verida_did_document._internal_.default.md#seed) -- [signKeyPair](verida_did_document._internal_.default.md#signkeypair) -- [storageContextKeys](verida_did_document._internal_.default.md#storagecontextkeys) -- [symKey](verida_did_document._internal_.default.md#symkey) - -### Methods - -- [\_init](verida_did_document._internal_.default.md#_init) -- [asymDecrypt](verida_did_document._internal_.default.md#asymdecrypt) -- [asymEncrypt](verida_did_document._internal_.default.md#asymencrypt) -- [buildSharedKeyEnd](verida_did_document._internal_.default.md#buildsharedkeyend) -- [buildSharedKeyStart](verida_did_document._internal_.default.md#buildsharedkeystart) -- [getKeys](verida_did_document._internal_.default.md#getkeys) -- [getSeed](verida_did_document._internal_.default.md#getseed) -- [getStorageContextKey](verida_did_document._internal_.default.md#getstoragecontextkey) -- [publicKeys](verida_did_document._internal_.default.md#publickeys) -- [sign](verida_did_document._internal_.default.md#sign) -- [symDecrypt](verida_did_document._internal_.default.md#symdecrypt) -- [symEncrypt](verida_did_document._internal_.default.md#symencrypt) -- [verifySig](verida_did_document._internal_.default.md#verifysig) - -## Constructors - -### constructor - -• **new default**(`seed`) - -A string used as a seed for this keyring. -The seed should be a hex signature obtained by 3ID signed consent message. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `seed` | `string` | - -#### Defined in - -packages/keyring/dist/keyring.d.ts:19 - -## Properties - -### asymKeyPair - -• `Optional` **asymKeyPair**: `any` - -#### Defined in - -packages/keyring/dist/keyring.d.ts:8 - -___ - -### buildKey - -• `Private` **buildKey**: `any` - -Helper function that generates a key of the appropriate type - -**`param`** - -**`param`** - -**`returns`** - -#### Defined in - -packages/keyring/dist/keyring.d.ts:29 - -___ - -### seed - -• `Private` **seed**: `any` - -#### Defined in - -packages/keyring/dist/keyring.d.ts:11 - -___ - -### signKeyPair - -• `Optional` **signKeyPair**: `any` - -#### Defined in - -packages/keyring/dist/keyring.d.ts:9 - -___ - -### storageContextKeys - -• `Private` **storageContextKeys**: `any` - -#### Defined in - -packages/keyring/dist/keyring.d.ts:12 - -___ - -### symKey - -• `Optional` **symKey**: `Uint8Array` - -#### Defined in - -packages/keyring/dist/keyring.d.ts:10 - -## Methods - -### \_init - -▸ **_init**(): `Promise`<`void`\> - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -packages/keyring/dist/keyring.d.ts:21 - -___ - -### asymDecrypt - -▸ **asymDecrypt**(`messageWithNonce`, `secretOrSharedKey`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `messageWithNonce` | `string` | -| `secretOrSharedKey` | `Uint8Array` | - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -packages/keyring/dist/keyring.d.ts:48 - -___ - -### asymEncrypt - -▸ **asymEncrypt**(`data`, `secretOrSharedKey`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `string` | -| `secretOrSharedKey` | `Uint8Array` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -packages/keyring/dist/keyring.d.ts:47 - -___ - -### buildSharedKeyEnd - -▸ **buildSharedKeyEnd**(`publicKey`): `Promise`<`Uint8Array`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `publicKey` | `Uint8Array` | - -#### Returns - -`Promise`<`Uint8Array`\> - -#### Defined in - -packages/keyring/dist/keyring.d.ts:50 - -___ - -### buildSharedKeyStart - -▸ **buildSharedKeyStart**(`privateKey`): `Promise`<`Uint8Array`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `privateKey` | `Uint8Array` | - -#### Returns - -`Promise`<`Uint8Array`\> - -#### Defined in - -packages/keyring/dist/keyring.d.ts:49 - -___ - -### getKeys - -▸ **getKeys**(): `Promise`<`any`\> - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -packages/keyring/dist/keyring.d.ts:20 - -___ - -### getSeed - -▸ **getSeed**(): `string` - -#### Returns - -`string` - -#### Defined in - -packages/keyring/dist/keyring.d.ts:51 - -___ - -### getStorageContextKey - -▸ **getStorageContextKey**(`databaseName`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `databaseName` | `string` | - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -packages/keyring/dist/keyring.d.ts:52 - -___ - -### publicKeys - -▸ **publicKeys**(): `Promise`<{ `asymPublicKey`: `Uint8Array` ; `asymPublicKeyBase58`: `string` ; `asymPublicKeyHex`: `string` ; `signPublicKey`: `Uint8Array` ; `signPublicKeyBase58`: `string` ; `signPublicKeyHex`: `string` }\> - -Generate an object containing all the public keys for this Keyring - -#### Returns - -`Promise`<{ `asymPublicKey`: `Uint8Array` ; `asymPublicKeyBase58`: `string` ; `asymPublicKeyHex`: `string` ; `signPublicKey`: `Uint8Array` ; `signPublicKeyBase58`: `string` ; `signPublicKeyHex`: `string` }\> - -#### Defined in - -packages/keyring/dist/keyring.d.ts:35 - -___ - -### sign - -▸ **sign**(`data`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `any` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -packages/keyring/dist/keyring.d.ts:43 - -___ - -### symDecrypt - -▸ **symDecrypt**(`data`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `string` | - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -packages/keyring/dist/keyring.d.ts:46 - -___ - -### symEncrypt - -▸ **symEncrypt**(`data`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -packages/keyring/dist/keyring.d.ts:45 - -___ - -### verifySig - -▸ **verifySig**(`data`, `sig`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `string` | -| `sig` | `string` | - -#### Returns - -`Promise`<`boolean`\> - -#### Defined in - -packages/keyring/dist/keyring.d.ts:44 diff --git a/docs/api/verida-js/classes/verida_encryption_utils.default.md b/docs/api/verida-js/classes/verida_encryption_utils.default.md deleted file mode 100644 index 31d0dcb..0000000 --- a/docs/api/verida-js/classes/verida_encryption_utils.default.md +++ /dev/null @@ -1,470 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/encryption-utils](../modules/verida_encryption_utils.md) / default - -# Class: default - -[@verida/encryption-utils](../modules/verida_encryption_utils.md).default - -Utilizes `tweetnacl` for symmetric and asymmetric encryption. - -Utilizes `keccak256` algorithm to hash signed data and `secp256k1` signature algorithm for the resulting signature. - -## Table of contents - -### Constructors - -- [constructor](verida_encryption_utils.default.md#constructor) - -### Methods - -- [asymDecrypt](verida_encryption_utils.default.md#asymdecrypt) -- [asymEncrypt](verida_encryption_utils.default.md#asymencrypt) -- [base58ToHex](verida_encryption_utils.default.md#base58tohex) -- [bytesToHex](verida_encryption_utils.default.md#bytestohex) -- [decodeBase64](verida_encryption_utils.default.md#decodebase64) -- [encodeBase64](verida_encryption_utils.default.md#encodebase64) -- [getSigner](verida_encryption_utils.default.md#getsigner) -- [hash](verida_encryption_utils.default.md#hash) -- [hashBytes](verida_encryption_utils.default.md#hashbytes) -- [hexToBase58](verida_encryption_utils.default.md#hextobase58) -- [hexToBytes](verida_encryption_utils.default.md#hextobytes) -- [publicKeyToAddress](verida_encryption_utils.default.md#publickeytoaddress) -- [randomKey](verida_encryption_utils.default.md#randomkey) -- [randomKeyPair](verida_encryption_utils.default.md#randomkeypair) -- [sharedKey](verida_encryption_utils.default.md#sharedkey) -- [signData](verida_encryption_utils.default.md#signdata) -- [symDecrypt](verida_encryption_utils.default.md#symdecrypt) -- [symDecryptBuffer](verida_encryption_utils.default.md#symdecryptbuffer) -- [symEncrypt](verida_encryption_utils.default.md#symencrypt) -- [symEncryptBuffer](verida_encryption_utils.default.md#symencryptbuffer) -- [verifySig](verida_encryption_utils.default.md#verifysig) - -## Constructors - -### constructor - -• **new default**() - -## Methods - -### asymDecrypt - -▸ `Static` **asymDecrypt**(`messageWithNonce`, `secretOrSharedKey`): `any` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `messageWithNonce` | `any` | -| `secretOrSharedKey` | `Uint8Array` | - -#### Returns - -`any` - -#### Defined in - -[packages/encryption-utils/src/index.ts:80](https://github.com/verida/verida-js/blob/5040472/packages/encryption-utils/src/index.ts#L80) - -___ - -### asymEncrypt - -▸ `Static` **asymEncrypt**(`data`, `secretOrSharedKey`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `any` | -| `secretOrSharedKey` | `Uint8Array` | - -#### Returns - -`string` - -#### Defined in - -[packages/encryption-utils/src/index.ts:67](https://github.com/verida/verida-js/blob/5040472/packages/encryption-utils/src/index.ts#L67) - -___ - -### base58ToHex - -▸ `Static` **base58ToHex**(`b58`): `Uint8Array` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `b58` | `string` | - -#### Returns - -`Uint8Array` - -#### Defined in - -[packages/encryption-utils/src/index.ts:182](https://github.com/verida/verida-js/blob/5040472/packages/encryption-utils/src/index.ts#L182) - -___ - -### bytesToHex - -▸ `Static` **bytesToHex**(`bytes`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `bytes` | `Uint8Array` | - -#### Returns - -`string` - -#### Defined in - -[packages/encryption-utils/src/index.ts:194](https://github.com/verida/verida-js/blob/5040472/packages/encryption-utils/src/index.ts#L194) - -___ - -### decodeBase64 - -▸ `Static` **decodeBase64**(`data`): `Uint8Array` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `any` | - -#### Returns - -`Uint8Array` - -#### Defined in - -[packages/encryption-utils/src/index.ts:157](https://github.com/verida/verida-js/blob/5040472/packages/encryption-utils/src/index.ts#L157) - -___ - -### encodeBase64 - -▸ `Static` **encodeBase64**(`data`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `any` | - -#### Returns - -`string` - -#### Defined in - -[packages/encryption-utils/src/index.ts:161](https://github.com/verida/verida-js/blob/5040472/packages/encryption-utils/src/index.ts#L161) - -___ - -### getSigner - -▸ `Static` **getSigner**(`data`, `signature`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `any` | -| `signature` | `string` | - -#### Returns - -`string` - -#### Defined in - -[packages/encryption-utils/src/index.ts:142](https://github.com/verida/verida-js/blob/5040472/packages/encryption-utils/src/index.ts#L142) - -___ - -### hash - -▸ `Static` **hash**(`data`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `any` | - -#### Returns - -`string` - -#### Defined in - -[packages/encryption-utils/src/index.ts:165](https://github.com/verida/verida-js/blob/5040472/packages/encryption-utils/src/index.ts#L165) - -___ - -### hashBytes - -▸ `Static` **hashBytes**(`data`): `Uint8Array` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `any` | - -#### Returns - -`Uint8Array` - -#### Defined in - -[packages/encryption-utils/src/index.ts:177](https://github.com/verida/verida-js/blob/5040472/packages/encryption-utils/src/index.ts#L177) - -___ - -### hexToBase58 - -▸ `Static` **hexToBase58**(`hex`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `hex` | `string` | - -#### Returns - -`string` - -#### Defined in - -[packages/encryption-utils/src/index.ts:186](https://github.com/verida/verida-js/blob/5040472/packages/encryption-utils/src/index.ts#L186) - -___ - -### hexToBytes - -▸ `Static` **hexToBytes**(`hex`): `Uint8Array` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `hex` | `string` | - -#### Returns - -`Uint8Array` - -#### Defined in - -[packages/encryption-utils/src/index.ts:190](https://github.com/verida/verida-js/blob/5040472/packages/encryption-utils/src/index.ts#L190) - -___ - -### publicKeyToAddress - -▸ `Static` **publicKeyToAddress**(`publicKeyHex`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `publicKeyHex` | `string` | - -#### Returns - -`string` - -#### Defined in - -[packages/encryption-utils/src/index.ts:198](https://github.com/verida/verida-js/blob/5040472/packages/encryption-utils/src/index.ts#L198) - -___ - -### randomKey - -▸ `Static` **randomKey**(`length`): `Uint8Array` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `length` | `number` | - -#### Returns - -`Uint8Array` - -#### Defined in - -[packages/encryption-utils/src/index.ts:102](https://github.com/verida/verida-js/blob/5040472/packages/encryption-utils/src/index.ts#L102) - -___ - -### randomKeyPair - -▸ `Static` **randomKeyPair**(): [`BoxKeyPair`](../interfaces/verida_encryption_utils._internal_.BoxKeyPair.md) - -#### Returns - -[`BoxKeyPair`](../interfaces/verida_encryption_utils._internal_.BoxKeyPair.md) - -#### Defined in - -[packages/encryption-utils/src/index.ts:106](https://github.com/verida/verida-js/blob/5040472/packages/encryption-utils/src/index.ts#L106) - -___ - -### sharedKey - -▸ `Static` **sharedKey**(`publicKeyBytes`, `privateKeyBytes`): `Uint8Array` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `publicKeyBytes` | `Uint8Array` | -| `privateKeyBytes` | `Uint8Array` | - -#### Returns - -`Uint8Array` - -#### Defined in - -[packages/encryption-utils/src/index.ts:98](https://github.com/verida/verida-js/blob/5040472/packages/encryption-utils/src/index.ts#L98) - -___ - -### signData - -▸ `Static` **signData**(`data`, `privateKeyBytes`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `any` | -| `privateKeyBytes` | `Uint8Array` | - -#### Returns - -`string` - -#### Defined in - -[packages/encryption-utils/src/index.ts:110](https://github.com/verida/verida-js/blob/5040472/packages/encryption-utils/src/index.ts#L110) - -___ - -### symDecrypt - -▸ `Static` **symDecrypt**(`messageWithNonce`, `keyUint8Array`): `any` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `messageWithNonce` | `any` | -| `keyUint8Array` | `Uint8Array` | - -#### Returns - -`any` - -#### Defined in - -[packages/encryption-utils/src/index.ts:61](https://github.com/verida/verida-js/blob/5040472/packages/encryption-utils/src/index.ts#L61) - -___ - -### symDecryptBuffer - -▸ `Static` **symDecryptBuffer**(`messageWithNonce`, `keyUint8Array`): `Uint8Array` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `messageWithNonce` | `any` | -| `keyUint8Array` | `Uint8Array` | - -#### Returns - -`Uint8Array` - -#### Defined in - -[packages/encryption-utils/src/index.ts:36](https://github.com/verida/verida-js/blob/5040472/packages/encryption-utils/src/index.ts#L36) - -___ - -### symEncrypt - -▸ `Static` **symEncrypt**(`data`, `keyUint8Array`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `any` | -| `keyUint8Array` | `Uint8Array` | - -#### Returns - -`string` - -#### Defined in - -[packages/encryption-utils/src/index.ts:52](https://github.com/verida/verida-js/blob/5040472/packages/encryption-utils/src/index.ts#L52) - -___ - -### symEncryptBuffer - -▸ `Static` **symEncryptBuffer**(`data`, `keyUint8Array`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `any` | -| `keyUint8Array` | `Uint8Array` | - -#### Returns - -`string` - -#### Defined in - -[packages/encryption-utils/src/index.ts:23](https://github.com/verida/verida-js/blob/5040472/packages/encryption-utils/src/index.ts#L23) - -___ - -### verifySig - -▸ `Static` **verifySig**(`data`, `signature`, `publicKeyOrAddress`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `any` | -| `signature` | `string` | -| `publicKeyOrAddress` | `string` | - -#### Returns - -`boolean` - -#### Defined in - -[packages/encryption-utils/src/index.ts:132](https://github.com/verida/verida-js/blob/5040472/packages/encryption-utils/src/index.ts#L132) diff --git a/docs/api/verida-js/classes/verida_helpers._internal_.EventEmitter-1.md b/docs/api/verida-js/classes/verida_helpers._internal_.EventEmitter-1.md deleted file mode 100644 index 341747b..0000000 --- a/docs/api/verida-js/classes/verida_helpers._internal_.EventEmitter-1.md +++ /dev/null @@ -1,1083 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/helpers](../modules/verida_helpers.md) / [](../modules/verida_helpers._internal_.md) / EventEmitter - -# Class: EventEmitter - -[@verida/helpers](../modules/verida_helpers.md).[](../modules/verida_helpers._internal_.md).EventEmitter - -The `EventEmitter` class is defined and exposed by the `events` module: - -```js -const EventEmitter = require('events'); -``` - -All `EventEmitter`s emit the event `'newListener'` when new listeners are -added and `'removeListener'` when existing listeners are removed. - -It supports the following option: - -**`since`** v0.1.26 - -## Hierarchy - -- `EventEmitter` - - ↳ **`EventEmitter`** - -## Table of contents - -### Constructors - -- [constructor](verida_helpers._internal_.EventEmitter-1.md#constructor) - -### Properties - -- [captureRejectionSymbol](verida_helpers._internal_.EventEmitter-1.md#capturerejectionsymbol) -- [captureRejections](verida_helpers._internal_.EventEmitter-1.md#capturerejections) -- [defaultMaxListeners](verida_helpers._internal_.EventEmitter-1.md#defaultmaxlisteners) -- [errorMonitor](verida_helpers._internal_.EventEmitter-1.md#errormonitor) - -### Methods - -- [addListener](verida_helpers._internal_.EventEmitter-1.md#addlistener) -- [emit](verida_helpers._internal_.EventEmitter-1.md#emit) -- [eventNames](verida_helpers._internal_.EventEmitter-1.md#eventnames) -- [getMaxListeners](verida_helpers._internal_.EventEmitter-1.md#getmaxlisteners) -- [listenerCount](verida_helpers._internal_.EventEmitter-1.md#listenercount) -- [listeners](verida_helpers._internal_.EventEmitter-1.md#listeners) -- [off](verida_helpers._internal_.EventEmitter-1.md#off) -- [on](verida_helpers._internal_.EventEmitter-1.md#on) -- [once](verida_helpers._internal_.EventEmitter-1.md#once) -- [prependListener](verida_helpers._internal_.EventEmitter-1.md#prependlistener) -- [prependOnceListener](verida_helpers._internal_.EventEmitter-1.md#prependoncelistener) -- [rawListeners](verida_helpers._internal_.EventEmitter-1.md#rawlisteners) -- [removeAllListeners](verida_helpers._internal_.EventEmitter-1.md#removealllisteners) -- [removeListener](verida_helpers._internal_.EventEmitter-1.md#removelistener) -- [setMaxListeners](verida_helpers._internal_.EventEmitter-1.md#setmaxlisteners) -- [getEventListeners](verida_helpers._internal_.EventEmitter-1.md#geteventlisteners) -- [listenerCount](verida_helpers._internal_.EventEmitter-1.md#listenercount) -- [on](verida_helpers._internal_.EventEmitter-1.md#on) -- [once](verida_helpers._internal_.EventEmitter-1.md#once) - -## Constructors - -### constructor - -• **new EventEmitter**(`options?`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options?` | [`EventEmitterOptions`](../interfaces/verida_helpers._internal_.EventEmitterOptions.md) | - -#### Inherited from - -NodeJS.EventEmitter.constructor - -#### Defined in - -node_modules/@types/node/events.d.ts:74 - -## Properties - -### captureRejectionSymbol - -▪ `Static` `Readonly` **captureRejectionSymbol**: typeof [`captureRejectionSymbol`](verida_helpers._internal_.EventEmitter-1.md#capturerejectionsymbol) - -#### Defined in - -node_modules/@types/node/events.d.ts:273 - -___ - -### captureRejections - -▪ `Static` **captureRejections**: `boolean` - -Sets or gets the default captureRejection value for all emitters. - -#### Defined in - -node_modules/@types/node/events.d.ts:278 - -___ - -### defaultMaxListeners - -▪ `Static` **defaultMaxListeners**: `number` - -#### Defined in - -node_modules/@types/node/events.d.ts:279 - -___ - -### errorMonitor - -▪ `Static` `Readonly` **errorMonitor**: typeof [`errorMonitor`](verida_helpers._internal_.EventEmitter-1.md#errormonitor) - -This symbol shall be used to install a listener for only monitoring `'error'` -events. Listeners installed using this symbol are called before the regular -`'error'` listeners are called. - -Installing a listener using this symbol does not change the behavior once an -`'error'` event is emitted, therefore the process will still crash if no -regular `'error'` listener is installed. - -#### Defined in - -node_modules/@types/node/events.d.ts:272 - -## Methods - -### addListener - -▸ **addListener**(`eventName`, `listener`): [`EventEmitter`](verida_helpers._internal_.EventEmitter-1.md) - -Alias for `emitter.on(eventName, listener)`. - -**`since`** v0.1.26 - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | `string` \| `symbol` | -| `listener` | (...`args`: `any`[]) => `void` | - -#### Returns - -[`EventEmitter`](verida_helpers._internal_.EventEmitter-1.md) - -#### Inherited from - -NodeJS.EventEmitter.addListener - -#### Defined in - -node_modules/@types/node/events.d.ts:299 - -___ - -### emit - -▸ **emit**(`eventName`, ...`args`): `boolean` - -Synchronously calls each of the listeners registered for the event named`eventName`, in the order they were registered, passing the supplied arguments -to each. - -Returns `true` if the event had listeners, `false` otherwise. - -```js -const EventEmitter = require('events'); -const myEmitter = new EventEmitter(); - -// First listener -myEmitter.on('event', function firstListener() { - console.log('Helloooo! first listener'); -}); -// Second listener -myEmitter.on('event', function secondListener(arg1, arg2) { - console.log(`event with parameters ${arg1}, ${arg2} in second listener`); -}); -// Third listener -myEmitter.on('event', function thirdListener(...args) { - const parameters = args.join(', '); - console.log(`event with parameters ${parameters} in third listener`); -}); - -console.log(myEmitter.listeners('event')); - -myEmitter.emit('event', 1, 2, 3, 4, 5); - -// Prints: -// [ -// [Function: firstListener], -// [Function: secondListener], -// [Function: thirdListener] -// ] -// Helloooo! first listener -// event with parameters 1, 2 in second listener -// event with parameters 1, 2, 3, 4, 5 in third listener -``` - -**`since`** v0.1.26 - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | `string` \| `symbol` | -| `...args` | `any`[] | - -#### Returns - -`boolean` - -#### Inherited from - -NodeJS.EventEmitter.emit - -#### Defined in - -node_modules/@types/node/events.d.ts:555 - -___ - -### eventNames - -▸ **eventNames**(): (`string` \| `symbol`)[] - -Returns an array listing the events for which the emitter has registered -listeners. The values in the array are strings or `Symbol`s. - -```js -const EventEmitter = require('events'); -const myEE = new EventEmitter(); -myEE.on('foo', () => {}); -myEE.on('bar', () => {}); - -const sym = Symbol('symbol'); -myEE.on(sym, () => {}); - -console.log(myEE.eventNames()); -// Prints: [ 'foo', 'bar', Symbol(symbol) ] -``` - -**`since`** v6.0.0 - -#### Returns - -(`string` \| `symbol`)[] - -#### Inherited from - -NodeJS.EventEmitter.eventNames - -#### Defined in - -node_modules/@types/node/events.d.ts:614 - -___ - -### getMaxListeners - -▸ **getMaxListeners**(): `number` - -Returns the current max listener value for the `EventEmitter` which is either -set by `emitter.setMaxListeners(n)` or defaults to [defaultMaxListeners](verida_helpers._internal_.EventEmitter-1.md#defaultmaxlisteners). - -**`since`** v1.0.0 - -#### Returns - -`number` - -#### Inherited from - -NodeJS.EventEmitter.getMaxListeners - -#### Defined in - -node_modules/@types/node/events.d.ts:471 - -___ - -### listenerCount - -▸ **listenerCount**(`eventName`): `number` - -Returns the number of listeners listening to the event named `eventName`. - -**`since`** v3.2.0 - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `eventName` | `string` \| `symbol` | The name of the event being listened for | - -#### Returns - -`number` - -#### Inherited from - -NodeJS.EventEmitter.listenerCount - -#### Defined in - -node_modules/@types/node/events.d.ts:561 - -___ - -### listeners - -▸ **listeners**(`eventName`): `Function`[] - -Returns a copy of the array of listeners for the event named `eventName`. - -```js -server.on('connection', (stream) => { - console.log('someone connected!'); -}); -console.log(util.inspect(server.listeners('connection'))); -// Prints: [ [Function] ] -``` - -**`since`** v0.1.26 - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | `string` \| `symbol` | - -#### Returns - -`Function`[] - -#### Inherited from - -NodeJS.EventEmitter.listeners - -#### Defined in - -node_modules/@types/node/events.d.ts:484 - -___ - -### off - -▸ **off**(`eventName`, `listener`): [`EventEmitter`](verida_helpers._internal_.EventEmitter-1.md) - -Alias for `emitter.removeListener()`. - -**`since`** v10.0.0 - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | `string` \| `symbol` | -| `listener` | (...`args`: `any`[]) => `void` | - -#### Returns - -[`EventEmitter`](verida_helpers._internal_.EventEmitter-1.md) - -#### Inherited from - -NodeJS.EventEmitter.off - -#### Defined in - -node_modules/@types/node/events.d.ts:444 - -___ - -### on - -▸ **on**(`eventName`, `listener`): [`EventEmitter`](verida_helpers._internal_.EventEmitter-1.md) - -Adds the `listener` function to the end of the listeners array for the -event named `eventName`. No checks are made to see if the `listener` has -already been added. Multiple calls passing the same combination of `eventName`and `listener` will result in the `listener` being added, and called, multiple -times. - -```js -server.on('connection', (stream) => { - console.log('someone connected!'); -}); -``` - -Returns a reference to the `EventEmitter`, so that calls can be chained. - -By default, event listeners are invoked in the order they are added. The`emitter.prependListener()` method can be used as an alternative to add the -event listener to the beginning of the listeners array. - -```js -const myEE = new EventEmitter(); -myEE.on('foo', () => console.log('a')); -myEE.prependListener('foo', () => console.log('b')); -myEE.emit('foo'); -// Prints: -// b -// a -``` - -**`since`** v0.1.101 - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `eventName` | `string` \| `symbol` | The name of the event. | -| `listener` | (...`args`: `any`[]) => `void` | The callback function | - -#### Returns - -[`EventEmitter`](verida_helpers._internal_.EventEmitter-1.md) - -#### Inherited from - -NodeJS.EventEmitter.on - -#### Defined in - -node_modules/@types/node/events.d.ts:330 - -___ - -### once - -▸ **once**(`eventName`, `listener`): [`EventEmitter`](verida_helpers._internal_.EventEmitter-1.md) - -Adds a **one-time**`listener` function for the event named `eventName`. The -next time `eventName` is triggered, this listener is removed and then invoked. - -```js -server.once('connection', (stream) => { - console.log('Ah, we have our first user!'); -}); -``` - -Returns a reference to the `EventEmitter`, so that calls can be chained. - -By default, event listeners are invoked in the order they are added. The`emitter.prependOnceListener()` method can be used as an alternative to add the -event listener to the beginning of the listeners array. - -```js -const myEE = new EventEmitter(); -myEE.once('foo', () => console.log('a')); -myEE.prependOnceListener('foo', () => console.log('b')); -myEE.emit('foo'); -// Prints: -// b -// a -``` - -**`since`** v0.3.0 - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `eventName` | `string` \| `symbol` | The name of the event. | -| `listener` | (...`args`: `any`[]) => `void` | The callback function | - -#### Returns - -[`EventEmitter`](verida_helpers._internal_.EventEmitter-1.md) - -#### Inherited from - -NodeJS.EventEmitter.once - -#### Defined in - -node_modules/@types/node/events.d.ts:359 - -___ - -### prependListener - -▸ **prependListener**(`eventName`, `listener`): [`EventEmitter`](verida_helpers._internal_.EventEmitter-1.md) - -Adds the `listener` function to the _beginning_ of the listeners array for the -event named `eventName`. No checks are made to see if the `listener` has -already been added. Multiple calls passing the same combination of `eventName`and `listener` will result in the `listener` being added, and called, multiple -times. - -```js -server.prependListener('connection', (stream) => { - console.log('someone connected!'); -}); -``` - -Returns a reference to the `EventEmitter`, so that calls can be chained. - -**`since`** v6.0.0 - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `eventName` | `string` \| `symbol` | The name of the event. | -| `listener` | (...`args`: `any`[]) => `void` | The callback function | - -#### Returns - -[`EventEmitter`](verida_helpers._internal_.EventEmitter-1.md) - -#### Inherited from - -NodeJS.EventEmitter.prependListener - -#### Defined in - -node_modules/@types/node/events.d.ts:579 - -___ - -### prependOnceListener - -▸ **prependOnceListener**(`eventName`, `listener`): [`EventEmitter`](verida_helpers._internal_.EventEmitter-1.md) - -Adds a **one-time**`listener` function for the event named `eventName` to the_beginning_ of the listeners array. The next time `eventName` is triggered, this -listener is removed, and then invoked. - -```js -server.prependOnceListener('connection', (stream) => { - console.log('Ah, we have our first user!'); -}); -``` - -Returns a reference to the `EventEmitter`, so that calls can be chained. - -**`since`** v6.0.0 - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `eventName` | `string` \| `symbol` | The name of the event. | -| `listener` | (...`args`: `any`[]) => `void` | The callback function | - -#### Returns - -[`EventEmitter`](verida_helpers._internal_.EventEmitter-1.md) - -#### Inherited from - -NodeJS.EventEmitter.prependOnceListener - -#### Defined in - -node_modules/@types/node/events.d.ts:595 - -___ - -### rawListeners - -▸ **rawListeners**(`eventName`): `Function`[] - -Returns a copy of the array of listeners for the event named `eventName`, -including any wrappers (such as those created by `.once()`). - -```js -const emitter = new EventEmitter(); -emitter.once('log', () => console.log('log once')); - -// Returns a new Array with a function `onceWrapper` which has a property -// `listener` which contains the original listener bound above -const listeners = emitter.rawListeners('log'); -const logFnWrapper = listeners[0]; - -// Logs "log once" to the console and does not unbind the `once` event -logFnWrapper.listener(); - -// Logs "log once" to the console and removes the listener -logFnWrapper(); - -emitter.on('log', () => console.log('log persistently')); -// Will return a new Array with a single function bound by `.on()` above -const newListeners = emitter.rawListeners('log'); - -// Logs "log persistently" twice -newListeners[0](); -emitter.emit('log'); -``` - -**`since`** v9.4.0 - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | `string` \| `symbol` | - -#### Returns - -`Function`[] - -#### Inherited from - -NodeJS.EventEmitter.rawListeners - -#### Defined in - -node_modules/@types/node/events.d.ts:514 - -___ - -### removeAllListeners - -▸ **removeAllListeners**(`event?`): [`EventEmitter`](verida_helpers._internal_.EventEmitter-1.md) - -Removes all listeners, or those of the specified `eventName`. - -It is bad practice to remove listeners added elsewhere in the code, -particularly when the `EventEmitter` instance was created by some other -component or module (e.g. sockets or file streams). - -Returns a reference to the `EventEmitter`, so that calls can be chained. - -**`since`** v0.1.26 - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event?` | `string` \| `symbol` | - -#### Returns - -[`EventEmitter`](verida_helpers._internal_.EventEmitter-1.md) - -#### Inherited from - -NodeJS.EventEmitter.removeAllListeners - -#### Defined in - -node_modules/@types/node/events.d.ts:455 - -___ - -### removeListener - -▸ **removeListener**(`eventName`, `listener`): [`EventEmitter`](verida_helpers._internal_.EventEmitter-1.md) - -Removes the specified `listener` from the listener array for the event named`eventName`. - -```js -const callback = (stream) => { - console.log('someone connected!'); -}; -server.on('connection', callback); -// ... -server.removeListener('connection', callback); -``` - -`removeListener()` will remove, at most, one instance of a listener from the -listener array. If any single listener has been added multiple times to the -listener array for the specified `eventName`, then `removeListener()` must be -called multiple times to remove each instance. - -Once an event is emitted, all listeners attached to it at the -time of emitting are called in order. This implies that any`removeListener()` or `removeAllListeners()` calls _after_ emitting and_before_ the last listener finishes execution will -not remove them from`emit()` in progress. Subsequent events behave as expected. - -```js -const myEmitter = new MyEmitter(); - -const callbackA = () => { - console.log('A'); - myEmitter.removeListener('event', callbackB); -}; - -const callbackB = () => { - console.log('B'); -}; - -myEmitter.on('event', callbackA); - -myEmitter.on('event', callbackB); - -// callbackA removes listener callbackB but it will still be called. -// Internal listener array at time of emit [callbackA, callbackB] -myEmitter.emit('event'); -// Prints: -// A -// B - -// callbackB is now removed. -// Internal listener array [callbackA] -myEmitter.emit('event'); -// Prints: -// A -``` - -Because listeners are managed using an internal array, calling this will -change the position indices of any listener registered _after_ the listener -being removed. This will not impact the order in which listeners are called, -but it means that any copies of the listener array as returned by -the `emitter.listeners()` method will need to be recreated. - -When a single function has been added as a handler multiple times for a single -event (as in the example below), `removeListener()` will remove the most -recently added instance. In the example the `once('ping')`listener is removed: - -```js -const ee = new EventEmitter(); - -function pong() { - console.log('pong'); -} - -ee.on('ping', pong); -ee.once('ping', pong); -ee.removeListener('ping', pong); - -ee.emit('ping'); -ee.emit('ping'); -``` - -Returns a reference to the `EventEmitter`, so that calls can be chained. - -**`since`** v0.1.26 - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | `string` \| `symbol` | -| `listener` | (...`args`: `any`[]) => `void` | - -#### Returns - -[`EventEmitter`](verida_helpers._internal_.EventEmitter-1.md) - -#### Inherited from - -NodeJS.EventEmitter.removeListener - -#### Defined in - -node_modules/@types/node/events.d.ts:439 - -___ - -### setMaxListeners - -▸ **setMaxListeners**(`n`): [`EventEmitter`](verida_helpers._internal_.EventEmitter-1.md) - -By default `EventEmitter`s will print a warning if more than `10` listeners are -added for a particular event. This is a useful default that helps finding -memory leaks. The `emitter.setMaxListeners()` method allows the limit to be -modified for this specific `EventEmitter` instance. The value can be set to`Infinity` (or `0`) to indicate an unlimited number of listeners. - -Returns a reference to the `EventEmitter`, so that calls can be chained. - -**`since`** v0.3.5 - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `n` | `number` | - -#### Returns - -[`EventEmitter`](verida_helpers._internal_.EventEmitter-1.md) - -#### Inherited from - -NodeJS.EventEmitter.setMaxListeners - -#### Defined in - -node_modules/@types/node/events.d.ts:465 - -___ - -### getEventListeners - -▸ `Static` **getEventListeners**(`emitter`, `name`): `Function`[] - -Returns a copy of the array of listeners for the event named `eventName`. - -For `EventEmitter`s this behaves exactly the same as calling `.listeners` on -the emitter. - -For `EventTarget`s this is the only way to get the event listeners for the -event target. This is useful for debugging and diagnostic purposes. - -```js -const { getEventListeners, EventEmitter } = require('events'); - -{ - const ee = new EventEmitter(); - const listener = () => console.log('Events are fun'); - ee.on('foo', listener); - getEventListeners(ee, 'foo'); // [listener] -} -{ - const et = new EventTarget(); - const listener = () => console.log('Events are fun'); - et.addEventListener('foo', listener); - getEventListeners(et, 'foo'); // [listener] -} -``` - -**`since`** v15.2.0 - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `emitter` | `EventEmitter` \| [`DOMEventTarget`](../interfaces/verida_helpers._internal_.DOMEventTarget.md) | -| `name` | `string` \| `symbol` | - -#### Returns - -`Function`[] - -#### Defined in - -node_modules/@types/node/events.d.ts:262 - -___ - -### listenerCount - -▸ `Static` **listenerCount**(`emitter`, `eventName`): `number` - -A class method that returns the number of listeners for the given `eventName`registered on the given `emitter`. - -```js -const { EventEmitter, listenerCount } = require('events'); -const myEmitter = new EventEmitter(); -myEmitter.on('event', () => {}); -myEmitter.on('event', () => {}); -console.log(listenerCount(myEmitter, 'event')); -// Prints: 2 -``` - -**`since`** v0.9.12 - -**`deprecated`** Since v3.2.0 - Use `listenerCount` instead. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `emitter` | `EventEmitter` | The emitter to query | -| `eventName` | `string` \| `symbol` | The event name | - -#### Returns - -`number` - -#### Inherited from - -NodeJS.EventEmitter.listenerCount - -#### Defined in - -node_modules/@types/node/events.d.ts:234 - -___ - -### on - -▸ `Static` **on**(`emitter`, `eventName`, `options?`): [`AsyncIterableIterator`](../interfaces/verida_helpers._internal_.AsyncIterableIterator.md)<`any`\> - -```js -const { on, EventEmitter } = require('events'); - -(async () => { - const ee = new EventEmitter(); - - // Emit later on - process.nextTick(() => { - ee.emit('foo', 'bar'); - ee.emit('foo', 42); - }); - - for await (const event of on(ee, 'foo')) { - // The execution of this inner block is synchronous and it - // processes one event at a time (even with await). Do not use - // if concurrent execution is required. - console.log(event); // prints ['bar'] [42] - } - // Unreachable here -})(); -``` - -Returns an `AsyncIterator` that iterates `eventName` events. It will throw -if the `EventEmitter` emits `'error'`. It removes all listeners when -exiting the loop. The `value` returned by each iteration is an array -composed of the emitted event arguments. - -An `AbortSignal` can be used to cancel waiting on events: - -```js -const { on, EventEmitter } = require('events'); -const ac = new AbortController(); - -(async () => { - const ee = new EventEmitter(); - - // Emit later on - process.nextTick(() => { - ee.emit('foo', 'bar'); - ee.emit('foo', 42); - }); - - for await (const event of on(ee, 'foo', { signal: ac.signal })) { - // The execution of this inner block is synchronous and it - // processes one event at a time (even with await). Do not use - // if concurrent execution is required. - console.log(event); // prints ['bar'] [42] - } - // Unreachable here -})(); - -process.nextTick(() => ac.abort()); -``` - -**`since`** v13.6.0, v12.16.0 - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `emitter` | `EventEmitter` | - | -| `eventName` | `string` | The name of the event being listened for | -| `options?` | [`StaticEventEmitterOptions`](../interfaces/verida_helpers._internal_.StaticEventEmitterOptions.md) | - | - -#### Returns - -[`AsyncIterableIterator`](../interfaces/verida_helpers._internal_.AsyncIterableIterator.md)<`any`\> - -that iterates `eventName` events emitted by the `emitter` - -#### Inherited from - -NodeJS.EventEmitter.on - -#### Defined in - -node_modules/@types/node/events.d.ts:217 - -___ - -### once - -▸ `Static` **once**(`emitter`, `eventName`, `options?`): `Promise`<`any`[]\> - -Creates a `Promise` that is fulfilled when the `EventEmitter` emits the given -event or that is rejected if the `EventEmitter` emits `'error'` while waiting. -The `Promise` will resolve with an array of all the arguments emitted to the -given event. - -This method is intentionally generic and works with the web platform[EventTarget](https://dom.spec.whatwg.org/#interface-eventtarget) interface, which has no special`'error'` event -semantics and does not listen to the `'error'` event. - -```js -const { once, EventEmitter } = require('events'); - -async function run() { - const ee = new EventEmitter(); - - process.nextTick(() => { - ee.emit('myevent', 42); - }); - - const [value] = await once(ee, 'myevent'); - console.log(value); - - const err = new Error('kaboom'); - process.nextTick(() => { - ee.emit('error', err); - }); - - try { - await once(ee, 'myevent'); - } catch (err) { - console.log('error happened', err); - } -} - -run(); -``` - -The special handling of the `'error'` event is only used when `events.once()`is used to wait for another event. If `events.once()` is used to wait for the -'`error'` event itself, then it is treated as any other kind of event without -special handling: - -```js -const { EventEmitter, once } = require('events'); - -const ee = new EventEmitter(); - -once(ee, 'error') - .then(([err]) => console.log('ok', err.message)) - .catch((err) => console.log('error', err.message)); - -ee.emit('error', new Error('boom')); - -// Prints: ok boom -``` - -An `AbortSignal` can be used to cancel waiting for the event: - -```js -const { EventEmitter, once } = require('events'); - -const ee = new EventEmitter(); -const ac = new AbortController(); - -async function foo(emitter, event, signal) { - try { - await once(emitter, event, { signal }); - console.log('event emitted!'); - } catch (error) { - if (error.name === 'AbortError') { - console.error('Waiting for the event was canceled!'); - } else { - console.error('There was an error', error.message); - } - } -} - -foo(ee, 'foo', ac.signal); -ac.abort(); // Abort waiting for the event -ee.emit('foo'); // Prints: Waiting for the event was canceled! -``` - -**`since`** v11.13.0, v10.16.0 - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `emitter` | [`NodeEventTarget`](../interfaces/verida_helpers._internal_.NodeEventTarget.md) | -| `eventName` | `string` \| `symbol` | -| `options?` | [`StaticEventEmitterOptions`](../interfaces/verida_helpers._internal_.StaticEventEmitterOptions.md) | - -#### Returns - -`Promise`<`any`[]\> - -#### Inherited from - -NodeJS.EventEmitter.once - -#### Defined in - -node_modules/@types/node/events.d.ts:157 - -▸ `Static` **once**(`emitter`, `eventName`, `options?`): `Promise`<`any`[]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `emitter` | [`DOMEventTarget`](../interfaces/verida_helpers._internal_.DOMEventTarget.md) | -| `eventName` | `string` | -| `options?` | [`StaticEventEmitterOptions`](../interfaces/verida_helpers._internal_.StaticEventEmitterOptions.md) | - -#### Returns - -`Promise`<`any`[]\> - -#### Inherited from - -NodeJS.EventEmitter.once - -#### Defined in - -node_modules/@types/node/events.d.ts:158 diff --git a/docs/api/verida-js/classes/verida_keyring.Keyring.md b/docs/api/verida-js/classes/verida_keyring.Keyring.md deleted file mode 100644 index 5609683..0000000 --- a/docs/api/verida-js/classes/verida_keyring.Keyring.md +++ /dev/null @@ -1,428 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/keyring](../modules/verida_keyring.md) / Keyring - -# Class: Keyring - -[@verida/keyring](../modules/verida_keyring.md).Keyring - -Class that takes a signature (generated from a signed consent message) and generates a -collection of asymmetric keys, symmetric key and signing key for a given secure storage -context. - -## Implements - -- [`IKeyring`](../interfaces/verida_keyring._internal_.IKeyring.md) - -## Table of contents - -### Constructors - -- [constructor](verida_keyring.Keyring.md#constructor) - -### Properties - -- [asymKeyPair](verida_keyring.Keyring.md#asymkeypair) -- [seed](verida_keyring.Keyring.md#seed) -- [signKeyPair](verida_keyring.Keyring.md#signkeypair) -- [storageContextKeys](verida_keyring.Keyring.md#storagecontextkeys) -- [symKey](verida_keyring.Keyring.md#symkey) - -### Methods - -- [\_init](verida_keyring.Keyring.md#_init) -- [asymDecrypt](verida_keyring.Keyring.md#asymdecrypt) -- [asymEncrypt](verida_keyring.Keyring.md#asymencrypt) -- [buildKey](verida_keyring.Keyring.md#buildkey) -- [buildSharedKeyEnd](verida_keyring.Keyring.md#buildsharedkeyend) -- [buildSharedKeyStart](verida_keyring.Keyring.md#buildsharedkeystart) -- [getKeys](verida_keyring.Keyring.md#getkeys) -- [getSeed](verida_keyring.Keyring.md#getseed) -- [getStorageContextKey](verida_keyring.Keyring.md#getstoragecontextkey) -- [publicKeys](verida_keyring.Keyring.md#publickeys) -- [sign](verida_keyring.Keyring.md#sign) -- [symDecrypt](verida_keyring.Keyring.md#symdecrypt) -- [symEncrypt](verida_keyring.Keyring.md#symencrypt) -- [verifySig](verida_keyring.Keyring.md#verifysig) - -## Constructors - -### constructor - -• **new Keyring**(`seed`) - -A string used as a seed for this keyring. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `seed` | `string` | - -#### Defined in - -[packages/keyring/src/keyring.ts:25](https://github.com/verida/verida-js/blob/5040472/packages/keyring/src/keyring.ts#L25) - -## Properties - -### asymKeyPair - -• `Optional` **asymKeyPair**: [`BoxKeyPair`](../interfaces/verida_keyring._internal_.BoxKeyPair.md) - -#### Defined in - -[packages/keyring/src/keyring.ts:13](https://github.com/verida/verida-js/blob/5040472/packages/keyring/src/keyring.ts#L13) - -___ - -### seed - -• `Private` **seed**: `string` - -#### Defined in - -[packages/keyring/src/keyring.ts:17](https://github.com/verida/verida-js/blob/5040472/packages/keyring/src/keyring.ts#L17) - -___ - -### signKeyPair - -• `Optional` **signKeyPair**: [`SignKeyPair`](../interfaces/verida_keyring._internal_.SignKeyPair.md) - -#### Defined in - -[packages/keyring/src/keyring.ts:14](https://github.com/verida/verida-js/blob/5040472/packages/keyring/src/keyring.ts#L14) - -___ - -### storageContextKeys - -• `Private` **storageContextKeys**: `any` = `{}` - -#### Defined in - -[packages/keyring/src/keyring.ts:18](https://github.com/verida/verida-js/blob/5040472/packages/keyring/src/keyring.ts#L18) - -___ - -### symKey - -• `Optional` **symKey**: `Uint8Array` - -#### Defined in - -[packages/keyring/src/keyring.ts:15](https://github.com/verida/verida-js/blob/5040472/packages/keyring/src/keyring.ts#L15) - -## Methods - -### \_init - -▸ **_init**(): `Promise`<`void`\> - -#### Returns - -`Promise`<`void`\> - -#### Implementation of - -[IKeyring](../interfaces/verida_keyring._internal_.IKeyring.md).[_init](../interfaces/verida_keyring._internal_.IKeyring.md#_init) - -#### Defined in - -[packages/keyring/src/keyring.ts:53](https://github.com/verida/verida-js/blob/5040472/packages/keyring/src/keyring.ts#L53) - -___ - -### asymDecrypt - -▸ **asymDecrypt**(`messageWithNonce`, `secretOrSharedKey`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `messageWithNonce` | `string` | -| `secretOrSharedKey` | `Uint8Array` | - -#### Returns - -`Promise`<`any`\> - -#### Implementation of - -[IKeyring](../interfaces/verida_keyring._internal_.IKeyring.md).[asymDecrypt](../interfaces/verida_keyring._internal_.IKeyring.md#asymdecrypt) - -#### Defined in - -[packages/keyring/src/keyring.ts:138](https://github.com/verida/verida-js/blob/5040472/packages/keyring/src/keyring.ts#L138) - -___ - -### asymEncrypt - -▸ **asymEncrypt**(`data`, `secretOrSharedKey`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `string` | -| `secretOrSharedKey` | `Uint8Array` | - -#### Returns - -`Promise`<`string`\> - -#### Implementation of - -[IKeyring](../interfaces/verida_keyring._internal_.IKeyring.md).[asymEncrypt](../interfaces/verida_keyring._internal_.IKeyring.md#asymencrypt) - -#### Defined in - -[packages/keyring/src/keyring.ts:133](https://github.com/verida/verida-js/blob/5040472/packages/keyring/src/keyring.ts#L133) - -___ - -### buildKey - -▸ `Private` **buildKey**(`seed`, `keyType`): `Promise`<[`BoxKeyPair`](../interfaces/verida_keyring._internal_.BoxKeyPair.md)\> - -Helper function that generates a key of the appropriate type - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `seed` | `string` | -| `keyType` | [`KeyringKeyType`](../enums/verida_keyring._internal_.KeyringKeyType.md) | - -#### Returns - -`Promise`<[`BoxKeyPair`](../interfaces/verida_keyring._internal_.BoxKeyPair.md)\> - -#### Defined in - -[packages/keyring/src/keyring.ts:72](https://github.com/verida/verida-js/blob/5040472/packages/keyring/src/keyring.ts#L72) - -___ - -### buildSharedKeyEnd - -▸ **buildSharedKeyEnd**(`publicKey`): `Promise`<`Uint8Array`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `publicKey` | `Uint8Array` | - -#### Returns - -`Promise`<`Uint8Array`\> - -#### Implementation of - -[IKeyring](../interfaces/verida_keyring._internal_.IKeyring.md).[buildSharedKeyEnd](../interfaces/verida_keyring._internal_.IKeyring.md#buildsharedkeyend) - -#### Defined in - -[packages/keyring/src/keyring.ts:148](https://github.com/verida/verida-js/blob/5040472/packages/keyring/src/keyring.ts#L148) - -___ - -### buildSharedKeyStart - -▸ **buildSharedKeyStart**(`privateKey`): `Promise`<`Uint8Array`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `privateKey` | `Uint8Array` | - -#### Returns - -`Promise`<`Uint8Array`\> - -#### Implementation of - -[IKeyring](../interfaces/verida_keyring._internal_.IKeyring.md).[buildSharedKeyStart](../interfaces/verida_keyring._internal_.IKeyring.md#buildsharedkeystart) - -#### Defined in - -[packages/keyring/src/keyring.ts:143](https://github.com/verida/verida-js/blob/5040472/packages/keyring/src/keyring.ts#L143) - -___ - -### getKeys - -▸ **getKeys**(): `Promise`<`any`\> - -#### Returns - -`Promise`<`any`\> - -#### Implementation of - -[IKeyring](../interfaces/verida_keyring._internal_.IKeyring.md).[getKeys](../interfaces/verida_keyring._internal_.IKeyring.md#getkeys) - -#### Defined in - -[packages/keyring/src/keyring.ts:29](https://github.com/verida/verida-js/blob/5040472/packages/keyring/src/keyring.ts#L29) - -___ - -### getSeed - -▸ **getSeed**(): `string` - -#### Returns - -`string` - -#### Implementation of - -[IKeyring](../interfaces/verida_keyring._internal_.IKeyring.md).[getSeed](../interfaces/verida_keyring._internal_.IKeyring.md#getseed) - -#### Defined in - -[packages/keyring/src/keyring.ts:153](https://github.com/verida/verida-js/blob/5040472/packages/keyring/src/keyring.ts#L153) - -___ - -### getStorageContextKey - -▸ **getStorageContextKey**(`databaseName`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `databaseName` | `string` | - -#### Returns - -`Promise`<`any`\> - -#### Implementation of - -[IKeyring](../interfaces/verida_keyring._internal_.IKeyring.md).[getStorageContextKey](../interfaces/verida_keyring._internal_.IKeyring.md#getstoragecontextkey) - -#### Defined in - -[packages/keyring/src/keyring.ts:157](https://github.com/verida/verida-js/blob/5040472/packages/keyring/src/keyring.ts#L157) - -___ - -### publicKeys - -▸ **publicKeys**(): `Promise`<[`KeyringPublicKeys`](../interfaces/verida_keyring._internal_.KeyringPublicKeys.md)\> - -Generate an object containing all the public keys for this Keyring - -#### Returns - -`Promise`<[`KeyringPublicKeys`](../interfaces/verida_keyring._internal_.KeyringPublicKeys.md)\> - -#### Implementation of - -[IKeyring](../interfaces/verida_keyring._internal_.IKeyring.md).[publicKeys](../interfaces/verida_keyring._internal_.IKeyring.md#publickeys) - -#### Defined in - -[packages/keyring/src/keyring.ts:100](https://github.com/verida/verida-js/blob/5040472/packages/keyring/src/keyring.ts#L100) - -___ - -### sign - -▸ **sign**(`data`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `any` | - -#### Returns - -`Promise`<`string`\> - -#### Implementation of - -[IKeyring](../interfaces/verida_keyring._internal_.IKeyring.md).[sign](../interfaces/verida_keyring._internal_.IKeyring.md#sign) - -#### Defined in - -[packages/keyring/src/keyring.ts:113](https://github.com/verida/verida-js/blob/5040472/packages/keyring/src/keyring.ts#L113) - -___ - -### symDecrypt - -▸ **symDecrypt**(`data`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `string` | - -#### Returns - -`Promise`<`any`\> - -#### Implementation of - -[IKeyring](../interfaces/verida_keyring._internal_.IKeyring.md).[symDecrypt](../interfaces/verida_keyring._internal_.IKeyring.md#symdecrypt) - -#### Defined in - -[packages/keyring/src/keyring.ts:128](https://github.com/verida/verida-js/blob/5040472/packages/keyring/src/keyring.ts#L128) - -___ - -### symEncrypt - -▸ **symEncrypt**(`data`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Implementation of - -[IKeyring](../interfaces/verida_keyring._internal_.IKeyring.md).[symEncrypt](../interfaces/verida_keyring._internal_.IKeyring.md#symencrypt) - -#### Defined in - -[packages/keyring/src/keyring.ts:123](https://github.com/verida/verida-js/blob/5040472/packages/keyring/src/keyring.ts#L123) - -___ - -### verifySig - -▸ **verifySig**(`data`, `sig`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `string` | -| `sig` | `string` | - -#### Returns - -`Promise`<`boolean`\> - -#### Implementation of - -[IKeyring](../interfaces/verida_keyring._internal_.IKeyring.md).[verifySig](../interfaces/verida_keyring._internal_.IKeyring.md#verifysig) - -#### Defined in - -[packages/keyring/src/keyring.ts:118](https://github.com/verida/verida-js/blob/5040472/packages/keyring/src/keyring.ts#L118) diff --git a/docs/api/verida-js/classes/verida_storage_link.DIDStorageConfig.md b/docs/api/verida-js/classes/verida_storage_link.DIDStorageConfig.md deleted file mode 100644 index 40006d9..0000000 --- a/docs/api/verida-js/classes/verida_storage_link.DIDStorageConfig.md +++ /dev/null @@ -1,47 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/storage-link](../modules/verida_storage_link.md) / DIDStorageConfig - -# Class: DIDStorageConfig - -[@verida/storage-link](../modules/verida_storage_link.md).DIDStorageConfig - -## Table of contents - -### Constructors - -- [constructor](verida_storage_link.DIDStorageConfig.md#constructor) - -### Methods - -- [generate](verida_storage_link.DIDStorageConfig.md#generate) - -## Constructors - -### constructor - -• **new DIDStorageConfig**() - -## Methods - -### generate - -▸ `Static` **generate**(`account`, `contextName`, `servicesConfig`): `Promise`<[`SecureContextConfig`](../interfaces/verida_storage_link._internal_.SecureContextConfig.md)\> - -Generate a storage link for an existing DID - -**`todo:`** Update `account` to specify `AccountInterface` (once moved into its own package) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `account` | `any` | -| `contextName` | `string` | -| `servicesConfig` | [`SecureContextServices`](../interfaces/verida_storage_link._internal_.SecureContextServices.md) | - -#### Returns - -`Promise`<[`SecureContextConfig`](../interfaces/verida_storage_link._internal_.SecureContextConfig.md)\> - -#### Defined in - -[packages/storage-link/src/did-storage-config.ts:13](https://github.com/verida/verida-js/blob/5040472/packages/storage-link/src/did-storage-config.ts#L13) diff --git a/docs/api/verida-js/classes/verida_storage_link.StorageLink.md b/docs/api/verida-js/classes/verida_storage_link.StorageLink.md deleted file mode 100644 index 29e2391..0000000 --- a/docs/api/verida-js/classes/verida_storage_link.StorageLink.md +++ /dev/null @@ -1,207 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/storage-link](../modules/verida_storage_link.md) / StorageLink - -# Class: StorageLink - -[@verida/storage-link](../modules/verida_storage_link.md).StorageLink - -Class representing the link between a DID and Storage context - -## Table of contents - -### Constructors - -- [constructor](verida_storage_link.StorageLink.md#constructor) - -### Methods - -- [\_findHash](verida_storage_link.StorageLink.md#_findhash) -- [buildSecureContexts](verida_storage_link.StorageLink.md#buildsecurecontexts) -- [getLink](verida_storage_link.StorageLink.md#getlink) -- [getLinks](verida_storage_link.StorageLink.md#getlinks) -- [setContextService](verida_storage_link.StorageLink.md#setcontextservice) -- [setLink](verida_storage_link.StorageLink.md#setlink) -- [standardizeUrls](verida_storage_link.StorageLink.md#standardizeurls) -- [unlink](verida_storage_link.StorageLink.md#unlink) - -## Constructors - -### constructor - -• **new StorageLink**() - -## Methods - -### \_findHash - -▸ `Static` **_findHash**(`contexts`, `hash`): `undefined` \| [`SecureContextConfig`](../interfaces/verida_storage_link._internal_.SecureContextConfig.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contexts` | `any`[] | -| `hash` | `string` | - -#### Returns - -`undefined` \| [`SecureContextConfig`](../interfaces/verida_storage_link._internal_.SecureContextConfig.md) - -#### Defined in - -[packages/storage-link/src/storage-link.ts:135](https://github.com/verida/verida-js/blob/5040472/packages/storage-link/src/storage-link.ts#L135) - -___ - -### buildSecureContexts - -▸ `Static` **buildSecureContexts**(`didDocument`): [`SecureContextConfig`](../interfaces/verida_storage_link._internal_.SecureContextConfig.md)[] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `didDocument` | [`default`](verida_storage_link._internal_.default.md) | - -#### Returns - -[`SecureContextConfig`](../interfaces/verida_storage_link._internal_.SecureContextConfig.md)[] - -#### Defined in - -[packages/storage-link/src/storage-link.ts:143](https://github.com/verida/verida-js/blob/5040472/packages/storage-link/src/storage-link.ts#L143) - -___ - -### getLink - -▸ `Static` **getLink**(`didClient`, `did`, `context`, `contextIsName?`): `Promise`<`undefined` \| [`SecureContextConfig`](../interfaces/verida_storage_link._internal_.SecureContextConfig.md)\> - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `didClient` | [`DIDClient`](verida_storage_link._internal_.DIDClient.md) | `undefined` | -| `did` | `string` | `undefined` | -| `context` | `string` | `undefined` | -| `contextIsName` | `boolean` | `true` | - -#### Returns - -`Promise`<`undefined` \| [`SecureContextConfig`](../interfaces/verida_storage_link._internal_.SecureContextConfig.md)\> - -SecureStorageContextConfig | undefined (if not found) - -#### Defined in - -[packages/storage-link/src/storage-link.ts:34](https://github.com/verida/verida-js/blob/5040472/packages/storage-link/src/storage-link.ts#L34) - -___ - -### getLinks - -▸ `Static` **getLinks**(`didClient`, `did`): `Promise`<[`SecureContextConfig`](../interfaces/verida_storage_link._internal_.SecureContextConfig.md)[]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `didClient` | [`DIDClient`](verida_storage_link._internal_.DIDClient.md) | -| `did` | `string` | - -#### Returns - -`Promise`<[`SecureContextConfig`](../interfaces/verida_storage_link._internal_.SecureContextConfig.md)[]\> - -#### Defined in - -[packages/storage-link/src/storage-link.ts:13](https://github.com/verida/verida-js/blob/5040472/packages/storage-link/src/storage-link.ts#L13) - -___ - -### setContextService - -▸ `Static` **setContextService**(`didClient`, `contextName`, `endpointType`, `serverType`, `endpointUris`): `Promise`<[`VdaDidEndpointResponses`](../modules/verida_storage_link._internal_.md#vdadidendpointresponses)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `didClient` | [`DIDClient`](verida_storage_link._internal_.DIDClient.md) | -| `contextName` | `string` | -| `endpointType` | [`SecureContextEndpointType`](../enums/verida_storage_link._internal_.SecureContextEndpointType.md) | -| `serverType` | `string` | -| `endpointUris` | `string`[] | - -#### Returns - -`Promise`<[`VdaDidEndpointResponses`](../modules/verida_storage_link._internal_.md#vdadidendpointresponses)\> - -#### Defined in - -[packages/storage-link/src/storage-link.ts:89](https://github.com/verida/verida-js/blob/5040472/packages/storage-link/src/storage-link.ts#L89) - -___ - -### setLink - -▸ `Static` **setLink**(`didClient`, `storageConfig`, `keyring`, `privateKey`): `Promise`<[`VdaDidEndpointResponses`](../modules/verida_storage_link._internal_.md#vdadidendpointresponses)\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `didClient` | [`DIDClient`](verida_storage_link._internal_.DIDClient.md) | | -| `storageConfig` | [`SecureContextConfig`](../interfaces/verida_storage_link._internal_.SecureContextConfig.md) | (Must have .id as the contextName) | -| `keyring` | [`IKeyring`](../interfaces/verida_storage_link._internal_.IKeyring.md) | - | -| `privateKey` | `string` | - | - -#### Returns - -`Promise`<[`VdaDidEndpointResponses`](../modules/verida_storage_link._internal_.md#vdadidendpointresponses)\> - -#### Defined in - -[packages/storage-link/src/storage-link.ts:51](https://github.com/verida/verida-js/blob/5040472/packages/storage-link/src/storage-link.ts#L51) - -___ - -### standardizeUrls - -▸ `Static` **standardizeUrls**(`endpoints`): [`ServiceEndpoint`](../modules/verida_storage_link._internal_.md#serviceendpoint)[] - -Ensure the URL has a trailing slash and appropriate port set - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `endpoints` | [`ServiceEndpoint`](../modules/verida_storage_link._internal_.md#serviceendpoint)[] | - -#### Returns - -[`ServiceEndpoint`](../modules/verida_storage_link._internal_.md#serviceendpoint)[] - -#### Defined in - -[packages/storage-link/src/storage-link.ts:235](https://github.com/verida/verida-js/blob/5040472/packages/storage-link/src/storage-link.ts#L235) - -___ - -### unlink - -▸ `Static` **unlink**(`didClient`, `contextName`): `Promise`<`boolean` \| [`VdaDidEndpointResponses`](../modules/verida_storage_link._internal_.md#vdadidendpointresponses)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `didClient` | [`DIDClient`](verida_storage_link._internal_.DIDClient.md) | -| `contextName` | `string` | - -#### Returns - -`Promise`<`boolean` \| [`VdaDidEndpointResponses`](../modules/verida_storage_link._internal_.md#vdadidendpointresponses)\> - -#### Defined in - -[packages/storage-link/src/storage-link.ts:113](https://github.com/verida/verida-js/blob/5040472/packages/storage-link/src/storage-link.ts#L113) diff --git a/docs/api/verida-js/classes/verida_storage_link._internal_.BigNumber.md b/docs/api/verida-js/classes/verida_storage_link._internal_.BigNumber.md deleted file mode 100644 index 1af20ca..0000000 --- a/docs/api/verida-js/classes/verida_storage_link._internal_.BigNumber.md +++ /dev/null @@ -1,631 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/storage-link](../modules/verida_storage_link.md) / [](../modules/verida_storage_link._internal_.md) / BigNumber - -# Class: BigNumber - -[@verida/storage-link](../modules/verida_storage_link.md).[](../modules/verida_storage_link._internal_.md).BigNumber - -## Implements - -- [`Hexable`](../interfaces/verida_storage_link._internal_.Hexable.md) - -## Table of contents - -### Constructors - -- [constructor](verida_storage_link._internal_.BigNumber.md#constructor) - -### Properties - -- [\_hex](verida_storage_link._internal_.BigNumber.md#_hex) -- [\_isBigNumber](verida_storage_link._internal_.BigNumber.md#_isbignumber) - -### Methods - -- [abs](verida_storage_link._internal_.BigNumber.md#abs) -- [add](verida_storage_link._internal_.BigNumber.md#add) -- [and](verida_storage_link._internal_.BigNumber.md#and) -- [div](verida_storage_link._internal_.BigNumber.md#div) -- [eq](verida_storage_link._internal_.BigNumber.md#eq) -- [fromTwos](verida_storage_link._internal_.BigNumber.md#fromtwos) -- [gt](verida_storage_link._internal_.BigNumber.md#gt) -- [gte](verida_storage_link._internal_.BigNumber.md#gte) -- [isNegative](verida_storage_link._internal_.BigNumber.md#isnegative) -- [isZero](verida_storage_link._internal_.BigNumber.md#iszero) -- [lt](verida_storage_link._internal_.BigNumber.md#lt) -- [lte](verida_storage_link._internal_.BigNumber.md#lte) -- [mask](verida_storage_link._internal_.BigNumber.md#mask) -- [mod](verida_storage_link._internal_.BigNumber.md#mod) -- [mul](verida_storage_link._internal_.BigNumber.md#mul) -- [or](verida_storage_link._internal_.BigNumber.md#or) -- [pow](verida_storage_link._internal_.BigNumber.md#pow) -- [shl](verida_storage_link._internal_.BigNumber.md#shl) -- [shr](verida_storage_link._internal_.BigNumber.md#shr) -- [sub](verida_storage_link._internal_.BigNumber.md#sub) -- [toBigInt](verida_storage_link._internal_.BigNumber.md#tobigint) -- [toHexString](verida_storage_link._internal_.BigNumber.md#tohexstring) -- [toJSON](verida_storage_link._internal_.BigNumber.md#tojson) -- [toNumber](verida_storage_link._internal_.BigNumber.md#tonumber) -- [toString](verida_storage_link._internal_.BigNumber.md#tostring) -- [toTwos](verida_storage_link._internal_.BigNumber.md#totwos) -- [xor](verida_storage_link._internal_.BigNumber.md#xor) -- [from](verida_storage_link._internal_.BigNumber.md#from) -- [isBigNumber](verida_storage_link._internal_.BigNumber.md#isbignumber) - -## Constructors - -### constructor - -• **new BigNumber**(`constructorGuard`, `hex`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `constructorGuard` | `any` | -| `hex` | `string` | - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:7 - -## Properties - -### \_hex - -• `Readonly` **\_hex**: `string` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:5 - -___ - -### \_isBigNumber - -• `Readonly` **\_isBigNumber**: `boolean` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:6 - -## Methods - -### abs - -▸ **abs**(): [`BigNumber`](verida_storage_link._internal_.BigNumber.md) - -#### Returns - -[`BigNumber`](verida_storage_link._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:10 - -___ - -### add - -▸ **add**(`other`): [`BigNumber`](verida_storage_link._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_storage_link._internal_.md#bignumberish) | - -#### Returns - -[`BigNumber`](verida_storage_link._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:11 - -___ - -### and - -▸ **and**(`other`): [`BigNumber`](verida_storage_link._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_storage_link._internal_.md#bignumberish) | - -#### Returns - -[`BigNumber`](verida_storage_link._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:17 - -___ - -### div - -▸ **div**(`other`): [`BigNumber`](verida_storage_link._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_storage_link._internal_.md#bignumberish) | - -#### Returns - -[`BigNumber`](verida_storage_link._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:13 - -___ - -### eq - -▸ **eq**(`other`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_storage_link._internal_.md#bignumberish) | - -#### Returns - -`boolean` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:23 - -___ - -### fromTwos - -▸ **fromTwos**(`value`): [`BigNumber`](verida_storage_link._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `number` | - -#### Returns - -[`BigNumber`](verida_storage_link._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:8 - -___ - -### gt - -▸ **gt**(`other`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_storage_link._internal_.md#bignumberish) | - -#### Returns - -`boolean` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:26 - -___ - -### gte - -▸ **gte**(`other`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_storage_link._internal_.md#bignumberish) | - -#### Returns - -`boolean` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:27 - -___ - -### isNegative - -▸ **isNegative**(): `boolean` - -#### Returns - -`boolean` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:28 - -___ - -### isZero - -▸ **isZero**(): `boolean` - -#### Returns - -`boolean` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:29 - -___ - -### lt - -▸ **lt**(`other`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_storage_link._internal_.md#bignumberish) | - -#### Returns - -`boolean` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:24 - -___ - -### lte - -▸ **lte**(`other`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_storage_link._internal_.md#bignumberish) | - -#### Returns - -`boolean` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:25 - -___ - -### mask - -▸ **mask**(`value`): [`BigNumber`](verida_storage_link._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `number` | - -#### Returns - -[`BigNumber`](verida_storage_link._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:20 - -___ - -### mod - -▸ **mod**(`other`): [`BigNumber`](verida_storage_link._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_storage_link._internal_.md#bignumberish) | - -#### Returns - -[`BigNumber`](verida_storage_link._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:15 - -___ - -### mul - -▸ **mul**(`other`): [`BigNumber`](verida_storage_link._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_storage_link._internal_.md#bignumberish) | - -#### Returns - -[`BigNumber`](verida_storage_link._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:14 - -___ - -### or - -▸ **or**(`other`): [`BigNumber`](verida_storage_link._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_storage_link._internal_.md#bignumberish) | - -#### Returns - -[`BigNumber`](verida_storage_link._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:18 - -___ - -### pow - -▸ **pow**(`other`): [`BigNumber`](verida_storage_link._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_storage_link._internal_.md#bignumberish) | - -#### Returns - -[`BigNumber`](verida_storage_link._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:16 - -___ - -### shl - -▸ **shl**(`value`): [`BigNumber`](verida_storage_link._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `number` | - -#### Returns - -[`BigNumber`](verida_storage_link._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:21 - -___ - -### shr - -▸ **shr**(`value`): [`BigNumber`](verida_storage_link._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `number` | - -#### Returns - -[`BigNumber`](verida_storage_link._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:22 - -___ - -### sub - -▸ **sub**(`other`): [`BigNumber`](verida_storage_link._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_storage_link._internal_.md#bignumberish) | - -#### Returns - -[`BigNumber`](verida_storage_link._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:12 - -___ - -### toBigInt - -▸ **toBigInt**(): `bigint` - -#### Returns - -`bigint` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:31 - -___ - -### toHexString - -▸ **toHexString**(): `string` - -#### Returns - -`string` - -#### Implementation of - -[Hexable](../interfaces/verida_storage_link._internal_.Hexable.md).[toHexString](../interfaces/verida_storage_link._internal_.Hexable.md#tohexstring) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:33 - -___ - -### toJSON - -▸ **toJSON**(`key?`): `any` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `key?` | `string` | - -#### Returns - -`any` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:34 - -___ - -### toNumber - -▸ **toNumber**(): `number` - -#### Returns - -`number` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:30 - -___ - -### toString - -▸ **toString**(): `string` - -#### Returns - -`string` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:32 - -___ - -### toTwos - -▸ **toTwos**(`value`): [`BigNumber`](verida_storage_link._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `number` | - -#### Returns - -[`BigNumber`](verida_storage_link._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:9 - -___ - -### xor - -▸ **xor**(`other`): [`BigNumber`](verida_storage_link._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_storage_link._internal_.md#bignumberish) | - -#### Returns - -[`BigNumber`](verida_storage_link._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:19 - -___ - -### from - -▸ `Static` **from**(`value`): [`BigNumber`](verida_storage_link._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `any` | - -#### Returns - -[`BigNumber`](verida_storage_link._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:35 - -___ - -### isBigNumber - -▸ `Static` **isBigNumber**(`value`): value is BigNumber - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `any` | - -#### Returns - -value is BigNumber - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:36 diff --git a/docs/api/verida-js/classes/verida_storage_link._internal_.DIDClient.md b/docs/api/verida-js/classes/verida_storage_link._internal_.DIDClient.md deleted file mode 100644 index fbb6432..0000000 --- a/docs/api/verida-js/classes/verida_storage_link._internal_.DIDClient.md +++ /dev/null @@ -1,305 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/storage-link](../modules/verida_storage_link.md) / [](../modules/verida_storage_link._internal_.md) / DIDClient - -# Class: DIDClient - -[@verida/storage-link](../modules/verida_storage_link.md).[](../modules/verida_storage_link._internal_.md).DIDClient - -## Implements - -- [`IDIDClient`](../interfaces/verida_storage_link._internal_.IDIDClient.md) - -## Table of contents - -### Constructors - -- [constructor](verida_storage_link._internal_.DIDClient.md#constructor) - -### Properties - -- [config](verida_storage_link._internal_.DIDClient.md#config) -- [defaultEndpoints](verida_storage_link._internal_.DIDClient.md#defaultendpoints) -- [didResolver](verida_storage_link._internal_.DIDClient.md#didresolver) -- [endpointErrors](verida_storage_link._internal_.DIDClient.md#endpointerrors) -- [vdaDid](verida_storage_link._internal_.DIDClient.md#vdadid) -- [veridaWallet](verida_storage_link._internal_.DIDClient.md#veridawallet) - -### Methods - -- [authenticate](verida_storage_link._internal_.DIDClient.md#authenticate) -- [authenticated](verida_storage_link._internal_.DIDClient.md#authenticated) -- [destroy](verida_storage_link._internal_.DIDClient.md#destroy) -- [get](verida_storage_link._internal_.DIDClient.md#get) -- [getDid](verida_storage_link._internal_.DIDClient.md#getdid) -- [getLastEndpointErrors](verida_storage_link._internal_.DIDClient.md#getlastendpointerrors) -- [getPublicKey](verida_storage_link._internal_.DIDClient.md#getpublickey) -- [getRpcUrl](verida_storage_link._internal_.DIDClient.md#getrpcurl) -- [save](verida_storage_link._internal_.DIDClient.md#save) - -## Constructors - -### constructor - -• **new DIDClient**(`config`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | [`DIDClientConfig`](../interfaces/verida_storage_link._internal_.DIDClientConfig.md) | - -#### Defined in - -packages/did-client/dist/did-client.d.ts:10 - -## Properties - -### config - -• `Private` **config**: `any` - -#### Defined in - -packages/did-client/dist/did-client.d.ts:4 - -___ - -### defaultEndpoints - -• `Private` `Optional` **defaultEndpoints**: `any` - -#### Defined in - -packages/did-client/dist/did-client.d.ts:8 - -___ - -### didResolver - -• `Private` **didResolver**: `any` - -#### Defined in - -packages/did-client/dist/did-client.d.ts:5 - -___ - -### endpointErrors - -• `Private` `Optional` **endpointErrors**: `any` - -#### Defined in - -packages/did-client/dist/did-client.d.ts:9 - -___ - -### vdaDid - -• `Private` `Optional` **vdaDid**: `any` - -#### Defined in - -packages/did-client/dist/did-client.d.ts:6 - -___ - -### veridaWallet - -• `Private` **veridaWallet**: `any` - -#### Defined in - -packages/did-client/dist/did-client.d.ts:7 - -## Methods - -### authenticate - -▸ **authenticate**(`veridaPrivateKey`, `callType`, `web3Config`, `defaultEndpoints`): `void` - -Unlock save() function by providing verida signing key. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `veridaPrivateKey` | `string` | Private key of a Verida Account. Used to sign transactions in the DID Registry to verify the request originated from the DID owner / controller | -| `callType` | [`Web3CallType`](../modules/verida_storage_link._internal_.md#web3calltype) | Blockchain interaction mode. 'web3' \| 'gasless' | -| `web3Config` | [`Web3SelfTransactionConfigPart`](../interfaces/verida_storage_link._internal_.Web3SelfTransactionConfigPart.md) \| [`Web3MetaTransactionConfig`](../interfaces/verida_storage_link._internal_.Web3MetaTransactionConfig.md) | Web3 configuration. If `web3`, you must provide `privateKey` (MATIC private key that will pay for gas). If `gasless` you must specify `endpointUrl` (URL of the meta transaction server) and any appropriate `serverConfig` and `postConfig`. | -| `defaultEndpoints` | `string`[] | - | - -#### Returns - -`void` - -#### Implementation of - -[IDIDClient](../interfaces/verida_storage_link._internal_.IDIDClient.md).[authenticate](../interfaces/verida_storage_link._internal_.IDIDClient.md#authenticate) - -#### Defined in - -packages/did-client/dist/did-client.d.ts:19 - -___ - -### authenticated - -▸ **authenticated**(): `boolean` - -#### Returns - -`boolean` - -#### Implementation of - -[IDIDClient](../interfaces/verida_storage_link._internal_.IDIDClient.md).[authenticated](../interfaces/verida_storage_link._internal_.IDIDClient.md#authenticated) - -#### Defined in - -packages/did-client/dist/did-client.d.ts:20 - -___ - -### destroy - -▸ **destroy**(): `Promise`<[`VdaDidEndpointResponses`](../modules/verida_storage_link._internal_.md#vdadidendpointresponses)\> - -Destroy this DID - -Note: This can not be reversed and is written to the blockchain - -#### Returns - -`Promise`<[`VdaDidEndpointResponses`](../modules/verida_storage_link._internal_.md#vdadidendpointresponses)\> - -#### Defined in - -packages/did-client/dist/did-client.d.ts:28 - -___ - -### get - -▸ **get**(`did`): `Promise`<[`default`](verida_storage_link._internal_.default.md)\> - -Get original document loaded from blockchain. Creates a new document if it didn't exist - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did` | `string` | - -#### Returns - -`Promise`<[`default`](verida_storage_link._internal_.default.md)\> - -DID Document instance - -#### Implementation of - -[IDIDClient](../interfaces/verida_storage_link._internal_.IDIDClient.md).[get](../interfaces/verida_storage_link._internal_.IDIDClient.md#get) - -#### Defined in - -packages/did-client/dist/did-client.d.ts:42 - -___ - -### getDid - -▸ **getDid**(): `undefined` \| `string` - -#### Returns - -`undefined` \| `string` - -#### Implementation of - -[IDIDClient](../interfaces/verida_storage_link._internal_.IDIDClient.md).[getDid](../interfaces/verida_storage_link._internal_.IDIDClient.md#getdid) - -#### Defined in - -packages/did-client/dist/did-client.d.ts:21 - -___ - -### getLastEndpointErrors - -▸ **getLastEndpointErrors**(): [`VdaDidEndpointResponses`](../modules/verida_storage_link._internal_.md#vdadidendpointresponses) - -#### Returns - -[`VdaDidEndpointResponses`](../modules/verida_storage_link._internal_.md#vdadidendpointresponses) - -#### Implementation of - -[IDIDClient](../interfaces/verida_storage_link._internal_.IDIDClient.md).[getLastEndpointErrors](../interfaces/verida_storage_link._internal_.IDIDClient.md#getlastendpointerrors) - -#### Defined in - -packages/did-client/dist/did-client.d.ts:36 - -___ - -### getPublicKey - -▸ **getPublicKey**(): `undefined` \| `string` - -#### Returns - -`undefined` \| `string` - -#### Implementation of - -[IDIDClient](../interfaces/verida_storage_link._internal_.IDIDClient.md).[getPublicKey](../interfaces/verida_storage_link._internal_.IDIDClient.md#getpublickey) - -#### Defined in - -packages/did-client/dist/did-client.d.ts:22 - -___ - -### getRpcUrl - -▸ **getRpcUrl**(): `string` - -#### Returns - -`string` - -#### Implementation of - -[IDIDClient](../interfaces/verida_storage_link._internal_.IDIDClient.md).[getRpcUrl](../interfaces/verida_storage_link._internal_.IDIDClient.md#getrpcurl) - -#### Defined in - -packages/did-client/dist/did-client.d.ts:11 - -___ - -### save - -▸ **save**(`document`): `Promise`<[`VdaDidEndpointResponses`](../modules/verida_storage_link._internal_.md#vdadidendpointresponses)\> - -Save DIDDocument to the chain - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `document` | [`default`](verida_storage_link._internal_.default.md) | Updated DIDDocuent | - -#### Returns - -`Promise`<[`VdaDidEndpointResponses`](../modules/verida_storage_link._internal_.md#vdadidendpointresponses)\> - -true if success. - -#### Implementation of - -[IDIDClient](../interfaces/verida_storage_link._internal_.IDIDClient.md).[save](../interfaces/verida_storage_link._internal_.IDIDClient.md#save) - -#### Defined in - -packages/did-client/dist/did-client.d.ts:35 diff --git a/docs/api/verida-js/classes/verida_storage_link._internal_.Description.md b/docs/api/verida-js/classes/verida_storage_link._internal_.Description.md deleted file mode 100644 index 6e6be36..0000000 --- a/docs/api/verida-js/classes/verida_storage_link._internal_.Description.md +++ /dev/null @@ -1,45 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/storage-link](../modules/verida_storage_link.md) / [](../modules/verida_storage_link._internal_.md) / Description - -# Class: Description - -[@verida/storage-link](../modules/verida_storage_link.md).[](../modules/verida_storage_link._internal_.md).Description - -## Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `any` | - -## Hierarchy - -- **`Description`** - - ↳ [`ForkEvent`](verida_storage_link._internal_.ForkEvent.md) - -## Table of contents - -### Constructors - -- [constructor](verida_storage_link._internal_.Description.md#constructor) - -## Constructors - -### constructor - -• **new Description**<`T`\>(`info`) - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `any` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `info` | { [K in string \| number \| symbol]: T[K] } | - -#### Defined in - -node_modules/@ethersproject/properties/lib/index.d.ts:13 diff --git a/docs/api/verida-js/classes/verida_storage_link._internal_.ForkEvent.md b/docs/api/verida-js/classes/verida_storage_link._internal_.ForkEvent.md deleted file mode 100644 index 5f32a06..0000000 --- a/docs/api/verida-js/classes/verida_storage_link._internal_.ForkEvent.md +++ /dev/null @@ -1,86 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/storage-link](../modules/verida_storage_link.md) / [](../modules/verida_storage_link._internal_.md) / ForkEvent - -# Class: ForkEvent - -[@verida/storage-link](../modules/verida_storage_link.md).[](../modules/verida_storage_link._internal_.md).ForkEvent - -## Hierarchy - -- [`Description`](verida_storage_link._internal_.Description.md) - - ↳ **`ForkEvent`** - -## Table of contents - -### Constructors - -- [constructor](verida_storage_link._internal_.ForkEvent.md#constructor) - -### Properties - -- [\_isForkEvent](verida_storage_link._internal_.ForkEvent.md#_isforkevent) -- [expiry](verida_storage_link._internal_.ForkEvent.md#expiry) - -### Methods - -- [isForkEvent](verida_storage_link._internal_.ForkEvent.md#isforkevent) - -## Constructors - -### constructor - -• **new ForkEvent**(`info`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `info` | `Object` | - -#### Inherited from - -[Description](verida_storage_link._internal_.Description.md).[constructor](verida_storage_link._internal_.Description.md#constructor) - -#### Defined in - -node_modules/@ethersproject/properties/lib/index.d.ts:13 - -## Properties - -### \_isForkEvent - -• `Optional` `Readonly` **\_isForkEvent**: `boolean` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:103 - -___ - -### expiry - -• `Readonly` **expiry**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:102 - -## Methods - -### isForkEvent - -▸ `Static` **isForkEvent**(`value`): value is ForkEvent - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `any` | - -#### Returns - -value is ForkEvent - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:104 diff --git a/docs/api/verida-js/classes/verida_storage_link._internal_.Provider.md b/docs/api/verida-js/classes/verida_storage_link._internal_.Provider.md deleted file mode 100644 index 2c0bc68..0000000 --- a/docs/api/verida-js/classes/verida_storage_link._internal_.Provider.md +++ /dev/null @@ -1,645 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/storage-link](../modules/verida_storage_link.md) / [](../modules/verida_storage_link._internal_.md) / Provider - -# Class: Provider - -[@verida/storage-link](../modules/verida_storage_link.md).[](../modules/verida_storage_link._internal_.md).Provider - -## Implements - -- [`OnceBlockable`](../interfaces/verida_storage_link._internal_.OnceBlockable.md) - -## Table of contents - -### Constructors - -- [constructor](verida_storage_link._internal_.Provider.md#constructor) - -### Properties - -- [\_isProvider](verida_storage_link._internal_.Provider.md#_isprovider) - -### Methods - -- [addListener](verida_storage_link._internal_.Provider.md#addlistener) -- [call](verida_storage_link._internal_.Provider.md#call) -- [emit](verida_storage_link._internal_.Provider.md#emit) -- [estimateGas](verida_storage_link._internal_.Provider.md#estimategas) -- [getBalance](verida_storage_link._internal_.Provider.md#getbalance) -- [getBlock](verida_storage_link._internal_.Provider.md#getblock) -- [getBlockNumber](verida_storage_link._internal_.Provider.md#getblocknumber) -- [getBlockWithTransactions](verida_storage_link._internal_.Provider.md#getblockwithtransactions) -- [getCode](verida_storage_link._internal_.Provider.md#getcode) -- [getFeeData](verida_storage_link._internal_.Provider.md#getfeedata) -- [getGasPrice](verida_storage_link._internal_.Provider.md#getgasprice) -- [getLogs](verida_storage_link._internal_.Provider.md#getlogs) -- [getNetwork](verida_storage_link._internal_.Provider.md#getnetwork) -- [getStorageAt](verida_storage_link._internal_.Provider.md#getstorageat) -- [getTransaction](verida_storage_link._internal_.Provider.md#gettransaction) -- [getTransactionCount](verida_storage_link._internal_.Provider.md#gettransactioncount) -- [getTransactionReceipt](verida_storage_link._internal_.Provider.md#gettransactionreceipt) -- [listenerCount](verida_storage_link._internal_.Provider.md#listenercount) -- [listeners](verida_storage_link._internal_.Provider.md#listeners) -- [lookupAddress](verida_storage_link._internal_.Provider.md#lookupaddress) -- [off](verida_storage_link._internal_.Provider.md#off) -- [on](verida_storage_link._internal_.Provider.md#on) -- [once](verida_storage_link._internal_.Provider.md#once) -- [removeAllListeners](verida_storage_link._internal_.Provider.md#removealllisteners) -- [removeListener](verida_storage_link._internal_.Provider.md#removelistener) -- [resolveName](verida_storage_link._internal_.Provider.md#resolvename) -- [sendTransaction](verida_storage_link._internal_.Provider.md#sendtransaction) -- [waitForTransaction](verida_storage_link._internal_.Provider.md#waitfortransaction) -- [isProvider](verida_storage_link._internal_.Provider.md#isprovider) - -## Constructors - -### constructor - -• **new Provider**() - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:153 - -## Properties - -### \_isProvider - -• `Readonly` **\_isProvider**: `boolean` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:152 - -## Methods - -### addListener - -▸ **addListener**(`eventName`, `listener`): [`Provider`](verida_storage_link._internal_.Provider.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | [`EventType`](../modules/verida_storage_link._internal_.md#eventtype) | -| `listener` | [`Listener`](../modules/verida_storage_link._internal_.md#listener) | - -#### Returns - -[`Provider`](verida_storage_link._internal_.Provider.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:149 - -___ - -### call - -▸ `Abstract` **call**(`transaction`, `blockTag?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transaction` | [`Deferrable`](../modules/verida_storage_link._internal_.md#deferrable)<[`TransactionRequest`](../modules/verida_storage_link._internal_.md#transactionrequest)\> | -| `blockTag?` | [`BlockTag`](../modules/verida_storage_link._internal_.md#blocktag) \| `Promise`<[`BlockTag`](../modules/verida_storage_link._internal_.md#blocktag)\> | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:133 - -___ - -### emit - -▸ `Abstract` **emit**(`eventName`, ...`args`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | [`EventType`](../modules/verida_storage_link._internal_.md#eventtype) | -| `...args` | `any`[] | - -#### Returns - -`boolean` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:144 - -___ - -### estimateGas - -▸ `Abstract` **estimateGas**(`transaction`): `Promise`<[`BigNumber`](verida_storage_link._internal_.BigNumber.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transaction` | [`Deferrable`](../modules/verida_storage_link._internal_.md#deferrable)<[`TransactionRequest`](../modules/verida_storage_link._internal_.md#transactionrequest)\> | - -#### Returns - -`Promise`<[`BigNumber`](verida_storage_link._internal_.BigNumber.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:134 - -___ - -### getBalance - -▸ `Abstract` **getBalance**(`addressOrName`, `blockTag?`): `Promise`<[`BigNumber`](verida_storage_link._internal_.BigNumber.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `addressOrName` | `string` \| `Promise`<`string`\> | -| `blockTag?` | [`BlockTag`](../modules/verida_storage_link._internal_.md#blocktag) \| `Promise`<[`BlockTag`](../modules/verida_storage_link._internal_.md#blocktag)\> | - -#### Returns - -`Promise`<[`BigNumber`](verida_storage_link._internal_.BigNumber.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:128 - -___ - -### getBlock - -▸ `Abstract` **getBlock**(`blockHashOrBlockTag`): `Promise`<[`Block`](../interfaces/verida_storage_link._internal_.Block.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `blockHashOrBlockTag` | [`BlockTag`](../modules/verida_storage_link._internal_.md#blocktag) \| `Promise`<[`BlockTag`](../modules/verida_storage_link._internal_.md#blocktag)\> | - -#### Returns - -`Promise`<[`Block`](../interfaces/verida_storage_link._internal_.Block.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:135 - -___ - -### getBlockNumber - -▸ `Abstract` **getBlockNumber**(): `Promise`<`number`\> - -#### Returns - -`Promise`<`number`\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:125 - -___ - -### getBlockWithTransactions - -▸ `Abstract` **getBlockWithTransactions**(`blockHashOrBlockTag`): `Promise`<[`BlockWithTransactions`](../interfaces/verida_storage_link._internal_.BlockWithTransactions.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `blockHashOrBlockTag` | [`BlockTag`](../modules/verida_storage_link._internal_.md#blocktag) \| `Promise`<[`BlockTag`](../modules/verida_storage_link._internal_.md#blocktag)\> | - -#### Returns - -`Promise`<[`BlockWithTransactions`](../interfaces/verida_storage_link._internal_.BlockWithTransactions.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:136 - -___ - -### getCode - -▸ `Abstract` **getCode**(`addressOrName`, `blockTag?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `addressOrName` | `string` \| `Promise`<`string`\> | -| `blockTag?` | [`BlockTag`](../modules/verida_storage_link._internal_.md#blocktag) \| `Promise`<[`BlockTag`](../modules/verida_storage_link._internal_.md#blocktag)\> | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:130 - -___ - -### getFeeData - -▸ **getFeeData**(): `Promise`<[`FeeData`](../interfaces/verida_storage_link._internal_.FeeData.md)\> - -#### Returns - -`Promise`<[`FeeData`](../interfaces/verida_storage_link._internal_.FeeData.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:127 - -___ - -### getGasPrice - -▸ `Abstract` **getGasPrice**(): `Promise`<[`BigNumber`](verida_storage_link._internal_.BigNumber.md)\> - -#### Returns - -`Promise`<[`BigNumber`](verida_storage_link._internal_.BigNumber.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:126 - -___ - -### getLogs - -▸ `Abstract` **getLogs**(`filter`): `Promise`<[`Log`](../interfaces/verida_storage_link._internal_.Log.md)[]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `filter` | [`Filter`](../interfaces/verida_storage_link._internal_.Filter.md) | - -#### Returns - -`Promise`<[`Log`](../interfaces/verida_storage_link._internal_.Log.md)[]\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:139 - -___ - -### getNetwork - -▸ `Abstract` **getNetwork**(): `Promise`<[`Network`](../modules/verida_storage_link._internal_.md#network)\> - -#### Returns - -`Promise`<[`Network`](../modules/verida_storage_link._internal_.md#network)\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:124 - -___ - -### getStorageAt - -▸ `Abstract` **getStorageAt**(`addressOrName`, `position`, `blockTag?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `addressOrName` | `string` \| `Promise`<`string`\> | -| `position` | [`BigNumberish`](../modules/verida_storage_link._internal_.md#bignumberish) \| `Promise`<[`BigNumberish`](../modules/verida_storage_link._internal_.md#bignumberish)\> | -| `blockTag?` | [`BlockTag`](../modules/verida_storage_link._internal_.md#blocktag) \| `Promise`<[`BlockTag`](../modules/verida_storage_link._internal_.md#blocktag)\> | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:131 - -___ - -### getTransaction - -▸ `Abstract` **getTransaction**(`transactionHash`): `Promise`<[`TransactionResponse`](../interfaces/verida_storage_link._internal_.TransactionResponse.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transactionHash` | `string` | - -#### Returns - -`Promise`<[`TransactionResponse`](../interfaces/verida_storage_link._internal_.TransactionResponse.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:137 - -___ - -### getTransactionCount - -▸ `Abstract` **getTransactionCount**(`addressOrName`, `blockTag?`): `Promise`<`number`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `addressOrName` | `string` \| `Promise`<`string`\> | -| `blockTag?` | [`BlockTag`](../modules/verida_storage_link._internal_.md#blocktag) \| `Promise`<[`BlockTag`](../modules/verida_storage_link._internal_.md#blocktag)\> | - -#### Returns - -`Promise`<`number`\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:129 - -___ - -### getTransactionReceipt - -▸ `Abstract` **getTransactionReceipt**(`transactionHash`): `Promise`<[`TransactionReceipt`](../interfaces/verida_storage_link._internal_.TransactionReceipt.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transactionHash` | `string` | - -#### Returns - -`Promise`<[`TransactionReceipt`](../interfaces/verida_storage_link._internal_.TransactionReceipt.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:138 - -___ - -### listenerCount - -▸ `Abstract` **listenerCount**(`eventName?`): `number` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName?` | [`EventType`](../modules/verida_storage_link._internal_.md#eventtype) | - -#### Returns - -`number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:145 - -___ - -### listeners - -▸ `Abstract` **listeners**(`eventName?`): [`Listener`](../modules/verida_storage_link._internal_.md#listener)[] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName?` | [`EventType`](../modules/verida_storage_link._internal_.md#eventtype) | - -#### Returns - -[`Listener`](../modules/verida_storage_link._internal_.md#listener)[] - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:146 - -___ - -### lookupAddress - -▸ `Abstract` **lookupAddress**(`address`): `Promise`<``null`` \| `string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `address` | `string` \| `Promise`<`string`\> | - -#### Returns - -`Promise`<``null`` \| `string`\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:141 - -___ - -### off - -▸ `Abstract` **off**(`eventName`, `listener?`): [`Provider`](verida_storage_link._internal_.Provider.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | [`EventType`](../modules/verida_storage_link._internal_.md#eventtype) | -| `listener?` | [`Listener`](../modules/verida_storage_link._internal_.md#listener) | - -#### Returns - -[`Provider`](verida_storage_link._internal_.Provider.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:147 - -___ - -### on - -▸ `Abstract` **on**(`eventName`, `listener`): [`Provider`](verida_storage_link._internal_.Provider.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | [`EventType`](../modules/verida_storage_link._internal_.md#eventtype) | -| `listener` | [`Listener`](../modules/verida_storage_link._internal_.md#listener) | - -#### Returns - -[`Provider`](verida_storage_link._internal_.Provider.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:142 - -___ - -### once - -▸ `Abstract` **once**(`eventName`, `listener`): [`Provider`](verida_storage_link._internal_.Provider.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | [`EventType`](../modules/verida_storage_link._internal_.md#eventtype) | -| `listener` | [`Listener`](../modules/verida_storage_link._internal_.md#listener) | - -#### Returns - -[`Provider`](verida_storage_link._internal_.Provider.md) - -#### Implementation of - -[OnceBlockable](../interfaces/verida_storage_link._internal_.OnceBlockable.md).[once](../interfaces/verida_storage_link._internal_.OnceBlockable.md#once) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:143 - -___ - -### removeAllListeners - -▸ `Abstract` **removeAllListeners**(`eventName?`): [`Provider`](verida_storage_link._internal_.Provider.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName?` | [`EventType`](../modules/verida_storage_link._internal_.md#eventtype) | - -#### Returns - -[`Provider`](verida_storage_link._internal_.Provider.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:148 - -___ - -### removeListener - -▸ **removeListener**(`eventName`, `listener`): [`Provider`](verida_storage_link._internal_.Provider.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | [`EventType`](../modules/verida_storage_link._internal_.md#eventtype) | -| `listener` | [`Listener`](../modules/verida_storage_link._internal_.md#listener) | - -#### Returns - -[`Provider`](verida_storage_link._internal_.Provider.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:150 - -___ - -### resolveName - -▸ `Abstract` **resolveName**(`name`): `Promise`<``null`` \| `string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` \| `Promise`<`string`\> | - -#### Returns - -`Promise`<``null`` \| `string`\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:140 - -___ - -### sendTransaction - -▸ `Abstract` **sendTransaction**(`signedTransaction`): `Promise`<[`TransactionResponse`](../interfaces/verida_storage_link._internal_.TransactionResponse.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `signedTransaction` | `string` \| `Promise`<`string`\> | - -#### Returns - -`Promise`<[`TransactionResponse`](../interfaces/verida_storage_link._internal_.TransactionResponse.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:132 - -___ - -### waitForTransaction - -▸ `Abstract` **waitForTransaction**(`transactionHash`, `confirmations?`, `timeout?`): `Promise`<[`TransactionReceipt`](../interfaces/verida_storage_link._internal_.TransactionReceipt.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transactionHash` | `string` | -| `confirmations?` | `number` | -| `timeout?` | `number` | - -#### Returns - -`Promise`<[`TransactionReceipt`](../interfaces/verida_storage_link._internal_.TransactionReceipt.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:151 - -___ - -### isProvider - -▸ `Static` **isProvider**(`value`): value is Provider - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `any` | - -#### Returns - -value is Provider - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:154 diff --git a/docs/api/verida-js/classes/verida_storage_link._internal_.Signer.md b/docs/api/verida-js/classes/verida_storage_link._internal_.Signer.md deleted file mode 100644 index 532c31c..0000000 --- a/docs/api/verida-js/classes/verida_storage_link._internal_.Signer.md +++ /dev/null @@ -1,383 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/storage-link](../modules/verida_storage_link.md) / [](../modules/verida_storage_link._internal_.md) / Signer - -# Class: Signer - -[@verida/storage-link](../modules/verida_storage_link.md).[](../modules/verida_storage_link._internal_.md).Signer - -## Table of contents - -### Constructors - -- [constructor](verida_storage_link._internal_.Signer.md#constructor) - -### Properties - -- [\_isSigner](verida_storage_link._internal_.Signer.md#_issigner) -- [provider](verida_storage_link._internal_.Signer.md#provider) - -### Methods - -- [\_checkProvider](verida_storage_link._internal_.Signer.md#_checkprovider) -- [call](verida_storage_link._internal_.Signer.md#call) -- [checkTransaction](verida_storage_link._internal_.Signer.md#checktransaction) -- [connect](verida_storage_link._internal_.Signer.md#connect) -- [estimateGas](verida_storage_link._internal_.Signer.md#estimategas) -- [getAddress](verida_storage_link._internal_.Signer.md#getaddress) -- [getBalance](verida_storage_link._internal_.Signer.md#getbalance) -- [getChainId](verida_storage_link._internal_.Signer.md#getchainid) -- [getFeeData](verida_storage_link._internal_.Signer.md#getfeedata) -- [getGasPrice](verida_storage_link._internal_.Signer.md#getgasprice) -- [getTransactionCount](verida_storage_link._internal_.Signer.md#gettransactioncount) -- [populateTransaction](verida_storage_link._internal_.Signer.md#populatetransaction) -- [resolveName](verida_storage_link._internal_.Signer.md#resolvename) -- [sendTransaction](verida_storage_link._internal_.Signer.md#sendtransaction) -- [signMessage](verida_storage_link._internal_.Signer.md#signmessage) -- [signTransaction](verida_storage_link._internal_.Signer.md#signtransaction) -- [isSigner](verida_storage_link._internal_.Signer.md#issigner) - -## Constructors - -### constructor - -• **new Signer**() - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:30 - -## Properties - -### \_isSigner - -• `Readonly` **\_isSigner**: `boolean` - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:29 - -___ - -### provider - -• `Optional` `Readonly` **provider**: [`Provider`](verida_storage_link._internal_.Provider.md) - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:24 - -## Methods - -### \_checkProvider - -▸ **_checkProvider**(`operation?`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `operation?` | `string` | - -#### Returns - -`void` - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:42 - -___ - -### call - -▸ **call**(`transaction`, `blockTag?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transaction` | [`Deferrable`](../modules/verida_storage_link._internal_.md#deferrable)<[`TransactionRequest`](../modules/verida_storage_link._internal_.md#transactionrequest)\> | -| `blockTag?` | [`BlockTag`](../modules/verida_storage_link._internal_.md#blocktag) | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:34 - -___ - -### checkTransaction - -▸ **checkTransaction**(`transaction`): [`Deferrable`](../modules/verida_storage_link._internal_.md#deferrable)<[`TransactionRequest`](../modules/verida_storage_link._internal_.md#transactionrequest)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transaction` | [`Deferrable`](../modules/verida_storage_link._internal_.md#deferrable)<[`TransactionRequest`](../modules/verida_storage_link._internal_.md#transactionrequest)\> | - -#### Returns - -[`Deferrable`](../modules/verida_storage_link._internal_.md#deferrable)<[`TransactionRequest`](../modules/verida_storage_link._internal_.md#transactionrequest)\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:40 - -___ - -### connect - -▸ `Abstract` **connect**(`provider`): [`Signer`](verida_storage_link._internal_.Signer.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `provider` | [`Provider`](verida_storage_link._internal_.Provider.md) | - -#### Returns - -[`Signer`](verida_storage_link._internal_.Signer.md) - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:28 - -___ - -### estimateGas - -▸ **estimateGas**(`transaction`): `Promise`<[`BigNumber`](verida_storage_link._internal_.BigNumber.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transaction` | [`Deferrable`](../modules/verida_storage_link._internal_.md#deferrable)<[`TransactionRequest`](../modules/verida_storage_link._internal_.md#transactionrequest)\> | - -#### Returns - -`Promise`<[`BigNumber`](verida_storage_link._internal_.BigNumber.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:33 - -___ - -### getAddress - -▸ `Abstract` **getAddress**(): `Promise`<`string`\> - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:25 - -___ - -### getBalance - -▸ **getBalance**(`blockTag?`): `Promise`<[`BigNumber`](verida_storage_link._internal_.BigNumber.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `blockTag?` | [`BlockTag`](../modules/verida_storage_link._internal_.md#blocktag) | - -#### Returns - -`Promise`<[`BigNumber`](verida_storage_link._internal_.BigNumber.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:31 - -___ - -### getChainId - -▸ **getChainId**(): `Promise`<`number`\> - -#### Returns - -`Promise`<`number`\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:36 - -___ - -### getFeeData - -▸ **getFeeData**(): `Promise`<[`FeeData`](../interfaces/verida_storage_link._internal_.FeeData.md)\> - -#### Returns - -`Promise`<[`FeeData`](../interfaces/verida_storage_link._internal_.FeeData.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:38 - -___ - -### getGasPrice - -▸ **getGasPrice**(): `Promise`<[`BigNumber`](verida_storage_link._internal_.BigNumber.md)\> - -#### Returns - -`Promise`<[`BigNumber`](verida_storage_link._internal_.BigNumber.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:37 - -___ - -### getTransactionCount - -▸ **getTransactionCount**(`blockTag?`): `Promise`<`number`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `blockTag?` | [`BlockTag`](../modules/verida_storage_link._internal_.md#blocktag) | - -#### Returns - -`Promise`<`number`\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:32 - -___ - -### populateTransaction - -▸ **populateTransaction**(`transaction`): `Promise`<[`TransactionRequest`](../modules/verida_storage_link._internal_.md#transactionrequest)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transaction` | [`Deferrable`](../modules/verida_storage_link._internal_.md#deferrable)<[`TransactionRequest`](../modules/verida_storage_link._internal_.md#transactionrequest)\> | - -#### Returns - -`Promise`<[`TransactionRequest`](../modules/verida_storage_link._internal_.md#transactionrequest)\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:41 - -___ - -### resolveName - -▸ **resolveName**(`name`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:39 - -___ - -### sendTransaction - -▸ **sendTransaction**(`transaction`): `Promise`<[`TransactionResponse`](../interfaces/verida_storage_link._internal_.TransactionResponse.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transaction` | [`Deferrable`](../modules/verida_storage_link._internal_.md#deferrable)<[`TransactionRequest`](../modules/verida_storage_link._internal_.md#transactionrequest)\> | - -#### Returns - -`Promise`<[`TransactionResponse`](../interfaces/verida_storage_link._internal_.TransactionResponse.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:35 - -___ - -### signMessage - -▸ `Abstract` **signMessage**(`message`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `message` | `string` \| [`Bytes`](../modules/verida_storage_link._internal_.md#bytes) | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:26 - -___ - -### signTransaction - -▸ `Abstract` **signTransaction**(`transaction`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transaction` | [`Deferrable`](../modules/verida_storage_link._internal_.md#deferrable)<[`TransactionRequest`](../modules/verida_storage_link._internal_.md#transactionrequest)\> | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:27 - -___ - -### isSigner - -▸ `Static` **isSigner**(`value`): value is Signer - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `any` | - -#### Returns - -value is Signer - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:43 diff --git a/docs/api/verida-js/classes/verida_storage_link._internal_.default-1.md b/docs/api/verida-js/classes/verida_storage_link._internal_.default-1.md deleted file mode 100644 index aba6ce6..0000000 --- a/docs/api/verida-js/classes/verida_storage_link._internal_.default-1.md +++ /dev/null @@ -1,378 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/storage-link](../modules/verida_storage_link.md) / [](../modules/verida_storage_link._internal_.md) / default - -# Class: default - -[@verida/storage-link](../modules/verida_storage_link.md).[](../modules/verida_storage_link._internal_.md).default - -## Table of contents - -### Constructors - -- [constructor](verida_storage_link._internal_.default-1.md#constructor) - -### Properties - -- [doc](verida_storage_link._internal_.default-1.md#doc) -- [errors](verida_storage_link._internal_.default-1.md#errors) -- [getProofData](verida_storage_link._internal_.default-1.md#getproofdata) - -### Accessors - -- [id](verida_storage_link._internal_.default-1.md#id) - -### Methods - -- [addContext](verida_storage_link._internal_.default-1.md#addcontext) -- [addContextAsymKey](verida_storage_link._internal_.default-1.md#addcontextasymkey) -- [addContextService](verida_storage_link._internal_.default-1.md#addcontextservice) -- [addContextSignKey](verida_storage_link._internal_.default-1.md#addcontextsignkey) -- [export](verida_storage_link._internal_.default-1.md#export) -- [getErrors](verida_storage_link._internal_.default-1.md#geterrors) -- [import](verida_storage_link._internal_.default-1.md#import) -- [locateServiceEndpoint](verida_storage_link._internal_.default-1.md#locateserviceendpoint) -- [removeContext](verida_storage_link._internal_.default-1.md#removecontext) -- [signProof](verida_storage_link._internal_.default-1.md#signproof) -- [verifyContextSignature](verida_storage_link._internal_.default-1.md#verifycontextsignature) -- [verifyProof](verida_storage_link._internal_.default-1.md#verifyproof) -- [verifySig](verida_storage_link._internal_.default-1.md#verifysig) -- [generateContextHash](verida_storage_link._internal_.default-1.md#generatecontexthash) - -## Constructors - -### constructor - -• **new default**(`doc`, `publicKeyHex?`) - -Force lower case DID as we can't guarantee the DID will always be provided with checksum - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `doc` | `string` \| [`DIDDocumentStruct`](../interfaces/verida_storage_link._internal_.DIDDocumentStruct.md) | -| `publicKeyHex?` | `string` | - -#### Defined in - -packages/did-document/dist/did-document.d.ts:12 - -## Properties - -### doc - -• `Private` **doc**: `any` - -#### Defined in - -packages/did-document/dist/did-document.d.ts:5 - -___ - -### errors - -• `Protected` **errors**: `string`[] - -#### Defined in - -packages/did-document/dist/did-document.d.ts:6 - -___ - -### getProofData - -• `Private` **getProofData**: `any` - -#### Defined in - -packages/did-document/dist/did-document.d.ts:33 - -## Accessors - -### id - -• `get` **id**(): `string` - -#### Returns - -`string` - -#### Defined in - -packages/did-document/dist/did-document.d.ts:13 - -## Methods - -### addContext - -▸ **addContext**(`contextName`, `keyring`, `endpoints`): `Promise`<`void`\> - -Not used directly, used for testing - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | -| `keyring` | [`default`](verida_storage_link._internal_.default-2.md) | -| `endpoints` | [`Endpoints`](../interfaces/verida_storage_link._internal_.Endpoints.md) | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -packages/did-document/dist/did-document.d.ts:22 - -___ - -### addContextAsymKey - -▸ **addContextAsymKey**(`contextHash`, `publicKeyHex`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextHash` | `string` | -| `publicKeyHex` | `string` | - -#### Returns - -`void` - -#### Defined in - -packages/did-document/dist/did-document.d.ts:28 - -___ - -### addContextService - -▸ **addContextService**(`contextHash`, `endpointType`, `serviceType`, `endpointUri`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextHash` | `string` | -| `endpointType` | [`EndpointType`](../enums/verida_storage_link._internal_.EndpointType.md) | -| `serviceType` | `string` | -| `endpointUri` | `string` | - -#### Returns - -`void` - -#### Defined in - -packages/did-document/dist/did-document.d.ts:26 - -___ - -### addContextSignKey - -▸ **addContextSignKey**(`contextHash`, `publicKeyHex`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextHash` | `string` | -| `publicKeyHex` | `string` | - -#### Returns - -`void` - -#### Defined in - -packages/did-document/dist/did-document.d.ts:27 - -___ - -### export - -▸ **export**(): [`DIDDocumentStruct`](../interfaces/verida_storage_link._internal_.DIDDocumentStruct.md) - -#### Returns - -[`DIDDocumentStruct`](../interfaces/verida_storage_link._internal_.DIDDocumentStruct.md) - -#### Defined in - -packages/did-document/dist/did-document.d.ts:25 - -___ - -### getErrors - -▸ **getErrors**(): `string`[] - -#### Returns - -`string`[] - -#### Defined in - -packages/did-document/dist/did-document.d.ts:14 - -___ - -### import - -▸ **import**(`doc`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `doc` | [`DIDDocumentStruct`](../interfaces/verida_storage_link._internal_.DIDDocumentStruct.md) | - -#### Returns - -`void` - -#### Defined in - -packages/did-document/dist/did-document.d.ts:24 - -___ - -### locateServiceEndpoint - -▸ **locateServiceEndpoint**(`contextName`, `endpointType`): `undefined` \| [`ServiceEndpoint`](../interfaces/verida_storage_link._internal_.ServiceEndpoint.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | -| `endpointType` | [`EndpointType`](../enums/verida_storage_link._internal_.EndpointType.md) | - -#### Returns - -`undefined` \| [`ServiceEndpoint`](../interfaces/verida_storage_link._internal_.ServiceEndpoint.md) - -#### Defined in - -packages/did-document/dist/did-document.d.ts:35 - -___ - -### removeContext - -▸ **removeContext**(`contextName`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | - -#### Returns - -`boolean` - -#### Defined in - -packages/did-document/dist/did-document.d.ts:23 - -___ - -### signProof - -▸ **signProof**(`privateKey`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `privateKey` | `string` \| `Uint8Array` | - -#### Returns - -`void` - -#### Defined in - -packages/did-document/dist/did-document.d.ts:29 - -___ - -### verifyContextSignature - -▸ **verifyContextSignature**(`data`, `contextName`, `signature`, `contextIsHash?`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `any` | -| `contextName` | `string` | -| `signature` | `string` | -| `contextIsHash?` | `boolean` | - -#### Returns - -`boolean` - -#### Defined in - -packages/did-document/dist/did-document.d.ts:32 - -___ - -### verifyProof - -▸ **verifyProof**(): `boolean` - -#### Returns - -`boolean` - -#### Defined in - -packages/did-document/dist/did-document.d.ts:30 - -___ - -### verifySig - -▸ **verifySig**(`data`, `signature`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `any` | -| `signature` | `string` | - -#### Returns - -`boolean` - -#### Defined in - -packages/did-document/dist/did-document.d.ts:31 - -___ - -### generateContextHash - -▸ `Static` **generateContextHash**(`did`, `contextName`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did` | `string` | -| `contextName` | `string` | - -#### Returns - -`string` - -#### Defined in - -packages/did-document/dist/did-document.d.ts:34 diff --git a/docs/api/verida-js/classes/verida_storage_link._internal_.default-2.md b/docs/api/verida-js/classes/verida_storage_link._internal_.default-2.md deleted file mode 100644 index 855777c..0000000 --- a/docs/api/verida-js/classes/verida_storage_link._internal_.default-2.md +++ /dev/null @@ -1,368 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/storage-link](../modules/verida_storage_link.md) / [](../modules/verida_storage_link._internal_.md) / default - -# Class: default - -[@verida/storage-link](../modules/verida_storage_link.md).[](../modules/verida_storage_link._internal_.md).default - -Class that takes a signature (generated from a signed consent message) and generates a -collection of asymmetric keys, symmetric key and signing key for a given secure storage -context. - -## Table of contents - -### Constructors - -- [constructor](verida_storage_link._internal_.default-2.md#constructor) - -### Properties - -- [asymKeyPair](verida_storage_link._internal_.default-2.md#asymkeypair) -- [buildKey](verida_storage_link._internal_.default-2.md#buildkey) -- [seed](verida_storage_link._internal_.default-2.md#seed) -- [signKeyPair](verida_storage_link._internal_.default-2.md#signkeypair) -- [storageContextKeys](verida_storage_link._internal_.default-2.md#storagecontextkeys) -- [symKey](verida_storage_link._internal_.default-2.md#symkey) - -### Methods - -- [\_init](verida_storage_link._internal_.default-2.md#_init) -- [asymDecrypt](verida_storage_link._internal_.default-2.md#asymdecrypt) -- [asymEncrypt](verida_storage_link._internal_.default-2.md#asymencrypt) -- [buildSharedKeyEnd](verida_storage_link._internal_.default-2.md#buildsharedkeyend) -- [buildSharedKeyStart](verida_storage_link._internal_.default-2.md#buildsharedkeystart) -- [getKeys](verida_storage_link._internal_.default-2.md#getkeys) -- [getSeed](verida_storage_link._internal_.default-2.md#getseed) -- [getStorageContextKey](verida_storage_link._internal_.default-2.md#getstoragecontextkey) -- [publicKeys](verida_storage_link._internal_.default-2.md#publickeys) -- [sign](verida_storage_link._internal_.default-2.md#sign) -- [symDecrypt](verida_storage_link._internal_.default-2.md#symdecrypt) -- [symEncrypt](verida_storage_link._internal_.default-2.md#symencrypt) -- [verifySig](verida_storage_link._internal_.default-2.md#verifysig) - -## Constructors - -### constructor - -• **new default**(`seed`) - -A string used as a seed for this keyring. -The seed should be a hex signature obtained by 3ID signed consent message. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `seed` | `string` | - -#### Defined in - -packages/keyring/dist/keyring.d.ts:19 - -## Properties - -### asymKeyPair - -• `Optional` **asymKeyPair**: [`BoxKeyPair`](../interfaces/verida_storage_link._internal_.BoxKeyPair.md) - -#### Defined in - -packages/keyring/dist/keyring.d.ts:8 - -___ - -### buildKey - -• `Private` **buildKey**: `any` - -Helper function that generates a key of the appropriate type - -**`param`** - -**`param`** - -**`returns`** - -#### Defined in - -packages/keyring/dist/keyring.d.ts:29 - -___ - -### seed - -• `Private` **seed**: `any` - -#### Defined in - -packages/keyring/dist/keyring.d.ts:11 - -___ - -### signKeyPair - -• `Optional` **signKeyPair**: [`SignKeyPair`](../interfaces/verida_storage_link._internal_.SignKeyPair.md) - -#### Defined in - -packages/keyring/dist/keyring.d.ts:9 - -___ - -### storageContextKeys - -• `Private` **storageContextKeys**: `any` - -#### Defined in - -packages/keyring/dist/keyring.d.ts:12 - -___ - -### symKey - -• `Optional` **symKey**: `Uint8Array` - -#### Defined in - -packages/keyring/dist/keyring.d.ts:10 - -## Methods - -### \_init - -▸ **_init**(): `Promise`<`void`\> - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -packages/keyring/dist/keyring.d.ts:21 - -___ - -### asymDecrypt - -▸ **asymDecrypt**(`messageWithNonce`, `secretOrSharedKey`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `messageWithNonce` | `string` | -| `secretOrSharedKey` | `Uint8Array` | - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -packages/keyring/dist/keyring.d.ts:48 - -___ - -### asymEncrypt - -▸ **asymEncrypt**(`data`, `secretOrSharedKey`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `string` | -| `secretOrSharedKey` | `Uint8Array` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -packages/keyring/dist/keyring.d.ts:47 - -___ - -### buildSharedKeyEnd - -▸ **buildSharedKeyEnd**(`publicKey`): `Promise`<`Uint8Array`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `publicKey` | `Uint8Array` | - -#### Returns - -`Promise`<`Uint8Array`\> - -#### Defined in - -packages/keyring/dist/keyring.d.ts:50 - -___ - -### buildSharedKeyStart - -▸ **buildSharedKeyStart**(`privateKey`): `Promise`<`Uint8Array`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `privateKey` | `Uint8Array` | - -#### Returns - -`Promise`<`Uint8Array`\> - -#### Defined in - -packages/keyring/dist/keyring.d.ts:49 - -___ - -### getKeys - -▸ **getKeys**(): `Promise`<`any`\> - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -packages/keyring/dist/keyring.d.ts:20 - -___ - -### getSeed - -▸ **getSeed**(): `string` - -#### Returns - -`string` - -#### Defined in - -packages/keyring/dist/keyring.d.ts:51 - -___ - -### getStorageContextKey - -▸ **getStorageContextKey**(`databaseName`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `databaseName` | `string` | - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -packages/keyring/dist/keyring.d.ts:52 - -___ - -### publicKeys - -▸ **publicKeys**(): `Promise`<{ `asymPublicKey`: `Uint8Array` ; `asymPublicKeyBase58`: `string` ; `asymPublicKeyHex`: `string` ; `signPublicKey`: `Uint8Array` ; `signPublicKeyBase58`: `string` ; `signPublicKeyHex`: `string` }\> - -Generate an object containing all the public keys for this Keyring - -#### Returns - -`Promise`<{ `asymPublicKey`: `Uint8Array` ; `asymPublicKeyBase58`: `string` ; `asymPublicKeyHex`: `string` ; `signPublicKey`: `Uint8Array` ; `signPublicKeyBase58`: `string` ; `signPublicKeyHex`: `string` }\> - -#### Defined in - -packages/keyring/dist/keyring.d.ts:35 - -___ - -### sign - -▸ **sign**(`data`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `any` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -packages/keyring/dist/keyring.d.ts:43 - -___ - -### symDecrypt - -▸ **symDecrypt**(`data`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `string` | - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -packages/keyring/dist/keyring.d.ts:46 - -___ - -### symEncrypt - -▸ **symEncrypt**(`data`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -packages/keyring/dist/keyring.d.ts:45 - -___ - -### verifySig - -▸ **verifySig**(`data`, `sig`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `string` | -| `sig` | `string` | - -#### Returns - -`Promise`<`boolean`\> - -#### Defined in - -packages/keyring/dist/keyring.d.ts:44 diff --git a/docs/api/verida-js/classes/verida_storage_link._internal_.default.md b/docs/api/verida-js/classes/verida_storage_link._internal_.default.md deleted file mode 100644 index d794042..0000000 --- a/docs/api/verida-js/classes/verida_storage_link._internal_.default.md +++ /dev/null @@ -1,515 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/storage-link](../modules/verida_storage_link.md) / [](../modules/verida_storage_link._internal_.md) / default - -# Class: default - -[@verida/storage-link](../modules/verida_storage_link.md).[](../modules/verida_storage_link._internal_.md).default - -## Implements - -- [`IDIDDocument`](../interfaces/verida_storage_link._internal_.IDIDDocument.md) - -## Table of contents - -### Constructors - -- [constructor](verida_storage_link._internal_.default.md#constructor) - -### Properties - -- [doc](verida_storage_link._internal_.default.md#doc) -- [errors](verida_storage_link._internal_.default.md#errors) -- [getProofData](verida_storage_link._internal_.default.md#getproofdata) - -### Accessors - -- [id](verida_storage_link._internal_.default.md#id) - -### Methods - -- [addContext](verida_storage_link._internal_.default.md#addcontext) -- [addContextAsymKey](verida_storage_link._internal_.default.md#addcontextasymkey) -- [addContextService](verida_storage_link._internal_.default.md#addcontextservice) -- [addContextSignKey](verida_storage_link._internal_.default.md#addcontextsignkey) -- [buildTimestamp](verida_storage_link._internal_.default.md#buildtimestamp) -- [export](verida_storage_link._internal_.default.md#export) -- [getErrors](verida_storage_link._internal_.default.md#geterrors) -- [import](verida_storage_link._internal_.default.md#import) -- [locateContextProof](verida_storage_link._internal_.default.md#locatecontextproof) -- [locateServiceEndpoint](verida_storage_link._internal_.default.md#locateserviceendpoint) -- [removeContext](verida_storage_link._internal_.default.md#removecontext) -- [setAttributes](verida_storage_link._internal_.default.md#setattributes) -- [signProof](verida_storage_link._internal_.default.md#signproof) -- [verifyContextSignature](verida_storage_link._internal_.default.md#verifycontextsignature) -- [verifyProof](verida_storage_link._internal_.default.md#verifyproof) -- [verifySig](verida_storage_link._internal_.default.md#verifysig) -- [generateContextHash](verida_storage_link._internal_.default.md#generatecontexthash) - -## Constructors - -### constructor - -• **new default**(`doc`, `publicKeyHex?`) - -Force lower case DID as we can't guarantee the DID will always be provided with checksum - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `doc` | `string` \| [`VeridaDocInterface`](../interfaces/verida_storage_link._internal_.VeridaDocInterface.md) | this value can be a DocInterface or DID. | -| `publicKeyHex?` | `string` | - | - -#### Defined in - -packages/did-document/dist/did-document.d.ts:11 - -## Properties - -### doc - -• `Private` **doc**: `any` - -#### Defined in - -packages/did-document/dist/did-document.d.ts:4 - -___ - -### errors - -• `Protected` **errors**: `string`[] - -#### Defined in - -packages/did-document/dist/did-document.d.ts:5 - -___ - -### getProofData - -• `Private` **getProofData**: `any` - -#### Defined in - -packages/did-document/dist/did-document.d.ts:37 - -## Accessors - -### id - -• `get` **id**(): `string` - -#### Returns - -`string` - -#### Implementation of - -IDIDDocument.id - -#### Defined in - -packages/did-document/dist/did-document.d.ts:12 - -## Methods - -### addContext - -▸ **addContext**(`contextName`, `keyring`, `privateKey`, `endpoints`): `Promise`<`void`\> - -Not used directly, used for testing - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `contextName` | `string` | string | -| `keyring` | [`IKeyring`](../interfaces/verida_storage_link._internal_.IKeyring.md) | Keyring | -| `privateKey` | `string` | Private key of the DID that controls this DID Document | -| `endpoints` | [`SecureContextEndpoints`](../interfaces/verida_storage_link._internal_.SecureContextEndpoints.md) | Endpoints | - -#### Returns - -`Promise`<`void`\> - -#### Implementation of - -[IDIDDocument](../interfaces/verida_storage_link._internal_.IDIDDocument.md).[addContext](../interfaces/verida_storage_link._internal_.IDIDDocument.md#addcontext) - -#### Defined in - -packages/did-document/dist/did-document.d.ts:22 - -___ - -### addContextAsymKey - -▸ **addContextAsymKey**(`contextHash`, `publicKeyHex`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextHash` | `string` | -| `publicKeyHex` | `string` | - -#### Returns - -`void` - -#### Implementation of - -[IDIDDocument](../interfaces/verida_storage_link._internal_.IDIDDocument.md).[addContextAsymKey](../interfaces/verida_storage_link._internal_.IDIDDocument.md#addcontextasymkey) - -#### Defined in - -packages/did-document/dist/did-document.d.ts:29 - -___ - -### addContextService - -▸ **addContextService**(`contextHash`, `endpointType`, `serviceType`, `endpointUris`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextHash` | `string` | -| `endpointType` | [`SecureContextEndpointType`](../enums/verida_storage_link._internal_.SecureContextEndpointType.md) | -| `serviceType` | `string` | -| `endpointUris` | [`ServiceEndpoint`](../modules/verida_storage_link._internal_.md#serviceendpoint)[] | - -#### Returns - -`void` - -#### Implementation of - -[IDIDDocument](../interfaces/verida_storage_link._internal_.IDIDDocument.md).[addContextService](../interfaces/verida_storage_link._internal_.IDIDDocument.md#addcontextservice) - -#### Defined in - -packages/did-document/dist/did-document.d.ts:27 - -___ - -### addContextSignKey - -▸ **addContextSignKey**(`contextHash`, `publicKeyHex`, `proof`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextHash` | `string` | -| `publicKeyHex` | `string` | -| `proof` | `string` | - -#### Returns - -`void` - -#### Implementation of - -[IDIDDocument](../interfaces/verida_storage_link._internal_.IDIDDocument.md).[addContextSignKey](../interfaces/verida_storage_link._internal_.IDIDDocument.md#addcontextsignkey) - -#### Defined in - -packages/did-document/dist/did-document.d.ts:28 - -___ - -### buildTimestamp - -▸ **buildTimestamp**(`date`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `date` | `Date` | - -#### Returns - -`string` - -#### Implementation of - -[IDIDDocument](../interfaces/verida_storage_link._internal_.IDIDDocument.md).[buildTimestamp](../interfaces/verida_storage_link._internal_.IDIDDocument.md#buildtimestamp) - -#### Defined in - -packages/did-document/dist/did-document.d.ts:38 - -___ - -### export - -▸ **export**(): [`VeridaDocInterface`](../interfaces/verida_storage_link._internal_.VeridaDocInterface.md) - -#### Returns - -[`VeridaDocInterface`](../interfaces/verida_storage_link._internal_.VeridaDocInterface.md) - -#### Implementation of - -[IDIDDocument](../interfaces/verida_storage_link._internal_.IDIDDocument.md).[export](../interfaces/verida_storage_link._internal_.IDIDDocument.md#export) - -#### Defined in - -packages/did-document/dist/did-document.d.ts:26 - -___ - -### getErrors - -▸ **getErrors**(): `string`[] - -#### Returns - -`string`[] - -#### Implementation of - -[IDIDDocument](../interfaces/verida_storage_link._internal_.IDIDDocument.md).[getErrors](../interfaces/verida_storage_link._internal_.IDIDDocument.md#geterrors) - -#### Defined in - -packages/did-document/dist/did-document.d.ts:13 - -___ - -### import - -▸ **import**(`doc`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `doc` | [`VeridaDocInterface`](../interfaces/verida_storage_link._internal_.VeridaDocInterface.md) | - -#### Returns - -`void` - -#### Implementation of - -[IDIDDocument](../interfaces/verida_storage_link._internal_.IDIDDocument.md).[import](../interfaces/verida_storage_link._internal_.IDIDDocument.md#import) - -#### Defined in - -packages/did-document/dist/did-document.d.ts:25 - -___ - -### locateContextProof - -▸ **locateContextProof**(`contextName`): `undefined` \| `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | - -#### Returns - -`undefined` \| `string` - -#### Implementation of - -[IDIDDocument](../interfaces/verida_storage_link._internal_.IDIDDocument.md).[locateContextProof](../interfaces/verida_storage_link._internal_.IDIDDocument.md#locatecontextproof) - -#### Defined in - -packages/did-document/dist/did-document.d.ts:34 - -___ - -### locateServiceEndpoint - -▸ **locateServiceEndpoint**(`contextName`, `endpointType`): `undefined` \| [`Service`](../interfaces/verida_storage_link._internal_.Service.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | -| `endpointType` | [`SecureContextEndpointType`](../enums/verida_storage_link._internal_.SecureContextEndpointType.md) | - -#### Returns - -`undefined` \| [`Service`](../interfaces/verida_storage_link._internal_.Service.md) - -#### Implementation of - -[IDIDDocument](../interfaces/verida_storage_link._internal_.IDIDDocument.md).[locateServiceEndpoint](../interfaces/verida_storage_link._internal_.IDIDDocument.md#locateserviceendpoint) - -#### Defined in - -packages/did-document/dist/did-document.d.ts:33 - -___ - -### removeContext - -▸ **removeContext**(`contextName`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | - -#### Returns - -`boolean` - -#### Implementation of - -[IDIDDocument](../interfaces/verida_storage_link._internal_.IDIDDocument.md).[removeContext](../interfaces/verida_storage_link._internal_.IDIDDocument.md#removecontext) - -#### Defined in - -packages/did-document/dist/did-document.d.ts:23 - -___ - -### setAttributes - -▸ **setAttributes**(`attributes`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `attributes` | [`Record`](../modules/verida_storage_link._internal_.md#record)<`string`, `any`\> | - -#### Returns - -`void` - -#### Implementation of - -[IDIDDocument](../interfaces/verida_storage_link._internal_.IDIDDocument.md).[setAttributes](../interfaces/verida_storage_link._internal_.IDIDDocument.md#setattributes) - -#### Defined in - -packages/did-document/dist/did-document.d.ts:24 - -___ - -### signProof - -▸ **signProof**(`privateKey`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `privateKey` | `string` \| `Uint8Array` | - -#### Returns - -`void` - -#### Implementation of - -[IDIDDocument](../interfaces/verida_storage_link._internal_.IDIDDocument.md).[signProof](../interfaces/verida_storage_link._internal_.IDIDDocument.md#signproof) - -#### Defined in - -packages/did-document/dist/did-document.d.ts:35 - -___ - -### verifyContextSignature - -▸ **verifyContextSignature**(`data`, `contextName`, `signature`, `contextIsHash?`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `any` | -| `contextName` | `string` | -| `signature` | `string` | -| `contextIsHash?` | `boolean` | - -#### Returns - -`boolean` - -#### Implementation of - -[IDIDDocument](../interfaces/verida_storage_link._internal_.IDIDDocument.md).[verifyContextSignature](../interfaces/verida_storage_link._internal_.IDIDDocument.md#verifycontextsignature) - -#### Defined in - -packages/did-document/dist/did-document.d.ts:31 - -___ - -### verifyProof - -▸ **verifyProof**(): `boolean` - -#### Returns - -`boolean` - -#### Implementation of - -[IDIDDocument](../interfaces/verida_storage_link._internal_.IDIDDocument.md).[verifyProof](../interfaces/verida_storage_link._internal_.IDIDDocument.md#verifyproof) - -#### Defined in - -packages/did-document/dist/did-document.d.ts:36 - -___ - -### verifySig - -▸ **verifySig**(`data`, `signature`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `any` | -| `signature` | `string` | - -#### Returns - -`boolean` - -#### Implementation of - -[IDIDDocument](../interfaces/verida_storage_link._internal_.IDIDDocument.md).[verifySig](../interfaces/verida_storage_link._internal_.IDIDDocument.md#verifysig) - -#### Defined in - -packages/did-document/dist/did-document.d.ts:30 - -___ - -### generateContextHash - -▸ `Static` **generateContextHash**(`did`, `contextName`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did` | `string` | -| `contextName` | `string` | - -#### Returns - -`string` - -#### Defined in - -packages/did-document/dist/did-document.d.ts:32 diff --git a/docs/api/verida-js/classes/verida_types.ContextAuthorizationError.md b/docs/api/verida-js/classes/verida_types.ContextAuthorizationError.md deleted file mode 100644 index 73070fb..0000000 --- a/docs/api/verida-js/classes/verida_types.ContextAuthorizationError.md +++ /dev/null @@ -1,165 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/types](../modules/verida_types.md) / ContextAuthorizationError - -# Class: ContextAuthorizationError - -[@verida/types](../modules/verida_types.md).ContextAuthorizationError - -## Hierarchy - -- [`Error`](../modules/verida_types._internal_.md#error) - - ↳ **`ContextAuthorizationError`** - -## Table of contents - -### Constructors - -- [constructor](verida_types.ContextAuthorizationError.md#constructor) - -### Properties - -- [message](verida_types.ContextAuthorizationError.md#message) -- [name](verida_types.ContextAuthorizationError.md#name) -- [stack](verida_types.ContextAuthorizationError.md#stack) -- [prepareStackTrace](verida_types.ContextAuthorizationError.md#preparestacktrace) -- [stackTraceLimit](verida_types.ContextAuthorizationError.md#stacktracelimit) - -### Methods - -- [captureStackTrace](verida_types.ContextAuthorizationError.md#capturestacktrace) - -## Constructors - -### constructor - -• **new ContextAuthorizationError**(`message`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `message` | `string` | - -#### Overrides - -Error.constructor - -#### Defined in - -[packages/types/src/AccountInterfaces.ts:36](https://github.com/verida/verida-js/blob/5040472/packages/types/src/AccountInterfaces.ts#L36) - -## Properties - -### message - -• **message**: `string` - -#### Inherited from - -Error.message - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:974 - -___ - -### name - -• **name**: `string` - -#### Inherited from - -Error.name - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:973 - -___ - -### stack - -• `Optional` **stack**: `string` - -#### Inherited from - -Error.stack - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:975 - -___ - -### prepareStackTrace - -▪ `Static` `Optional` **prepareStackTrace**: (`err`: [`Error`](../modules/verida_types._internal_.md#error), `stackTraces`: [`CallSite`](../interfaces/verida_types._internal_.CallSite.md)[]) => `any` - -#### Type declaration - -▸ (`err`, `stackTraces`): `any` - -Optional override for formatting stack traces - -**`see`** https://v8.dev/docs/stack-trace-api#customizing-stack-traces - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `err` | [`Error`](../modules/verida_types._internal_.md#error) | -| `stackTraces` | [`CallSite`](../interfaces/verida_types._internal_.CallSite.md)[] | - -##### Returns - -`any` - -#### Inherited from - -Error.prepareStackTrace - -#### Defined in - -packages/types/node_modules/@types/node/ts4.8/globals.d.ts:11 - -___ - -### stackTraceLimit - -▪ `Static` **stackTraceLimit**: `number` - -#### Inherited from - -Error.stackTraceLimit - -#### Defined in - -packages/types/node_modules/@types/node/ts4.8/globals.d.ts:13 - -## Methods - -### captureStackTrace - -▸ `Static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` - -Create .stack property on a target object - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `targetObject` | `object` | -| `constructorOpt?` | `Function` | - -#### Returns - -`void` - -#### Inherited from - -Error.captureStackTrace - -#### Defined in - -packages/types/node_modules/@types/node/ts4.8/globals.d.ts:4 diff --git a/docs/api/verida-js/classes/verida_types._internal_.BigNumber.md b/docs/api/verida-js/classes/verida_types._internal_.BigNumber.md deleted file mode 100644 index 0ac907c..0000000 --- a/docs/api/verida-js/classes/verida_types._internal_.BigNumber.md +++ /dev/null @@ -1,631 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/types](../modules/verida_types.md) / [](../modules/verida_types._internal_.md) / BigNumber - -# Class: BigNumber - -[@verida/types](../modules/verida_types.md).[](../modules/verida_types._internal_.md).BigNumber - -## Implements - -- [`Hexable`](../interfaces/verida_types._internal_.Hexable.md) - -## Table of contents - -### Constructors - -- [constructor](verida_types._internal_.BigNumber.md#constructor) - -### Properties - -- [\_hex](verida_types._internal_.BigNumber.md#_hex) -- [\_isBigNumber](verida_types._internal_.BigNumber.md#_isbignumber) - -### Methods - -- [abs](verida_types._internal_.BigNumber.md#abs) -- [add](verida_types._internal_.BigNumber.md#add) -- [and](verida_types._internal_.BigNumber.md#and) -- [div](verida_types._internal_.BigNumber.md#div) -- [eq](verida_types._internal_.BigNumber.md#eq) -- [fromTwos](verida_types._internal_.BigNumber.md#fromtwos) -- [gt](verida_types._internal_.BigNumber.md#gt) -- [gte](verida_types._internal_.BigNumber.md#gte) -- [isNegative](verida_types._internal_.BigNumber.md#isnegative) -- [isZero](verida_types._internal_.BigNumber.md#iszero) -- [lt](verida_types._internal_.BigNumber.md#lt) -- [lte](verida_types._internal_.BigNumber.md#lte) -- [mask](verida_types._internal_.BigNumber.md#mask) -- [mod](verida_types._internal_.BigNumber.md#mod) -- [mul](verida_types._internal_.BigNumber.md#mul) -- [or](verida_types._internal_.BigNumber.md#or) -- [pow](verida_types._internal_.BigNumber.md#pow) -- [shl](verida_types._internal_.BigNumber.md#shl) -- [shr](verida_types._internal_.BigNumber.md#shr) -- [sub](verida_types._internal_.BigNumber.md#sub) -- [toBigInt](verida_types._internal_.BigNumber.md#tobigint) -- [toHexString](verida_types._internal_.BigNumber.md#tohexstring) -- [toJSON](verida_types._internal_.BigNumber.md#tojson) -- [toNumber](verida_types._internal_.BigNumber.md#tonumber) -- [toString](verida_types._internal_.BigNumber.md#tostring) -- [toTwos](verida_types._internal_.BigNumber.md#totwos) -- [xor](verida_types._internal_.BigNumber.md#xor) -- [from](verida_types._internal_.BigNumber.md#from) -- [isBigNumber](verida_types._internal_.BigNumber.md#isbignumber) - -## Constructors - -### constructor - -• **new BigNumber**(`constructorGuard`, `hex`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `constructorGuard` | `any` | -| `hex` | `string` | - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:7 - -## Properties - -### \_hex - -• `Readonly` **\_hex**: `string` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:5 - -___ - -### \_isBigNumber - -• `Readonly` **\_isBigNumber**: `boolean` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:6 - -## Methods - -### abs - -▸ **abs**(): [`BigNumber`](verida_types._internal_.BigNumber.md) - -#### Returns - -[`BigNumber`](verida_types._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:10 - -___ - -### add - -▸ **add**(`other`): [`BigNumber`](verida_types._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_types._internal_.md#bignumberish) | - -#### Returns - -[`BigNumber`](verida_types._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:11 - -___ - -### and - -▸ **and**(`other`): [`BigNumber`](verida_types._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_types._internal_.md#bignumberish) | - -#### Returns - -[`BigNumber`](verida_types._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:17 - -___ - -### div - -▸ **div**(`other`): [`BigNumber`](verida_types._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_types._internal_.md#bignumberish) | - -#### Returns - -[`BigNumber`](verida_types._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:13 - -___ - -### eq - -▸ **eq**(`other`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_types._internal_.md#bignumberish) | - -#### Returns - -`boolean` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:23 - -___ - -### fromTwos - -▸ **fromTwos**(`value`): [`BigNumber`](verida_types._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `number` | - -#### Returns - -[`BigNumber`](verida_types._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:8 - -___ - -### gt - -▸ **gt**(`other`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_types._internal_.md#bignumberish) | - -#### Returns - -`boolean` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:26 - -___ - -### gte - -▸ **gte**(`other`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_types._internal_.md#bignumberish) | - -#### Returns - -`boolean` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:27 - -___ - -### isNegative - -▸ **isNegative**(): `boolean` - -#### Returns - -`boolean` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:28 - -___ - -### isZero - -▸ **isZero**(): `boolean` - -#### Returns - -`boolean` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:29 - -___ - -### lt - -▸ **lt**(`other`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_types._internal_.md#bignumberish) | - -#### Returns - -`boolean` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:24 - -___ - -### lte - -▸ **lte**(`other`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_types._internal_.md#bignumberish) | - -#### Returns - -`boolean` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:25 - -___ - -### mask - -▸ **mask**(`value`): [`BigNumber`](verida_types._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `number` | - -#### Returns - -[`BigNumber`](verida_types._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:20 - -___ - -### mod - -▸ **mod**(`other`): [`BigNumber`](verida_types._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_types._internal_.md#bignumberish) | - -#### Returns - -[`BigNumber`](verida_types._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:15 - -___ - -### mul - -▸ **mul**(`other`): [`BigNumber`](verida_types._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_types._internal_.md#bignumberish) | - -#### Returns - -[`BigNumber`](verida_types._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:14 - -___ - -### or - -▸ **or**(`other`): [`BigNumber`](verida_types._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_types._internal_.md#bignumberish) | - -#### Returns - -[`BigNumber`](verida_types._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:18 - -___ - -### pow - -▸ **pow**(`other`): [`BigNumber`](verida_types._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_types._internal_.md#bignumberish) | - -#### Returns - -[`BigNumber`](verida_types._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:16 - -___ - -### shl - -▸ **shl**(`value`): [`BigNumber`](verida_types._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `number` | - -#### Returns - -[`BigNumber`](verida_types._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:21 - -___ - -### shr - -▸ **shr**(`value`): [`BigNumber`](verida_types._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `number` | - -#### Returns - -[`BigNumber`](verida_types._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:22 - -___ - -### sub - -▸ **sub**(`other`): [`BigNumber`](verida_types._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_types._internal_.md#bignumberish) | - -#### Returns - -[`BigNumber`](verida_types._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:12 - -___ - -### toBigInt - -▸ **toBigInt**(): `bigint` - -#### Returns - -`bigint` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:31 - -___ - -### toHexString - -▸ **toHexString**(): `string` - -#### Returns - -`string` - -#### Implementation of - -[Hexable](../interfaces/verida_types._internal_.Hexable.md).[toHexString](../interfaces/verida_types._internal_.Hexable.md#tohexstring) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:33 - -___ - -### toJSON - -▸ **toJSON**(`key?`): `any` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `key?` | `string` | - -#### Returns - -`any` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:34 - -___ - -### toNumber - -▸ **toNumber**(): `number` - -#### Returns - -`number` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:30 - -___ - -### toString - -▸ **toString**(): `string` - -#### Returns - -`string` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:32 - -___ - -### toTwos - -▸ **toTwos**(`value`): [`BigNumber`](verida_types._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `number` | - -#### Returns - -[`BigNumber`](verida_types._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:9 - -___ - -### xor - -▸ **xor**(`other`): [`BigNumber`](verida_types._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_types._internal_.md#bignumberish) | - -#### Returns - -[`BigNumber`](verida_types._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:19 - -___ - -### from - -▸ `Static` **from**(`value`): [`BigNumber`](verida_types._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `any` | - -#### Returns - -[`BigNumber`](verida_types._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:35 - -___ - -### isBigNumber - -▸ `Static` **isBigNumber**(`value`): value is BigNumber - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `any` | - -#### Returns - -value is BigNumber - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:36 diff --git a/docs/api/verida-js/classes/verida_types._internal_.Description.md b/docs/api/verida-js/classes/verida_types._internal_.Description.md deleted file mode 100644 index 66ca44c..0000000 --- a/docs/api/verida-js/classes/verida_types._internal_.Description.md +++ /dev/null @@ -1,45 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/types](../modules/verida_types.md) / [](../modules/verida_types._internal_.md) / Description - -# Class: Description - -[@verida/types](../modules/verida_types.md).[](../modules/verida_types._internal_.md).Description - -## Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `any` | - -## Hierarchy - -- **`Description`** - - ↳ [`ForkEvent`](verida_types._internal_.ForkEvent.md) - -## Table of contents - -### Constructors - -- [constructor](verida_types._internal_.Description.md#constructor) - -## Constructors - -### constructor - -• **new Description**<`T`\>(`info`) - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `any` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `info` | { [K in string \| number \| symbol]: T[K] } | - -#### Defined in - -node_modules/@ethersproject/properties/lib/index.d.ts:13 diff --git a/docs/api/verida-js/classes/verida_types._internal_.EventEmitter-1.md b/docs/api/verida-js/classes/verida_types._internal_.EventEmitter-1.md deleted file mode 100644 index 2393ace..0000000 --- a/docs/api/verida-js/classes/verida_types._internal_.EventEmitter-1.md +++ /dev/null @@ -1,1123 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/types](../modules/verida_types.md) / [](../modules/verida_types._internal_.md) / EventEmitter - -# Class: EventEmitter - -[@verida/types](../modules/verida_types.md).[](../modules/verida_types._internal_.md).EventEmitter - -The `EventEmitter` class is defined and exposed by the `events` module: - -```js -const EventEmitter = require('events'); -``` - -All `EventEmitter`s emit the event `'newListener'` when new listeners are -added and `'removeListener'` when existing listeners are removed. - -It supports the following option: - -**`since`** v0.1.26 - -## Hierarchy - -- `EventEmitter` - - ↳ **`EventEmitter`** - -## Table of contents - -### Constructors - -- [constructor](verida_types._internal_.EventEmitter-1.md#constructor) - -### Properties - -- [captureRejectionSymbol](verida_types._internal_.EventEmitter-1.md#capturerejectionsymbol) -- [captureRejections](verida_types._internal_.EventEmitter-1.md#capturerejections) -- [defaultMaxListeners](verida_types._internal_.EventEmitter-1.md#defaultmaxlisteners) -- [errorMonitor](verida_types._internal_.EventEmitter-1.md#errormonitor) - -### Methods - -- [addListener](verida_types._internal_.EventEmitter-1.md#addlistener) -- [emit](verida_types._internal_.EventEmitter-1.md#emit) -- [eventNames](verida_types._internal_.EventEmitter-1.md#eventnames) -- [getMaxListeners](verida_types._internal_.EventEmitter-1.md#getmaxlisteners) -- [listenerCount](verida_types._internal_.EventEmitter-1.md#listenercount) -- [listeners](verida_types._internal_.EventEmitter-1.md#listeners) -- [off](verida_types._internal_.EventEmitter-1.md#off) -- [on](verida_types._internal_.EventEmitter-1.md#on) -- [once](verida_types._internal_.EventEmitter-1.md#once) -- [prependListener](verida_types._internal_.EventEmitter-1.md#prependlistener) -- [prependOnceListener](verida_types._internal_.EventEmitter-1.md#prependoncelistener) -- [rawListeners](verida_types._internal_.EventEmitter-1.md#rawlisteners) -- [removeAllListeners](verida_types._internal_.EventEmitter-1.md#removealllisteners) -- [removeListener](verida_types._internal_.EventEmitter-1.md#removelistener) -- [setMaxListeners](verida_types._internal_.EventEmitter-1.md#setmaxlisteners) -- [getEventListeners](verida_types._internal_.EventEmitter-1.md#geteventlisteners) -- [listenerCount](verida_types._internal_.EventEmitter-1.md#listenercount) -- [on](verida_types._internal_.EventEmitter-1.md#on) -- [once](verida_types._internal_.EventEmitter-1.md#once) -- [setMaxListeners](verida_types._internal_.EventEmitter-1.md#setmaxlisteners) - -## Constructors - -### constructor - -• **new EventEmitter**(`options?`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options?` | [`EventEmitterOptions`](../interfaces/verida_types._internal_.EventEmitterOptions.md) | - -#### Inherited from - -NodeJS.EventEmitter.constructor - -#### Defined in - -packages/types/node_modules/@types/node/ts4.8/events.d.ts:111 - -## Properties - -### captureRejectionSymbol - -▪ `Static` `Readonly` **captureRejectionSymbol**: typeof [`captureRejectionSymbol`](verida_types._internal_.EventEmitter-1.md#capturerejectionsymbol) - -#### Defined in - -packages/types/node_modules/@types/node/ts4.8/events.d.ts:328 - -___ - -### captureRejections - -▪ `Static` **captureRejections**: `boolean` - -Sets or gets the default captureRejection value for all emitters. - -#### Defined in - -packages/types/node_modules/@types/node/ts4.8/events.d.ts:333 - -___ - -### defaultMaxListeners - -▪ `Static` **defaultMaxListeners**: `number` - -#### Defined in - -packages/types/node_modules/@types/node/ts4.8/events.d.ts:334 - -___ - -### errorMonitor - -▪ `Static` `Readonly` **errorMonitor**: typeof [`errorMonitor`](verida_types._internal_.EventEmitter-1.md#errormonitor) - -This symbol shall be used to install a listener for only monitoring `'error'` -events. Listeners installed using this symbol are called before the regular -`'error'` listeners are called. - -Installing a listener using this symbol does not change the behavior once an -`'error'` event is emitted, therefore the process will still crash if no -regular `'error'` listener is installed. - -#### Defined in - -packages/types/node_modules/@types/node/ts4.8/events.d.ts:327 - -## Methods - -### addListener - -▸ **addListener**(`eventName`, `listener`): [`EventEmitter`](verida_types._internal_.EventEmitter-1.md) - -Alias for `emitter.on(eventName, listener)`. - -**`since`** v0.1.26 - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | `string` \| `symbol` | -| `listener` | (...`args`: `any`[]) => `void` | - -#### Returns - -[`EventEmitter`](verida_types._internal_.EventEmitter-1.md) - -#### Inherited from - -NodeJS.EventEmitter.addListener - -#### Defined in - -packages/types/node_modules/@types/node/ts4.8/events.d.ts:354 - -___ - -### emit - -▸ **emit**(`eventName`, ...`args`): `boolean` - -Synchronously calls each of the listeners registered for the event named`eventName`, in the order they were registered, passing the supplied arguments -to each. - -Returns `true` if the event had listeners, `false` otherwise. - -```js -const EventEmitter = require('events'); -const myEmitter = new EventEmitter(); - -// First listener -myEmitter.on('event', function firstListener() { - console.log('Helloooo! first listener'); -}); -// Second listener -myEmitter.on('event', function secondListener(arg1, arg2) { - console.log(`event with parameters ${arg1}, ${arg2} in second listener`); -}); -// Third listener -myEmitter.on('event', function thirdListener(...args) { - const parameters = args.join(', '); - console.log(`event with parameters ${parameters} in third listener`); -}); - -console.log(myEmitter.listeners('event')); - -myEmitter.emit('event', 1, 2, 3, 4, 5); - -// Prints: -// [ -// [Function: firstListener], -// [Function: secondListener], -// [Function: thirdListener] -// ] -// Helloooo! first listener -// event with parameters 1, 2 in second listener -// event with parameters 1, 2, 3, 4, 5 in third listener -``` - -**`since`** v0.1.26 - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | `string` \| `symbol` | -| `...args` | `any`[] | - -#### Returns - -`boolean` - -#### Inherited from - -NodeJS.EventEmitter.emit - -#### Defined in - -packages/types/node_modules/@types/node/ts4.8/events.d.ts:610 - -___ - -### eventNames - -▸ **eventNames**(): (`string` \| `symbol`)[] - -Returns an array listing the events for which the emitter has registered -listeners. The values in the array are strings or `Symbol`s. - -```js -const EventEmitter = require('events'); -const myEE = new EventEmitter(); -myEE.on('foo', () => {}); -myEE.on('bar', () => {}); - -const sym = Symbol('symbol'); -myEE.on(sym, () => {}); - -console.log(myEE.eventNames()); -// Prints: [ 'foo', 'bar', Symbol(symbol) ] -``` - -**`since`** v6.0.0 - -#### Returns - -(`string` \| `symbol`)[] - -#### Inherited from - -NodeJS.EventEmitter.eventNames - -#### Defined in - -packages/types/node_modules/@types/node/ts4.8/events.d.ts:669 - -___ - -### getMaxListeners - -▸ **getMaxListeners**(): `number` - -Returns the current max listener value for the `EventEmitter` which is either -set by `emitter.setMaxListeners(n)` or defaults to [defaultMaxListeners](verida_types._internal_.EventEmitter-1.md#defaultmaxlisteners). - -**`since`** v1.0.0 - -#### Returns - -`number` - -#### Inherited from - -NodeJS.EventEmitter.getMaxListeners - -#### Defined in - -packages/types/node_modules/@types/node/ts4.8/events.d.ts:526 - -___ - -### listenerCount - -▸ **listenerCount**(`eventName`): `number` - -Returns the number of listeners listening to the event named `eventName`. - -**`since`** v3.2.0 - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `eventName` | `string` \| `symbol` | The name of the event being listened for | - -#### Returns - -`number` - -#### Inherited from - -NodeJS.EventEmitter.listenerCount - -#### Defined in - -packages/types/node_modules/@types/node/ts4.8/events.d.ts:616 - -___ - -### listeners - -▸ **listeners**(`eventName`): `Function`[] - -Returns a copy of the array of listeners for the event named `eventName`. - -```js -server.on('connection', (stream) => { - console.log('someone connected!'); -}); -console.log(util.inspect(server.listeners('connection'))); -// Prints: [ [Function] ] -``` - -**`since`** v0.1.26 - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | `string` \| `symbol` | - -#### Returns - -`Function`[] - -#### Inherited from - -NodeJS.EventEmitter.listeners - -#### Defined in - -packages/types/node_modules/@types/node/ts4.8/events.d.ts:539 - -___ - -### off - -▸ **off**(`eventName`, `listener`): [`EventEmitter`](verida_types._internal_.EventEmitter-1.md) - -Alias for `emitter.removeListener()`. - -**`since`** v10.0.0 - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | `string` \| `symbol` | -| `listener` | (...`args`: `any`[]) => `void` | - -#### Returns - -[`EventEmitter`](verida_types._internal_.EventEmitter-1.md) - -#### Inherited from - -NodeJS.EventEmitter.off - -#### Defined in - -packages/types/node_modules/@types/node/ts4.8/events.d.ts:499 - -___ - -### on - -▸ **on**(`eventName`, `listener`): [`EventEmitter`](verida_types._internal_.EventEmitter-1.md) - -Adds the `listener` function to the end of the listeners array for the -event named `eventName`. No checks are made to see if the `listener` has -already been added. Multiple calls passing the same combination of `eventName`and `listener` will result in the `listener` being added, and called, multiple -times. - -```js -server.on('connection', (stream) => { - console.log('someone connected!'); -}); -``` - -Returns a reference to the `EventEmitter`, so that calls can be chained. - -By default, event listeners are invoked in the order they are added. The`emitter.prependListener()` method can be used as an alternative to add the -event listener to the beginning of the listeners array. - -```js -const myEE = new EventEmitter(); -myEE.on('foo', () => console.log('a')); -myEE.prependListener('foo', () => console.log('b')); -myEE.emit('foo'); -// Prints: -// b -// a -``` - -**`since`** v0.1.101 - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `eventName` | `string` \| `symbol` | The name of the event. | -| `listener` | (...`args`: `any`[]) => `void` | The callback function | - -#### Returns - -[`EventEmitter`](verida_types._internal_.EventEmitter-1.md) - -#### Inherited from - -NodeJS.EventEmitter.on - -#### Defined in - -packages/types/node_modules/@types/node/ts4.8/events.d.ts:385 - -___ - -### once - -▸ **once**(`eventName`, `listener`): [`EventEmitter`](verida_types._internal_.EventEmitter-1.md) - -Adds a **one-time**`listener` function for the event named `eventName`. The -next time `eventName` is triggered, this listener is removed and then invoked. - -```js -server.once('connection', (stream) => { - console.log('Ah, we have our first user!'); -}); -``` - -Returns a reference to the `EventEmitter`, so that calls can be chained. - -By default, event listeners are invoked in the order they are added. The`emitter.prependOnceListener()` method can be used as an alternative to add the -event listener to the beginning of the listeners array. - -```js -const myEE = new EventEmitter(); -myEE.once('foo', () => console.log('a')); -myEE.prependOnceListener('foo', () => console.log('b')); -myEE.emit('foo'); -// Prints: -// b -// a -``` - -**`since`** v0.3.0 - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `eventName` | `string` \| `symbol` | The name of the event. | -| `listener` | (...`args`: `any`[]) => `void` | The callback function | - -#### Returns - -[`EventEmitter`](verida_types._internal_.EventEmitter-1.md) - -#### Inherited from - -NodeJS.EventEmitter.once - -#### Defined in - -packages/types/node_modules/@types/node/ts4.8/events.d.ts:414 - -___ - -### prependListener - -▸ **prependListener**(`eventName`, `listener`): [`EventEmitter`](verida_types._internal_.EventEmitter-1.md) - -Adds the `listener` function to the _beginning_ of the listeners array for the -event named `eventName`. No checks are made to see if the `listener` has -already been added. Multiple calls passing the same combination of `eventName`and `listener` will result in the `listener` being added, and called, multiple -times. - -```js -server.prependListener('connection', (stream) => { - console.log('someone connected!'); -}); -``` - -Returns a reference to the `EventEmitter`, so that calls can be chained. - -**`since`** v6.0.0 - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `eventName` | `string` \| `symbol` | The name of the event. | -| `listener` | (...`args`: `any`[]) => `void` | The callback function | - -#### Returns - -[`EventEmitter`](verida_types._internal_.EventEmitter-1.md) - -#### Inherited from - -NodeJS.EventEmitter.prependListener - -#### Defined in - -packages/types/node_modules/@types/node/ts4.8/events.d.ts:634 - -___ - -### prependOnceListener - -▸ **prependOnceListener**(`eventName`, `listener`): [`EventEmitter`](verida_types._internal_.EventEmitter-1.md) - -Adds a **one-time**`listener` function for the event named `eventName` to the _beginning_ of the listeners array. The next time `eventName` is triggered, this -listener is removed, and then invoked. - -```js -server.prependOnceListener('connection', (stream) => { - console.log('Ah, we have our first user!'); -}); -``` - -Returns a reference to the `EventEmitter`, so that calls can be chained. - -**`since`** v6.0.0 - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `eventName` | `string` \| `symbol` | The name of the event. | -| `listener` | (...`args`: `any`[]) => `void` | The callback function | - -#### Returns - -[`EventEmitter`](verida_types._internal_.EventEmitter-1.md) - -#### Inherited from - -NodeJS.EventEmitter.prependOnceListener - -#### Defined in - -packages/types/node_modules/@types/node/ts4.8/events.d.ts:650 - -___ - -### rawListeners - -▸ **rawListeners**(`eventName`): `Function`[] - -Returns a copy of the array of listeners for the event named `eventName`, -including any wrappers (such as those created by `.once()`). - -```js -const emitter = new EventEmitter(); -emitter.once('log', () => console.log('log once')); - -// Returns a new Array with a function `onceWrapper` which has a property -// `listener` which contains the original listener bound above -const listeners = emitter.rawListeners('log'); -const logFnWrapper = listeners[0]; - -// Logs "log once" to the console and does not unbind the `once` event -logFnWrapper.listener(); - -// Logs "log once" to the console and removes the listener -logFnWrapper(); - -emitter.on('log', () => console.log('log persistently')); -// Will return a new Array with a single function bound by `.on()` above -const newListeners = emitter.rawListeners('log'); - -// Logs "log persistently" twice -newListeners[0](); -emitter.emit('log'); -``` - -**`since`** v9.4.0 - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | `string` \| `symbol` | - -#### Returns - -`Function`[] - -#### Inherited from - -NodeJS.EventEmitter.rawListeners - -#### Defined in - -packages/types/node_modules/@types/node/ts4.8/events.d.ts:569 - -___ - -### removeAllListeners - -▸ **removeAllListeners**(`event?`): [`EventEmitter`](verida_types._internal_.EventEmitter-1.md) - -Removes all listeners, or those of the specified `eventName`. - -It is bad practice to remove listeners added elsewhere in the code, -particularly when the `EventEmitter` instance was created by some other -component or module (e.g. sockets or file streams). - -Returns a reference to the `EventEmitter`, so that calls can be chained. - -**`since`** v0.1.26 - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event?` | `string` \| `symbol` | - -#### Returns - -[`EventEmitter`](verida_types._internal_.EventEmitter-1.md) - -#### Inherited from - -NodeJS.EventEmitter.removeAllListeners - -#### Defined in - -packages/types/node_modules/@types/node/ts4.8/events.d.ts:510 - -___ - -### removeListener - -▸ **removeListener**(`eventName`, `listener`): [`EventEmitter`](verida_types._internal_.EventEmitter-1.md) - -Removes the specified `listener` from the listener array for the event named`eventName`. - -```js -const callback = (stream) => { - console.log('someone connected!'); -}; -server.on('connection', callback); -// ... -server.removeListener('connection', callback); -``` - -`removeListener()` will remove, at most, one instance of a listener from the -listener array. If any single listener has been added multiple times to the -listener array for the specified `eventName`, then `removeListener()` must be -called multiple times to remove each instance. - -Once an event is emitted, all listeners attached to it at the -time of emitting are called in order. This implies that any`removeListener()` or `removeAllListeners()` calls _after_ emitting and _before_ the last listener finishes execution -will not remove them from`emit()` in progress. Subsequent events behave as expected. - -```js -const myEmitter = new MyEmitter(); - -const callbackA = () => { - console.log('A'); - myEmitter.removeListener('event', callbackB); -}; - -const callbackB = () => { - console.log('B'); -}; - -myEmitter.on('event', callbackA); - -myEmitter.on('event', callbackB); - -// callbackA removes listener callbackB but it will still be called. -// Internal listener array at time of emit [callbackA, callbackB] -myEmitter.emit('event'); -// Prints: -// A -// B - -// callbackB is now removed. -// Internal listener array [callbackA] -myEmitter.emit('event'); -// Prints: -// A -``` - -Because listeners are managed using an internal array, calling this will -change the position indices of any listener registered _after_ the listener -being removed. This will not impact the order in which listeners are called, -but it means that any copies of the listener array as returned by -the `emitter.listeners()` method will need to be recreated. - -When a single function has been added as a handler multiple times for a single -event (as in the example below), `removeListener()` will remove the most -recently added instance. In the example the `once('ping')`listener is removed: - -```js -const ee = new EventEmitter(); - -function pong() { - console.log('pong'); -} - -ee.on('ping', pong); -ee.once('ping', pong); -ee.removeListener('ping', pong); - -ee.emit('ping'); -ee.emit('ping'); -``` - -Returns a reference to the `EventEmitter`, so that calls can be chained. - -**`since`** v0.1.26 - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | `string` \| `symbol` | -| `listener` | (...`args`: `any`[]) => `void` | - -#### Returns - -[`EventEmitter`](verida_types._internal_.EventEmitter-1.md) - -#### Inherited from - -NodeJS.EventEmitter.removeListener - -#### Defined in - -packages/types/node_modules/@types/node/ts4.8/events.d.ts:494 - -___ - -### setMaxListeners - -▸ **setMaxListeners**(`n`): [`EventEmitter`](verida_types._internal_.EventEmitter-1.md) - -By default `EventEmitter`s will print a warning if more than `10` listeners are -added for a particular event. This is a useful default that helps finding -memory leaks. The `emitter.setMaxListeners()` method allows the limit to be -modified for this specific `EventEmitter` instance. The value can be set to`Infinity` (or `0`) to indicate an unlimited number of listeners. - -Returns a reference to the `EventEmitter`, so that calls can be chained. - -**`since`** v0.3.5 - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `n` | `number` | - -#### Returns - -[`EventEmitter`](verida_types._internal_.EventEmitter-1.md) - -#### Inherited from - -NodeJS.EventEmitter.setMaxListeners - -#### Defined in - -packages/types/node_modules/@types/node/ts4.8/events.d.ts:520 - -___ - -### getEventListeners - -▸ `Static` **getEventListeners**(`emitter`, `name`): `Function`[] - -Returns a copy of the array of listeners for the event named `eventName`. - -For `EventEmitter`s this behaves exactly the same as calling `.listeners` on -the emitter. - -For `EventTarget`s this is the only way to get the event listeners for the -event target. This is useful for debugging and diagnostic purposes. - -```js -const { getEventListeners, EventEmitter } = require('events'); - -{ - const ee = new EventEmitter(); - const listener = () => console.log('Events are fun'); - ee.on('foo', listener); - getEventListeners(ee, 'foo'); // [listener] -} -{ - const et = new EventTarget(); - const listener = () => console.log('Events are fun'); - et.addEventListener('foo', listener); - getEventListeners(et, 'foo'); // [listener] -} -``` - -**`since`** v15.2.0, v14.17.0 - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `emitter` | `EventEmitter` \| [`_DOMEventTarget`](../interfaces/verida_types._internal_._DOMEventTarget.md) | -| `name` | `string` \| `symbol` | - -#### Returns - -`Function`[] - -#### Defined in - -packages/types/node_modules/@types/node/ts4.8/events.d.ts:299 - -___ - -### listenerCount - -▸ `Static` **listenerCount**(`emitter`, `eventName`): `number` - -A class method that returns the number of listeners for the given `eventName`registered on the given `emitter`. - -```js -const { EventEmitter, listenerCount } = require('events'); -const myEmitter = new EventEmitter(); -myEmitter.on('event', () => {}); -myEmitter.on('event', () => {}); -console.log(listenerCount(myEmitter, 'event')); -// Prints: 2 -``` - -**`since`** v0.9.12 - -**`deprecated`** Since v3.2.0 - Use `listenerCount` instead. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `emitter` | `EventEmitter` | The emitter to query | -| `eventName` | `string` \| `symbol` | The event name | - -#### Returns - -`number` - -#### Inherited from - -NodeJS.EventEmitter.listenerCount - -#### Defined in - -packages/types/node_modules/@types/node/ts4.8/events.d.ts:271 - -___ - -### on - -▸ `Static` **on**(`emitter`, `eventName`, `options?`): [`AsyncIterableIterator`](../interfaces/verida_types._internal_.AsyncIterableIterator.md)<`any`\> - -```js -const { on, EventEmitter } = require('events'); - -(async () => { - const ee = new EventEmitter(); - - // Emit later on - process.nextTick(() => { - ee.emit('foo', 'bar'); - ee.emit('foo', 42); - }); - - for await (const event of on(ee, 'foo')) { - // The execution of this inner block is synchronous and it - // processes one event at a time (even with await). Do not use - // if concurrent execution is required. - console.log(event); // prints ['bar'] [42] - } - // Unreachable here -})(); -``` - -Returns an `AsyncIterator` that iterates `eventName` events. It will throw -if the `EventEmitter` emits `'error'`. It removes all listeners when -exiting the loop. The `value` returned by each iteration is an array -composed of the emitted event arguments. - -An `AbortSignal` can be used to cancel waiting on events: - -```js -const { on, EventEmitter } = require('events'); -const ac = new AbortController(); - -(async () => { - const ee = new EventEmitter(); - - // Emit later on - process.nextTick(() => { - ee.emit('foo', 'bar'); - ee.emit('foo', 42); - }); - - for await (const event of on(ee, 'foo', { signal: ac.signal })) { - // The execution of this inner block is synchronous and it - // processes one event at a time (even with await). Do not use - // if concurrent execution is required. - console.log(event); // prints ['bar'] [42] - } - // Unreachable here -})(); - -process.nextTick(() => ac.abort()); -``` - -**`since`** v13.6.0, v12.16.0 - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `emitter` | `EventEmitter` | - | -| `eventName` | `string` | The name of the event being listened for | -| `options?` | [`StaticEventEmitterOptions`](../interfaces/verida_types._internal_.StaticEventEmitterOptions.md) | - | - -#### Returns - -[`AsyncIterableIterator`](../interfaces/verida_types._internal_.AsyncIterableIterator.md)<`any`\> - -that iterates `eventName` events emitted by the `emitter` - -#### Inherited from - -NodeJS.EventEmitter.on - -#### Defined in - -packages/types/node_modules/@types/node/ts4.8/events.d.ts:254 - -___ - -### once - -▸ `Static` **once**(`emitter`, `eventName`, `options?`): `Promise`<`any`[]\> - -Creates a `Promise` that is fulfilled when the `EventEmitter` emits the given -event or that is rejected if the `EventEmitter` emits `'error'` while waiting. -The `Promise` will resolve with an array of all the arguments emitted to the -given event. - -This method is intentionally generic and works with the web platform [EventTarget](https://dom.spec.whatwg.org/#interface-eventtarget) interface, which has no special`'error'` event -semantics and does not listen to the `'error'` event. - -```js -const { once, EventEmitter } = require('events'); - -async function run() { - const ee = new EventEmitter(); - - process.nextTick(() => { - ee.emit('myevent', 42); - }); - - const [value] = await once(ee, 'myevent'); - console.log(value); - - const err = new Error('kaboom'); - process.nextTick(() => { - ee.emit('error', err); - }); - - try { - await once(ee, 'myevent'); - } catch (err) { - console.log('error happened', err); - } -} - -run(); -``` - -The special handling of the `'error'` event is only used when `events.once()`is used to wait for another event. If `events.once()` is used to wait for the -'`error'` event itself, then it is treated as any other kind of event without -special handling: - -```js -const { EventEmitter, once } = require('events'); - -const ee = new EventEmitter(); - -once(ee, 'error') - .then(([err]) => console.log('ok', err.message)) - .catch((err) => console.log('error', err.message)); - -ee.emit('error', new Error('boom')); - -// Prints: ok boom -``` - -An `AbortSignal` can be used to cancel waiting for the event: - -```js -const { EventEmitter, once } = require('events'); - -const ee = new EventEmitter(); -const ac = new AbortController(); - -async function foo(emitter, event, signal) { - try { - await once(emitter, event, { signal }); - console.log('event emitted!'); - } catch (error) { - if (error.name === 'AbortError') { - console.error('Waiting for the event was canceled!'); - } else { - console.error('There was an error', error.message); - } - } -} - -foo(ee, 'foo', ac.signal); -ac.abort(); // Abort waiting for the event -ee.emit('foo'); // Prints: Waiting for the event was canceled! -``` - -**`since`** v11.13.0, v10.16.0 - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `emitter` | [`_NodeEventTarget`](../interfaces/verida_types._internal_._NodeEventTarget.md) | -| `eventName` | `string` \| `symbol` | -| `options?` | [`StaticEventEmitterOptions`](../interfaces/verida_types._internal_.StaticEventEmitterOptions.md) | - -#### Returns - -`Promise`<`any`[]\> - -#### Inherited from - -NodeJS.EventEmitter.once - -#### Defined in - -packages/types/node_modules/@types/node/ts4.8/events.d.ts:194 - -▸ `Static` **once**(`emitter`, `eventName`, `options?`): `Promise`<`any`[]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `emitter` | [`_DOMEventTarget`](../interfaces/verida_types._internal_._DOMEventTarget.md) | -| `eventName` | `string` | -| `options?` | [`StaticEventEmitterOptions`](../interfaces/verida_types._internal_.StaticEventEmitterOptions.md) | - -#### Returns - -`Promise`<`any`[]\> - -#### Inherited from - -NodeJS.EventEmitter.once - -#### Defined in - -packages/types/node_modules/@types/node/ts4.8/events.d.ts:195 - -___ - -### setMaxListeners - -▸ `Static` **setMaxListeners**(`n?`, ...`eventTargets`): `void` - -```js -const { - setMaxListeners, - EventEmitter -} = require('events'); - -const target = new EventTarget(); -const emitter = new EventEmitter(); - -setMaxListeners(5, target, emitter); -``` - -**`since`** v15.4.0 - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `n?` | `number` | A non-negative number. The maximum number of listeners per `EventTarget` event. | -| `...eventTargets` | (`EventEmitter` \| [`_DOMEventTarget`](../interfaces/verida_types._internal_._DOMEventTarget.md))[] | - | - -#### Returns - -`void` - -#### Inherited from - -NodeJS.EventEmitter.setMaxListeners - -#### Defined in - -packages/types/node_modules/@types/node/ts4.8/events.d.ts:317 diff --git a/docs/api/verida-js/classes/verida_types._internal_.ForkEvent.md b/docs/api/verida-js/classes/verida_types._internal_.ForkEvent.md deleted file mode 100644 index 7f84b47..0000000 --- a/docs/api/verida-js/classes/verida_types._internal_.ForkEvent.md +++ /dev/null @@ -1,86 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/types](../modules/verida_types.md) / [](../modules/verida_types._internal_.md) / ForkEvent - -# Class: ForkEvent - -[@verida/types](../modules/verida_types.md).[](../modules/verida_types._internal_.md).ForkEvent - -## Hierarchy - -- [`Description`](verida_types._internal_.Description.md) - - ↳ **`ForkEvent`** - -## Table of contents - -### Constructors - -- [constructor](verida_types._internal_.ForkEvent.md#constructor) - -### Properties - -- [\_isForkEvent](verida_types._internal_.ForkEvent.md#_isforkevent) -- [expiry](verida_types._internal_.ForkEvent.md#expiry) - -### Methods - -- [isForkEvent](verida_types._internal_.ForkEvent.md#isforkevent) - -## Constructors - -### constructor - -• **new ForkEvent**(`info`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `info` | `Object` | - -#### Inherited from - -[Description](verida_types._internal_.Description.md).[constructor](verida_types._internal_.Description.md#constructor) - -#### Defined in - -node_modules/@ethersproject/properties/lib/index.d.ts:13 - -## Properties - -### \_isForkEvent - -• `Optional` `Readonly` **\_isForkEvent**: `boolean` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:103 - -___ - -### expiry - -• `Readonly` **expiry**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:102 - -## Methods - -### isForkEvent - -▸ `Static` **isForkEvent**(`value`): value is ForkEvent - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `any` | - -#### Returns - -value is ForkEvent - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:104 diff --git a/docs/api/verida-js/classes/verida_types._internal_.Provider.md b/docs/api/verida-js/classes/verida_types._internal_.Provider.md deleted file mode 100644 index fb930ab..0000000 --- a/docs/api/verida-js/classes/verida_types._internal_.Provider.md +++ /dev/null @@ -1,645 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/types](../modules/verida_types.md) / [](../modules/verida_types._internal_.md) / Provider - -# Class: Provider - -[@verida/types](../modules/verida_types.md).[](../modules/verida_types._internal_.md).Provider - -## Implements - -- [`OnceBlockable`](../interfaces/verida_types._internal_.OnceBlockable.md) - -## Table of contents - -### Constructors - -- [constructor](verida_types._internal_.Provider.md#constructor) - -### Properties - -- [\_isProvider](verida_types._internal_.Provider.md#_isprovider) - -### Methods - -- [addListener](verida_types._internal_.Provider.md#addlistener) -- [call](verida_types._internal_.Provider.md#call) -- [emit](verida_types._internal_.Provider.md#emit) -- [estimateGas](verida_types._internal_.Provider.md#estimategas) -- [getBalance](verida_types._internal_.Provider.md#getbalance) -- [getBlock](verida_types._internal_.Provider.md#getblock) -- [getBlockNumber](verida_types._internal_.Provider.md#getblocknumber) -- [getBlockWithTransactions](verida_types._internal_.Provider.md#getblockwithtransactions) -- [getCode](verida_types._internal_.Provider.md#getcode) -- [getFeeData](verida_types._internal_.Provider.md#getfeedata) -- [getGasPrice](verida_types._internal_.Provider.md#getgasprice) -- [getLogs](verida_types._internal_.Provider.md#getlogs) -- [getNetwork](verida_types._internal_.Provider.md#getnetwork) -- [getStorageAt](verida_types._internal_.Provider.md#getstorageat) -- [getTransaction](verida_types._internal_.Provider.md#gettransaction) -- [getTransactionCount](verida_types._internal_.Provider.md#gettransactioncount) -- [getTransactionReceipt](verida_types._internal_.Provider.md#gettransactionreceipt) -- [listenerCount](verida_types._internal_.Provider.md#listenercount) -- [listeners](verida_types._internal_.Provider.md#listeners) -- [lookupAddress](verida_types._internal_.Provider.md#lookupaddress) -- [off](verida_types._internal_.Provider.md#off) -- [on](verida_types._internal_.Provider.md#on) -- [once](verida_types._internal_.Provider.md#once) -- [removeAllListeners](verida_types._internal_.Provider.md#removealllisteners) -- [removeListener](verida_types._internal_.Provider.md#removelistener) -- [resolveName](verida_types._internal_.Provider.md#resolvename) -- [sendTransaction](verida_types._internal_.Provider.md#sendtransaction) -- [waitForTransaction](verida_types._internal_.Provider.md#waitfortransaction) -- [isProvider](verida_types._internal_.Provider.md#isprovider) - -## Constructors - -### constructor - -• **new Provider**() - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:153 - -## Properties - -### \_isProvider - -• `Readonly` **\_isProvider**: `boolean` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:152 - -## Methods - -### addListener - -▸ **addListener**(`eventName`, `listener`): [`Provider`](verida_types._internal_.Provider.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | [`EventType`](../modules/verida_types._internal_.md#eventtype) | -| `listener` | [`Listener`](../modules/verida_types._internal_.md#listener) | - -#### Returns - -[`Provider`](verida_types._internal_.Provider.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:149 - -___ - -### call - -▸ `Abstract` **call**(`transaction`, `blockTag?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transaction` | [`Deferrable`](../modules/verida_types._internal_.md#deferrable)<[`TransactionRequest`](../modules/verida_types._internal_.md#transactionrequest)\> | -| `blockTag?` | [`BlockTag`](../modules/verida_types._internal_.md#blocktag) \| `Promise`<[`BlockTag`](../modules/verida_types._internal_.md#blocktag)\> | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:133 - -___ - -### emit - -▸ `Abstract` **emit**(`eventName`, ...`args`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | [`EventType`](../modules/verida_types._internal_.md#eventtype) | -| `...args` | `any`[] | - -#### Returns - -`boolean` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:144 - -___ - -### estimateGas - -▸ `Abstract` **estimateGas**(`transaction`): `Promise`<[`BigNumber`](verida_types._internal_.BigNumber.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transaction` | [`Deferrable`](../modules/verida_types._internal_.md#deferrable)<[`TransactionRequest`](../modules/verida_types._internal_.md#transactionrequest)\> | - -#### Returns - -`Promise`<[`BigNumber`](verida_types._internal_.BigNumber.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:134 - -___ - -### getBalance - -▸ `Abstract` **getBalance**(`addressOrName`, `blockTag?`): `Promise`<[`BigNumber`](verida_types._internal_.BigNumber.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `addressOrName` | `string` \| `Promise`<`string`\> | -| `blockTag?` | [`BlockTag`](../modules/verida_types._internal_.md#blocktag) \| `Promise`<[`BlockTag`](../modules/verida_types._internal_.md#blocktag)\> | - -#### Returns - -`Promise`<[`BigNumber`](verida_types._internal_.BigNumber.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:128 - -___ - -### getBlock - -▸ `Abstract` **getBlock**(`blockHashOrBlockTag`): `Promise`<[`Block`](../interfaces/verida_types._internal_.Block.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `blockHashOrBlockTag` | [`BlockTag`](../modules/verida_types._internal_.md#blocktag) \| `Promise`<[`BlockTag`](../modules/verida_types._internal_.md#blocktag)\> | - -#### Returns - -`Promise`<[`Block`](../interfaces/verida_types._internal_.Block.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:135 - -___ - -### getBlockNumber - -▸ `Abstract` **getBlockNumber**(): `Promise`<`number`\> - -#### Returns - -`Promise`<`number`\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:125 - -___ - -### getBlockWithTransactions - -▸ `Abstract` **getBlockWithTransactions**(`blockHashOrBlockTag`): `Promise`<[`BlockWithTransactions`](../interfaces/verida_types._internal_.BlockWithTransactions.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `blockHashOrBlockTag` | [`BlockTag`](../modules/verida_types._internal_.md#blocktag) \| `Promise`<[`BlockTag`](../modules/verida_types._internal_.md#blocktag)\> | - -#### Returns - -`Promise`<[`BlockWithTransactions`](../interfaces/verida_types._internal_.BlockWithTransactions.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:136 - -___ - -### getCode - -▸ `Abstract` **getCode**(`addressOrName`, `blockTag?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `addressOrName` | `string` \| `Promise`<`string`\> | -| `blockTag?` | [`BlockTag`](../modules/verida_types._internal_.md#blocktag) \| `Promise`<[`BlockTag`](../modules/verida_types._internal_.md#blocktag)\> | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:130 - -___ - -### getFeeData - -▸ **getFeeData**(): `Promise`<[`FeeData`](../interfaces/verida_types._internal_.FeeData.md)\> - -#### Returns - -`Promise`<[`FeeData`](../interfaces/verida_types._internal_.FeeData.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:127 - -___ - -### getGasPrice - -▸ `Abstract` **getGasPrice**(): `Promise`<[`BigNumber`](verida_types._internal_.BigNumber.md)\> - -#### Returns - -`Promise`<[`BigNumber`](verida_types._internal_.BigNumber.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:126 - -___ - -### getLogs - -▸ `Abstract` **getLogs**(`filter`): `Promise`<[`Log`](../interfaces/verida_types._internal_.Log.md)[]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `filter` | [`Filter`](../interfaces/verida_types._internal_.Filter.md) | - -#### Returns - -`Promise`<[`Log`](../interfaces/verida_types._internal_.Log.md)[]\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:139 - -___ - -### getNetwork - -▸ `Abstract` **getNetwork**(): `Promise`<[`Network`](../modules/verida_types._internal_.md#network)\> - -#### Returns - -`Promise`<[`Network`](../modules/verida_types._internal_.md#network)\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:124 - -___ - -### getStorageAt - -▸ `Abstract` **getStorageAt**(`addressOrName`, `position`, `blockTag?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `addressOrName` | `string` \| `Promise`<`string`\> | -| `position` | [`BigNumberish`](../modules/verida_types._internal_.md#bignumberish) \| `Promise`<[`BigNumberish`](../modules/verida_types._internal_.md#bignumberish)\> | -| `blockTag?` | [`BlockTag`](../modules/verida_types._internal_.md#blocktag) \| `Promise`<[`BlockTag`](../modules/verida_types._internal_.md#blocktag)\> | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:131 - -___ - -### getTransaction - -▸ `Abstract` **getTransaction**(`transactionHash`): `Promise`<[`TransactionResponse`](../interfaces/verida_types._internal_.TransactionResponse.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transactionHash` | `string` | - -#### Returns - -`Promise`<[`TransactionResponse`](../interfaces/verida_types._internal_.TransactionResponse.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:137 - -___ - -### getTransactionCount - -▸ `Abstract` **getTransactionCount**(`addressOrName`, `blockTag?`): `Promise`<`number`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `addressOrName` | `string` \| `Promise`<`string`\> | -| `blockTag?` | [`BlockTag`](../modules/verida_types._internal_.md#blocktag) \| `Promise`<[`BlockTag`](../modules/verida_types._internal_.md#blocktag)\> | - -#### Returns - -`Promise`<`number`\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:129 - -___ - -### getTransactionReceipt - -▸ `Abstract` **getTransactionReceipt**(`transactionHash`): `Promise`<[`TransactionReceipt`](../interfaces/verida_types._internal_.TransactionReceipt.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transactionHash` | `string` | - -#### Returns - -`Promise`<[`TransactionReceipt`](../interfaces/verida_types._internal_.TransactionReceipt.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:138 - -___ - -### listenerCount - -▸ `Abstract` **listenerCount**(`eventName?`): `number` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName?` | [`EventType`](../modules/verida_types._internal_.md#eventtype) | - -#### Returns - -`number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:145 - -___ - -### listeners - -▸ `Abstract` **listeners**(`eventName?`): [`Listener`](../modules/verida_types._internal_.md#listener)[] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName?` | [`EventType`](../modules/verida_types._internal_.md#eventtype) | - -#### Returns - -[`Listener`](../modules/verida_types._internal_.md#listener)[] - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:146 - -___ - -### lookupAddress - -▸ `Abstract` **lookupAddress**(`address`): `Promise`<``null`` \| `string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `address` | `string` \| `Promise`<`string`\> | - -#### Returns - -`Promise`<``null`` \| `string`\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:141 - -___ - -### off - -▸ `Abstract` **off**(`eventName`, `listener?`): [`Provider`](verida_types._internal_.Provider.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | [`EventType`](../modules/verida_types._internal_.md#eventtype) | -| `listener?` | [`Listener`](../modules/verida_types._internal_.md#listener) | - -#### Returns - -[`Provider`](verida_types._internal_.Provider.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:147 - -___ - -### on - -▸ `Abstract` **on**(`eventName`, `listener`): [`Provider`](verida_types._internal_.Provider.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | [`EventType`](../modules/verida_types._internal_.md#eventtype) | -| `listener` | [`Listener`](../modules/verida_types._internal_.md#listener) | - -#### Returns - -[`Provider`](verida_types._internal_.Provider.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:142 - -___ - -### once - -▸ `Abstract` **once**(`eventName`, `listener`): [`Provider`](verida_types._internal_.Provider.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | [`EventType`](../modules/verida_types._internal_.md#eventtype) | -| `listener` | [`Listener`](../modules/verida_types._internal_.md#listener) | - -#### Returns - -[`Provider`](verida_types._internal_.Provider.md) - -#### Implementation of - -[OnceBlockable](../interfaces/verida_types._internal_.OnceBlockable.md).[once](../interfaces/verida_types._internal_.OnceBlockable.md#once) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:143 - -___ - -### removeAllListeners - -▸ `Abstract` **removeAllListeners**(`eventName?`): [`Provider`](verida_types._internal_.Provider.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName?` | [`EventType`](../modules/verida_types._internal_.md#eventtype) | - -#### Returns - -[`Provider`](verida_types._internal_.Provider.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:148 - -___ - -### removeListener - -▸ **removeListener**(`eventName`, `listener`): [`Provider`](verida_types._internal_.Provider.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | [`EventType`](../modules/verida_types._internal_.md#eventtype) | -| `listener` | [`Listener`](../modules/verida_types._internal_.md#listener) | - -#### Returns - -[`Provider`](verida_types._internal_.Provider.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:150 - -___ - -### resolveName - -▸ `Abstract` **resolveName**(`name`): `Promise`<``null`` \| `string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` \| `Promise`<`string`\> | - -#### Returns - -`Promise`<``null`` \| `string`\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:140 - -___ - -### sendTransaction - -▸ `Abstract` **sendTransaction**(`signedTransaction`): `Promise`<[`TransactionResponse`](../interfaces/verida_types._internal_.TransactionResponse.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `signedTransaction` | `string` \| `Promise`<`string`\> | - -#### Returns - -`Promise`<[`TransactionResponse`](../interfaces/verida_types._internal_.TransactionResponse.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:132 - -___ - -### waitForTransaction - -▸ `Abstract` **waitForTransaction**(`transactionHash`, `confirmations?`, `timeout?`): `Promise`<[`TransactionReceipt`](../interfaces/verida_types._internal_.TransactionReceipt.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transactionHash` | `string` | -| `confirmations?` | `number` | -| `timeout?` | `number` | - -#### Returns - -`Promise`<[`TransactionReceipt`](../interfaces/verida_types._internal_.TransactionReceipt.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:151 - -___ - -### isProvider - -▸ `Static` **isProvider**(`value`): value is Provider - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `any` | - -#### Returns - -value is Provider - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:154 diff --git a/docs/api/verida-js/classes/verida_types._internal_.Signer.md b/docs/api/verida-js/classes/verida_types._internal_.Signer.md deleted file mode 100644 index 23dc567..0000000 --- a/docs/api/verida-js/classes/verida_types._internal_.Signer.md +++ /dev/null @@ -1,383 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/types](../modules/verida_types.md) / [](../modules/verida_types._internal_.md) / Signer - -# Class: Signer - -[@verida/types](../modules/verida_types.md).[](../modules/verida_types._internal_.md).Signer - -## Table of contents - -### Constructors - -- [constructor](verida_types._internal_.Signer.md#constructor) - -### Properties - -- [\_isSigner](verida_types._internal_.Signer.md#_issigner) -- [provider](verida_types._internal_.Signer.md#provider) - -### Methods - -- [\_checkProvider](verida_types._internal_.Signer.md#_checkprovider) -- [call](verida_types._internal_.Signer.md#call) -- [checkTransaction](verida_types._internal_.Signer.md#checktransaction) -- [connect](verida_types._internal_.Signer.md#connect) -- [estimateGas](verida_types._internal_.Signer.md#estimategas) -- [getAddress](verida_types._internal_.Signer.md#getaddress) -- [getBalance](verida_types._internal_.Signer.md#getbalance) -- [getChainId](verida_types._internal_.Signer.md#getchainid) -- [getFeeData](verida_types._internal_.Signer.md#getfeedata) -- [getGasPrice](verida_types._internal_.Signer.md#getgasprice) -- [getTransactionCount](verida_types._internal_.Signer.md#gettransactioncount) -- [populateTransaction](verida_types._internal_.Signer.md#populatetransaction) -- [resolveName](verida_types._internal_.Signer.md#resolvename) -- [sendTransaction](verida_types._internal_.Signer.md#sendtransaction) -- [signMessage](verida_types._internal_.Signer.md#signmessage) -- [signTransaction](verida_types._internal_.Signer.md#signtransaction) -- [isSigner](verida_types._internal_.Signer.md#issigner) - -## Constructors - -### constructor - -• **new Signer**() - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:30 - -## Properties - -### \_isSigner - -• `Readonly` **\_isSigner**: `boolean` - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:29 - -___ - -### provider - -• `Optional` `Readonly` **provider**: [`Provider`](verida_types._internal_.Provider.md) - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:24 - -## Methods - -### \_checkProvider - -▸ **_checkProvider**(`operation?`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `operation?` | `string` | - -#### Returns - -`void` - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:42 - -___ - -### call - -▸ **call**(`transaction`, `blockTag?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transaction` | [`Deferrable`](../modules/verida_types._internal_.md#deferrable)<[`TransactionRequest`](../modules/verida_types._internal_.md#transactionrequest)\> | -| `blockTag?` | [`BlockTag`](../modules/verida_types._internal_.md#blocktag) | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:34 - -___ - -### checkTransaction - -▸ **checkTransaction**(`transaction`): [`Deferrable`](../modules/verida_types._internal_.md#deferrable)<[`TransactionRequest`](../modules/verida_types._internal_.md#transactionrequest)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transaction` | [`Deferrable`](../modules/verida_types._internal_.md#deferrable)<[`TransactionRequest`](../modules/verida_types._internal_.md#transactionrequest)\> | - -#### Returns - -[`Deferrable`](../modules/verida_types._internal_.md#deferrable)<[`TransactionRequest`](../modules/verida_types._internal_.md#transactionrequest)\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:40 - -___ - -### connect - -▸ `Abstract` **connect**(`provider`): [`Signer`](verida_types._internal_.Signer.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `provider` | [`Provider`](verida_types._internal_.Provider.md) | - -#### Returns - -[`Signer`](verida_types._internal_.Signer.md) - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:28 - -___ - -### estimateGas - -▸ **estimateGas**(`transaction`): `Promise`<[`BigNumber`](verida_types._internal_.BigNumber.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transaction` | [`Deferrable`](../modules/verida_types._internal_.md#deferrable)<[`TransactionRequest`](../modules/verida_types._internal_.md#transactionrequest)\> | - -#### Returns - -`Promise`<[`BigNumber`](verida_types._internal_.BigNumber.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:33 - -___ - -### getAddress - -▸ `Abstract` **getAddress**(): `Promise`<`string`\> - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:25 - -___ - -### getBalance - -▸ **getBalance**(`blockTag?`): `Promise`<[`BigNumber`](verida_types._internal_.BigNumber.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `blockTag?` | [`BlockTag`](../modules/verida_types._internal_.md#blocktag) | - -#### Returns - -`Promise`<[`BigNumber`](verida_types._internal_.BigNumber.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:31 - -___ - -### getChainId - -▸ **getChainId**(): `Promise`<`number`\> - -#### Returns - -`Promise`<`number`\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:36 - -___ - -### getFeeData - -▸ **getFeeData**(): `Promise`<[`FeeData`](../interfaces/verida_types._internal_.FeeData.md)\> - -#### Returns - -`Promise`<[`FeeData`](../interfaces/verida_types._internal_.FeeData.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:38 - -___ - -### getGasPrice - -▸ **getGasPrice**(): `Promise`<[`BigNumber`](verida_types._internal_.BigNumber.md)\> - -#### Returns - -`Promise`<[`BigNumber`](verida_types._internal_.BigNumber.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:37 - -___ - -### getTransactionCount - -▸ **getTransactionCount**(`blockTag?`): `Promise`<`number`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `blockTag?` | [`BlockTag`](../modules/verida_types._internal_.md#blocktag) | - -#### Returns - -`Promise`<`number`\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:32 - -___ - -### populateTransaction - -▸ **populateTransaction**(`transaction`): `Promise`<[`TransactionRequest`](../modules/verida_types._internal_.md#transactionrequest)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transaction` | [`Deferrable`](../modules/verida_types._internal_.md#deferrable)<[`TransactionRequest`](../modules/verida_types._internal_.md#transactionrequest)\> | - -#### Returns - -`Promise`<[`TransactionRequest`](../modules/verida_types._internal_.md#transactionrequest)\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:41 - -___ - -### resolveName - -▸ **resolveName**(`name`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:39 - -___ - -### sendTransaction - -▸ **sendTransaction**(`transaction`): `Promise`<[`TransactionResponse`](../interfaces/verida_types._internal_.TransactionResponse.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transaction` | [`Deferrable`](../modules/verida_types._internal_.md#deferrable)<[`TransactionRequest`](../modules/verida_types._internal_.md#transactionrequest)\> | - -#### Returns - -`Promise`<[`TransactionResponse`](../interfaces/verida_types._internal_.TransactionResponse.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:35 - -___ - -### signMessage - -▸ `Abstract` **signMessage**(`message`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `message` | `string` \| [`Bytes`](../modules/verida_types._internal_.md#bytes) | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:26 - -___ - -### signTransaction - -▸ `Abstract` **signTransaction**(`transaction`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transaction` | [`Deferrable`](../modules/verida_types._internal_.md#deferrable)<[`TransactionRequest`](../modules/verida_types._internal_.md#transactionrequest)\> | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:27 - -___ - -### isSigner - -▸ `Static` **isSigner**(`value`): value is Signer - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `any` | - -#### Returns - -value is Signer - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:43 diff --git a/docs/api/verida-js/classes/verida_vda_common._internal_.BigNumber.md b/docs/api/verida-js/classes/verida_vda_common._internal_.BigNumber.md deleted file mode 100644 index 83ead26..0000000 --- a/docs/api/verida-js/classes/verida_vda_common._internal_.BigNumber.md +++ /dev/null @@ -1,631 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-common](../modules/verida_vda_common.md) / [](../modules/verida_vda_common._internal_.md) / BigNumber - -# Class: BigNumber - -[@verida/vda-common](../modules/verida_vda_common.md).[](../modules/verida_vda_common._internal_.md).BigNumber - -## Implements - -- [`Hexable`](../interfaces/verida_vda_common._internal_.Hexable.md) - -## Table of contents - -### Constructors - -- [constructor](verida_vda_common._internal_.BigNumber.md#constructor) - -### Properties - -- [\_hex](verida_vda_common._internal_.BigNumber.md#_hex) -- [\_isBigNumber](verida_vda_common._internal_.BigNumber.md#_isbignumber) - -### Methods - -- [abs](verida_vda_common._internal_.BigNumber.md#abs) -- [add](verida_vda_common._internal_.BigNumber.md#add) -- [and](verida_vda_common._internal_.BigNumber.md#and) -- [div](verida_vda_common._internal_.BigNumber.md#div) -- [eq](verida_vda_common._internal_.BigNumber.md#eq) -- [fromTwos](verida_vda_common._internal_.BigNumber.md#fromtwos) -- [gt](verida_vda_common._internal_.BigNumber.md#gt) -- [gte](verida_vda_common._internal_.BigNumber.md#gte) -- [isNegative](verida_vda_common._internal_.BigNumber.md#isnegative) -- [isZero](verida_vda_common._internal_.BigNumber.md#iszero) -- [lt](verida_vda_common._internal_.BigNumber.md#lt) -- [lte](verida_vda_common._internal_.BigNumber.md#lte) -- [mask](verida_vda_common._internal_.BigNumber.md#mask) -- [mod](verida_vda_common._internal_.BigNumber.md#mod) -- [mul](verida_vda_common._internal_.BigNumber.md#mul) -- [or](verida_vda_common._internal_.BigNumber.md#or) -- [pow](verida_vda_common._internal_.BigNumber.md#pow) -- [shl](verida_vda_common._internal_.BigNumber.md#shl) -- [shr](verida_vda_common._internal_.BigNumber.md#shr) -- [sub](verida_vda_common._internal_.BigNumber.md#sub) -- [toBigInt](verida_vda_common._internal_.BigNumber.md#tobigint) -- [toHexString](verida_vda_common._internal_.BigNumber.md#tohexstring) -- [toJSON](verida_vda_common._internal_.BigNumber.md#tojson) -- [toNumber](verida_vda_common._internal_.BigNumber.md#tonumber) -- [toString](verida_vda_common._internal_.BigNumber.md#tostring) -- [toTwos](verida_vda_common._internal_.BigNumber.md#totwos) -- [xor](verida_vda_common._internal_.BigNumber.md#xor) -- [from](verida_vda_common._internal_.BigNumber.md#from) -- [isBigNumber](verida_vda_common._internal_.BigNumber.md#isbignumber) - -## Constructors - -### constructor - -• **new BigNumber**(`constructorGuard`, `hex`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `constructorGuard` | `any` | -| `hex` | `string` | - -#### Defined in - -node_modules/ethers/node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:7 - -## Properties - -### \_hex - -• `Readonly` **\_hex**: `string` - -#### Defined in - -node_modules/ethers/node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:5 - -___ - -### \_isBigNumber - -• `Readonly` **\_isBigNumber**: `boolean` - -#### Defined in - -node_modules/ethers/node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:6 - -## Methods - -### abs - -▸ **abs**(): [`BigNumber`](verida_vda_common._internal_.BigNumber.md) - -#### Returns - -[`BigNumber`](verida_vda_common._internal_.BigNumber.md) - -#### Defined in - -node_modules/ethers/node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:10 - -___ - -### add - -▸ **add**(`other`): [`BigNumber`](verida_vda_common._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_vda_common._internal_.md#bignumberish) | - -#### Returns - -[`BigNumber`](verida_vda_common._internal_.BigNumber.md) - -#### Defined in - -node_modules/ethers/node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:11 - -___ - -### and - -▸ **and**(`other`): [`BigNumber`](verida_vda_common._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_vda_common._internal_.md#bignumberish) | - -#### Returns - -[`BigNumber`](verida_vda_common._internal_.BigNumber.md) - -#### Defined in - -node_modules/ethers/node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:17 - -___ - -### div - -▸ **div**(`other`): [`BigNumber`](verida_vda_common._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_vda_common._internal_.md#bignumberish) | - -#### Returns - -[`BigNumber`](verida_vda_common._internal_.BigNumber.md) - -#### Defined in - -node_modules/ethers/node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:13 - -___ - -### eq - -▸ **eq**(`other`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_vda_common._internal_.md#bignumberish) | - -#### Returns - -`boolean` - -#### Defined in - -node_modules/ethers/node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:23 - -___ - -### fromTwos - -▸ **fromTwos**(`value`): [`BigNumber`](verida_vda_common._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `number` | - -#### Returns - -[`BigNumber`](verida_vda_common._internal_.BigNumber.md) - -#### Defined in - -node_modules/ethers/node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:8 - -___ - -### gt - -▸ **gt**(`other`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_vda_common._internal_.md#bignumberish) | - -#### Returns - -`boolean` - -#### Defined in - -node_modules/ethers/node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:26 - -___ - -### gte - -▸ **gte**(`other`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_vda_common._internal_.md#bignumberish) | - -#### Returns - -`boolean` - -#### Defined in - -node_modules/ethers/node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:27 - -___ - -### isNegative - -▸ **isNegative**(): `boolean` - -#### Returns - -`boolean` - -#### Defined in - -node_modules/ethers/node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:28 - -___ - -### isZero - -▸ **isZero**(): `boolean` - -#### Returns - -`boolean` - -#### Defined in - -node_modules/ethers/node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:29 - -___ - -### lt - -▸ **lt**(`other`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_vda_common._internal_.md#bignumberish) | - -#### Returns - -`boolean` - -#### Defined in - -node_modules/ethers/node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:24 - -___ - -### lte - -▸ **lte**(`other`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_vda_common._internal_.md#bignumberish) | - -#### Returns - -`boolean` - -#### Defined in - -node_modules/ethers/node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:25 - -___ - -### mask - -▸ **mask**(`value`): [`BigNumber`](verida_vda_common._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `number` | - -#### Returns - -[`BigNumber`](verida_vda_common._internal_.BigNumber.md) - -#### Defined in - -node_modules/ethers/node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:20 - -___ - -### mod - -▸ **mod**(`other`): [`BigNumber`](verida_vda_common._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_vda_common._internal_.md#bignumberish) | - -#### Returns - -[`BigNumber`](verida_vda_common._internal_.BigNumber.md) - -#### Defined in - -node_modules/ethers/node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:15 - -___ - -### mul - -▸ **mul**(`other`): [`BigNumber`](verida_vda_common._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_vda_common._internal_.md#bignumberish) | - -#### Returns - -[`BigNumber`](verida_vda_common._internal_.BigNumber.md) - -#### Defined in - -node_modules/ethers/node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:14 - -___ - -### or - -▸ **or**(`other`): [`BigNumber`](verida_vda_common._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_vda_common._internal_.md#bignumberish) | - -#### Returns - -[`BigNumber`](verida_vda_common._internal_.BigNumber.md) - -#### Defined in - -node_modules/ethers/node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:18 - -___ - -### pow - -▸ **pow**(`other`): [`BigNumber`](verida_vda_common._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_vda_common._internal_.md#bignumberish) | - -#### Returns - -[`BigNumber`](verida_vda_common._internal_.BigNumber.md) - -#### Defined in - -node_modules/ethers/node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:16 - -___ - -### shl - -▸ **shl**(`value`): [`BigNumber`](verida_vda_common._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `number` | - -#### Returns - -[`BigNumber`](verida_vda_common._internal_.BigNumber.md) - -#### Defined in - -node_modules/ethers/node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:21 - -___ - -### shr - -▸ **shr**(`value`): [`BigNumber`](verida_vda_common._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `number` | - -#### Returns - -[`BigNumber`](verida_vda_common._internal_.BigNumber.md) - -#### Defined in - -node_modules/ethers/node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:22 - -___ - -### sub - -▸ **sub**(`other`): [`BigNumber`](verida_vda_common._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_vda_common._internal_.md#bignumberish) | - -#### Returns - -[`BigNumber`](verida_vda_common._internal_.BigNumber.md) - -#### Defined in - -node_modules/ethers/node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:12 - -___ - -### toBigInt - -▸ **toBigInt**(): `bigint` - -#### Returns - -`bigint` - -#### Defined in - -node_modules/ethers/node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:31 - -___ - -### toHexString - -▸ **toHexString**(): `string` - -#### Returns - -`string` - -#### Implementation of - -[Hexable](../interfaces/verida_vda_common._internal_.Hexable.md).[toHexString](../interfaces/verida_vda_common._internal_.Hexable.md#tohexstring) - -#### Defined in - -node_modules/ethers/node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:33 - -___ - -### toJSON - -▸ **toJSON**(`key?`): `any` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `key?` | `string` | - -#### Returns - -`any` - -#### Defined in - -node_modules/ethers/node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:34 - -___ - -### toNumber - -▸ **toNumber**(): `number` - -#### Returns - -`number` - -#### Defined in - -node_modules/ethers/node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:30 - -___ - -### toString - -▸ **toString**(): `string` - -#### Returns - -`string` - -#### Defined in - -node_modules/ethers/node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:32 - -___ - -### toTwos - -▸ **toTwos**(`value`): [`BigNumber`](verida_vda_common._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `number` | - -#### Returns - -[`BigNumber`](verida_vda_common._internal_.BigNumber.md) - -#### Defined in - -node_modules/ethers/node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:9 - -___ - -### xor - -▸ **xor**(`other`): [`BigNumber`](verida_vda_common._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_vda_common._internal_.md#bignumberish) | - -#### Returns - -[`BigNumber`](verida_vda_common._internal_.BigNumber.md) - -#### Defined in - -node_modules/ethers/node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:19 - -___ - -### from - -▸ `Static` **from**(`value`): [`BigNumber`](verida_vda_common._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `any` | - -#### Returns - -[`BigNumber`](verida_vda_common._internal_.BigNumber.md) - -#### Defined in - -node_modules/ethers/node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:35 - -___ - -### isBigNumber - -▸ `Static` **isBigNumber**(`value`): value is BigNumber - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `any` | - -#### Returns - -value is BigNumber - -#### Defined in - -node_modules/ethers/node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:36 diff --git a/docs/api/verida-js/classes/verida_vda_did.VdaDid.md b/docs/api/verida-js/classes/verida_vda_did.VdaDid.md deleted file mode 100644 index 56217d6..0000000 --- a/docs/api/verida-js/classes/verida_vda_did.VdaDid.md +++ /dev/null @@ -1,244 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-did](../modules/verida_vda_did.md) / VdaDid - -# Class: VdaDid - -[@verida/vda-did](../modules/verida_vda_did.md).VdaDid - -## Table of contents - -### Constructors - -- [constructor](verida_vda_did.VdaDid.md#constructor) - -### Properties - -- [blockchain](verida_vda_did.VdaDid.md#blockchain) -- [lastEndpointErrors](verida_vda_did.VdaDid.md#lastendpointerrors) -- [options](verida_vda_did.VdaDid.md#options) - -### Methods - -- [addEndpoint](verida_vda_did.VdaDid.md#addendpoint) -- [create](verida_vda_did.VdaDid.md#create) -- [delete](verida_vda_did.VdaDid.md#delete) -- [deleteFromEndpoints](verida_vda_did.VdaDid.md#deletefromendpoints) -- [fetchDocumentHistory](verida_vda_did.VdaDid.md#fetchdocumenthistory) -- [getLastEndpointErrors](verida_vda_did.VdaDid.md#getlastendpointerrors) -- [removeEndpoint](verida_vda_did.VdaDid.md#removeendpoint) -- [update](verida_vda_did.VdaDid.md#update) - -## Constructors - -### constructor - -• **new VdaDid**(`options`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options` | [`VdaDidConfigurationOptions`](../interfaces/verida_vda_did._internal_.VdaDidConfigurationOptions.md) | - -#### Defined in - -[packages/vda-did/src/vdaDid.ts:15](https://github.com/verida/verida-js/blob/5040472/packages/vda-did/src/vdaDid.ts#L15) - -## Properties - -### blockchain - -• `Private` **blockchain**: [`default`](verida_vda_did._internal_.default.md) - -#### Defined in - -[packages/vda-did/src/vdaDid.ts:12](https://github.com/verida/verida-js/blob/5040472/packages/vda-did/src/vdaDid.ts#L12) - -___ - -### lastEndpointErrors - -• `Private` `Optional` **lastEndpointErrors**: [`VdaDidEndpointResponses`](../modules/verida_vda_did._internal_.md#vdadidendpointresponses) - -#### Defined in - -[packages/vda-did/src/vdaDid.ts:13](https://github.com/verida/verida-js/blob/5040472/packages/vda-did/src/vdaDid.ts#L13) - -___ - -### options - -• `Private` **options**: [`VdaDidConfigurationOptions`](../interfaces/verida_vda_did._internal_.VdaDidConfigurationOptions.md) - -#### Defined in - -[packages/vda-did/src/vdaDid.ts:11](https://github.com/verida/verida-js/blob/5040472/packages/vda-did/src/vdaDid.ts#L11) - -## Methods - -### addEndpoint - -▸ **addEndpoint**(`endpointUri`, `verifyAllVersions?`): `Promise`<`void`\> - -Add a new to an existing DID - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `endpointUri` | `string` | `undefined` | -| `verifyAllVersions` | `boolean` | `false` | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -[packages/vda-did/src/vdaDid.ts:283](https://github.com/verida/verida-js/blob/5040472/packages/vda-did/src/vdaDid.ts#L283) - -___ - -### create - -▸ **create**(`didDocument`, `endpoints`, `retries?`): `Promise`<[`VdaDidEndpointResponses`](../modules/verida_vda_did._internal_.md#vdadidendpointresponses)\> - -Publish the first version of a DIDDocument to a list of endpoints. - -If an endpoint fails to accept the DID Document, that endpoint will be ignored and won't be included in the -list of valid endpoints on chain. - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `didDocument` | [`default`](verida_vda_did._internal_.default-1.md) | `undefined` | -| `endpoints` | `string`[] | `undefined` | -| `retries` | `number` | `3` | - -#### Returns - -`Promise`<[`VdaDidEndpointResponses`](../modules/verida_vda_did._internal_.md#vdadidendpointresponses)\> - -VdaDidEndpointResponses Map of endpoints where the DID Document was successfully published - -#### Defined in - -[packages/vda-did/src/vdaDid.ts:30](https://github.com/verida/verida-js/blob/5040472/packages/vda-did/src/vdaDid.ts#L30) - -___ - -### delete - -▸ **delete**(): `Promise`<[`VdaDidEndpointResponses`](../modules/verida_vda_did._internal_.md#vdadidendpointresponses)\> - -#### Returns - -`Promise`<[`VdaDidEndpointResponses`](../modules/verida_vda_did._internal_.md#vdadidendpointresponses)\> - -#### Defined in - -[packages/vda-did/src/vdaDid.ts:249](https://github.com/verida/verida-js/blob/5040472/packages/vda-did/src/vdaDid.ts#L249) - -___ - -### deleteFromEndpoints - -▸ `Private` **deleteFromEndpoints**(`endpoints`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `endpoints` | `string`[] | - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -[packages/vda-did/src/vdaDid.ts:202](https://github.com/verida/verida-js/blob/5040472/packages/vda-did/src/vdaDid.ts#L202) - -___ - -### fetchDocumentHistory - -▸ `Private` **fetchDocumentHistory**(`endpoints`): `Promise`<[`default`](verida_vda_did._internal_.default-1.md)[]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `endpoints` | `string`[] | - -#### Returns - -`Promise`<[`default`](verida_vda_did._internal_.default-1.md)[]\> - -#### Defined in - -[packages/vda-did/src/vdaDid.ts:335](https://github.com/verida/verida-js/blob/5040472/packages/vda-did/src/vdaDid.ts#L335) - -___ - -### getLastEndpointErrors - -▸ **getLastEndpointErrors**(): `undefined` \| [`VdaDidEndpointResponses`](../modules/verida_vda_did._internal_.md#vdadidendpointresponses) - -#### Returns - -`undefined` \| [`VdaDidEndpointResponses`](../modules/verida_vda_did._internal_.md#vdadidendpointresponses) - -#### Defined in - -[packages/vda-did/src/vdaDid.ts:331](https://github.com/verida/verida-js/blob/5040472/packages/vda-did/src/vdaDid.ts#L331) - -___ - -### removeEndpoint - -▸ **removeEndpoint**(`did`, `endpoint`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did` | `string` | -| `endpoint` | `string` | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -[packages/vda-did/src/vdaDid.ts:323](https://github.com/verida/verida-js/blob/5040472/packages/vda-did/src/vdaDid.ts#L323) - -___ - -### update - -▸ **update**(`didDocument`, `controllerPrivateKey?`): `Promise`<[`VdaDidEndpointResponses`](../modules/verida_vda_did._internal_.md#vdadidendpointresponses)\> - -Publish an updated version of a DIDDocument to a list of endpoints. - -If an endpoint fails to accept the DID Document, that will be reflected in the response. - -Note: Any failed endpoints will remain on-chain and will need to have the update re-attempted or remove the endpoint from the DID Registry - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `didDocument` | [`default`](verida_vda_did._internal_.default-1.md) | -| `controllerPrivateKey?` | `string` | - -#### Returns - -`Promise`<[`VdaDidEndpointResponses`](../modules/verida_vda_did._internal_.md#vdadidendpointresponses)\> - -VdaDidEndpointResponses Map of endpoints where the DID Document was successfully published - -#### Defined in - -[packages/vda-did/src/vdaDid.ts:112](https://github.com/verida/verida-js/blob/5040472/packages/vda-did/src/vdaDid.ts#L112) diff --git a/docs/api/verida-js/classes/verida_vda_did._internal_.AbiCoder.md b/docs/api/verida-js/classes/verida_vda_did._internal_.AbiCoder.md deleted file mode 100644 index 1dd38ca..0000000 --- a/docs/api/verida-js/classes/verida_vda_did._internal_.AbiCoder.md +++ /dev/null @@ -1,183 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-did](../modules/verida_vda_did.md) / [](../modules/verida_vda_did._internal_.md) / AbiCoder - -# Class: AbiCoder - -[@verida/vda-did](../modules/verida_vda_did.md).[](../modules/verida_vda_did._internal_.md).AbiCoder - -## Table of contents - -### Constructors - -- [constructor](verida_vda_did._internal_.AbiCoder.md#constructor) - -### Properties - -- [coerceFunc](verida_vda_did._internal_.AbiCoder.md#coercefunc) - -### Methods - -- [\_getCoder](verida_vda_did._internal_.AbiCoder.md#_getcoder) -- [\_getReader](verida_vda_did._internal_.AbiCoder.md#_getreader) -- [\_getWordSize](verida_vda_did._internal_.AbiCoder.md#_getwordsize) -- [\_getWriter](verida_vda_did._internal_.AbiCoder.md#_getwriter) -- [decode](verida_vda_did._internal_.AbiCoder.md#decode) -- [encode](verida_vda_did._internal_.AbiCoder.md#encode) -- [getDefaultValue](verida_vda_did._internal_.AbiCoder.md#getdefaultvalue) - -## Constructors - -### constructor - -• **new AbiCoder**(`coerceFunc?`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `coerceFunc?` | [`CoerceFunc`](../modules/verida_vda_did._internal_.md#coercefunc) | - -#### Defined in - -node_modules/@ethersproject/abi/lib/abi-coder.d.ts:7 - -## Properties - -### coerceFunc - -• `Readonly` **coerceFunc**: [`CoerceFunc`](../modules/verida_vda_did._internal_.md#coercefunc) - -#### Defined in - -node_modules/@ethersproject/abi/lib/abi-coder.d.ts:6 - -## Methods - -### \_getCoder - -▸ **_getCoder**(`param`): [`Coder`](verida_vda_did._internal_.Coder.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `param` | [`ParamType`](verida_vda_did._internal_.ParamType.md) | - -#### Returns - -[`Coder`](verida_vda_did._internal_.Coder.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/abi-coder.d.ts:8 - -___ - -### \_getReader - -▸ **_getReader**(`data`, `allowLoose?`): [`Reader`](verida_vda_did._internal_.Reader.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `Uint8Array` | -| `allowLoose?` | `boolean` | - -#### Returns - -[`Reader`](verida_vda_did._internal_.Reader.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/abi-coder.d.ts:10 - -___ - -### \_getWordSize - -▸ **_getWordSize**(): `number` - -#### Returns - -`number` - -#### Defined in - -node_modules/@ethersproject/abi/lib/abi-coder.d.ts:9 - -___ - -### \_getWriter - -▸ **_getWriter**(): [`Writer`](verida_vda_did._internal_.Writer.md) - -#### Returns - -[`Writer`](verida_vda_did._internal_.Writer.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/abi-coder.d.ts:11 - -___ - -### decode - -▸ **decode**(`types`, `data`, `loose?`): [`Result`](../interfaces/verida_vda_did._internal_.Result.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `types` | readonly (`string` \| [`ParamType`](verida_vda_did._internal_.ParamType.md))[] | -| `data` | [`BytesLike`](../modules/verida_vda_did._internal_.md#byteslike) | -| `loose?` | `boolean` | - -#### Returns - -[`Result`](../interfaces/verida_vda_did._internal_.Result.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/abi-coder.d.ts:14 - -___ - -### encode - -▸ **encode**(`types`, `values`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `types` | readonly (`string` \| [`ParamType`](verida_vda_did._internal_.ParamType.md))[] | -| `values` | readonly `any`[] | - -#### Returns - -`string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/abi-coder.d.ts:13 - -___ - -### getDefaultValue - -▸ **getDefaultValue**(`types`): [`Result`](../interfaces/verida_vda_did._internal_.Result.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `types` | readonly (`string` \| [`ParamType`](verida_vda_did._internal_.ParamType.md))[] | - -#### Returns - -[`Result`](../interfaces/verida_vda_did._internal_.Result.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/abi-coder.d.ts:12 diff --git a/docs/api/verida-js/classes/verida_vda_did._internal_.BaseContract.md b/docs/api/verida-js/classes/verida_vda_did._internal_.BaseContract.md deleted file mode 100644 index 18f0c63..0000000 --- a/docs/api/verida-js/classes/verida_vda_did._internal_.BaseContract.md +++ /dev/null @@ -1,660 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-did](../modules/verida_vda_did.md) / [](../modules/verida_vda_did._internal_.md) / BaseContract - -# Class: BaseContract - -[@verida/vda-did](../modules/verida_vda_did.md).[](../modules/verida_vda_did._internal_.md).BaseContract - -## Hierarchy - -- **`BaseContract`** - - ↳ [`Contract`](verida_vda_did._internal_.Contract.md) - -## Table of contents - -### Constructors - -- [constructor](verida_vda_did._internal_.BaseContract.md#constructor) - -### Properties - -- [\_addEventListener](verida_vda_did._internal_.BaseContract.md#_addeventlistener) -- [\_deployedPromise](verida_vda_did._internal_.BaseContract.md#_deployedpromise) -- [\_getRunningEvent](verida_vda_did._internal_.BaseContract.md#_getrunningevent) -- [\_normalizeRunningEvent](verida_vda_did._internal_.BaseContract.md#_normalizerunningevent) -- [\_runningEvents](verida_vda_did._internal_.BaseContract.md#_runningevents) -- [\_wrappedEmits](verida_vda_did._internal_.BaseContract.md#_wrappedemits) -- [address](verida_vda_did._internal_.BaseContract.md#address) -- [callStatic](verida_vda_did._internal_.BaseContract.md#callstatic) -- [deployTransaction](verida_vda_did._internal_.BaseContract.md#deploytransaction) -- [estimateGas](verida_vda_did._internal_.BaseContract.md#estimategas) -- [filters](verida_vda_did._internal_.BaseContract.md#filters) -- [functions](verida_vda_did._internal_.BaseContract.md#functions) -- [interface](verida_vda_did._internal_.BaseContract.md#interface) -- [populateTransaction](verida_vda_did._internal_.BaseContract.md#populatetransaction) -- [provider](verida_vda_did._internal_.BaseContract.md#provider) -- [resolvedAddress](verida_vda_did._internal_.BaseContract.md#resolvedaddress) -- [signer](verida_vda_did._internal_.BaseContract.md#signer) - -### Methods - -- [\_checkRunningEvents](verida_vda_did._internal_.BaseContract.md#_checkrunningevents) -- [\_deployed](verida_vda_did._internal_.BaseContract.md#_deployed) -- [\_wrapEvent](verida_vda_did._internal_.BaseContract.md#_wrapevent) -- [attach](verida_vda_did._internal_.BaseContract.md#attach) -- [connect](verida_vda_did._internal_.BaseContract.md#connect) -- [deployed](verida_vda_did._internal_.BaseContract.md#deployed) -- [emit](verida_vda_did._internal_.BaseContract.md#emit) -- [fallback](verida_vda_did._internal_.BaseContract.md#fallback) -- [listenerCount](verida_vda_did._internal_.BaseContract.md#listenercount) -- [listeners](verida_vda_did._internal_.BaseContract.md#listeners) -- [off](verida_vda_did._internal_.BaseContract.md#off) -- [on](verida_vda_did._internal_.BaseContract.md#on) -- [once](verida_vda_did._internal_.BaseContract.md#once) -- [queryFilter](verida_vda_did._internal_.BaseContract.md#queryfilter) -- [removeAllListeners](verida_vda_did._internal_.BaseContract.md#removealllisteners) -- [removeListener](verida_vda_did._internal_.BaseContract.md#removelistener) -- [getContractAddress](verida_vda_did._internal_.BaseContract.md#getcontractaddress) -- [getInterface](verida_vda_did._internal_.BaseContract.md#getinterface) -- [isIndexed](verida_vda_did._internal_.BaseContract.md#isindexed) - -## Constructors - -### constructor - -• **new BaseContract**(`addressOrName`, `contractInterface`, `signerOrProvider?`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `addressOrName` | `string` | -| `contractInterface` | [`ContractInterface`](../modules/verida_vda_did._internal_.md#contractinterface) | -| `signerOrProvider?` | [`Signer`](verida_vda_did._internal_.Signer.md) \| [`Provider`](verida_vda_did._internal_.Provider.md) | - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:107 - -## Properties - -### \_addEventListener - -• `Private` **\_addEventListener**: `any` - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:123 - -___ - -### \_deployedPromise - -• **\_deployedPromise**: `Promise`<[`Contract`](verida_vda_did._internal_.Contract.md)\> - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:100 - -___ - -### \_getRunningEvent - -• `Private` **\_getRunningEvent**: `any` - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:120 - -___ - -### \_normalizeRunningEvent - -• `Private` **\_normalizeRunningEvent**: `any` - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:119 - -___ - -### \_runningEvents - -• **\_runningEvents**: `Object` - -#### Index signature - -▪ [eventTag: `string`]: [`RunningEvent`](verida_vda_did._internal_.RunningEvent.md) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:101 - -___ - -### \_wrappedEmits - -• **\_wrappedEmits**: `Object` - -#### Index signature - -▪ [eventTag: `string`]: (...`args`: `any`[]) => `void` - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:104 - -___ - -### address - -• `Readonly` **address**: `string` - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:79 - -___ - -### callStatic - -• `Readonly` **callStatic**: `Object` - -#### Index signature - -▪ [name: `string`]: [`ContractFunction`](../modules/verida_vda_did._internal_.md#contractfunction) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:86 - -___ - -### deployTransaction - -• `Readonly` **deployTransaction**: [`TransactionResponse`](../interfaces/verida_vda_did._internal_.TransactionResponse.md) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:99 - -___ - -### estimateGas - -• `Readonly` **estimateGas**: `Object` - -#### Index signature - -▪ [name: `string`]: [`ContractFunction`](../modules/verida_vda_did._internal_.md#contractfunction)<[`BigNumber`](verida_vda_did._internal_.BigNumber.md)\> - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:89 - -___ - -### filters - -• `Readonly` **filters**: `Object` - -#### Index signature - -▪ [name: `string`]: (...`args`: `any`[]) => [`EventFilter`](../modules/verida_vda_did._internal_.md#eventfilter) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:95 - -___ - -### functions - -• `Readonly` **functions**: `Object` - -#### Index signature - -▪ [name: `string`]: [`ContractFunction`](../modules/verida_vda_did._internal_.md#contractfunction) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:83 - -___ - -### interface - -• `Readonly` **interface**: [`Interface`](verida_vda_did._internal_.Interface.md) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:80 - -___ - -### populateTransaction - -• `Readonly` **populateTransaction**: `Object` - -#### Index signature - -▪ [name: `string`]: [`ContractFunction`](../modules/verida_vda_did._internal_.md#contractfunction)<[`PopulatedTransaction`](../interfaces/verida_vda_did._internal_.PopulatedTransaction.md)\> - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:92 - -___ - -### provider - -• `Readonly` **provider**: [`Provider`](verida_vda_did._internal_.Provider.md) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:82 - -___ - -### resolvedAddress - -• `Readonly` **resolvedAddress**: `Promise`<`string`\> - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:98 - -___ - -### signer - -• `Readonly` **signer**: [`Signer`](verida_vda_did._internal_.Signer.md) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:81 - -## Methods - -### \_checkRunningEvents - -▸ **_checkRunningEvents**(`runningEvent`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `runningEvent` | [`RunningEvent`](verida_vda_did._internal_.RunningEvent.md) | - -#### Returns - -`void` - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:121 - -___ - -### \_deployed - -▸ **_deployed**(`blockTag?`): `Promise`<[`Contract`](verida_vda_did._internal_.Contract.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `blockTag?` | [`BlockTag`](../modules/verida_vda_did._internal_.md#blocktag) | - -#### Returns - -`Promise`<[`Contract`](verida_vda_did._internal_.Contract.md)\> - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:114 - -___ - -### \_wrapEvent - -▸ **_wrapEvent**(`runningEvent`, `log`, `listener`): [`Event`](../interfaces/verida_vda_did._internal_.Event.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `runningEvent` | [`RunningEvent`](verida_vda_did._internal_.RunningEvent.md) | -| `log` | [`Log`](../interfaces/verida_vda_did._internal_.Log.md) | -| `listener` | [`Listener`](../modules/verida_vda_did._internal_.md#listener) | - -#### Returns - -[`Event`](../interfaces/verida_vda_did._internal_.Event.md) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:122 - -___ - -### attach - -▸ **attach**(`addressOrName`): [`Contract`](verida_vda_did._internal_.Contract.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `addressOrName` | `string` | - -#### Returns - -[`Contract`](verida_vda_did._internal_.Contract.md) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:117 - -___ - -### connect - -▸ **connect**(`signerOrProvider`): [`Contract`](verida_vda_did._internal_.Contract.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `signerOrProvider` | `string` \| [`Signer`](verida_vda_did._internal_.Signer.md) \| [`Provider`](verida_vda_did._internal_.Provider.md) | - -#### Returns - -[`Contract`](verida_vda_did._internal_.Contract.md) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:116 - -___ - -### deployed - -▸ **deployed**(): `Promise`<[`Contract`](verida_vda_did._internal_.Contract.md)\> - -#### Returns - -`Promise`<[`Contract`](verida_vda_did._internal_.Contract.md)\> - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:113 - -___ - -### emit - -▸ **emit**(`eventName`, ...`args`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | `string` \| [`EventFilter`](../modules/verida_vda_did._internal_.md#eventfilter) | -| `...args` | `any`[] | - -#### Returns - -`boolean` - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:127 - -___ - -### fallback - -▸ **fallback**(`overrides?`): `Promise`<[`TransactionResponse`](../interfaces/verida_vda_did._internal_.TransactionResponse.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `overrides?` | [`TransactionRequest`](../modules/verida_vda_did._internal_.md#transactionrequest) | - -#### Returns - -`Promise`<[`TransactionResponse`](../interfaces/verida_vda_did._internal_.TransactionResponse.md)\> - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:115 - -___ - -### listenerCount - -▸ **listenerCount**(`eventName?`): `number` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName?` | `string` \| [`EventFilter`](../modules/verida_vda_did._internal_.md#eventfilter) | - -#### Returns - -`number` - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:128 - -___ - -### listeners - -▸ **listeners**(`eventName?`): [`Listener`](../modules/verida_vda_did._internal_.md#listener)[] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName?` | `string` \| [`EventFilter`](../modules/verida_vda_did._internal_.md#eventfilter) | - -#### Returns - -[`Listener`](../modules/verida_vda_did._internal_.md#listener)[] - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:129 - -___ - -### off - -▸ **off**(`eventName`, `listener`): [`BaseContract`](verida_vda_did._internal_.BaseContract.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | `string` \| [`EventFilter`](../modules/verida_vda_did._internal_.md#eventfilter) | -| `listener` | [`Listener`](../modules/verida_vda_did._internal_.md#listener) | - -#### Returns - -[`BaseContract`](verida_vda_did._internal_.BaseContract.md) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:131 - -___ - -### on - -▸ **on**(`event`, `listener`): [`BaseContract`](verida_vda_did._internal_.BaseContract.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | `string` \| [`EventFilter`](../modules/verida_vda_did._internal_.md#eventfilter) | -| `listener` | [`Listener`](../modules/verida_vda_did._internal_.md#listener) | - -#### Returns - -[`BaseContract`](verida_vda_did._internal_.BaseContract.md) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:125 - -___ - -### once - -▸ **once**(`event`, `listener`): [`BaseContract`](verida_vda_did._internal_.BaseContract.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | `string` \| [`EventFilter`](../modules/verida_vda_did._internal_.md#eventfilter) | -| `listener` | [`Listener`](../modules/verida_vda_did._internal_.md#listener) | - -#### Returns - -[`BaseContract`](verida_vda_did._internal_.BaseContract.md) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:126 - -___ - -### queryFilter - -▸ **queryFilter**(`event`, `fromBlockOrBlockhash?`, `toBlock?`): `Promise`<[`Event`](../interfaces/verida_vda_did._internal_.Event.md)[]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | `string` \| [`EventFilter`](../modules/verida_vda_did._internal_.md#eventfilter) | -| `fromBlockOrBlockhash?` | [`BlockTag`](../modules/verida_vda_did._internal_.md#blocktag) | -| `toBlock?` | [`BlockTag`](../modules/verida_vda_did._internal_.md#blocktag) | - -#### Returns - -`Promise`<[`Event`](../interfaces/verida_vda_did._internal_.Event.md)[]\> - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:124 - -___ - -### removeAllListeners - -▸ **removeAllListeners**(`eventName?`): [`BaseContract`](verida_vda_did._internal_.BaseContract.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName?` | `string` \| [`EventFilter`](../modules/verida_vda_did._internal_.md#eventfilter) | - -#### Returns - -[`BaseContract`](verida_vda_did._internal_.BaseContract.md) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:130 - -___ - -### removeListener - -▸ **removeListener**(`eventName`, `listener`): [`BaseContract`](verida_vda_did._internal_.BaseContract.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | `string` \| [`EventFilter`](../modules/verida_vda_did._internal_.md#eventfilter) | -| `listener` | [`Listener`](../modules/verida_vda_did._internal_.md#listener) | - -#### Returns - -[`BaseContract`](verida_vda_did._internal_.BaseContract.md) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:132 - -___ - -### getContractAddress - -▸ `Static` **getContractAddress**(`transaction`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transaction` | `Object` | -| `transaction.from` | `string` | -| `transaction.nonce` | [`BigNumberish`](../modules/verida_vda_did._internal_.md#bignumberish) | - -#### Returns - -`string` - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:108 - -___ - -### getInterface - -▸ `Static` **getInterface**(`contractInterface`): [`Interface`](verida_vda_did._internal_.Interface.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contractInterface` | [`ContractInterface`](../modules/verida_vda_did._internal_.md#contractinterface) | - -#### Returns - -[`Interface`](verida_vda_did._internal_.Interface.md) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:112 - -___ - -### isIndexed - -▸ `Static` **isIndexed**(`value`): value is Indexed - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `any` | - -#### Returns - -value is Indexed - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:118 diff --git a/docs/api/verida-js/classes/verida_vda_did._internal_.BigNumber.md b/docs/api/verida-js/classes/verida_vda_did._internal_.BigNumber.md deleted file mode 100644 index affd049..0000000 --- a/docs/api/verida-js/classes/verida_vda_did._internal_.BigNumber.md +++ /dev/null @@ -1,631 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-did](../modules/verida_vda_did.md) / [](../modules/verida_vda_did._internal_.md) / BigNumber - -# Class: BigNumber - -[@verida/vda-did](../modules/verida_vda_did.md).[](../modules/verida_vda_did._internal_.md).BigNumber - -## Implements - -- [`Hexable`](../interfaces/verida_vda_did._internal_.Hexable.md) - -## Table of contents - -### Constructors - -- [constructor](verida_vda_did._internal_.BigNumber.md#constructor) - -### Properties - -- [\_hex](verida_vda_did._internal_.BigNumber.md#_hex) -- [\_isBigNumber](verida_vda_did._internal_.BigNumber.md#_isbignumber) - -### Methods - -- [abs](verida_vda_did._internal_.BigNumber.md#abs) -- [add](verida_vda_did._internal_.BigNumber.md#add) -- [and](verida_vda_did._internal_.BigNumber.md#and) -- [div](verida_vda_did._internal_.BigNumber.md#div) -- [eq](verida_vda_did._internal_.BigNumber.md#eq) -- [fromTwos](verida_vda_did._internal_.BigNumber.md#fromtwos) -- [gt](verida_vda_did._internal_.BigNumber.md#gt) -- [gte](verida_vda_did._internal_.BigNumber.md#gte) -- [isNegative](verida_vda_did._internal_.BigNumber.md#isnegative) -- [isZero](verida_vda_did._internal_.BigNumber.md#iszero) -- [lt](verida_vda_did._internal_.BigNumber.md#lt) -- [lte](verida_vda_did._internal_.BigNumber.md#lte) -- [mask](verida_vda_did._internal_.BigNumber.md#mask) -- [mod](verida_vda_did._internal_.BigNumber.md#mod) -- [mul](verida_vda_did._internal_.BigNumber.md#mul) -- [or](verida_vda_did._internal_.BigNumber.md#or) -- [pow](verida_vda_did._internal_.BigNumber.md#pow) -- [shl](verida_vda_did._internal_.BigNumber.md#shl) -- [shr](verida_vda_did._internal_.BigNumber.md#shr) -- [sub](verida_vda_did._internal_.BigNumber.md#sub) -- [toBigInt](verida_vda_did._internal_.BigNumber.md#tobigint) -- [toHexString](verida_vda_did._internal_.BigNumber.md#tohexstring) -- [toJSON](verida_vda_did._internal_.BigNumber.md#tojson) -- [toNumber](verida_vda_did._internal_.BigNumber.md#tonumber) -- [toString](verida_vda_did._internal_.BigNumber.md#tostring) -- [toTwos](verida_vda_did._internal_.BigNumber.md#totwos) -- [xor](verida_vda_did._internal_.BigNumber.md#xor) -- [from](verida_vda_did._internal_.BigNumber.md#from) -- [isBigNumber](verida_vda_did._internal_.BigNumber.md#isbignumber) - -## Constructors - -### constructor - -• **new BigNumber**(`constructorGuard`, `hex`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `constructorGuard` | `any` | -| `hex` | `string` | - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:7 - -## Properties - -### \_hex - -• `Readonly` **\_hex**: `string` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:5 - -___ - -### \_isBigNumber - -• `Readonly` **\_isBigNumber**: `boolean` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:6 - -## Methods - -### abs - -▸ **abs**(): [`BigNumber`](verida_vda_did._internal_.BigNumber.md) - -#### Returns - -[`BigNumber`](verida_vda_did._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:10 - -___ - -### add - -▸ **add**(`other`): [`BigNumber`](verida_vda_did._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_vda_did._internal_.md#bignumberish) | - -#### Returns - -[`BigNumber`](verida_vda_did._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:11 - -___ - -### and - -▸ **and**(`other`): [`BigNumber`](verida_vda_did._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_vda_did._internal_.md#bignumberish) | - -#### Returns - -[`BigNumber`](verida_vda_did._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:17 - -___ - -### div - -▸ **div**(`other`): [`BigNumber`](verida_vda_did._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_vda_did._internal_.md#bignumberish) | - -#### Returns - -[`BigNumber`](verida_vda_did._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:13 - -___ - -### eq - -▸ **eq**(`other`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_vda_did._internal_.md#bignumberish) | - -#### Returns - -`boolean` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:23 - -___ - -### fromTwos - -▸ **fromTwos**(`value`): [`BigNumber`](verida_vda_did._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `number` | - -#### Returns - -[`BigNumber`](verida_vda_did._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:8 - -___ - -### gt - -▸ **gt**(`other`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_vda_did._internal_.md#bignumberish) | - -#### Returns - -`boolean` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:26 - -___ - -### gte - -▸ **gte**(`other`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_vda_did._internal_.md#bignumberish) | - -#### Returns - -`boolean` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:27 - -___ - -### isNegative - -▸ **isNegative**(): `boolean` - -#### Returns - -`boolean` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:28 - -___ - -### isZero - -▸ **isZero**(): `boolean` - -#### Returns - -`boolean` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:29 - -___ - -### lt - -▸ **lt**(`other`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_vda_did._internal_.md#bignumberish) | - -#### Returns - -`boolean` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:24 - -___ - -### lte - -▸ **lte**(`other`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_vda_did._internal_.md#bignumberish) | - -#### Returns - -`boolean` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:25 - -___ - -### mask - -▸ **mask**(`value`): [`BigNumber`](verida_vda_did._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `number` | - -#### Returns - -[`BigNumber`](verida_vda_did._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:20 - -___ - -### mod - -▸ **mod**(`other`): [`BigNumber`](verida_vda_did._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_vda_did._internal_.md#bignumberish) | - -#### Returns - -[`BigNumber`](verida_vda_did._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:15 - -___ - -### mul - -▸ **mul**(`other`): [`BigNumber`](verida_vda_did._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_vda_did._internal_.md#bignumberish) | - -#### Returns - -[`BigNumber`](verida_vda_did._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:14 - -___ - -### or - -▸ **or**(`other`): [`BigNumber`](verida_vda_did._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_vda_did._internal_.md#bignumberish) | - -#### Returns - -[`BigNumber`](verida_vda_did._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:18 - -___ - -### pow - -▸ **pow**(`other`): [`BigNumber`](verida_vda_did._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_vda_did._internal_.md#bignumberish) | - -#### Returns - -[`BigNumber`](verida_vda_did._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:16 - -___ - -### shl - -▸ **shl**(`value`): [`BigNumber`](verida_vda_did._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `number` | - -#### Returns - -[`BigNumber`](verida_vda_did._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:21 - -___ - -### shr - -▸ **shr**(`value`): [`BigNumber`](verida_vda_did._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `number` | - -#### Returns - -[`BigNumber`](verida_vda_did._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:22 - -___ - -### sub - -▸ **sub**(`other`): [`BigNumber`](verida_vda_did._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_vda_did._internal_.md#bignumberish) | - -#### Returns - -[`BigNumber`](verida_vda_did._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:12 - -___ - -### toBigInt - -▸ **toBigInt**(): `bigint` - -#### Returns - -`bigint` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:31 - -___ - -### toHexString - -▸ **toHexString**(): `string` - -#### Returns - -`string` - -#### Implementation of - -[Hexable](../interfaces/verida_vda_did._internal_.Hexable.md).[toHexString](../interfaces/verida_vda_did._internal_.Hexable.md#tohexstring) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:33 - -___ - -### toJSON - -▸ **toJSON**(`key?`): `any` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `key?` | `string` | - -#### Returns - -`any` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:34 - -___ - -### toNumber - -▸ **toNumber**(): `number` - -#### Returns - -`number` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:30 - -___ - -### toString - -▸ **toString**(): `string` - -#### Returns - -`string` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:32 - -___ - -### toTwos - -▸ **toTwos**(`value`): [`BigNumber`](verida_vda_did._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `number` | - -#### Returns - -[`BigNumber`](verida_vda_did._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:9 - -___ - -### xor - -▸ **xor**(`other`): [`BigNumber`](verida_vda_did._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_vda_did._internal_.md#bignumberish) | - -#### Returns - -[`BigNumber`](verida_vda_did._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:19 - -___ - -### from - -▸ `Static` **from**(`value`): [`BigNumber`](verida_vda_did._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `any` | - -#### Returns - -[`BigNumber`](verida_vda_did._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:35 - -___ - -### isBigNumber - -▸ `Static` **isBigNumber**(`value`): value is BigNumber - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `any` | - -#### Returns - -value is BigNumber - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:36 diff --git a/docs/api/verida-js/classes/verida_vda_did._internal_.Coder.md b/docs/api/verida-js/classes/verida_vda_did._internal_.Coder.md deleted file mode 100644 index 7ecd84a..0000000 --- a/docs/api/verida-js/classes/verida_vda_did._internal_.Coder.md +++ /dev/null @@ -1,160 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-did](../modules/verida_vda_did.md) / [](../modules/verida_vda_did._internal_.md) / Coder - -# Class: Coder - -[@verida/vda-did](../modules/verida_vda_did.md).[](../modules/verida_vda_did._internal_.md).Coder - -## Table of contents - -### Constructors - -- [constructor](verida_vda_did._internal_.Coder.md#constructor) - -### Properties - -- [dynamic](verida_vda_did._internal_.Coder.md#dynamic) -- [localName](verida_vda_did._internal_.Coder.md#localname) -- [name](verida_vda_did._internal_.Coder.md#name) -- [type](verida_vda_did._internal_.Coder.md#type) - -### Methods - -- [\_throwError](verida_vda_did._internal_.Coder.md#_throwerror) -- [decode](verida_vda_did._internal_.Coder.md#decode) -- [defaultValue](verida_vda_did._internal_.Coder.md#defaultvalue) -- [encode](verida_vda_did._internal_.Coder.md#encode) - -## Constructors - -### constructor - -• **new Coder**(`name`, `type`, `localName`, `dynamic`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` | -| `type` | `string` | -| `localName` | `string` | -| `dynamic` | `boolean` | - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:16 - -## Properties - -### dynamic - -• `Readonly` **dynamic**: `boolean` - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:15 - -___ - -### localName - -• `Readonly` **localName**: `string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:14 - -___ - -### name - -• `Readonly` **name**: `string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:12 - -___ - -### type - -• `Readonly` **type**: `string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:13 - -## Methods - -### \_throwError - -▸ **_throwError**(`message`, `value`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `message` | `string` | -| `value` | `any` | - -#### Returns - -`void` - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:17 - -___ - -### decode - -▸ `Abstract` **decode**(`reader`): `any` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `reader` | [`Reader`](verida_vda_did._internal_.Reader.md) | - -#### Returns - -`any` - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:19 - -___ - -### defaultValue - -▸ `Abstract` **defaultValue**(): `any` - -#### Returns - -`any` - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:20 - -___ - -### encode - -▸ `Abstract` **encode**(`writer`, `value`): `number` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `writer` | [`Writer`](verida_vda_did._internal_.Writer.md) | -| `value` | `any` | - -#### Returns - -`number` - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:18 diff --git a/docs/api/verida-js/classes/verida_vda_did._internal_.ConstructorFragment.md b/docs/api/verida-js/classes/verida_vda_did._internal_.ConstructorFragment.md deleted file mode 100644 index d0716a1..0000000 --- a/docs/api/verida-js/classes/verida_vda_did._internal_.ConstructorFragment.md +++ /dev/null @@ -1,285 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-did](../modules/verida_vda_did.md) / [](../modules/verida_vda_did._internal_.md) / ConstructorFragment - -# Class: ConstructorFragment - -[@verida/vda-did](../modules/verida_vda_did.md).[](../modules/verida_vda_did._internal_.md).ConstructorFragment - -## Hierarchy - -- [`Fragment`](verida_vda_did._internal_.Fragment.md) - - ↳ **`ConstructorFragment`** - - ↳↳ [`FunctionFragment`](verida_vda_did._internal_.FunctionFragment.md) - -## Table of contents - -### Constructors - -- [constructor](verida_vda_did._internal_.ConstructorFragment.md#constructor) - -### Properties - -- [\_isFragment](verida_vda_did._internal_.ConstructorFragment.md#_isfragment) -- [gas](verida_vda_did._internal_.ConstructorFragment.md#gas) -- [inputs](verida_vda_did._internal_.ConstructorFragment.md#inputs) -- [name](verida_vda_did._internal_.ConstructorFragment.md#name) -- [payable](verida_vda_did._internal_.ConstructorFragment.md#payable) -- [stateMutability](verida_vda_did._internal_.ConstructorFragment.md#statemutability) -- [type](verida_vda_did._internal_.ConstructorFragment.md#type) - -### Methods - -- [format](verida_vda_did._internal_.ConstructorFragment.md#format) -- [from](verida_vda_did._internal_.ConstructorFragment.md#from) -- [fromObject](verida_vda_did._internal_.ConstructorFragment.md#fromobject) -- [fromString](verida_vda_did._internal_.ConstructorFragment.md#fromstring) -- [isConstructorFragment](verida_vda_did._internal_.ConstructorFragment.md#isconstructorfragment) -- [isFragment](verida_vda_did._internal_.ConstructorFragment.md#isfragment) - -## Constructors - -### constructor - -• **new ConstructorFragment**(`constructorGuard`, `params`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `constructorGuard` | `any` | -| `params` | `any` | - -#### Inherited from - -[Fragment](verida_vda_did._internal_.Fragment.md).[constructor](verida_vda_did._internal_.Fragment.md#constructor) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:44 - -## Properties - -### \_isFragment - -• `Readonly` **\_isFragment**: `boolean` - -#### Inherited from - -[Fragment](verida_vda_did._internal_.Fragment.md).[_isFragment](verida_vda_did._internal_.Fragment.md#_isfragment) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:43 - -___ - -### gas - -• `Optional` **gas**: [`BigNumber`](verida_vda_did._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:62 - -___ - -### inputs - -• `Readonly` **inputs**: [`ParamType`](verida_vda_did._internal_.ParamType.md)[] - -#### Inherited from - -[Fragment](verida_vda_did._internal_.Fragment.md).[inputs](verida_vda_did._internal_.Fragment.md#inputs) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:42 - -___ - -### name - -• `Readonly` **name**: `string` - -#### Inherited from - -[Fragment](verida_vda_did._internal_.Fragment.md).[name](verida_vda_did._internal_.Fragment.md#name) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:41 - -___ - -### payable - -• **payable**: `boolean` - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:61 - -___ - -### stateMutability - -• **stateMutability**: `string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:60 - -___ - -### type - -• `Readonly` **type**: `string` - -#### Inherited from - -[Fragment](verida_vda_did._internal_.Fragment.md).[type](verida_vda_did._internal_.Fragment.md#type) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:40 - -## Methods - -### format - -▸ **format**(`format?`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `format?` | `string` | - -#### Returns - -`string` - -#### Overrides - -[Fragment](verida_vda_did._internal_.Fragment.md).[format](verida_vda_did._internal_.Fragment.md#format) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:63 - -___ - -### from - -▸ `Static` **from**(`value`): [`ConstructorFragment`](verida_vda_did._internal_.ConstructorFragment.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `string` \| [`JsonFragment`](../interfaces/verida_vda_did._internal_.JsonFragment.md) \| [`ConstructorFragment`](verida_vda_did._internal_.ConstructorFragment.md) | - -#### Returns - -[`ConstructorFragment`](verida_vda_did._internal_.ConstructorFragment.md) - -#### Overrides - -[Fragment](verida_vda_did._internal_.Fragment.md).[from](verida_vda_did._internal_.Fragment.md#from) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:64 - -___ - -### fromObject - -▸ `Static` **fromObject**(`value`): [`ConstructorFragment`](verida_vda_did._internal_.ConstructorFragment.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | [`JsonFragment`](../interfaces/verida_vda_did._internal_.JsonFragment.md) \| [`ConstructorFragment`](verida_vda_did._internal_.ConstructorFragment.md) | - -#### Returns - -[`ConstructorFragment`](verida_vda_did._internal_.ConstructorFragment.md) - -#### Overrides - -[Fragment](verida_vda_did._internal_.Fragment.md).[fromObject](verida_vda_did._internal_.Fragment.md#fromobject) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:65 - -___ - -### fromString - -▸ `Static` **fromString**(`value`): [`ConstructorFragment`](verida_vda_did._internal_.ConstructorFragment.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `string` | - -#### Returns - -[`ConstructorFragment`](verida_vda_did._internal_.ConstructorFragment.md) - -#### Overrides - -[Fragment](verida_vda_did._internal_.Fragment.md).[fromString](verida_vda_did._internal_.Fragment.md#fromstring) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:66 - -___ - -### isConstructorFragment - -▸ `Static` **isConstructorFragment**(`value`): value is ConstructorFragment - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `any` | - -#### Returns - -value is ConstructorFragment - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:67 - -___ - -### isFragment - -▸ `Static` **isFragment**(`value`): value is Fragment - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `any` | - -#### Returns - -value is Fragment - -#### Inherited from - -[Fragment](verida_vda_did._internal_.Fragment.md).[isFragment](verida_vda_did._internal_.Fragment.md#isfragment) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:49 diff --git a/docs/api/verida-js/classes/verida_vda_did._internal_.Contract.md b/docs/api/verida-js/classes/verida_vda_did._internal_.Contract.md deleted file mode 100644 index 007e892..0000000 --- a/docs/api/verida-js/classes/verida_vda_did._internal_.Contract.md +++ /dev/null @@ -1,767 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-did](../modules/verida_vda_did.md) / [](../modules/verida_vda_did._internal_.md) / Contract - -# Class: Contract - -[@verida/vda-did](../modules/verida_vda_did.md).[](../modules/verida_vda_did._internal_.md).Contract - -## Hierarchy - -- [`BaseContract`](verida_vda_did._internal_.BaseContract.md) - - ↳ **`Contract`** - -## Indexable - -▪ [key: `string`]: [`ContractFunction`](../modules/verida_vda_did._internal_.md#contractfunction) \| `any` - -## Table of contents - -### Constructors - -- [constructor](verida_vda_did._internal_.Contract.md#constructor) - -### Properties - -- [\_deployedPromise](verida_vda_did._internal_.Contract.md#_deployedpromise) -- [\_runningEvents](verida_vda_did._internal_.Contract.md#_runningevents) -- [\_wrappedEmits](verida_vda_did._internal_.Contract.md#_wrappedemits) -- [address](verida_vda_did._internal_.Contract.md#address) -- [callStatic](verida_vda_did._internal_.Contract.md#callstatic) -- [deployTransaction](verida_vda_did._internal_.Contract.md#deploytransaction) -- [estimateGas](verida_vda_did._internal_.Contract.md#estimategas) -- [filters](verida_vda_did._internal_.Contract.md#filters) -- [functions](verida_vda_did._internal_.Contract.md#functions) -- [interface](verida_vda_did._internal_.Contract.md#interface) -- [populateTransaction](verida_vda_did._internal_.Contract.md#populatetransaction) -- [provider](verida_vda_did._internal_.Contract.md#provider) -- [resolvedAddress](verida_vda_did._internal_.Contract.md#resolvedaddress) -- [signer](verida_vda_did._internal_.Contract.md#signer) - -### Methods - -- [\_checkRunningEvents](verida_vda_did._internal_.Contract.md#_checkrunningevents) -- [\_deployed](verida_vda_did._internal_.Contract.md#_deployed) -- [\_wrapEvent](verida_vda_did._internal_.Contract.md#_wrapevent) -- [attach](verida_vda_did._internal_.Contract.md#attach) -- [connect](verida_vda_did._internal_.Contract.md#connect) -- [deployed](verida_vda_did._internal_.Contract.md#deployed) -- [emit](verida_vda_did._internal_.Contract.md#emit) -- [fallback](verida_vda_did._internal_.Contract.md#fallback) -- [listenerCount](verida_vda_did._internal_.Contract.md#listenercount) -- [listeners](verida_vda_did._internal_.Contract.md#listeners) -- [off](verida_vda_did._internal_.Contract.md#off) -- [on](verida_vda_did._internal_.Contract.md#on) -- [once](verida_vda_did._internal_.Contract.md#once) -- [queryFilter](verida_vda_did._internal_.Contract.md#queryfilter) -- [removeAllListeners](verida_vda_did._internal_.Contract.md#removealllisteners) -- [removeListener](verida_vda_did._internal_.Contract.md#removelistener) -- [getContractAddress](verida_vda_did._internal_.Contract.md#getcontractaddress) -- [getInterface](verida_vda_did._internal_.Contract.md#getinterface) -- [isIndexed](verida_vda_did._internal_.Contract.md#isindexed) - -## Constructors - -### constructor - -• **new Contract**(`addressOrName`, `contractInterface`, `signerOrProvider?`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `addressOrName` | `string` | -| `contractInterface` | [`ContractInterface`](../modules/verida_vda_did._internal_.md#contractinterface) | -| `signerOrProvider?` | [`Signer`](verida_vda_did._internal_.Signer.md) \| [`Provider`](verida_vda_did._internal_.Provider.md) | - -#### Inherited from - -[BaseContract](verida_vda_did._internal_.BaseContract.md).[constructor](verida_vda_did._internal_.BaseContract.md#constructor) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:107 - -## Properties - -### \_deployedPromise - -• **\_deployedPromise**: `Promise`<[`Contract`](verida_vda_did._internal_.Contract.md)\> - -#### Inherited from - -[BaseContract](verida_vda_did._internal_.BaseContract.md).[_deployedPromise](verida_vda_did._internal_.BaseContract.md#_deployedpromise) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:100 - -___ - -### \_runningEvents - -• **\_runningEvents**: `Object` - -#### Index signature - -▪ [eventTag: `string`]: [`RunningEvent`](verida_vda_did._internal_.RunningEvent.md) - -#### Inherited from - -[BaseContract](verida_vda_did._internal_.BaseContract.md).[_runningEvents](verida_vda_did._internal_.BaseContract.md#_runningevents) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:101 - -___ - -### \_wrappedEmits - -• **\_wrappedEmits**: `Object` - -#### Index signature - -▪ [eventTag: `string`]: (...`args`: `any`[]) => `void` - -#### Inherited from - -[BaseContract](verida_vda_did._internal_.BaseContract.md).[_wrappedEmits](verida_vda_did._internal_.BaseContract.md#_wrappedemits) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:104 - -___ - -### address - -• `Readonly` **address**: `string` - -#### Inherited from - -[BaseContract](verida_vda_did._internal_.BaseContract.md).[address](verida_vda_did._internal_.BaseContract.md#address) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:79 - -___ - -### callStatic - -• `Readonly` **callStatic**: `Object` - -#### Index signature - -▪ [name: `string`]: [`ContractFunction`](../modules/verida_vda_did._internal_.md#contractfunction) - -#### Inherited from - -[BaseContract](verida_vda_did._internal_.BaseContract.md).[callStatic](verida_vda_did._internal_.BaseContract.md#callstatic) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:86 - -___ - -### deployTransaction - -• `Readonly` **deployTransaction**: [`TransactionResponse`](../interfaces/verida_vda_did._internal_.TransactionResponse.md) - -#### Inherited from - -[BaseContract](verida_vda_did._internal_.BaseContract.md).[deployTransaction](verida_vda_did._internal_.BaseContract.md#deploytransaction) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:99 - -___ - -### estimateGas - -• `Readonly` **estimateGas**: `Object` - -#### Index signature - -▪ [name: `string`]: [`ContractFunction`](../modules/verida_vda_did._internal_.md#contractfunction)<[`BigNumber`](verida_vda_did._internal_.BigNumber.md)\> - -#### Inherited from - -[BaseContract](verida_vda_did._internal_.BaseContract.md).[estimateGas](verida_vda_did._internal_.BaseContract.md#estimategas) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:89 - -___ - -### filters - -• `Readonly` **filters**: `Object` - -#### Index signature - -▪ [name: `string`]: (...`args`: `any`[]) => [`EventFilter`](../modules/verida_vda_did._internal_.md#eventfilter) - -#### Inherited from - -[BaseContract](verida_vda_did._internal_.BaseContract.md).[filters](verida_vda_did._internal_.BaseContract.md#filters) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:95 - -___ - -### functions - -• `Readonly` **functions**: `Object` - -#### Index signature - -▪ [name: `string`]: [`ContractFunction`](../modules/verida_vda_did._internal_.md#contractfunction) - -#### Inherited from - -[BaseContract](verida_vda_did._internal_.BaseContract.md).[functions](verida_vda_did._internal_.BaseContract.md#functions) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:83 - -___ - -### interface - -• `Readonly` **interface**: [`Interface`](verida_vda_did._internal_.Interface.md) - -#### Inherited from - -[BaseContract](verida_vda_did._internal_.BaseContract.md).[interface](verida_vda_did._internal_.BaseContract.md#interface) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:80 - -___ - -### populateTransaction - -• `Readonly` **populateTransaction**: `Object` - -#### Index signature - -▪ [name: `string`]: [`ContractFunction`](../modules/verida_vda_did._internal_.md#contractfunction)<[`PopulatedTransaction`](../interfaces/verida_vda_did._internal_.PopulatedTransaction.md)\> - -#### Inherited from - -[BaseContract](verida_vda_did._internal_.BaseContract.md).[populateTransaction](verida_vda_did._internal_.BaseContract.md#populatetransaction) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:92 - -___ - -### provider - -• `Readonly` **provider**: [`Provider`](verida_vda_did._internal_.Provider.md) - -#### Inherited from - -[BaseContract](verida_vda_did._internal_.BaseContract.md).[provider](verida_vda_did._internal_.BaseContract.md#provider) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:82 - -___ - -### resolvedAddress - -• `Readonly` **resolvedAddress**: `Promise`<`string`\> - -#### Inherited from - -[BaseContract](verida_vda_did._internal_.BaseContract.md).[resolvedAddress](verida_vda_did._internal_.BaseContract.md#resolvedaddress) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:98 - -___ - -### signer - -• `Readonly` **signer**: [`Signer`](verida_vda_did._internal_.Signer.md) - -#### Inherited from - -[BaseContract](verida_vda_did._internal_.BaseContract.md).[signer](verida_vda_did._internal_.BaseContract.md#signer) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:81 - -## Methods - -### \_checkRunningEvents - -▸ **_checkRunningEvents**(`runningEvent`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `runningEvent` | [`RunningEvent`](verida_vda_did._internal_.RunningEvent.md) | - -#### Returns - -`void` - -#### Inherited from - -[BaseContract](verida_vda_did._internal_.BaseContract.md).[_checkRunningEvents](verida_vda_did._internal_.BaseContract.md#_checkrunningevents) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:121 - -___ - -### \_deployed - -▸ **_deployed**(`blockTag?`): `Promise`<[`Contract`](verida_vda_did._internal_.Contract.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `blockTag?` | [`BlockTag`](../modules/verida_vda_did._internal_.md#blocktag) | - -#### Returns - -`Promise`<[`Contract`](verida_vda_did._internal_.Contract.md)\> - -#### Inherited from - -[BaseContract](verida_vda_did._internal_.BaseContract.md).[_deployed](verida_vda_did._internal_.BaseContract.md#_deployed) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:114 - -___ - -### \_wrapEvent - -▸ **_wrapEvent**(`runningEvent`, `log`, `listener`): [`Event`](../interfaces/verida_vda_did._internal_.Event.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `runningEvent` | [`RunningEvent`](verida_vda_did._internal_.RunningEvent.md) | -| `log` | [`Log`](../interfaces/verida_vda_did._internal_.Log.md) | -| `listener` | [`Listener`](../modules/verida_vda_did._internal_.md#listener) | - -#### Returns - -[`Event`](../interfaces/verida_vda_did._internal_.Event.md) - -#### Inherited from - -[BaseContract](verida_vda_did._internal_.BaseContract.md).[_wrapEvent](verida_vda_did._internal_.BaseContract.md#_wrapevent) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:122 - -___ - -### attach - -▸ **attach**(`addressOrName`): [`Contract`](verida_vda_did._internal_.Contract.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `addressOrName` | `string` | - -#### Returns - -[`Contract`](verida_vda_did._internal_.Contract.md) - -#### Inherited from - -[BaseContract](verida_vda_did._internal_.BaseContract.md).[attach](verida_vda_did._internal_.BaseContract.md#attach) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:117 - -___ - -### connect - -▸ **connect**(`signerOrProvider`): [`Contract`](verida_vda_did._internal_.Contract.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `signerOrProvider` | `string` \| [`Signer`](verida_vda_did._internal_.Signer.md) \| [`Provider`](verida_vda_did._internal_.Provider.md) | - -#### Returns - -[`Contract`](verida_vda_did._internal_.Contract.md) - -#### Inherited from - -[BaseContract](verida_vda_did._internal_.BaseContract.md).[connect](verida_vda_did._internal_.BaseContract.md#connect) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:116 - -___ - -### deployed - -▸ **deployed**(): `Promise`<[`Contract`](verida_vda_did._internal_.Contract.md)\> - -#### Returns - -`Promise`<[`Contract`](verida_vda_did._internal_.Contract.md)\> - -#### Inherited from - -[BaseContract](verida_vda_did._internal_.BaseContract.md).[deployed](verida_vda_did._internal_.BaseContract.md#deployed) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:113 - -___ - -### emit - -▸ **emit**(`eventName`, ...`args`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | `string` \| [`EventFilter`](../modules/verida_vda_did._internal_.md#eventfilter) | -| `...args` | `any`[] | - -#### Returns - -`boolean` - -#### Inherited from - -[BaseContract](verida_vda_did._internal_.BaseContract.md).[emit](verida_vda_did._internal_.BaseContract.md#emit) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:127 - -___ - -### fallback - -▸ **fallback**(`overrides?`): `Promise`<[`TransactionResponse`](../interfaces/verida_vda_did._internal_.TransactionResponse.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `overrides?` | [`TransactionRequest`](../modules/verida_vda_did._internal_.md#transactionrequest) | - -#### Returns - -`Promise`<[`TransactionResponse`](../interfaces/verida_vda_did._internal_.TransactionResponse.md)\> - -#### Inherited from - -[BaseContract](verida_vda_did._internal_.BaseContract.md).[fallback](verida_vda_did._internal_.BaseContract.md#fallback) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:115 - -___ - -### listenerCount - -▸ **listenerCount**(`eventName?`): `number` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName?` | `string` \| [`EventFilter`](../modules/verida_vda_did._internal_.md#eventfilter) | - -#### Returns - -`number` - -#### Inherited from - -[BaseContract](verida_vda_did._internal_.BaseContract.md).[listenerCount](verida_vda_did._internal_.BaseContract.md#listenercount) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:128 - -___ - -### listeners - -▸ **listeners**(`eventName?`): [`Listener`](../modules/verida_vda_did._internal_.md#listener)[] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName?` | `string` \| [`EventFilter`](../modules/verida_vda_did._internal_.md#eventfilter) | - -#### Returns - -[`Listener`](../modules/verida_vda_did._internal_.md#listener)[] - -#### Inherited from - -[BaseContract](verida_vda_did._internal_.BaseContract.md).[listeners](verida_vda_did._internal_.BaseContract.md#listeners) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:129 - -___ - -### off - -▸ **off**(`eventName`, `listener`): [`Contract`](verida_vda_did._internal_.Contract.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | `string` \| [`EventFilter`](../modules/verida_vda_did._internal_.md#eventfilter) | -| `listener` | [`Listener`](../modules/verida_vda_did._internal_.md#listener) | - -#### Returns - -[`Contract`](verida_vda_did._internal_.Contract.md) - -#### Inherited from - -[BaseContract](verida_vda_did._internal_.BaseContract.md).[off](verida_vda_did._internal_.BaseContract.md#off) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:131 - -___ - -### on - -▸ **on**(`event`, `listener`): [`Contract`](verida_vda_did._internal_.Contract.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | `string` \| [`EventFilter`](../modules/verida_vda_did._internal_.md#eventfilter) | -| `listener` | [`Listener`](../modules/verida_vda_did._internal_.md#listener) | - -#### Returns - -[`Contract`](verida_vda_did._internal_.Contract.md) - -#### Inherited from - -[BaseContract](verida_vda_did._internal_.BaseContract.md).[on](verida_vda_did._internal_.BaseContract.md#on) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:125 - -___ - -### once - -▸ **once**(`event`, `listener`): [`Contract`](verida_vda_did._internal_.Contract.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | `string` \| [`EventFilter`](../modules/verida_vda_did._internal_.md#eventfilter) | -| `listener` | [`Listener`](../modules/verida_vda_did._internal_.md#listener) | - -#### Returns - -[`Contract`](verida_vda_did._internal_.Contract.md) - -#### Inherited from - -[BaseContract](verida_vda_did._internal_.BaseContract.md).[once](verida_vda_did._internal_.BaseContract.md#once) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:126 - -___ - -### queryFilter - -▸ **queryFilter**(`event`, `fromBlockOrBlockhash?`, `toBlock?`): `Promise`<[`Event`](../interfaces/verida_vda_did._internal_.Event.md)[]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | `string` \| [`EventFilter`](../modules/verida_vda_did._internal_.md#eventfilter) | -| `fromBlockOrBlockhash?` | [`BlockTag`](../modules/verida_vda_did._internal_.md#blocktag) | -| `toBlock?` | [`BlockTag`](../modules/verida_vda_did._internal_.md#blocktag) | - -#### Returns - -`Promise`<[`Event`](../interfaces/verida_vda_did._internal_.Event.md)[]\> - -#### Inherited from - -[BaseContract](verida_vda_did._internal_.BaseContract.md).[queryFilter](verida_vda_did._internal_.BaseContract.md#queryfilter) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:124 - -___ - -### removeAllListeners - -▸ **removeAllListeners**(`eventName?`): [`Contract`](verida_vda_did._internal_.Contract.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName?` | `string` \| [`EventFilter`](../modules/verida_vda_did._internal_.md#eventfilter) | - -#### Returns - -[`Contract`](verida_vda_did._internal_.Contract.md) - -#### Inherited from - -[BaseContract](verida_vda_did._internal_.BaseContract.md).[removeAllListeners](verida_vda_did._internal_.BaseContract.md#removealllisteners) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:130 - -___ - -### removeListener - -▸ **removeListener**(`eventName`, `listener`): [`Contract`](verida_vda_did._internal_.Contract.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | `string` \| [`EventFilter`](../modules/verida_vda_did._internal_.md#eventfilter) | -| `listener` | [`Listener`](../modules/verida_vda_did._internal_.md#listener) | - -#### Returns - -[`Contract`](verida_vda_did._internal_.Contract.md) - -#### Inherited from - -[BaseContract](verida_vda_did._internal_.BaseContract.md).[removeListener](verida_vda_did._internal_.BaseContract.md#removelistener) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:132 - -___ - -### getContractAddress - -▸ `Static` **getContractAddress**(`transaction`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transaction` | `Object` | -| `transaction.from` | `string` | -| `transaction.nonce` | [`BigNumberish`](../modules/verida_vda_did._internal_.md#bignumberish) | - -#### Returns - -`string` - -#### Inherited from - -[BaseContract](verida_vda_did._internal_.BaseContract.md).[getContractAddress](verida_vda_did._internal_.BaseContract.md#getcontractaddress) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:108 - -___ - -### getInterface - -▸ `Static` **getInterface**(`contractInterface`): [`Interface`](verida_vda_did._internal_.Interface.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contractInterface` | [`ContractInterface`](../modules/verida_vda_did._internal_.md#contractinterface) | - -#### Returns - -[`Interface`](verida_vda_did._internal_.Interface.md) - -#### Inherited from - -[BaseContract](verida_vda_did._internal_.BaseContract.md).[getInterface](verida_vda_did._internal_.BaseContract.md#getinterface) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:112 - -___ - -### isIndexed - -▸ `Static` **isIndexed**(`value`): value is Indexed - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `any` | - -#### Returns - -value is Indexed - -#### Inherited from - -[BaseContract](verida_vda_did._internal_.BaseContract.md).[isIndexed](verida_vda_did._internal_.BaseContract.md#isindexed) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:118 diff --git a/docs/api/verida-js/classes/verida_vda_did._internal_.Description.md b/docs/api/verida-js/classes/verida_vda_did._internal_.Description.md deleted file mode 100644 index 22b7708..0000000 --- a/docs/api/verida-js/classes/verida_vda_did._internal_.Description.md +++ /dev/null @@ -1,53 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-did](../modules/verida_vda_did.md) / [](../modules/verida_vda_did._internal_.md) / Description - -# Class: Description - -[@verida/vda-did](../modules/verida_vda_did.md).[](../modules/verida_vda_did._internal_.md).Description - -## Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `any` | - -## Hierarchy - -- **`Description`** - - ↳ [`Indexed`](verida_vda_did._internal_.Indexed.md) - - ↳ [`TransactionDescription`](verida_vda_did._internal_.TransactionDescription.md) - - ↳ [`LogDescription`](verida_vda_did._internal_.LogDescription.md) - - ↳ [`ErrorDescription`](verida_vda_did._internal_.ErrorDescription.md) - - ↳ [`ForkEvent`](verida_vda_did._internal_.ForkEvent.md) - -## Table of contents - -### Constructors - -- [constructor](verida_vda_did._internal_.Description.md#constructor) - -## Constructors - -### constructor - -• **new Description**<`T`\>(`info`) - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `any` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `info` | { [K in string \| number \| symbol]: T[K] } | - -#### Defined in - -node_modules/@ethersproject/properties/lib/index.d.ts:13 diff --git a/docs/api/verida-js/classes/verida_vda_did._internal_.ErrorDescription.md b/docs/api/verida-js/classes/verida_vda_did._internal_.ErrorDescription.md deleted file mode 100644 index bb610a6..0000000 --- a/docs/api/verida-js/classes/verida_vda_did._internal_.ErrorDescription.md +++ /dev/null @@ -1,100 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-did](../modules/verida_vda_did.md) / [](../modules/verida_vda_did._internal_.md) / ErrorDescription - -# Class: ErrorDescription - -[@verida/vda-did](../modules/verida_vda_did.md).[](../modules/verida_vda_did._internal_.md).ErrorDescription - -## Hierarchy - -- [`Description`](verida_vda_did._internal_.Description.md)<[`ErrorDescription`](verida_vda_did._internal_.ErrorDescription.md)\> - - ↳ **`ErrorDescription`** - -## Table of contents - -### Constructors - -- [constructor](verida_vda_did._internal_.ErrorDescription.md#constructor) - -### Properties - -- [args](verida_vda_did._internal_.ErrorDescription.md#args) -- [errorFragment](verida_vda_did._internal_.ErrorDescription.md#errorfragment) -- [name](verida_vda_did._internal_.ErrorDescription.md#name) -- [sighash](verida_vda_did._internal_.ErrorDescription.md#sighash) -- [signature](verida_vda_did._internal_.ErrorDescription.md#signature) - -## Constructors - -### constructor - -• **new ErrorDescription**(`info`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `info` | `Object` | -| `info.args` | [`Result`](../interfaces/verida_vda_did._internal_.Result.md) | -| `info.errorFragment` | [`ErrorFragment`](verida_vda_did._internal_.ErrorFragment.md) | -| `info.name` | `string` | -| `info.sighash` | `string` | -| `info.signature` | `string` | - -#### Inherited from - -[Description](verida_vda_did._internal_.Description.md).[constructor](verida_vda_did._internal_.Description.md#constructor) - -#### Defined in - -node_modules/@ethersproject/properties/lib/index.d.ts:13 - -## Properties - -### args - -• `Readonly` **args**: [`Result`](../interfaces/verida_vda_did._internal_.Result.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:26 - -___ - -### errorFragment - -• `Readonly` **errorFragment**: [`ErrorFragment`](verida_vda_did._internal_.ErrorFragment.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:24 - -___ - -### name - -• `Readonly` **name**: `string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:25 - -___ - -### sighash - -• `Readonly` **sighash**: `string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:28 - -___ - -### signature - -• `Readonly` **signature**: `string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:27 diff --git a/docs/api/verida-js/classes/verida_vda_did._internal_.ErrorFragment.md b/docs/api/verida-js/classes/verida_vda_did._internal_.ErrorFragment.md deleted file mode 100644 index 8355ae9..0000000 --- a/docs/api/verida-js/classes/verida_vda_did._internal_.ErrorFragment.md +++ /dev/null @@ -1,250 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-did](../modules/verida_vda_did.md) / [](../modules/verida_vda_did._internal_.md) / ErrorFragment - -# Class: ErrorFragment - -[@verida/vda-did](../modules/verida_vda_did.md).[](../modules/verida_vda_did._internal_.md).ErrorFragment - -## Hierarchy - -- [`Fragment`](verida_vda_did._internal_.Fragment.md) - - ↳ **`ErrorFragment`** - -## Table of contents - -### Constructors - -- [constructor](verida_vda_did._internal_.ErrorFragment.md#constructor) - -### Properties - -- [\_isFragment](verida_vda_did._internal_.ErrorFragment.md#_isfragment) -- [inputs](verida_vda_did._internal_.ErrorFragment.md#inputs) -- [name](verida_vda_did._internal_.ErrorFragment.md#name) -- [type](verida_vda_did._internal_.ErrorFragment.md#type) - -### Methods - -- [format](verida_vda_did._internal_.ErrorFragment.md#format) -- [from](verida_vda_did._internal_.ErrorFragment.md#from) -- [fromObject](verida_vda_did._internal_.ErrorFragment.md#fromobject) -- [fromString](verida_vda_did._internal_.ErrorFragment.md#fromstring) -- [isErrorFragment](verida_vda_did._internal_.ErrorFragment.md#iserrorfragment) -- [isFragment](verida_vda_did._internal_.ErrorFragment.md#isfragment) - -## Constructors - -### constructor - -• **new ErrorFragment**(`constructorGuard`, `params`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `constructorGuard` | `any` | -| `params` | `any` | - -#### Inherited from - -[Fragment](verida_vda_did._internal_.Fragment.md).[constructor](verida_vda_did._internal_.Fragment.md#constructor) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:44 - -## Properties - -### \_isFragment - -• `Readonly` **\_isFragment**: `boolean` - -#### Inherited from - -[Fragment](verida_vda_did._internal_.Fragment.md).[_isFragment](verida_vda_did._internal_.Fragment.md#_isfragment) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:43 - -___ - -### inputs - -• `Readonly` **inputs**: [`ParamType`](verida_vda_did._internal_.ParamType.md)[] - -#### Inherited from - -[Fragment](verida_vda_did._internal_.Fragment.md).[inputs](verida_vda_did._internal_.Fragment.md#inputs) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:42 - -___ - -### name - -• `Readonly` **name**: `string` - -#### Inherited from - -[Fragment](verida_vda_did._internal_.Fragment.md).[name](verida_vda_did._internal_.Fragment.md#name) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:41 - -___ - -### type - -• `Readonly` **type**: `string` - -#### Inherited from - -[Fragment](verida_vda_did._internal_.Fragment.md).[type](verida_vda_did._internal_.Fragment.md#type) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:40 - -## Methods - -### format - -▸ **format**(`format?`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `format?` | `string` | - -#### Returns - -`string` - -#### Overrides - -[Fragment](verida_vda_did._internal_.Fragment.md).[format](verida_vda_did._internal_.Fragment.md#format) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:79 - -___ - -### from - -▸ `Static` **from**(`value`): [`ErrorFragment`](verida_vda_did._internal_.ErrorFragment.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `string` \| [`JsonFragment`](../interfaces/verida_vda_did._internal_.JsonFragment.md) \| [`ErrorFragment`](verida_vda_did._internal_.ErrorFragment.md) | - -#### Returns - -[`ErrorFragment`](verida_vda_did._internal_.ErrorFragment.md) - -#### Overrides - -[Fragment](verida_vda_did._internal_.Fragment.md).[from](verida_vda_did._internal_.Fragment.md#from) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:80 - -___ - -### fromObject - -▸ `Static` **fromObject**(`value`): [`ErrorFragment`](verida_vda_did._internal_.ErrorFragment.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | [`JsonFragment`](../interfaces/verida_vda_did._internal_.JsonFragment.md) \| [`ErrorFragment`](verida_vda_did._internal_.ErrorFragment.md) | - -#### Returns - -[`ErrorFragment`](verida_vda_did._internal_.ErrorFragment.md) - -#### Overrides - -[Fragment](verida_vda_did._internal_.Fragment.md).[fromObject](verida_vda_did._internal_.Fragment.md#fromobject) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:81 - -___ - -### fromString - -▸ `Static` **fromString**(`value`): [`ErrorFragment`](verida_vda_did._internal_.ErrorFragment.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `string` | - -#### Returns - -[`ErrorFragment`](verida_vda_did._internal_.ErrorFragment.md) - -#### Overrides - -[Fragment](verida_vda_did._internal_.Fragment.md).[fromString](verida_vda_did._internal_.Fragment.md#fromstring) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:82 - -___ - -### isErrorFragment - -▸ `Static` **isErrorFragment**(`value`): value is ErrorFragment - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `any` | - -#### Returns - -value is ErrorFragment - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:83 - -___ - -### isFragment - -▸ `Static` **isFragment**(`value`): value is Fragment - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `any` | - -#### Returns - -value is Fragment - -#### Inherited from - -[Fragment](verida_vda_did._internal_.Fragment.md).[isFragment](verida_vda_did._internal_.Fragment.md#isfragment) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:49 diff --git a/docs/api/verida-js/classes/verida_vda_did._internal_.EventFragment.md b/docs/api/verida-js/classes/verida_vda_did._internal_.EventFragment.md deleted file mode 100644 index b02dc59..0000000 --- a/docs/api/verida-js/classes/verida_vda_did._internal_.EventFragment.md +++ /dev/null @@ -1,261 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-did](../modules/verida_vda_did.md) / [](../modules/verida_vda_did._internal_.md) / EventFragment - -# Class: EventFragment - -[@verida/vda-did](../modules/verida_vda_did.md).[](../modules/verida_vda_did._internal_.md).EventFragment - -## Hierarchy - -- [`Fragment`](verida_vda_did._internal_.Fragment.md) - - ↳ **`EventFragment`** - -## Table of contents - -### Constructors - -- [constructor](verida_vda_did._internal_.EventFragment.md#constructor) - -### Properties - -- [\_isFragment](verida_vda_did._internal_.EventFragment.md#_isfragment) -- [anonymous](verida_vda_did._internal_.EventFragment.md#anonymous) -- [inputs](verida_vda_did._internal_.EventFragment.md#inputs) -- [name](verida_vda_did._internal_.EventFragment.md#name) -- [type](verida_vda_did._internal_.EventFragment.md#type) - -### Methods - -- [format](verida_vda_did._internal_.EventFragment.md#format) -- [from](verida_vda_did._internal_.EventFragment.md#from) -- [fromObject](verida_vda_did._internal_.EventFragment.md#fromobject) -- [fromString](verida_vda_did._internal_.EventFragment.md#fromstring) -- [isEventFragment](verida_vda_did._internal_.EventFragment.md#iseventfragment) -- [isFragment](verida_vda_did._internal_.EventFragment.md#isfragment) - -## Constructors - -### constructor - -• **new EventFragment**(`constructorGuard`, `params`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `constructorGuard` | `any` | -| `params` | `any` | - -#### Inherited from - -[Fragment](verida_vda_did._internal_.Fragment.md).[constructor](verida_vda_did._internal_.Fragment.md#constructor) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:44 - -## Properties - -### \_isFragment - -• `Readonly` **\_isFragment**: `boolean` - -#### Inherited from - -[Fragment](verida_vda_did._internal_.Fragment.md).[_isFragment](verida_vda_did._internal_.Fragment.md#_isfragment) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:43 - -___ - -### anonymous - -• `Readonly` **anonymous**: `boolean` - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:52 - -___ - -### inputs - -• `Readonly` **inputs**: [`ParamType`](verida_vda_did._internal_.ParamType.md)[] - -#### Inherited from - -[Fragment](verida_vda_did._internal_.Fragment.md).[inputs](verida_vda_did._internal_.Fragment.md#inputs) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:42 - -___ - -### name - -• `Readonly` **name**: `string` - -#### Inherited from - -[Fragment](verida_vda_did._internal_.Fragment.md).[name](verida_vda_did._internal_.Fragment.md#name) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:41 - -___ - -### type - -• `Readonly` **type**: `string` - -#### Inherited from - -[Fragment](verida_vda_did._internal_.Fragment.md).[type](verida_vda_did._internal_.Fragment.md#type) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:40 - -## Methods - -### format - -▸ **format**(`format?`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `format?` | `string` | - -#### Returns - -`string` - -#### Overrides - -[Fragment](verida_vda_did._internal_.Fragment.md).[format](verida_vda_did._internal_.Fragment.md#format) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:53 - -___ - -### from - -▸ `Static` **from**(`value`): [`EventFragment`](verida_vda_did._internal_.EventFragment.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `string` \| [`JsonFragment`](../interfaces/verida_vda_did._internal_.JsonFragment.md) \| [`EventFragment`](verida_vda_did._internal_.EventFragment.md) | - -#### Returns - -[`EventFragment`](verida_vda_did._internal_.EventFragment.md) - -#### Overrides - -[Fragment](verida_vda_did._internal_.Fragment.md).[from](verida_vda_did._internal_.Fragment.md#from) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:54 - -___ - -### fromObject - -▸ `Static` **fromObject**(`value`): [`EventFragment`](verida_vda_did._internal_.EventFragment.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | [`JsonFragment`](../interfaces/verida_vda_did._internal_.JsonFragment.md) \| [`EventFragment`](verida_vda_did._internal_.EventFragment.md) | - -#### Returns - -[`EventFragment`](verida_vda_did._internal_.EventFragment.md) - -#### Overrides - -[Fragment](verida_vda_did._internal_.Fragment.md).[fromObject](verida_vda_did._internal_.Fragment.md#fromobject) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:55 - -___ - -### fromString - -▸ `Static` **fromString**(`value`): [`EventFragment`](verida_vda_did._internal_.EventFragment.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `string` | - -#### Returns - -[`EventFragment`](verida_vda_did._internal_.EventFragment.md) - -#### Overrides - -[Fragment](verida_vda_did._internal_.Fragment.md).[fromString](verida_vda_did._internal_.Fragment.md#fromstring) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:56 - -___ - -### isEventFragment - -▸ `Static` **isEventFragment**(`value`): value is EventFragment - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `any` | - -#### Returns - -value is EventFragment - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:57 - -___ - -### isFragment - -▸ `Static` **isFragment**(`value`): value is Fragment - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `any` | - -#### Returns - -value is Fragment - -#### Inherited from - -[Fragment](verida_vda_did._internal_.Fragment.md).[isFragment](verida_vda_did._internal_.Fragment.md#isfragment) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:49 diff --git a/docs/api/verida-js/classes/verida_vda_did._internal_.ForkEvent.md b/docs/api/verida-js/classes/verida_vda_did._internal_.ForkEvent.md deleted file mode 100644 index 005b1d7..0000000 --- a/docs/api/verida-js/classes/verida_vda_did._internal_.ForkEvent.md +++ /dev/null @@ -1,86 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-did](../modules/verida_vda_did.md) / [](../modules/verida_vda_did._internal_.md) / ForkEvent - -# Class: ForkEvent - -[@verida/vda-did](../modules/verida_vda_did.md).[](../modules/verida_vda_did._internal_.md).ForkEvent - -## Hierarchy - -- [`Description`](verida_vda_did._internal_.Description.md) - - ↳ **`ForkEvent`** - -## Table of contents - -### Constructors - -- [constructor](verida_vda_did._internal_.ForkEvent.md#constructor) - -### Properties - -- [\_isForkEvent](verida_vda_did._internal_.ForkEvent.md#_isforkevent) -- [expiry](verida_vda_did._internal_.ForkEvent.md#expiry) - -### Methods - -- [isForkEvent](verida_vda_did._internal_.ForkEvent.md#isforkevent) - -## Constructors - -### constructor - -• **new ForkEvent**(`info`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `info` | `Object` | - -#### Inherited from - -[Description](verida_vda_did._internal_.Description.md).[constructor](verida_vda_did._internal_.Description.md#constructor) - -#### Defined in - -node_modules/@ethersproject/properties/lib/index.d.ts:13 - -## Properties - -### \_isForkEvent - -• `Optional` `Readonly` **\_isForkEvent**: `boolean` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:103 - -___ - -### expiry - -• `Readonly` **expiry**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:102 - -## Methods - -### isForkEvent - -▸ `Static` **isForkEvent**(`value`): value is ForkEvent - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `any` | - -#### Returns - -value is ForkEvent - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:104 diff --git a/docs/api/verida-js/classes/verida_vda_did._internal_.Fragment.md b/docs/api/verida-js/classes/verida_vda_did._internal_.Fragment.md deleted file mode 100644 index 69ca56d..0000000 --- a/docs/api/verida-js/classes/verida_vda_did._internal_.Fragment.md +++ /dev/null @@ -1,193 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-did](../modules/verida_vda_did.md) / [](../modules/verida_vda_did._internal_.md) / Fragment - -# Class: Fragment - -[@verida/vda-did](../modules/verida_vda_did.md).[](../modules/verida_vda_did._internal_.md).Fragment - -## Hierarchy - -- **`Fragment`** - - ↳ [`ConstructorFragment`](verida_vda_did._internal_.ConstructorFragment.md) - - ↳ [`EventFragment`](verida_vda_did._internal_.EventFragment.md) - - ↳ [`ErrorFragment`](verida_vda_did._internal_.ErrorFragment.md) - -## Table of contents - -### Constructors - -- [constructor](verida_vda_did._internal_.Fragment.md#constructor) - -### Properties - -- [\_isFragment](verida_vda_did._internal_.Fragment.md#_isfragment) -- [inputs](verida_vda_did._internal_.Fragment.md#inputs) -- [name](verida_vda_did._internal_.Fragment.md#name) -- [type](verida_vda_did._internal_.Fragment.md#type) - -### Methods - -- [format](verida_vda_did._internal_.Fragment.md#format) -- [from](verida_vda_did._internal_.Fragment.md#from) -- [fromObject](verida_vda_did._internal_.Fragment.md#fromobject) -- [fromString](verida_vda_did._internal_.Fragment.md#fromstring) -- [isFragment](verida_vda_did._internal_.Fragment.md#isfragment) - -## Constructors - -### constructor - -• **new Fragment**(`constructorGuard`, `params`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `constructorGuard` | `any` | -| `params` | `any` | - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:44 - -## Properties - -### \_isFragment - -• `Readonly` **\_isFragment**: `boolean` - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:43 - -___ - -### inputs - -• `Readonly` **inputs**: [`ParamType`](verida_vda_did._internal_.ParamType.md)[] - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:42 - -___ - -### name - -• `Readonly` **name**: `string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:41 - -___ - -### type - -• `Readonly` **type**: `string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:40 - -## Methods - -### format - -▸ `Abstract` **format**(`format?`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `format?` | `string` | - -#### Returns - -`string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:45 - -___ - -### from - -▸ `Static` **from**(`value`): [`Fragment`](verida_vda_did._internal_.Fragment.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `string` \| [`Fragment`](verida_vda_did._internal_.Fragment.md) \| [`JsonFragment`](../interfaces/verida_vda_did._internal_.JsonFragment.md) | - -#### Returns - -[`Fragment`](verida_vda_did._internal_.Fragment.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:46 - -___ - -### fromObject - -▸ `Static` **fromObject**(`value`): [`Fragment`](verida_vda_did._internal_.Fragment.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | [`Fragment`](verida_vda_did._internal_.Fragment.md) \| [`JsonFragment`](../interfaces/verida_vda_did._internal_.JsonFragment.md) | - -#### Returns - -[`Fragment`](verida_vda_did._internal_.Fragment.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:47 - -___ - -### fromString - -▸ `Static` **fromString**(`value`): [`Fragment`](verida_vda_did._internal_.Fragment.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `string` | - -#### Returns - -[`Fragment`](verida_vda_did._internal_.Fragment.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:48 - -___ - -### isFragment - -▸ `Static` **isFragment**(`value`): value is Fragment - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `any` | - -#### Returns - -value is Fragment - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:49 diff --git a/docs/api/verida-js/classes/verida_vda_did._internal_.FunctionFragment.md b/docs/api/verida-js/classes/verida_vda_did._internal_.FunctionFragment.md deleted file mode 100644 index c999e90..0000000 --- a/docs/api/verida-js/classes/verida_vda_did._internal_.FunctionFragment.md +++ /dev/null @@ -1,342 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-did](../modules/verida_vda_did.md) / [](../modules/verida_vda_did._internal_.md) / FunctionFragment - -# Class: FunctionFragment - -[@verida/vda-did](../modules/verida_vda_did.md).[](../modules/verida_vda_did._internal_.md).FunctionFragment - -## Hierarchy - -- [`ConstructorFragment`](verida_vda_did._internal_.ConstructorFragment.md) - - ↳ **`FunctionFragment`** - -## Table of contents - -### Constructors - -- [constructor](verida_vda_did._internal_.FunctionFragment.md#constructor) - -### Properties - -- [\_isFragment](verida_vda_did._internal_.FunctionFragment.md#_isfragment) -- [constant](verida_vda_did._internal_.FunctionFragment.md#constant) -- [gas](verida_vda_did._internal_.FunctionFragment.md#gas) -- [inputs](verida_vda_did._internal_.FunctionFragment.md#inputs) -- [name](verida_vda_did._internal_.FunctionFragment.md#name) -- [outputs](verida_vda_did._internal_.FunctionFragment.md#outputs) -- [payable](verida_vda_did._internal_.FunctionFragment.md#payable) -- [stateMutability](verida_vda_did._internal_.FunctionFragment.md#statemutability) -- [type](verida_vda_did._internal_.FunctionFragment.md#type) - -### Methods - -- [format](verida_vda_did._internal_.FunctionFragment.md#format) -- [from](verida_vda_did._internal_.FunctionFragment.md#from) -- [fromObject](verida_vda_did._internal_.FunctionFragment.md#fromobject) -- [fromString](verida_vda_did._internal_.FunctionFragment.md#fromstring) -- [isConstructorFragment](verida_vda_did._internal_.FunctionFragment.md#isconstructorfragment) -- [isFragment](verida_vda_did._internal_.FunctionFragment.md#isfragment) -- [isFunctionFragment](verida_vda_did._internal_.FunctionFragment.md#isfunctionfragment) - -## Constructors - -### constructor - -• **new FunctionFragment**(`constructorGuard`, `params`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `constructorGuard` | `any` | -| `params` | `any` | - -#### Inherited from - -[ConstructorFragment](verida_vda_did._internal_.ConstructorFragment.md).[constructor](verida_vda_did._internal_.ConstructorFragment.md#constructor) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:44 - -## Properties - -### \_isFragment - -• `Readonly` **\_isFragment**: `boolean` - -#### Inherited from - -[ConstructorFragment](verida_vda_did._internal_.ConstructorFragment.md).[_isFragment](verida_vda_did._internal_.ConstructorFragment.md#_isfragment) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:43 - -___ - -### constant - -• **constant**: `boolean` - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:70 - -___ - -### gas - -• `Optional` **gas**: [`BigNumber`](verida_vda_did._internal_.BigNumber.md) - -#### Inherited from - -[ConstructorFragment](verida_vda_did._internal_.ConstructorFragment.md).[gas](verida_vda_did._internal_.ConstructorFragment.md#gas) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:62 - -___ - -### inputs - -• `Readonly` **inputs**: [`ParamType`](verida_vda_did._internal_.ParamType.md)[] - -#### Inherited from - -[ConstructorFragment](verida_vda_did._internal_.ConstructorFragment.md).[inputs](verida_vda_did._internal_.ConstructorFragment.md#inputs) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:42 - -___ - -### name - -• `Readonly` **name**: `string` - -#### Inherited from - -[ConstructorFragment](verida_vda_did._internal_.ConstructorFragment.md).[name](verida_vda_did._internal_.ConstructorFragment.md#name) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:41 - -___ - -### outputs - -• `Optional` **outputs**: [`ParamType`](verida_vda_did._internal_.ParamType.md)[] - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:71 - -___ - -### payable - -• **payable**: `boolean` - -#### Inherited from - -[ConstructorFragment](verida_vda_did._internal_.ConstructorFragment.md).[payable](verida_vda_did._internal_.ConstructorFragment.md#payable) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:61 - -___ - -### stateMutability - -• **stateMutability**: `string` - -#### Inherited from - -[ConstructorFragment](verida_vda_did._internal_.ConstructorFragment.md).[stateMutability](verida_vda_did._internal_.ConstructorFragment.md#statemutability) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:60 - -___ - -### type - -• `Readonly` **type**: `string` - -#### Inherited from - -[ConstructorFragment](verida_vda_did._internal_.ConstructorFragment.md).[type](verida_vda_did._internal_.ConstructorFragment.md#type) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:40 - -## Methods - -### format - -▸ **format**(`format?`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `format?` | `string` | - -#### Returns - -`string` - -#### Overrides - -[ConstructorFragment](verida_vda_did._internal_.ConstructorFragment.md).[format](verida_vda_did._internal_.ConstructorFragment.md#format) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:72 - -___ - -### from - -▸ `Static` **from**(`value`): [`FunctionFragment`](verida_vda_did._internal_.FunctionFragment.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `string` \| [`JsonFragment`](../interfaces/verida_vda_did._internal_.JsonFragment.md) \| [`FunctionFragment`](verida_vda_did._internal_.FunctionFragment.md) | - -#### Returns - -[`FunctionFragment`](verida_vda_did._internal_.FunctionFragment.md) - -#### Overrides - -[ConstructorFragment](verida_vda_did._internal_.ConstructorFragment.md).[from](verida_vda_did._internal_.ConstructorFragment.md#from) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:73 - -___ - -### fromObject - -▸ `Static` **fromObject**(`value`): [`FunctionFragment`](verida_vda_did._internal_.FunctionFragment.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | [`JsonFragment`](../interfaces/verida_vda_did._internal_.JsonFragment.md) \| [`FunctionFragment`](verida_vda_did._internal_.FunctionFragment.md) | - -#### Returns - -[`FunctionFragment`](verida_vda_did._internal_.FunctionFragment.md) - -#### Overrides - -[ConstructorFragment](verida_vda_did._internal_.ConstructorFragment.md).[fromObject](verida_vda_did._internal_.ConstructorFragment.md#fromobject) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:74 - -___ - -### fromString - -▸ `Static` **fromString**(`value`): [`FunctionFragment`](verida_vda_did._internal_.FunctionFragment.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `string` | - -#### Returns - -[`FunctionFragment`](verida_vda_did._internal_.FunctionFragment.md) - -#### Overrides - -[ConstructorFragment](verida_vda_did._internal_.ConstructorFragment.md).[fromString](verida_vda_did._internal_.ConstructorFragment.md#fromstring) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:75 - -___ - -### isConstructorFragment - -▸ `Static` **isConstructorFragment**(`value`): value is ConstructorFragment - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `any` | - -#### Returns - -value is ConstructorFragment - -#### Inherited from - -[ConstructorFragment](verida_vda_did._internal_.ConstructorFragment.md).[isConstructorFragment](verida_vda_did._internal_.ConstructorFragment.md#isconstructorfragment) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:67 - -___ - -### isFragment - -▸ `Static` **isFragment**(`value`): value is Fragment - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `any` | - -#### Returns - -value is Fragment - -#### Inherited from - -[ConstructorFragment](verida_vda_did._internal_.ConstructorFragment.md).[isFragment](verida_vda_did._internal_.ConstructorFragment.md#isfragment) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:49 - -___ - -### isFunctionFragment - -▸ `Static` **isFunctionFragment**(`value`): value is FunctionFragment - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `any` | - -#### Returns - -value is FunctionFragment - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:76 diff --git a/docs/api/verida-js/classes/verida_vda_did._internal_.Indexed.md b/docs/api/verida-js/classes/verida_vda_did._internal_.Indexed.md deleted file mode 100644 index b687285..0000000 --- a/docs/api/verida-js/classes/verida_vda_did._internal_.Indexed.md +++ /dev/null @@ -1,88 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-did](../modules/verida_vda_did.md) / [](../modules/verida_vda_did._internal_.md) / Indexed - -# Class: Indexed - -[@verida/vda-did](../modules/verida_vda_did.md).[](../modules/verida_vda_did._internal_.md).Indexed - -## Hierarchy - -- [`Description`](verida_vda_did._internal_.Description.md)<[`Indexed`](verida_vda_did._internal_.Indexed.md)\> - - ↳ **`Indexed`** - -## Table of contents - -### Constructors - -- [constructor](verida_vda_did._internal_.Indexed.md#constructor) - -### Properties - -- [\_isIndexed](verida_vda_did._internal_.Indexed.md#_isindexed) -- [hash](verida_vda_did._internal_.Indexed.md#hash) - -### Methods - -- [isIndexed](verida_vda_did._internal_.Indexed.md#isindexed) - -## Constructors - -### constructor - -• **new Indexed**(`info`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `info` | `Object` | -| `info._isIndexed` | `boolean` | -| `info.hash` | `string` | - -#### Inherited from - -[Description](verida_vda_did._internal_.Description.md).[constructor](verida_vda_did._internal_.Description.md#constructor) - -#### Defined in - -node_modules/@ethersproject/properties/lib/index.d.ts:13 - -## Properties - -### \_isIndexed - -• `Readonly` **\_isIndexed**: `boolean` - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:32 - -___ - -### hash - -• `Readonly` **hash**: `string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:31 - -## Methods - -### isIndexed - -▸ `Static` **isIndexed**(`value`): value is Indexed - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `any` | - -#### Returns - -value is Indexed - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:33 diff --git a/docs/api/verida-js/classes/verida_vda_did._internal_.Interface.md b/docs/api/verida-js/classes/verida_vda_did._internal_.Interface.md deleted file mode 100644 index 6c4e097..0000000 --- a/docs/api/verida-js/classes/verida_vda_did._internal_.Interface.md +++ /dev/null @@ -1,698 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-did](../modules/verida_vda_did.md) / [](../modules/verida_vda_did._internal_.md) / Interface - -# Class: Interface - -[@verida/vda-did](../modules/verida_vda_did.md).[](../modules/verida_vda_did._internal_.md).Interface - -## Table of contents - -### Constructors - -- [constructor](verida_vda_did._internal_.Interface.md#constructor) - -### Properties - -- [\_abiCoder](verida_vda_did._internal_.Interface.md#_abicoder) -- [\_isInterface](verida_vda_did._internal_.Interface.md#_isinterface) -- [deploy](verida_vda_did._internal_.Interface.md#deploy) -- [errors](verida_vda_did._internal_.Interface.md#errors) -- [events](verida_vda_did._internal_.Interface.md#events) -- [fragments](verida_vda_did._internal_.Interface.md#fragments) -- [functions](verida_vda_did._internal_.Interface.md#functions) -- [structs](verida_vda_did._internal_.Interface.md#structs) - -### Methods - -- [\_decodeParams](verida_vda_did._internal_.Interface.md#_decodeparams) -- [\_encodeParams](verida_vda_did._internal_.Interface.md#_encodeparams) -- [decodeErrorResult](verida_vda_did._internal_.Interface.md#decodeerrorresult) -- [decodeEventLog](verida_vda_did._internal_.Interface.md#decodeeventlog) -- [decodeFunctionData](verida_vda_did._internal_.Interface.md#decodefunctiondata) -- [decodeFunctionResult](verida_vda_did._internal_.Interface.md#decodefunctionresult) -- [encodeDeploy](verida_vda_did._internal_.Interface.md#encodedeploy) -- [encodeErrorResult](verida_vda_did._internal_.Interface.md#encodeerrorresult) -- [encodeEventLog](verida_vda_did._internal_.Interface.md#encodeeventlog) -- [encodeFilterTopics](verida_vda_did._internal_.Interface.md#encodefiltertopics) -- [encodeFunctionData](verida_vda_did._internal_.Interface.md#encodefunctiondata) -- [encodeFunctionResult](verida_vda_did._internal_.Interface.md#encodefunctionresult) -- [format](verida_vda_did._internal_.Interface.md#format) -- [getError](verida_vda_did._internal_.Interface.md#geterror) -- [getEvent](verida_vda_did._internal_.Interface.md#getevent) -- [getEventTopic](verida_vda_did._internal_.Interface.md#geteventtopic) -- [getFunction](verida_vda_did._internal_.Interface.md#getfunction) -- [getSighash](verida_vda_did._internal_.Interface.md#getsighash) -- [parseError](verida_vda_did._internal_.Interface.md#parseerror) -- [parseLog](verida_vda_did._internal_.Interface.md#parselog) -- [parseTransaction](verida_vda_did._internal_.Interface.md#parsetransaction) -- [getAbiCoder](verida_vda_did._internal_.Interface.md#getabicoder) -- [getAddress](verida_vda_did._internal_.Interface.md#getaddress) -- [getEventTopic](verida_vda_did._internal_.Interface.md#geteventtopic) -- [getSighash](verida_vda_did._internal_.Interface.md#getsighash) -- [isInterface](verida_vda_did._internal_.Interface.md#isinterface) - -## Constructors - -### constructor - -• **new Interface**(`fragments`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `fragments` | `string` \| readonly (`string` \| [`Fragment`](verida_vda_did._internal_.Fragment.md) \| [`JsonFragment`](../interfaces/verida_vda_did._internal_.JsonFragment.md))[] | - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:52 - -## Properties - -### \_abiCoder - -• `Readonly` **\_abiCoder**: [`AbiCoder`](verida_vda_did._internal_.AbiCoder.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:50 - -___ - -### \_isInterface - -• `Readonly` **\_isInterface**: `boolean` - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:51 - -___ - -### deploy - -• `Readonly` **deploy**: [`ConstructorFragment`](verida_vda_did._internal_.ConstructorFragment.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:49 - -___ - -### errors - -• `Readonly` **errors**: `Object` - -#### Index signature - -▪ [name: `string`]: [`ErrorFragment`](verida_vda_did._internal_.ErrorFragment.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:37 - -___ - -### events - -• `Readonly` **events**: `Object` - -#### Index signature - -▪ [name: `string`]: [`EventFragment`](verida_vda_did._internal_.EventFragment.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:40 - -___ - -### fragments - -• `Readonly` **fragments**: readonly [`Fragment`](verida_vda_did._internal_.Fragment.md)[] - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:36 - -___ - -### functions - -• `Readonly` **functions**: `Object` - -#### Index signature - -▪ [name: `string`]: [`FunctionFragment`](verida_vda_did._internal_.FunctionFragment.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:43 - -___ - -### structs - -• `Readonly` **structs**: `Object` - -#### Index signature - -▪ [name: `string`]: `any` - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:46 - -## Methods - -### \_decodeParams - -▸ **_decodeParams**(`params`, `data`): [`Result`](../interfaces/verida_vda_did._internal_.Result.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `params` | readonly [`ParamType`](verida_vda_did._internal_.ParamType.md)[] | -| `data` | [`BytesLike`](../modules/verida_vda_did._internal_.md#byteslike) | - -#### Returns - -[`Result`](../interfaces/verida_vda_did._internal_.Result.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:63 - -___ - -### \_encodeParams - -▸ **_encodeParams**(`params`, `values`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `params` | readonly [`ParamType`](verida_vda_did._internal_.ParamType.md)[] | -| `values` | readonly `any`[] | - -#### Returns - -`string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:64 - -___ - -### decodeErrorResult - -▸ **decodeErrorResult**(`fragment`, `data`): [`Result`](../interfaces/verida_vda_did._internal_.Result.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `fragment` | `string` \| [`ErrorFragment`](verida_vda_did._internal_.ErrorFragment.md) | -| `data` | [`BytesLike`](../modules/verida_vda_did._internal_.md#byteslike) | - -#### Returns - -[`Result`](../interfaces/verida_vda_did._internal_.Result.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:66 - -___ - -### decodeEventLog - -▸ **decodeEventLog**(`eventFragment`, `data`, `topics?`): [`Result`](../interfaces/verida_vda_did._internal_.Result.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventFragment` | `string` \| [`EventFragment`](verida_vda_did._internal_.EventFragment.md) | -| `data` | [`BytesLike`](../modules/verida_vda_did._internal_.md#byteslike) | -| `topics?` | readonly `string`[] | - -#### Returns - -[`Result`](../interfaces/verida_vda_did._internal_.Result.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:77 - -___ - -### decodeFunctionData - -▸ **decodeFunctionData**(`functionFragment`, `data`): [`Result`](../interfaces/verida_vda_did._internal_.Result.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `functionFragment` | `string` \| [`FunctionFragment`](verida_vda_did._internal_.FunctionFragment.md) | -| `data` | [`BytesLike`](../modules/verida_vda_did._internal_.md#byteslike) | - -#### Returns - -[`Result`](../interfaces/verida_vda_did._internal_.Result.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:68 - -___ - -### decodeFunctionResult - -▸ **decodeFunctionResult**(`functionFragment`, `data`): [`Result`](../interfaces/verida_vda_did._internal_.Result.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `functionFragment` | `string` \| [`FunctionFragment`](verida_vda_did._internal_.FunctionFragment.md) | -| `data` | [`BytesLike`](../modules/verida_vda_did._internal_.md#byteslike) | - -#### Returns - -[`Result`](../interfaces/verida_vda_did._internal_.Result.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:70 - -___ - -### encodeDeploy - -▸ **encodeDeploy**(`values?`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `values?` | readonly `any`[] | - -#### Returns - -`string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:65 - -___ - -### encodeErrorResult - -▸ **encodeErrorResult**(`fragment`, `values?`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `fragment` | `string` \| [`ErrorFragment`](verida_vda_did._internal_.ErrorFragment.md) | -| `values?` | readonly `any`[] | - -#### Returns - -`string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:67 - -___ - -### encodeEventLog - -▸ **encodeEventLog**(`eventFragment`, `values`): `Object` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventFragment` | `string` \| [`EventFragment`](verida_vda_did._internal_.EventFragment.md) | -| `values` | readonly `any`[] | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `data` | `string` | -| `topics` | `string`[] | - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:73 - -___ - -### encodeFilterTopics - -▸ **encodeFilterTopics**(`eventFragment`, `values`): (`string` \| `string`[])[] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventFragment` | `string` \| [`EventFragment`](verida_vda_did._internal_.EventFragment.md) | -| `values` | readonly `any`[] | - -#### Returns - -(`string` \| `string`[])[] - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:72 - -___ - -### encodeFunctionData - -▸ **encodeFunctionData**(`functionFragment`, `values?`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `functionFragment` | `string` \| [`FunctionFragment`](verida_vda_did._internal_.FunctionFragment.md) | -| `values?` | readonly `any`[] | - -#### Returns - -`string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:69 - -___ - -### encodeFunctionResult - -▸ **encodeFunctionResult**(`functionFragment`, `values?`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `functionFragment` | `string` \| [`FunctionFragment`](verida_vda_did._internal_.FunctionFragment.md) | -| `values?` | readonly `any`[] | - -#### Returns - -`string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:71 - -___ - -### format - -▸ **format**(`format?`): `string` \| `string`[] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `format?` | `string` | - -#### Returns - -`string` \| `string`[] - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:53 - -___ - -### getError - -▸ **getError**(`nameOrSignatureOrSighash`): [`ErrorFragment`](verida_vda_did._internal_.ErrorFragment.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `nameOrSignatureOrSighash` | `string` | - -#### Returns - -[`ErrorFragment`](verida_vda_did._internal_.ErrorFragment.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:60 - -___ - -### getEvent - -▸ **getEvent**(`nameOrSignatureOrTopic`): [`EventFragment`](verida_vda_did._internal_.EventFragment.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `nameOrSignatureOrTopic` | `string` | - -#### Returns - -[`EventFragment`](verida_vda_did._internal_.EventFragment.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:59 - -___ - -### getEventTopic - -▸ **getEventTopic**(`eventFragment`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventFragment` | `string` \| [`EventFragment`](verida_vda_did._internal_.EventFragment.md) | - -#### Returns - -`string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:62 - -___ - -### getFunction - -▸ **getFunction**(`nameOrSignatureOrSighash`): [`FunctionFragment`](verida_vda_did._internal_.FunctionFragment.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `nameOrSignatureOrSighash` | `string` | - -#### Returns - -[`FunctionFragment`](verida_vda_did._internal_.FunctionFragment.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:58 - -___ - -### getSighash - -▸ **getSighash**(`fragment`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `fragment` | `string` \| [`ErrorFragment`](verida_vda_did._internal_.ErrorFragment.md) \| [`FunctionFragment`](verida_vda_did._internal_.FunctionFragment.md) | - -#### Returns - -`string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:61 - -___ - -### parseError - -▸ **parseError**(`data`): [`ErrorDescription`](verida_vda_did._internal_.ErrorDescription.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | [`BytesLike`](../modules/verida_vda_did._internal_.md#byteslike) | - -#### Returns - -[`ErrorDescription`](verida_vda_did._internal_.ErrorDescription.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:86 - -___ - -### parseLog - -▸ **parseLog**(`log`): [`LogDescription`](verida_vda_did._internal_.LogDescription.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `log` | `Object` | -| `log.data` | `string` | -| `log.topics` | `string`[] | - -#### Returns - -[`LogDescription`](verida_vda_did._internal_.LogDescription.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:82 - -___ - -### parseTransaction - -▸ **parseTransaction**(`tx`): [`TransactionDescription`](verida_vda_did._internal_.TransactionDescription.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `tx` | `Object` | -| `tx.data` | `string` | -| `tx.value?` | [`BigNumberish`](../modules/verida_vda_did._internal_.md#bignumberish) | - -#### Returns - -[`TransactionDescription`](verida_vda_did._internal_.TransactionDescription.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:78 - -___ - -### getAbiCoder - -▸ `Static` **getAbiCoder**(): [`AbiCoder`](verida_vda_did._internal_.AbiCoder.md) - -#### Returns - -[`AbiCoder`](verida_vda_did._internal_.AbiCoder.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:54 - -___ - -### getAddress - -▸ `Static` **getAddress**(`address`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `address` | `string` | - -#### Returns - -`string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:55 - -___ - -### getEventTopic - -▸ `Static` **getEventTopic**(`eventFragment`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventFragment` | [`EventFragment`](verida_vda_did._internal_.EventFragment.md) | - -#### Returns - -`string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:57 - -___ - -### getSighash - -▸ `Static` **getSighash**(`fragment`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `fragment` | [`ErrorFragment`](verida_vda_did._internal_.ErrorFragment.md) \| [`FunctionFragment`](verida_vda_did._internal_.FunctionFragment.md) | - -#### Returns - -`string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:56 - -___ - -### isInterface - -▸ `Static` **isInterface**(`value`): value is Interface - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `any` | - -#### Returns - -value is Interface - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:87 diff --git a/docs/api/verida-js/classes/verida_vda_did._internal_.LogDescription.md b/docs/api/verida-js/classes/verida_vda_did._internal_.LogDescription.md deleted file mode 100644 index 535e573..0000000 --- a/docs/api/verida-js/classes/verida_vda_did._internal_.LogDescription.md +++ /dev/null @@ -1,100 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-did](../modules/verida_vda_did.md) / [](../modules/verida_vda_did._internal_.md) / LogDescription - -# Class: LogDescription - -[@verida/vda-did](../modules/verida_vda_did.md).[](../modules/verida_vda_did._internal_.md).LogDescription - -## Hierarchy - -- [`Description`](verida_vda_did._internal_.Description.md)<[`LogDescription`](verida_vda_did._internal_.LogDescription.md)\> - - ↳ **`LogDescription`** - -## Table of contents - -### Constructors - -- [constructor](verida_vda_did._internal_.LogDescription.md#constructor) - -### Properties - -- [args](verida_vda_did._internal_.LogDescription.md#args) -- [eventFragment](verida_vda_did._internal_.LogDescription.md#eventfragment) -- [name](verida_vda_did._internal_.LogDescription.md#name) -- [signature](verida_vda_did._internal_.LogDescription.md#signature) -- [topic](verida_vda_did._internal_.LogDescription.md#topic) - -## Constructors - -### constructor - -• **new LogDescription**(`info`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `info` | `Object` | -| `info.args` | [`Result`](../interfaces/verida_vda_did._internal_.Result.md) | -| `info.eventFragment` | [`EventFragment`](verida_vda_did._internal_.EventFragment.md) | -| `info.name` | `string` | -| `info.signature` | `string` | -| `info.topic` | `string` | - -#### Inherited from - -[Description](verida_vda_did._internal_.Description.md).[constructor](verida_vda_did._internal_.Description.md#constructor) - -#### Defined in - -node_modules/@ethersproject/properties/lib/index.d.ts:13 - -## Properties - -### args - -• `Readonly` **args**: [`Result`](../interfaces/verida_vda_did._internal_.Result.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:13 - -___ - -### eventFragment - -• `Readonly` **eventFragment**: [`EventFragment`](verida_vda_did._internal_.EventFragment.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:9 - -___ - -### name - -• `Readonly` **name**: `string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:10 - -___ - -### signature - -• `Readonly` **signature**: `string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:11 - -___ - -### topic - -• `Readonly` **topic**: `string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:12 diff --git a/docs/api/verida-js/classes/verida_vda_did._internal_.ParamType.md b/docs/api/verida-js/classes/verida_vda_did._internal_.ParamType.md deleted file mode 100644 index 5f3fad0..0000000 --- a/docs/api/verida-js/classes/verida_vda_did._internal_.ParamType.md +++ /dev/null @@ -1,229 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-did](../modules/verida_vda_did.md) / [](../modules/verida_vda_did._internal_.md) / ParamType - -# Class: ParamType - -[@verida/vda-did](../modules/verida_vda_did.md).[](../modules/verida_vda_did._internal_.md).ParamType - -## Table of contents - -### Constructors - -- [constructor](verida_vda_did._internal_.ParamType.md#constructor) - -### Properties - -- [\_isParamType](verida_vda_did._internal_.ParamType.md#_isparamtype) -- [arrayChildren](verida_vda_did._internal_.ParamType.md#arraychildren) -- [arrayLength](verida_vda_did._internal_.ParamType.md#arraylength) -- [baseType](verida_vda_did._internal_.ParamType.md#basetype) -- [components](verida_vda_did._internal_.ParamType.md#components) -- [indexed](verida_vda_did._internal_.ParamType.md#indexed) -- [name](verida_vda_did._internal_.ParamType.md#name) -- [type](verida_vda_did._internal_.ParamType.md#type) - -### Methods - -- [format](verida_vda_did._internal_.ParamType.md#format) -- [from](verida_vda_did._internal_.ParamType.md#from) -- [fromObject](verida_vda_did._internal_.ParamType.md#fromobject) -- [fromString](verida_vda_did._internal_.ParamType.md#fromstring) -- [isParamType](verida_vda_did._internal_.ParamType.md#isparamtype) - -## Constructors - -### constructor - -• **new ParamType**(`constructorGuard`, `params`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `constructorGuard` | `any` | -| `params` | `any` | - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:32 - -## Properties - -### \_isParamType - -• `Readonly` **\_isParamType**: `boolean` - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:31 - -___ - -### arrayChildren - -• `Readonly` **arrayChildren**: [`ParamType`](verida_vda_did._internal_.ParamType.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:30 - -___ - -### arrayLength - -• `Readonly` **arrayLength**: `number` - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:29 - -___ - -### baseType - -• `Readonly` **baseType**: `string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:26 - -___ - -### components - -• `Readonly` **components**: [`ParamType`](verida_vda_did._internal_.ParamType.md)[] - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:28 - -___ - -### indexed - -• `Readonly` **indexed**: `boolean` - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:27 - -___ - -### name - -• `Readonly` **name**: `string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:24 - -___ - -### type - -• `Readonly` **type**: `string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:25 - -## Methods - -### format - -▸ **format**(`format?`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `format?` | `string` | - -#### Returns - -`string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:33 - -___ - -### from - -▸ `Static` **from**(`value`, `allowIndexed?`): [`ParamType`](verida_vda_did._internal_.ParamType.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `string` \| [`ParamType`](verida_vda_did._internal_.ParamType.md) \| [`JsonFragmentType`](../interfaces/verida_vda_did._internal_.JsonFragmentType.md) | -| `allowIndexed?` | `boolean` | - -#### Returns - -[`ParamType`](verida_vda_did._internal_.ParamType.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:34 - -___ - -### fromObject - -▸ `Static` **fromObject**(`value`): [`ParamType`](verida_vda_did._internal_.ParamType.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | [`ParamType`](verida_vda_did._internal_.ParamType.md) \| [`JsonFragmentType`](../interfaces/verida_vda_did._internal_.JsonFragmentType.md) | - -#### Returns - -[`ParamType`](verida_vda_did._internal_.ParamType.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:35 - -___ - -### fromString - -▸ `Static` **fromString**(`value`, `allowIndexed?`): [`ParamType`](verida_vda_did._internal_.ParamType.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `string` | -| `allowIndexed?` | `boolean` | - -#### Returns - -[`ParamType`](verida_vda_did._internal_.ParamType.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:36 - -___ - -### isParamType - -▸ `Static` **isParamType**(`value`): value is ParamType - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `any` | - -#### Returns - -value is ParamType - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:37 diff --git a/docs/api/verida-js/classes/verida_vda_did._internal_.Provider.md b/docs/api/verida-js/classes/verida_vda_did._internal_.Provider.md deleted file mode 100644 index 1800248..0000000 --- a/docs/api/verida-js/classes/verida_vda_did._internal_.Provider.md +++ /dev/null @@ -1,645 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-did](../modules/verida_vda_did.md) / [](../modules/verida_vda_did._internal_.md) / Provider - -# Class: Provider - -[@verida/vda-did](../modules/verida_vda_did.md).[](../modules/verida_vda_did._internal_.md).Provider - -## Implements - -- [`OnceBlockable`](../interfaces/verida_vda_did._internal_.OnceBlockable.md) - -## Table of contents - -### Constructors - -- [constructor](verida_vda_did._internal_.Provider.md#constructor) - -### Properties - -- [\_isProvider](verida_vda_did._internal_.Provider.md#_isprovider) - -### Methods - -- [addListener](verida_vda_did._internal_.Provider.md#addlistener) -- [call](verida_vda_did._internal_.Provider.md#call) -- [emit](verida_vda_did._internal_.Provider.md#emit) -- [estimateGas](verida_vda_did._internal_.Provider.md#estimategas) -- [getBalance](verida_vda_did._internal_.Provider.md#getbalance) -- [getBlock](verida_vda_did._internal_.Provider.md#getblock) -- [getBlockNumber](verida_vda_did._internal_.Provider.md#getblocknumber) -- [getBlockWithTransactions](verida_vda_did._internal_.Provider.md#getblockwithtransactions) -- [getCode](verida_vda_did._internal_.Provider.md#getcode) -- [getFeeData](verida_vda_did._internal_.Provider.md#getfeedata) -- [getGasPrice](verida_vda_did._internal_.Provider.md#getgasprice) -- [getLogs](verida_vda_did._internal_.Provider.md#getlogs) -- [getNetwork](verida_vda_did._internal_.Provider.md#getnetwork) -- [getStorageAt](verida_vda_did._internal_.Provider.md#getstorageat) -- [getTransaction](verida_vda_did._internal_.Provider.md#gettransaction) -- [getTransactionCount](verida_vda_did._internal_.Provider.md#gettransactioncount) -- [getTransactionReceipt](verida_vda_did._internal_.Provider.md#gettransactionreceipt) -- [listenerCount](verida_vda_did._internal_.Provider.md#listenercount) -- [listeners](verida_vda_did._internal_.Provider.md#listeners) -- [lookupAddress](verida_vda_did._internal_.Provider.md#lookupaddress) -- [off](verida_vda_did._internal_.Provider.md#off) -- [on](verida_vda_did._internal_.Provider.md#on) -- [once](verida_vda_did._internal_.Provider.md#once) -- [removeAllListeners](verida_vda_did._internal_.Provider.md#removealllisteners) -- [removeListener](verida_vda_did._internal_.Provider.md#removelistener) -- [resolveName](verida_vda_did._internal_.Provider.md#resolvename) -- [sendTransaction](verida_vda_did._internal_.Provider.md#sendtransaction) -- [waitForTransaction](verida_vda_did._internal_.Provider.md#waitfortransaction) -- [isProvider](verida_vda_did._internal_.Provider.md#isprovider) - -## Constructors - -### constructor - -• **new Provider**() - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:153 - -## Properties - -### \_isProvider - -• `Readonly` **\_isProvider**: `boolean` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:152 - -## Methods - -### addListener - -▸ **addListener**(`eventName`, `listener`): [`Provider`](verida_vda_did._internal_.Provider.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | [`EventType`](../modules/verida_vda_did._internal_.md#eventtype) | -| `listener` | [`Listener`](../modules/verida_vda_did._internal_.md#listener) | - -#### Returns - -[`Provider`](verida_vda_did._internal_.Provider.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:149 - -___ - -### call - -▸ `Abstract` **call**(`transaction`, `blockTag?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transaction` | [`Deferrable`](../modules/verida_vda_did._internal_.md#deferrable)<[`TransactionRequest`](../modules/verida_vda_did._internal_.md#transactionrequest)\> | -| `blockTag?` | [`BlockTag`](../modules/verida_vda_did._internal_.md#blocktag) \| `Promise`<[`BlockTag`](../modules/verida_vda_did._internal_.md#blocktag)\> | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:133 - -___ - -### emit - -▸ `Abstract` **emit**(`eventName`, ...`args`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | [`EventType`](../modules/verida_vda_did._internal_.md#eventtype) | -| `...args` | `any`[] | - -#### Returns - -`boolean` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:144 - -___ - -### estimateGas - -▸ `Abstract` **estimateGas**(`transaction`): `Promise`<[`BigNumber`](verida_vda_did._internal_.BigNumber.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transaction` | [`Deferrable`](../modules/verida_vda_did._internal_.md#deferrable)<[`TransactionRequest`](../modules/verida_vda_did._internal_.md#transactionrequest)\> | - -#### Returns - -`Promise`<[`BigNumber`](verida_vda_did._internal_.BigNumber.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:134 - -___ - -### getBalance - -▸ `Abstract` **getBalance**(`addressOrName`, `blockTag?`): `Promise`<[`BigNumber`](verida_vda_did._internal_.BigNumber.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `addressOrName` | `string` \| `Promise`<`string`\> | -| `blockTag?` | [`BlockTag`](../modules/verida_vda_did._internal_.md#blocktag) \| `Promise`<[`BlockTag`](../modules/verida_vda_did._internal_.md#blocktag)\> | - -#### Returns - -`Promise`<[`BigNumber`](verida_vda_did._internal_.BigNumber.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:128 - -___ - -### getBlock - -▸ `Abstract` **getBlock**(`blockHashOrBlockTag`): `Promise`<[`Block`](../interfaces/verida_vda_did._internal_.Block.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `blockHashOrBlockTag` | [`BlockTag`](../modules/verida_vda_did._internal_.md#blocktag) \| `Promise`<[`BlockTag`](../modules/verida_vda_did._internal_.md#blocktag)\> | - -#### Returns - -`Promise`<[`Block`](../interfaces/verida_vda_did._internal_.Block.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:135 - -___ - -### getBlockNumber - -▸ `Abstract` **getBlockNumber**(): `Promise`<`number`\> - -#### Returns - -`Promise`<`number`\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:125 - -___ - -### getBlockWithTransactions - -▸ `Abstract` **getBlockWithTransactions**(`blockHashOrBlockTag`): `Promise`<[`BlockWithTransactions`](../interfaces/verida_vda_did._internal_.BlockWithTransactions.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `blockHashOrBlockTag` | [`BlockTag`](../modules/verida_vda_did._internal_.md#blocktag) \| `Promise`<[`BlockTag`](../modules/verida_vda_did._internal_.md#blocktag)\> | - -#### Returns - -`Promise`<[`BlockWithTransactions`](../interfaces/verida_vda_did._internal_.BlockWithTransactions.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:136 - -___ - -### getCode - -▸ `Abstract` **getCode**(`addressOrName`, `blockTag?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `addressOrName` | `string` \| `Promise`<`string`\> | -| `blockTag?` | [`BlockTag`](../modules/verida_vda_did._internal_.md#blocktag) \| `Promise`<[`BlockTag`](../modules/verida_vda_did._internal_.md#blocktag)\> | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:130 - -___ - -### getFeeData - -▸ **getFeeData**(): `Promise`<[`FeeData`](../interfaces/verida_vda_did._internal_.FeeData.md)\> - -#### Returns - -`Promise`<[`FeeData`](../interfaces/verida_vda_did._internal_.FeeData.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:127 - -___ - -### getGasPrice - -▸ `Abstract` **getGasPrice**(): `Promise`<[`BigNumber`](verida_vda_did._internal_.BigNumber.md)\> - -#### Returns - -`Promise`<[`BigNumber`](verida_vda_did._internal_.BigNumber.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:126 - -___ - -### getLogs - -▸ `Abstract` **getLogs**(`filter`): `Promise`<[`Log`](../interfaces/verida_vda_did._internal_.Log.md)[]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `filter` | [`Filter`](../interfaces/verida_vda_did._internal_.Filter.md) | - -#### Returns - -`Promise`<[`Log`](../interfaces/verida_vda_did._internal_.Log.md)[]\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:139 - -___ - -### getNetwork - -▸ `Abstract` **getNetwork**(): `Promise`<[`Network`](../modules/verida_vda_did._internal_.md#network)\> - -#### Returns - -`Promise`<[`Network`](../modules/verida_vda_did._internal_.md#network)\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:124 - -___ - -### getStorageAt - -▸ `Abstract` **getStorageAt**(`addressOrName`, `position`, `blockTag?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `addressOrName` | `string` \| `Promise`<`string`\> | -| `position` | [`BigNumberish`](../modules/verida_vda_did._internal_.md#bignumberish) \| `Promise`<[`BigNumberish`](../modules/verida_vda_did._internal_.md#bignumberish)\> | -| `blockTag?` | [`BlockTag`](../modules/verida_vda_did._internal_.md#blocktag) \| `Promise`<[`BlockTag`](../modules/verida_vda_did._internal_.md#blocktag)\> | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:131 - -___ - -### getTransaction - -▸ `Abstract` **getTransaction**(`transactionHash`): `Promise`<[`TransactionResponse`](../interfaces/verida_vda_did._internal_.TransactionResponse.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transactionHash` | `string` | - -#### Returns - -`Promise`<[`TransactionResponse`](../interfaces/verida_vda_did._internal_.TransactionResponse.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:137 - -___ - -### getTransactionCount - -▸ `Abstract` **getTransactionCount**(`addressOrName`, `blockTag?`): `Promise`<`number`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `addressOrName` | `string` \| `Promise`<`string`\> | -| `blockTag?` | [`BlockTag`](../modules/verida_vda_did._internal_.md#blocktag) \| `Promise`<[`BlockTag`](../modules/verida_vda_did._internal_.md#blocktag)\> | - -#### Returns - -`Promise`<`number`\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:129 - -___ - -### getTransactionReceipt - -▸ `Abstract` **getTransactionReceipt**(`transactionHash`): `Promise`<[`TransactionReceipt`](../interfaces/verida_vda_did._internal_.TransactionReceipt.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transactionHash` | `string` | - -#### Returns - -`Promise`<[`TransactionReceipt`](../interfaces/verida_vda_did._internal_.TransactionReceipt.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:138 - -___ - -### listenerCount - -▸ `Abstract` **listenerCount**(`eventName?`): `number` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName?` | [`EventType`](../modules/verida_vda_did._internal_.md#eventtype) | - -#### Returns - -`number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:145 - -___ - -### listeners - -▸ `Abstract` **listeners**(`eventName?`): [`Listener`](../modules/verida_vda_did._internal_.md#listener)[] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName?` | [`EventType`](../modules/verida_vda_did._internal_.md#eventtype) | - -#### Returns - -[`Listener`](../modules/verida_vda_did._internal_.md#listener)[] - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:146 - -___ - -### lookupAddress - -▸ `Abstract` **lookupAddress**(`address`): `Promise`<``null`` \| `string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `address` | `string` \| `Promise`<`string`\> | - -#### Returns - -`Promise`<``null`` \| `string`\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:141 - -___ - -### off - -▸ `Abstract` **off**(`eventName`, `listener?`): [`Provider`](verida_vda_did._internal_.Provider.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | [`EventType`](../modules/verida_vda_did._internal_.md#eventtype) | -| `listener?` | [`Listener`](../modules/verida_vda_did._internal_.md#listener) | - -#### Returns - -[`Provider`](verida_vda_did._internal_.Provider.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:147 - -___ - -### on - -▸ `Abstract` **on**(`eventName`, `listener`): [`Provider`](verida_vda_did._internal_.Provider.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | [`EventType`](../modules/verida_vda_did._internal_.md#eventtype) | -| `listener` | [`Listener`](../modules/verida_vda_did._internal_.md#listener) | - -#### Returns - -[`Provider`](verida_vda_did._internal_.Provider.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:142 - -___ - -### once - -▸ `Abstract` **once**(`eventName`, `listener`): [`Provider`](verida_vda_did._internal_.Provider.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | [`EventType`](../modules/verida_vda_did._internal_.md#eventtype) | -| `listener` | [`Listener`](../modules/verida_vda_did._internal_.md#listener) | - -#### Returns - -[`Provider`](verida_vda_did._internal_.Provider.md) - -#### Implementation of - -[OnceBlockable](../interfaces/verida_vda_did._internal_.OnceBlockable.md).[once](../interfaces/verida_vda_did._internal_.OnceBlockable.md#once) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:143 - -___ - -### removeAllListeners - -▸ `Abstract` **removeAllListeners**(`eventName?`): [`Provider`](verida_vda_did._internal_.Provider.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName?` | [`EventType`](../modules/verida_vda_did._internal_.md#eventtype) | - -#### Returns - -[`Provider`](verida_vda_did._internal_.Provider.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:148 - -___ - -### removeListener - -▸ **removeListener**(`eventName`, `listener`): [`Provider`](verida_vda_did._internal_.Provider.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | [`EventType`](../modules/verida_vda_did._internal_.md#eventtype) | -| `listener` | [`Listener`](../modules/verida_vda_did._internal_.md#listener) | - -#### Returns - -[`Provider`](verida_vda_did._internal_.Provider.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:150 - -___ - -### resolveName - -▸ `Abstract` **resolveName**(`name`): `Promise`<``null`` \| `string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` \| `Promise`<`string`\> | - -#### Returns - -`Promise`<``null`` \| `string`\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:140 - -___ - -### sendTransaction - -▸ `Abstract` **sendTransaction**(`signedTransaction`): `Promise`<[`TransactionResponse`](../interfaces/verida_vda_did._internal_.TransactionResponse.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `signedTransaction` | `string` \| `Promise`<`string`\> | - -#### Returns - -`Promise`<[`TransactionResponse`](../interfaces/verida_vda_did._internal_.TransactionResponse.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:132 - -___ - -### waitForTransaction - -▸ `Abstract` **waitForTransaction**(`transactionHash`, `confirmations?`, `timeout?`): `Promise`<[`TransactionReceipt`](../interfaces/verida_vda_did._internal_.TransactionReceipt.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transactionHash` | `string` | -| `confirmations?` | `number` | -| `timeout?` | `number` | - -#### Returns - -`Promise`<[`TransactionReceipt`](../interfaces/verida_vda_did._internal_.TransactionReceipt.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:151 - -___ - -### isProvider - -▸ `Static` **isProvider**(`value`): value is Provider - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `any` | - -#### Returns - -value is Provider - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:154 diff --git a/docs/api/verida-js/classes/verida_vda_did._internal_.Reader.md b/docs/api/verida-js/classes/verida_vda_did._internal_.Reader.md deleted file mode 100644 index 6bf8755..0000000 --- a/docs/api/verida-js/classes/verida_vda_did._internal_.Reader.md +++ /dev/null @@ -1,249 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-did](../modules/verida_vda_did.md) / [](../modules/verida_vda_did._internal_.md) / Reader - -# Class: Reader - -[@verida/vda-did](../modules/verida_vda_did.md).[](../modules/verida_vda_did._internal_.md).Reader - -## Table of contents - -### Constructors - -- [constructor](verida_vda_did._internal_.Reader.md#constructor) - -### Properties - -- [\_coerceFunc](verida_vda_did._internal_.Reader.md#_coercefunc) -- [\_data](verida_vda_did._internal_.Reader.md#_data) -- [\_offset](verida_vda_did._internal_.Reader.md#_offset) -- [allowLoose](verida_vda_did._internal_.Reader.md#allowloose) -- [wordSize](verida_vda_did._internal_.Reader.md#wordsize) - -### Accessors - -- [consumed](verida_vda_did._internal_.Reader.md#consumed) -- [data](verida_vda_did._internal_.Reader.md#data) - -### Methods - -- [\_peekBytes](verida_vda_did._internal_.Reader.md#_peekbytes) -- [coerce](verida_vda_did._internal_.Reader.md#coerce) -- [readBytes](verida_vda_did._internal_.Reader.md#readbytes) -- [readValue](verida_vda_did._internal_.Reader.md#readvalue) -- [subReader](verida_vda_did._internal_.Reader.md#subreader) -- [coerce](verida_vda_did._internal_.Reader.md#coerce) - -## Constructors - -### constructor - -• **new Reader**(`data`, `wordSize?`, `coerceFunc?`, `allowLoose?`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | [`BytesLike`](../modules/verida_vda_did._internal_.md#byteslike) | -| `wordSize?` | `number` | -| `coerceFunc?` | [`CoerceFunc`](../modules/verida_vda_did._internal_.md#coercefunc) | -| `allowLoose?` | `boolean` | - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:43 - -## Properties - -### \_coerceFunc - -• `Readonly` **\_coerceFunc**: [`CoerceFunc`](../modules/verida_vda_did._internal_.md#coercefunc) - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:41 - -___ - -### \_data - -• `Readonly` **\_data**: `Uint8Array` - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:40 - -___ - -### \_offset - -• **\_offset**: `number` - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:42 - -___ - -### allowLoose - -• `Readonly` **allowLoose**: `boolean` - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:39 - -___ - -### wordSize - -• `Readonly` **wordSize**: `number` - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:38 - -## Accessors - -### consumed - -• `get` **consumed**(): `number` - -#### Returns - -`number` - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:45 - -___ - -### data - -• `get` **data**(): `string` - -#### Returns - -`string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:44 - -## Methods - -### \_peekBytes - -▸ **_peekBytes**(`offset`, `length`, `loose?`): `Uint8Array` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `offset` | `number` | -| `length` | `number` | -| `loose?` | `boolean` | - -#### Returns - -`Uint8Array` - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:48 - -___ - -### coerce - -▸ **coerce**(`name`, `value`): `any` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` | -| `value` | `any` | - -#### Returns - -`any` - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:47 - -___ - -### readBytes - -▸ **readBytes**(`length`, `loose?`): `Uint8Array` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `length` | `number` | -| `loose?` | `boolean` | - -#### Returns - -`Uint8Array` - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:50 - -___ - -### readValue - -▸ **readValue**(): [`BigNumber`](verida_vda_did._internal_.BigNumber.md) - -#### Returns - -[`BigNumber`](verida_vda_did._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:51 - -___ - -### subReader - -▸ **subReader**(`offset`): [`Reader`](verida_vda_did._internal_.Reader.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `offset` | `number` | - -#### Returns - -[`Reader`](verida_vda_did._internal_.Reader.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:49 - -___ - -### coerce - -▸ `Static` **coerce**(`name`, `value`): `any` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` | -| `value` | `any` | - -#### Returns - -`any` - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:46 diff --git a/docs/api/verida-js/classes/verida_vda_did._internal_.RunningEvent.md b/docs/api/verida-js/classes/verida_vda_did._internal_.RunningEvent.md deleted file mode 100644 index 0f5ba3c..0000000 --- a/docs/api/verida-js/classes/verida_vda_did._internal_.RunningEvent.md +++ /dev/null @@ -1,218 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-did](../modules/verida_vda_did.md) / [](../modules/verida_vda_did._internal_.md) / RunningEvent - -# Class: RunningEvent - -[@verida/vda-did](../modules/verida_vda_did.md).[](../modules/verida_vda_did._internal_.md).RunningEvent - -## Table of contents - -### Constructors - -- [constructor](verida_vda_did._internal_.RunningEvent.md#constructor) - -### Properties - -- [\_listeners](verida_vda_did._internal_.RunningEvent.md#_listeners) -- [filter](verida_vda_did._internal_.RunningEvent.md#filter) -- [tag](verida_vda_did._internal_.RunningEvent.md#tag) - -### Methods - -- [addListener](verida_vda_did._internal_.RunningEvent.md#addlistener) -- [getEmit](verida_vda_did._internal_.RunningEvent.md#getemit) -- [listenerCount](verida_vda_did._internal_.RunningEvent.md#listenercount) -- [listeners](verida_vda_did._internal_.RunningEvent.md#listeners) -- [prepareEvent](verida_vda_did._internal_.RunningEvent.md#prepareevent) -- [removeAllListeners](verida_vda_did._internal_.RunningEvent.md#removealllisteners) -- [removeListener](verida_vda_did._internal_.RunningEvent.md#removelistener) -- [run](verida_vda_did._internal_.RunningEvent.md#run) - -## Constructors - -### constructor - -• **new RunningEvent**(`tag`, `filter`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `tag` | `string` | -| `filter` | [`EventFilter`](../modules/verida_vda_did._internal_.md#eventfilter) | - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:67 - -## Properties - -### \_listeners - -• `Private` **\_listeners**: `any` - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:66 - -___ - -### filter - -• `Readonly` **filter**: [`EventFilter`](../modules/verida_vda_did._internal_.md#eventfilter) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:65 - -___ - -### tag - -• `Readonly` **tag**: `string` - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:64 - -## Methods - -### addListener - -▸ **addListener**(`listener`, `once`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `listener` | [`Listener`](../modules/verida_vda_did._internal_.md#listener) | -| `once` | `boolean` | - -#### Returns - -`void` - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:68 - -___ - -### getEmit - -▸ **getEmit**(`event`): `any`[] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | [`Event`](../interfaces/verida_vda_did._internal_.Event.md) | - -#### Returns - -`any`[] - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:75 - -___ - -### listenerCount - -▸ **listenerCount**(): `number` - -#### Returns - -`number` - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:72 - -___ - -### listeners - -▸ **listeners**(): [`Listener`](../modules/verida_vda_did._internal_.md#listener)[] - -#### Returns - -[`Listener`](../modules/verida_vda_did._internal_.md#listener)[] - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:71 - -___ - -### prepareEvent - -▸ **prepareEvent**(`event`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | [`Event`](../interfaces/verida_vda_did._internal_.Event.md) | - -#### Returns - -`void` - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:74 - -___ - -### removeAllListeners - -▸ **removeAllListeners**(): `void` - -#### Returns - -`void` - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:70 - -___ - -### removeListener - -▸ **removeListener**(`listener`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `listener` | [`Listener`](../modules/verida_vda_did._internal_.md#listener) | - -#### Returns - -`void` - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:69 - -___ - -### run - -▸ **run**(`args`): `number` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `args` | `any`[] | - -#### Returns - -`number` - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:73 diff --git a/docs/api/verida-js/classes/verida_vda_did._internal_.Signer.md b/docs/api/verida-js/classes/verida_vda_did._internal_.Signer.md deleted file mode 100644 index a2b43a7..0000000 --- a/docs/api/verida-js/classes/verida_vda_did._internal_.Signer.md +++ /dev/null @@ -1,383 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-did](../modules/verida_vda_did.md) / [](../modules/verida_vda_did._internal_.md) / Signer - -# Class: Signer - -[@verida/vda-did](../modules/verida_vda_did.md).[](../modules/verida_vda_did._internal_.md).Signer - -## Table of contents - -### Constructors - -- [constructor](verida_vda_did._internal_.Signer.md#constructor) - -### Properties - -- [\_isSigner](verida_vda_did._internal_.Signer.md#_issigner) -- [provider](verida_vda_did._internal_.Signer.md#provider) - -### Methods - -- [\_checkProvider](verida_vda_did._internal_.Signer.md#_checkprovider) -- [call](verida_vda_did._internal_.Signer.md#call) -- [checkTransaction](verida_vda_did._internal_.Signer.md#checktransaction) -- [connect](verida_vda_did._internal_.Signer.md#connect) -- [estimateGas](verida_vda_did._internal_.Signer.md#estimategas) -- [getAddress](verida_vda_did._internal_.Signer.md#getaddress) -- [getBalance](verida_vda_did._internal_.Signer.md#getbalance) -- [getChainId](verida_vda_did._internal_.Signer.md#getchainid) -- [getFeeData](verida_vda_did._internal_.Signer.md#getfeedata) -- [getGasPrice](verida_vda_did._internal_.Signer.md#getgasprice) -- [getTransactionCount](verida_vda_did._internal_.Signer.md#gettransactioncount) -- [populateTransaction](verida_vda_did._internal_.Signer.md#populatetransaction) -- [resolveName](verida_vda_did._internal_.Signer.md#resolvename) -- [sendTransaction](verida_vda_did._internal_.Signer.md#sendtransaction) -- [signMessage](verida_vda_did._internal_.Signer.md#signmessage) -- [signTransaction](verida_vda_did._internal_.Signer.md#signtransaction) -- [isSigner](verida_vda_did._internal_.Signer.md#issigner) - -## Constructors - -### constructor - -• **new Signer**() - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:30 - -## Properties - -### \_isSigner - -• `Readonly` **\_isSigner**: `boolean` - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:29 - -___ - -### provider - -• `Optional` `Readonly` **provider**: [`Provider`](verida_vda_did._internal_.Provider.md) - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:24 - -## Methods - -### \_checkProvider - -▸ **_checkProvider**(`operation?`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `operation?` | `string` | - -#### Returns - -`void` - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:42 - -___ - -### call - -▸ **call**(`transaction`, `blockTag?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transaction` | [`Deferrable`](../modules/verida_vda_did._internal_.md#deferrable)<[`TransactionRequest`](../modules/verida_vda_did._internal_.md#transactionrequest)\> | -| `blockTag?` | [`BlockTag`](../modules/verida_vda_did._internal_.md#blocktag) | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:34 - -___ - -### checkTransaction - -▸ **checkTransaction**(`transaction`): [`Deferrable`](../modules/verida_vda_did._internal_.md#deferrable)<[`TransactionRequest`](../modules/verida_vda_did._internal_.md#transactionrequest)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transaction` | [`Deferrable`](../modules/verida_vda_did._internal_.md#deferrable)<[`TransactionRequest`](../modules/verida_vda_did._internal_.md#transactionrequest)\> | - -#### Returns - -[`Deferrable`](../modules/verida_vda_did._internal_.md#deferrable)<[`TransactionRequest`](../modules/verida_vda_did._internal_.md#transactionrequest)\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:40 - -___ - -### connect - -▸ `Abstract` **connect**(`provider`): [`Signer`](verida_vda_did._internal_.Signer.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `provider` | [`Provider`](verida_vda_did._internal_.Provider.md) | - -#### Returns - -[`Signer`](verida_vda_did._internal_.Signer.md) - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:28 - -___ - -### estimateGas - -▸ **estimateGas**(`transaction`): `Promise`<[`BigNumber`](verida_vda_did._internal_.BigNumber.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transaction` | [`Deferrable`](../modules/verida_vda_did._internal_.md#deferrable)<[`TransactionRequest`](../modules/verida_vda_did._internal_.md#transactionrequest)\> | - -#### Returns - -`Promise`<[`BigNumber`](verida_vda_did._internal_.BigNumber.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:33 - -___ - -### getAddress - -▸ `Abstract` **getAddress**(): `Promise`<`string`\> - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:25 - -___ - -### getBalance - -▸ **getBalance**(`blockTag?`): `Promise`<[`BigNumber`](verida_vda_did._internal_.BigNumber.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `blockTag?` | [`BlockTag`](../modules/verida_vda_did._internal_.md#blocktag) | - -#### Returns - -`Promise`<[`BigNumber`](verida_vda_did._internal_.BigNumber.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:31 - -___ - -### getChainId - -▸ **getChainId**(): `Promise`<`number`\> - -#### Returns - -`Promise`<`number`\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:36 - -___ - -### getFeeData - -▸ **getFeeData**(): `Promise`<[`FeeData`](../interfaces/verida_vda_did._internal_.FeeData.md)\> - -#### Returns - -`Promise`<[`FeeData`](../interfaces/verida_vda_did._internal_.FeeData.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:38 - -___ - -### getGasPrice - -▸ **getGasPrice**(): `Promise`<[`BigNumber`](verida_vda_did._internal_.BigNumber.md)\> - -#### Returns - -`Promise`<[`BigNumber`](verida_vda_did._internal_.BigNumber.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:37 - -___ - -### getTransactionCount - -▸ **getTransactionCount**(`blockTag?`): `Promise`<`number`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `blockTag?` | [`BlockTag`](../modules/verida_vda_did._internal_.md#blocktag) | - -#### Returns - -`Promise`<`number`\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:32 - -___ - -### populateTransaction - -▸ **populateTransaction**(`transaction`): `Promise`<[`TransactionRequest`](../modules/verida_vda_did._internal_.md#transactionrequest)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transaction` | [`Deferrable`](../modules/verida_vda_did._internal_.md#deferrable)<[`TransactionRequest`](../modules/verida_vda_did._internal_.md#transactionrequest)\> | - -#### Returns - -`Promise`<[`TransactionRequest`](../modules/verida_vda_did._internal_.md#transactionrequest)\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:41 - -___ - -### resolveName - -▸ **resolveName**(`name`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:39 - -___ - -### sendTransaction - -▸ **sendTransaction**(`transaction`): `Promise`<[`TransactionResponse`](../interfaces/verida_vda_did._internal_.TransactionResponse.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transaction` | [`Deferrable`](../modules/verida_vda_did._internal_.md#deferrable)<[`TransactionRequest`](../modules/verida_vda_did._internal_.md#transactionrequest)\> | - -#### Returns - -`Promise`<[`TransactionResponse`](../interfaces/verida_vda_did._internal_.TransactionResponse.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:35 - -___ - -### signMessage - -▸ `Abstract` **signMessage**(`message`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `message` | `string` \| [`Bytes`](../modules/verida_vda_did._internal_.md#bytes) | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:26 - -___ - -### signTransaction - -▸ `Abstract` **signTransaction**(`transaction`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transaction` | [`Deferrable`](../modules/verida_vda_did._internal_.md#deferrable)<[`TransactionRequest`](../modules/verida_vda_did._internal_.md#transactionrequest)\> | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:27 - -___ - -### isSigner - -▸ `Static` **isSigner**(`value`): value is Signer - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `any` | - -#### Returns - -value is Signer - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:43 diff --git a/docs/api/verida-js/classes/verida_vda_did._internal_.TransactionDescription.md b/docs/api/verida-js/classes/verida_vda_did._internal_.TransactionDescription.md deleted file mode 100644 index f5c005b..0000000 --- a/docs/api/verida-js/classes/verida_vda_did._internal_.TransactionDescription.md +++ /dev/null @@ -1,112 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-did](../modules/verida_vda_did.md) / [](../modules/verida_vda_did._internal_.md) / TransactionDescription - -# Class: TransactionDescription - -[@verida/vda-did](../modules/verida_vda_did.md).[](../modules/verida_vda_did._internal_.md).TransactionDescription - -## Hierarchy - -- [`Description`](verida_vda_did._internal_.Description.md)<[`TransactionDescription`](verida_vda_did._internal_.TransactionDescription.md)\> - - ↳ **`TransactionDescription`** - -## Table of contents - -### Constructors - -- [constructor](verida_vda_did._internal_.TransactionDescription.md#constructor) - -### Properties - -- [args](verida_vda_did._internal_.TransactionDescription.md#args) -- [functionFragment](verida_vda_did._internal_.TransactionDescription.md#functionfragment) -- [name](verida_vda_did._internal_.TransactionDescription.md#name) -- [sighash](verida_vda_did._internal_.TransactionDescription.md#sighash) -- [signature](verida_vda_did._internal_.TransactionDescription.md#signature) -- [value](verida_vda_did._internal_.TransactionDescription.md#value) - -## Constructors - -### constructor - -• **new TransactionDescription**(`info`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `info` | `Object` | -| `info.args` | [`Result`](../interfaces/verida_vda_did._internal_.Result.md) | -| `info.functionFragment` | [`FunctionFragment`](verida_vda_did._internal_.FunctionFragment.md) | -| `info.name` | `string` | -| `info.sighash` | `string` | -| `info.signature` | `string` | -| `info.value` | [`BigNumber`](verida_vda_did._internal_.BigNumber.md) | - -#### Inherited from - -[Description](verida_vda_did._internal_.Description.md).[constructor](verida_vda_did._internal_.Description.md#constructor) - -#### Defined in - -node_modules/@ethersproject/properties/lib/index.d.ts:13 - -## Properties - -### args - -• `Readonly` **args**: [`Result`](../interfaces/verida_vda_did._internal_.Result.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:18 - -___ - -### functionFragment - -• `Readonly` **functionFragment**: [`FunctionFragment`](verida_vda_did._internal_.FunctionFragment.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:16 - -___ - -### name - -• `Readonly` **name**: `string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:17 - -___ - -### sighash - -• `Readonly` **sighash**: `string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:20 - -___ - -### signature - -• `Readonly` **signature**: `string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:19 - -___ - -### value - -• `Readonly` **value**: [`BigNumber`](verida_vda_did._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:21 diff --git a/docs/api/verida-js/classes/verida_vda_did._internal_.VeridaContract.md b/docs/api/verida-js/classes/verida_vda_did._internal_.VeridaContract.md deleted file mode 100644 index 19af218..0000000 --- a/docs/api/verida-js/classes/verida_vda_did._internal_.VeridaContract.md +++ /dev/null @@ -1,199 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-did](../modules/verida_vda_did.md) / [](../modules/verida_vda_did._internal_.md) / VeridaContract - -# Class: VeridaContract - -[@verida/vda-did](../modules/verida_vda_did.md).[](../modules/verida_vda_did._internal_.md).VeridaContract - -Class representing any Verida Smart Contrat - -## Indexable - -▪ [key: `string`]: `any` - -Need such fields to add sub methods in constructor - -## Table of contents - -### Constructors - -- [constructor](verida_vda_did._internal_.VeridaContract.md#constructor) - -### Properties - -- [callMethod](verida_vda_did._internal_.VeridaContract.md#callmethod) -- [contract](verida_vda_did._internal_.VeridaContract.md#contract) -- [endPoint](verida_vda_did._internal_.VeridaContract.md#endpoint) -- [gaslessPostConfig](verida_vda_did._internal_.VeridaContract.md#gaslesspostconfig) -- [gaslessServerConfig](verida_vda_did._internal_.VeridaContract.md#gaslessserverconfig) -- [server](verida_vda_did._internal_.VeridaContract.md#server) -- [signer](verida_vda_did._internal_.VeridaContract.md#signer) -- [type](verida_vda_did._internal_.VeridaContract.md#type) -- [web3Config](verida_vda_did._internal_.VeridaContract.md#web3config) - -### Methods - -- [attachContract](verida_vda_did._internal_.VeridaContract.md#attachcontract) - -## Constructors - -### constructor - -• **new VeridaContract**(`type`, `config`) - -Create Verida smart contract instance. Add member functions of contract as parameters. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `type` | [`Web3CallType`](../modules/verida_vda_did._internal_.md#web3calltype) | interaction mode | -| `config` | [`VeridaWeb3Config`](../modules/verida_vda_did._internal_.md#veridaweb3config) | configuration for creating VeridaContract instance | - -#### Defined in - -packages/vda-web3-client/build/src/VeridaContractBase.d.ts:31 - -## Properties - -### callMethod - -• `Protected` **callMethod**: (`methodName`: `string`, `methodType`: `string`, `params`: `any`, `gasConfig?`: [`Web3GasConfiguration`](../interfaces/verida_vda_did._internal_.Web3GasConfiguration.md)) => `Promise`<[`VdaTransactionResult`](../interfaces/verida_vda_did._internal_.VdaTransactionResult.md)\> - -#### Type declaration - -▸ (`methodName`, `methodType`, `params`, `gasConfig?`): `Promise`<[`VdaTransactionResult`](../interfaces/verida_vda_did._internal_.VdaTransactionResult.md)\> - -Perform smart contract interaction. Called by member function that were created in constructor. - -##### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `methodName` | `string` | Calling method name of smart contract. From ABI. | -| `methodType` | `string` | Method type. Shows whether method in smart contract is Call function or not. | -| `params` | `any` | Parameters used to make interaction with smart contract : Array | -| `gasConfig?` | [`Web3GasConfiguration`](../interfaces/verida_vda_did._internal_.Web3GasConfiguration.md) | Gas configuration. Only available for non-view functions in Web3 mode | - -##### Returns - -`Promise`<[`VdaTransactionResult`](../interfaces/verida_vda_did._internal_.VdaTransactionResult.md)\> - -- Response from smart contract interaction - -#### Defined in - -packages/vda-web3-client/build/src/VeridaContractBase.d.ts:46 - -___ - -### contract - -• `Protected` `Optional` **contract**: [`Contract`](verida_vda_did._internal_.Contract.md) - -Contract instance used in web3 mode - -#### Defined in - -packages/vda-web3-client/build/src/VeridaContractBase.d.ts:13 - -___ - -### endPoint - -• `Protected` `Optional` **endPoint**: `string` - -endpoint url : Need to be defined in sub class constructor - -#### Defined in - -packages/vda-web3-client/build/src/VeridaContractBase.d.ts:18 - -___ - -### gaslessPostConfig - -• `Protected` `Optional` **gaslessPostConfig**: [`Web3GaslessPostConfig`](../interfaces/verida_vda_did._internal_.Web3GaslessPostConfig.md) - -#### Defined in - -packages/vda-web3-client/build/src/VeridaContractBase.d.ts:25 - -___ - -### gaslessServerConfig - -• `Protected` `Optional` **gaslessServerConfig**: [`Web3GaslessRequestConfig`](../interfaces/verida_vda_did._internal_.Web3GaslessRequestConfig.md) - -Configuration for gasless mode - -#### Defined in - -packages/vda-web3-client/build/src/VeridaContractBase.d.ts:24 - -___ - -### server - -• `Protected` **server**: `any` - -Axios instance used in gasless mode - -#### Defined in - -packages/vda-web3-client/build/src/VeridaContractBase.d.ts:16 - -___ - -### signer - -• `Protected` `Optional` **signer**: [`Signer`](verida_vda_did._internal_.Signer.md) - -#### Defined in - -packages/vda-web3-client/build/src/VeridaContractBase.d.ts:14 - -___ - -### type - -• `Protected` **type**: [`Web3CallType`](../modules/verida_vda_did._internal_.md#web3calltype) - -Smart contract interaction mode - -#### Defined in - -packages/vda-web3-client/build/src/VeridaContractBase.d.ts:11 - -___ - -### web3Config - -• `Protected` `Optional` **web3Config**: [`Web3SelfTransactionConfig`](../interfaces/verida_vda_did._internal_.Web3SelfTransactionConfig.md) - -Configuration for web3 mode - -#### Defined in - -packages/vda-web3-client/build/src/VeridaContractBase.d.ts:22 - -## Methods - -### attachContract - -▸ `Protected` **attachContract**(`controller?`): `Promise`<[`Contract`](verida_vda_did._internal_.Contract.md)\> - -Connect signer to contract to sign transactions. Called in web3 mode only - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `controller?` | `string` \| `Promise`<`string`\> | : Wallet public address | - -#### Returns - -`Promise`<[`Contract`](verida_vda_did._internal_.Contract.md)\> - -#### Defined in - -packages/vda-web3-client/build/src/VeridaContractBase.d.ts:37 diff --git a/docs/api/verida-js/classes/verida_vda_did._internal_.Writer.md b/docs/api/verida-js/classes/verida_vda_did._internal_.Writer.md deleted file mode 100644 index 8fac49a..0000000 --- a/docs/api/verida-js/classes/verida_vda_did._internal_.Writer.md +++ /dev/null @@ -1,242 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-did](../modules/verida_vda_did.md) / [](../modules/verida_vda_did._internal_.md) / Writer - -# Class: Writer - -[@verida/vda-did](../modules/verida_vda_did.md).[](../modules/verida_vda_did._internal_.md).Writer - -## Table of contents - -### Constructors - -- [constructor](verida_vda_did._internal_.Writer.md#constructor) - -### Properties - -- [\_data](verida_vda_did._internal_.Writer.md#_data) -- [\_dataLength](verida_vda_did._internal_.Writer.md#_datalength) -- [\_padding](verida_vda_did._internal_.Writer.md#_padding) -- [wordSize](verida_vda_did._internal_.Writer.md#wordsize) - -### Accessors - -- [data](verida_vda_did._internal_.Writer.md#data) -- [length](verida_vda_did._internal_.Writer.md#length) - -### Methods - -- [\_getValue](verida_vda_did._internal_.Writer.md#_getvalue) -- [\_writeData](verida_vda_did._internal_.Writer.md#_writedata) -- [appendWriter](verida_vda_did._internal_.Writer.md#appendwriter) -- [writeBytes](verida_vda_did._internal_.Writer.md#writebytes) -- [writeUpdatableValue](verida_vda_did._internal_.Writer.md#writeupdatablevalue) -- [writeValue](verida_vda_did._internal_.Writer.md#writevalue) - -## Constructors - -### constructor - -• **new Writer**(`wordSize?`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `wordSize?` | `number` | - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:27 - -## Properties - -### \_data - -• **\_data**: `Uint8Array`[] - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:24 - -___ - -### \_dataLength - -• **\_dataLength**: `number` - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:25 - -___ - -### \_padding - -• **\_padding**: `Uint8Array` - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:26 - -___ - -### wordSize - -• `Readonly` **wordSize**: `number` - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:23 - -## Accessors - -### data - -• `get` **data**(): `string` - -#### Returns - -`string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:28 - -___ - -### length - -• `get` **length**(): `number` - -#### Returns - -`number` - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:29 - -## Methods - -### \_getValue - -▸ **_getValue**(`value`): `Uint8Array` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | [`BigNumberish`](../modules/verida_vda_did._internal_.md#bignumberish) | - -#### Returns - -`Uint8Array` - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:33 - -___ - -### \_writeData - -▸ **_writeData**(`data`): `number` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `Uint8Array` | - -#### Returns - -`number` - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:30 - -___ - -### appendWriter - -▸ **appendWriter**(`writer`): `number` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `writer` | [`Writer`](verida_vda_did._internal_.Writer.md) | - -#### Returns - -`number` - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:31 - -___ - -### writeBytes - -▸ **writeBytes**(`value`): `number` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | [`BytesLike`](../modules/verida_vda_did._internal_.md#byteslike) | - -#### Returns - -`number` - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:32 - -___ - -### writeUpdatableValue - -▸ **writeUpdatableValue**(): (`value`: [`BigNumberish`](../modules/verida_vda_did._internal_.md#bignumberish)) => `void` - -#### Returns - -`fn` - -▸ (`value`): `void` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | [`BigNumberish`](../modules/verida_vda_did._internal_.md#bignumberish) | - -##### Returns - -`void` - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:35 - -___ - -### writeValue - -▸ **writeValue**(`value`): `number` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | [`BigNumberish`](../modules/verida_vda_did._internal_.md#bignumberish) | - -#### Returns - -`number` - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:34 diff --git a/docs/api/verida-js/classes/verida_vda_did._internal_.default-1.md b/docs/api/verida-js/classes/verida_vda_did._internal_.default-1.md deleted file mode 100644 index 052c092..0000000 --- a/docs/api/verida-js/classes/verida_vda_did._internal_.default-1.md +++ /dev/null @@ -1,515 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-did](../modules/verida_vda_did.md) / [](../modules/verida_vda_did._internal_.md) / default - -# Class: default - -[@verida/vda-did](../modules/verida_vda_did.md).[](../modules/verida_vda_did._internal_.md).default - -## Implements - -- [`IDIDDocument`](../interfaces/verida_vda_did._internal_.IDIDDocument.md) - -## Table of contents - -### Constructors - -- [constructor](verida_vda_did._internal_.default-1.md#constructor) - -### Properties - -- [doc](verida_vda_did._internal_.default-1.md#doc) -- [errors](verida_vda_did._internal_.default-1.md#errors) -- [getProofData](verida_vda_did._internal_.default-1.md#getproofdata) - -### Accessors - -- [id](verida_vda_did._internal_.default-1.md#id) - -### Methods - -- [addContext](verida_vda_did._internal_.default-1.md#addcontext) -- [addContextAsymKey](verida_vda_did._internal_.default-1.md#addcontextasymkey) -- [addContextService](verida_vda_did._internal_.default-1.md#addcontextservice) -- [addContextSignKey](verida_vda_did._internal_.default-1.md#addcontextsignkey) -- [buildTimestamp](verida_vda_did._internal_.default-1.md#buildtimestamp) -- [export](verida_vda_did._internal_.default-1.md#export) -- [getErrors](verida_vda_did._internal_.default-1.md#geterrors) -- [import](verida_vda_did._internal_.default-1.md#import) -- [locateContextProof](verida_vda_did._internal_.default-1.md#locatecontextproof) -- [locateServiceEndpoint](verida_vda_did._internal_.default-1.md#locateserviceendpoint) -- [removeContext](verida_vda_did._internal_.default-1.md#removecontext) -- [setAttributes](verida_vda_did._internal_.default-1.md#setattributes) -- [signProof](verida_vda_did._internal_.default-1.md#signproof) -- [verifyContextSignature](verida_vda_did._internal_.default-1.md#verifycontextsignature) -- [verifyProof](verida_vda_did._internal_.default-1.md#verifyproof) -- [verifySig](verida_vda_did._internal_.default-1.md#verifysig) -- [generateContextHash](verida_vda_did._internal_.default-1.md#generatecontexthash) - -## Constructors - -### constructor - -• **new default**(`doc`, `publicKeyHex?`) - -Force lower case DID as we can't guarantee the DID will always be provided with checksum - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `doc` | `string` \| [`VeridaDocInterface`](../interfaces/verida_vda_did._internal_.VeridaDocInterface.md) | this value can be a DocInterface or DID. | -| `publicKeyHex?` | `string` | - | - -#### Defined in - -packages/did-document/dist/did-document.d.ts:11 - -## Properties - -### doc - -• `Private` **doc**: `any` - -#### Defined in - -packages/did-document/dist/did-document.d.ts:4 - -___ - -### errors - -• `Protected` **errors**: `string`[] - -#### Defined in - -packages/did-document/dist/did-document.d.ts:5 - -___ - -### getProofData - -• `Private` **getProofData**: `any` - -#### Defined in - -packages/did-document/dist/did-document.d.ts:37 - -## Accessors - -### id - -• `get` **id**(): `string` - -#### Returns - -`string` - -#### Implementation of - -IDIDDocument.id - -#### Defined in - -packages/did-document/dist/did-document.d.ts:12 - -## Methods - -### addContext - -▸ **addContext**(`contextName`, `keyring`, `privateKey`, `endpoints`): `Promise`<`void`\> - -Not used directly, used for testing - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `contextName` | `string` | string | -| `keyring` | [`IKeyring`](../interfaces/verida_vda_did._internal_.IKeyring.md) | Keyring | -| `privateKey` | `string` | Private key of the DID that controls this DID Document | -| `endpoints` | [`SecureContextEndpoints`](../interfaces/verida_vda_did._internal_.SecureContextEndpoints.md) | Endpoints | - -#### Returns - -`Promise`<`void`\> - -#### Implementation of - -[IDIDDocument](../interfaces/verida_vda_did._internal_.IDIDDocument.md).[addContext](../interfaces/verida_vda_did._internal_.IDIDDocument.md#addcontext) - -#### Defined in - -packages/did-document/dist/did-document.d.ts:22 - -___ - -### addContextAsymKey - -▸ **addContextAsymKey**(`contextHash`, `publicKeyHex`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextHash` | `string` | -| `publicKeyHex` | `string` | - -#### Returns - -`void` - -#### Implementation of - -[IDIDDocument](../interfaces/verida_vda_did._internal_.IDIDDocument.md).[addContextAsymKey](../interfaces/verida_vda_did._internal_.IDIDDocument.md#addcontextasymkey) - -#### Defined in - -packages/did-document/dist/did-document.d.ts:29 - -___ - -### addContextService - -▸ **addContextService**(`contextHash`, `endpointType`, `serviceType`, `endpointUris`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextHash` | `string` | -| `endpointType` | [`SecureContextEndpointType`](../enums/verida_vda_did._internal_.SecureContextEndpointType.md) | -| `serviceType` | `string` | -| `endpointUris` | [`ServiceEndpoint`](../modules/verida_vda_did._internal_.md#serviceendpoint)[] | - -#### Returns - -`void` - -#### Implementation of - -[IDIDDocument](../interfaces/verida_vda_did._internal_.IDIDDocument.md).[addContextService](../interfaces/verida_vda_did._internal_.IDIDDocument.md#addcontextservice) - -#### Defined in - -packages/did-document/dist/did-document.d.ts:27 - -___ - -### addContextSignKey - -▸ **addContextSignKey**(`contextHash`, `publicKeyHex`, `proof`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextHash` | `string` | -| `publicKeyHex` | `string` | -| `proof` | `string` | - -#### Returns - -`void` - -#### Implementation of - -[IDIDDocument](../interfaces/verida_vda_did._internal_.IDIDDocument.md).[addContextSignKey](../interfaces/verida_vda_did._internal_.IDIDDocument.md#addcontextsignkey) - -#### Defined in - -packages/did-document/dist/did-document.d.ts:28 - -___ - -### buildTimestamp - -▸ **buildTimestamp**(`date`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `date` | `Date` | - -#### Returns - -`string` - -#### Implementation of - -[IDIDDocument](../interfaces/verida_vda_did._internal_.IDIDDocument.md).[buildTimestamp](../interfaces/verida_vda_did._internal_.IDIDDocument.md#buildtimestamp) - -#### Defined in - -packages/did-document/dist/did-document.d.ts:38 - -___ - -### export - -▸ **export**(): [`VeridaDocInterface`](../interfaces/verida_vda_did._internal_.VeridaDocInterface.md) - -#### Returns - -[`VeridaDocInterface`](../interfaces/verida_vda_did._internal_.VeridaDocInterface.md) - -#### Implementation of - -[IDIDDocument](../interfaces/verida_vda_did._internal_.IDIDDocument.md).[export](../interfaces/verida_vda_did._internal_.IDIDDocument.md#export) - -#### Defined in - -packages/did-document/dist/did-document.d.ts:26 - -___ - -### getErrors - -▸ **getErrors**(): `string`[] - -#### Returns - -`string`[] - -#### Implementation of - -[IDIDDocument](../interfaces/verida_vda_did._internal_.IDIDDocument.md).[getErrors](../interfaces/verida_vda_did._internal_.IDIDDocument.md#geterrors) - -#### Defined in - -packages/did-document/dist/did-document.d.ts:13 - -___ - -### import - -▸ **import**(`doc`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `doc` | [`VeridaDocInterface`](../interfaces/verida_vda_did._internal_.VeridaDocInterface.md) | - -#### Returns - -`void` - -#### Implementation of - -[IDIDDocument](../interfaces/verida_vda_did._internal_.IDIDDocument.md).[import](../interfaces/verida_vda_did._internal_.IDIDDocument.md#import) - -#### Defined in - -packages/did-document/dist/did-document.d.ts:25 - -___ - -### locateContextProof - -▸ **locateContextProof**(`contextName`): `undefined` \| `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | - -#### Returns - -`undefined` \| `string` - -#### Implementation of - -[IDIDDocument](../interfaces/verida_vda_did._internal_.IDIDDocument.md).[locateContextProof](../interfaces/verida_vda_did._internal_.IDIDDocument.md#locatecontextproof) - -#### Defined in - -packages/did-document/dist/did-document.d.ts:34 - -___ - -### locateServiceEndpoint - -▸ **locateServiceEndpoint**(`contextName`, `endpointType`): `undefined` \| [`Service`](../interfaces/verida_vda_did._internal_.Service.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | -| `endpointType` | [`SecureContextEndpointType`](../enums/verida_vda_did._internal_.SecureContextEndpointType.md) | - -#### Returns - -`undefined` \| [`Service`](../interfaces/verida_vda_did._internal_.Service.md) - -#### Implementation of - -[IDIDDocument](../interfaces/verida_vda_did._internal_.IDIDDocument.md).[locateServiceEndpoint](../interfaces/verida_vda_did._internal_.IDIDDocument.md#locateserviceendpoint) - -#### Defined in - -packages/did-document/dist/did-document.d.ts:33 - -___ - -### removeContext - -▸ **removeContext**(`contextName`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | - -#### Returns - -`boolean` - -#### Implementation of - -[IDIDDocument](../interfaces/verida_vda_did._internal_.IDIDDocument.md).[removeContext](../interfaces/verida_vda_did._internal_.IDIDDocument.md#removecontext) - -#### Defined in - -packages/did-document/dist/did-document.d.ts:23 - -___ - -### setAttributes - -▸ **setAttributes**(`attributes`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `attributes` | [`Record`](../modules/verida_vda_did._internal_.md#record)<`string`, `any`\> | - -#### Returns - -`void` - -#### Implementation of - -[IDIDDocument](../interfaces/verida_vda_did._internal_.IDIDDocument.md).[setAttributes](../interfaces/verida_vda_did._internal_.IDIDDocument.md#setattributes) - -#### Defined in - -packages/did-document/dist/did-document.d.ts:24 - -___ - -### signProof - -▸ **signProof**(`privateKey`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `privateKey` | `string` \| `Uint8Array` | - -#### Returns - -`void` - -#### Implementation of - -[IDIDDocument](../interfaces/verida_vda_did._internal_.IDIDDocument.md).[signProof](../interfaces/verida_vda_did._internal_.IDIDDocument.md#signproof) - -#### Defined in - -packages/did-document/dist/did-document.d.ts:35 - -___ - -### verifyContextSignature - -▸ **verifyContextSignature**(`data`, `contextName`, `signature`, `contextIsHash?`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `any` | -| `contextName` | `string` | -| `signature` | `string` | -| `contextIsHash?` | `boolean` | - -#### Returns - -`boolean` - -#### Implementation of - -[IDIDDocument](../interfaces/verida_vda_did._internal_.IDIDDocument.md).[verifyContextSignature](../interfaces/verida_vda_did._internal_.IDIDDocument.md#verifycontextsignature) - -#### Defined in - -packages/did-document/dist/did-document.d.ts:31 - -___ - -### verifyProof - -▸ **verifyProof**(): `boolean` - -#### Returns - -`boolean` - -#### Implementation of - -[IDIDDocument](../interfaces/verida_vda_did._internal_.IDIDDocument.md).[verifyProof](../interfaces/verida_vda_did._internal_.IDIDDocument.md#verifyproof) - -#### Defined in - -packages/did-document/dist/did-document.d.ts:36 - -___ - -### verifySig - -▸ **verifySig**(`data`, `signature`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `any` | -| `signature` | `string` | - -#### Returns - -`boolean` - -#### Implementation of - -[IDIDDocument](../interfaces/verida_vda_did._internal_.IDIDDocument.md).[verifySig](../interfaces/verida_vda_did._internal_.IDIDDocument.md#verifysig) - -#### Defined in - -packages/did-document/dist/did-document.d.ts:30 - -___ - -### generateContextHash - -▸ `Static` **generateContextHash**(`did`, `contextName`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did` | `string` | -| `contextName` | `string` | - -#### Returns - -`string` - -#### Defined in - -packages/did-document/dist/did-document.d.ts:32 diff --git a/docs/api/verida-js/classes/verida_vda_did._internal_.default.md b/docs/api/verida-js/classes/verida_vda_did._internal_.default.md deleted file mode 100644 index 2197d44..0000000 --- a/docs/api/verida-js/classes/verida_vda_did._internal_.default.md +++ /dev/null @@ -1,295 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-did](../modules/verida_vda_did.md) / [](../modules/verida_vda_did._internal_.md) / default - -# Class: default - -[@verida/vda-did](../modules/verida_vda_did.md).[](../modules/verida_vda_did._internal_.md).default - -## Table of contents - -### Constructors - -- [constructor](verida_vda_did._internal_.default.md#constructor) - -### Properties - -- [didAddress](verida_vda_did._internal_.default.md#didaddress) -- [network](verida_vda_did._internal_.default.md#network) -- [options](verida_vda_did._internal_.default.md#options) -- [vdaWeb3Client](verida_vda_did._internal_.default.md#vdaweb3client) - -### Methods - -- [activeDIDCount](verida_vda_did._internal_.default.md#activedidcount) -- [getController](verida_vda_did._internal_.default.md#getcontroller) -- [getControllerSignature](verida_vda_did._internal_.default.md#getcontrollersignature) -- [getRegisterSignature](verida_vda_did._internal_.default.md#getregistersignature) -- [getRevokeSignature](verida_vda_did._internal_.default.md#getrevokesignature) -- [lookup](verida_vda_did._internal_.default.md#lookup) -- [nonceFN](verida_vda_did._internal_.default.md#noncefn) -- [register](verida_vda_did._internal_.default.md#register) -- [revoke](verida_vda_did._internal_.default.md#revoke) -- [setController](verida_vda_did._internal_.default.md#setcontroller) - -## Constructors - -### constructor - -• **new default**(`options`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options` | [`VdaDidConfigurationOptions`](../interfaces/verida_vda_did._internal_.VdaDidConfigurationOptions.md) | - -#### Defined in - -[packages/vda-did/src/blockchain/blockchainApi.ts:21](https://github.com/verida/verida-js/blob/5040472/packages/vda-did/src/blockchain/blockchainApi.ts#L21) - -## Properties - -### didAddress - -• `Private` **didAddress**: `string` - -#### Defined in - -[packages/vda-did/src/blockchain/blockchainApi.ts:17](https://github.com/verida/verida-js/blob/5040472/packages/vda-did/src/blockchain/blockchainApi.ts#L17) - -___ - -### network - -• `Private` **network**: `string` - -#### Defined in - -[packages/vda-did/src/blockchain/blockchainApi.ts:16](https://github.com/verida/verida-js/blob/5040472/packages/vda-did/src/blockchain/blockchainApi.ts#L16) - -___ - -### options - -• `Private` **options**: [`VdaDidConfigurationOptions`](../interfaces/verida_vda_did._internal_.VdaDidConfigurationOptions.md) - -#### Defined in - -[packages/vda-did/src/blockchain/blockchainApi.ts:15](https://github.com/verida/verida-js/blob/5040472/packages/vda-did/src/blockchain/blockchainApi.ts#L15) - -___ - -### vdaWeb3Client - -• `Private` **vdaWeb3Client**: [`VeridaContract`](verida_vda_did._internal_.VeridaContract.md) - -#### Defined in - -[packages/vda-did/src/blockchain/blockchainApi.ts:19](https://github.com/verida/verida-js/blob/5040472/packages/vda-did/src/blockchain/blockchainApi.ts#L19) - -## Methods - -### activeDIDCount - -▸ **activeDIDCount**(): `Promise`<`any`\> - -Get active DID count - -#### Returns - -`Promise`<`any`\> - -Number of active did count - -#### Defined in - -[packages/vda-did/src/blockchain/blockchainApi.ts:222](https://github.com/verida/verida-js/blob/5040472/packages/vda-did/src/blockchain/blockchainApi.ts#L222) - -___ - -### getController - -▸ **getController**(): `Promise`<`any`\> - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -[packages/vda-did/src/blockchain/blockchainApi.ts:175](https://github.com/verida/verida-js/blob/5040472/packages/vda-did/src/blockchain/blockchainApi.ts#L175) - -___ - -### getControllerSignature - -▸ `Private` **getControllerSignature**(`controller`): `Promise`<`string`\> - -Get a signature for {@link BlockchainApi#setController} function - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `controller` | `string` | DID address of controller that will be set | - -#### Returns - -`Promise`<`string`\> - -Signature - -#### Defined in - -[packages/vda-did/src/blockchain/blockchainApi.ts:134](https://github.com/verida/verida-js/blob/5040472/packages/vda-did/src/blockchain/blockchainApi.ts#L134) - -___ - -### getRegisterSignature - -▸ `Private` **getRegisterSignature**(`endpoints`): `Promise`<`string`\> - -Get a signature for {@link BlockchainApi#register} function - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `endpoints` | `string`[] | Array of endpoints to be registered | - -#### Returns - -`Promise`<`string`\> - -Signature - -#### Defined in - -[packages/vda-did/src/blockchain/blockchainApi.ts:91](https://github.com/verida/verida-js/blob/5040472/packages/vda-did/src/blockchain/blockchainApi.ts#L91) - -___ - -### getRevokeSignature - -▸ `Private` **getRevokeSignature**(): `Promise`<`string`\> - -Get a signature for {@link BlockchainApi#revoke} function - -#### Returns - -`Promise`<`string`\> - -Signature - -#### Defined in - -[packages/vda-did/src/blockchain/blockchainApi.ts:189](https://github.com/verida/verida-js/blob/5040472/packages/vda-did/src/blockchain/blockchainApi.ts#L189) - -___ - -### lookup - -▸ **lookup**(`did`): `Promise`<[`LookupResponse`](../interfaces/verida_vda_did._internal_.LookupResponse.md)\> - -Get a controller & Endpoints' array of a DID address fro blockchain - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did` | `string` | - -#### Returns - -`Promise`<[`LookupResponse`](../interfaces/verida_vda_did._internal_.LookupResponse.md)\> - -Controller & Endpoints array - -#### Defined in - -[packages/vda-did/src/blockchain/blockchainApi.ts:71](https://github.com/verida/verida-js/blob/5040472/packages/vda-did/src/blockchain/blockchainApi.ts#L71) - -___ - -### nonceFN - -▸ **nonceFN**(): `Promise`<`any`\> - -Get a nonce from DIDRegistry contract - -#### Returns - -`Promise`<`any`\> - -nonce of DID - -#### Defined in - -[packages/vda-did/src/blockchain/blockchainApi.ts:59](https://github.com/verida/verida-js/blob/5040472/packages/vda-did/src/blockchain/blockchainApi.ts#L59) - -___ - -### register - -▸ **register**(`endpoints`, `gasConfig?`): `Promise`<`void`\> - -Register endpoints to blockchain - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `endpoints` | `string`[] | Array of endpoints to be registered | -| `gasConfig?` | [`Web3GasConfiguration`](../interfaces/verida_vda_did._internal_.Web3GasConfiguration.md) | - | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -[packages/vda-did/src/blockchain/blockchainApi.ts:111](https://github.com/verida/verida-js/blob/5040472/packages/vda-did/src/blockchain/blockchainApi.ts#L111) - -___ - -### revoke - -▸ **revoke**(`gasConfig?`): `Promise`<`void`\> - -Revoke a DID address from the blockchain - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `gasConfig?` | [`Web3GasConfiguration`](../interfaces/verida_vda_did._internal_.Web3GasConfiguration.md) | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -[packages/vda-did/src/blockchain/blockchainApi.ts:200](https://github.com/verida/verida-js/blob/5040472/packages/vda-did/src/blockchain/blockchainApi.ts#L200) - -___ - -### setController - -▸ **setController**(`controllerPrivateKey`, `gasConfig?`): `Promise`<`void`\> - -Set a controller of the {@link BlockchainApi#didAddress} to the blockchain - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `controllerPrivateKey` | `string` | private key of new controller | -| `gasConfig?` | [`Web3GasConfiguration`](../interfaces/verida_vda_did._internal_.Web3GasConfiguration.md) | - | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -[packages/vda-did/src/blockchain/blockchainApi.ts:148](https://github.com/verida/verida-js/blob/5040472/packages/vda-did/src/blockchain/blockchainApi.ts#L148) diff --git a/docs/api/verida-js/classes/verida_vda_did_resolver.VdaDidResolver.md b/docs/api/verida-js/classes/verida_vda_did_resolver.VdaDidResolver.md deleted file mode 100644 index 9445001..0000000 --- a/docs/api/verida-js/classes/verida_vda_did_resolver.VdaDidResolver.md +++ /dev/null @@ -1,150 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-did-resolver](../modules/verida_vda_did_resolver.md) / VdaDidResolver - -# Class: VdaDidResolver - -[@verida/vda-did-resolver](../modules/verida_vda_did_resolver.md).VdaDidResolver - -## Table of contents - -### Constructors - -- [constructor](verida_vda_did_resolver.VdaDidResolver.md#constructor) - -### Properties - -- [defaultTimeout](verida_vda_did_resolver.VdaDidResolver.md#defaulttimeout) -- [options](verida_vda_did_resolver.VdaDidResolver.md#options) - -### Methods - -- [\_resolve](verida_vda_did_resolver.VdaDidResolver.md#_resolve) -- [build](verida_vda_did_resolver.VdaDidResolver.md#build) -- [fetchDocuments](verida_vda_did_resolver.VdaDidResolver.md#fetchdocuments) -- [resolve](verida_vda_did_resolver.VdaDidResolver.md#resolve) - -## Constructors - -### constructor - -• **new VdaDidResolver**(`options`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options` | [`Web3ResolverConfigurationOptions`](../interfaces/verida_vda_did_resolver._internal_.Web3ResolverConfigurationOptions.md) | - -#### Defined in - -[packages/vda-did-resolver/src/resolver.ts:32](https://github.com/verida/verida-js/blob/5040472/packages/vda-did-resolver/src/resolver.ts#L32) - -## Properties - -### defaultTimeout - -• `Private` **defaultTimeout**: `number` = `10000` - -#### Defined in - -[packages/vda-did-resolver/src/resolver.ts:30](https://github.com/verida/verida-js/blob/5040472/packages/vda-did-resolver/src/resolver.ts#L30) - -___ - -### options - -• `Private` **options**: [`Web3ResolverConfigurationOptions`](../interfaces/verida_vda_did_resolver._internal_.Web3ResolverConfigurationOptions.md) - -#### Defined in - -[packages/vda-did-resolver/src/resolver.ts:29](https://github.com/verida/verida-js/blob/5040472/packages/vda-did-resolver/src/resolver.ts#L29) - -## Methods - -### \_resolve - -▸ **_resolve**(`parsed`): `Promise`<[`DIDDocument`](../modules/verida_vda_did_resolver._internal_.md#diddocument)\> - -Resolve a DID Document - -For performance, the latest version is fetched from endpoint. It is possible to fetch all versions -and verify them by using the `fullVerification` query param. - -Supports query parameters: - -`timestamp`: Return DID document that was valid at the specified timestamp -`fullVerification`: Verify every copy of the DID document instead of using consensus - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `parsed` | `any` | - -#### Returns - -`Promise`<[`DIDDocument`](../modules/verida_vda_did_resolver._internal_.md#diddocument)\> - -#### Defined in - -[packages/vda-did-resolver/src/resolver.ts:83](https://github.com/verida/verida-js/blob/5040472/packages/vda-did-resolver/src/resolver.ts#L83) - -___ - -### build - -▸ **build**(): [`Record`](../modules/verida_vda_did_resolver._internal_.md#record)<`string`, [`DIDResolver`](../modules/verida_vda_did_resolver._internal_.md#didresolver)\> - -#### Returns - -[`Record`](../modules/verida_vda_did_resolver._internal_.md#record)<`string`, [`DIDResolver`](../modules/verida_vda_did_resolver._internal_.md#didresolver)\> - -#### Defined in - -[packages/vda-did-resolver/src/resolver.ts:143](https://github.com/verida/verida-js/blob/5040472/packages/vda-did-resolver/src/resolver.ts#L143) - -___ - -### fetchDocuments - -▸ `Private` **fetchDocuments**(`endpoints`): `Promise`<[`DIDDocument`](../modules/verida_vda_did_resolver._internal_.md#diddocument)[]\> - -Fetch the latest DIDDocument stored at each endpoint - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `endpoints` | `string`[] | - -#### Returns - -`Promise`<[`DIDDocument`](../modules/verida_vda_did_resolver._internal_.md#diddocument)[]\> - -#### Defined in - -[packages/vda-did-resolver/src/resolver.ts:119](https://github.com/verida/verida-js/blob/5040472/packages/vda-did-resolver/src/resolver.ts#L119) - -___ - -### resolve - -▸ **resolve**(`did`, `parsed`, `_unused`, `options`): `Promise`<[`DIDResolutionResult`](../interfaces/verida_vda_did_resolver._internal_.DIDResolutionResult.md)\> - -Resolve a DIDDocument from a DID - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did` | `string` | -| `parsed` | [`ParsedDID`](../interfaces/verida_vda_did_resolver._internal_.ParsedDID.md) | -| `_unused` | [`Resolvable`](../interfaces/verida_vda_did_resolver._internal_.Resolvable.md) | -| `options` | [`DIDResolutionOptions`](../interfaces/verida_vda_did_resolver._internal_.DIDResolutionOptions.md) | - -#### Returns - -`Promise`<[`DIDResolutionResult`](../interfaces/verida_vda_did_resolver._internal_.DIDResolutionResult.md)\> - -#### Defined in - -[packages/vda-did-resolver/src/resolver.ts:37](https://github.com/verida/verida-js/blob/5040472/packages/vda-did-resolver/src/resolver.ts#L37) diff --git a/docs/api/verida-js/classes/verida_vda_name_client.VeridaNameClient.md b/docs/api/verida-js/classes/verida_vda_name_client.VeridaNameClient.md deleted file mode 100644 index d8d1c90..0000000 --- a/docs/api/verida-js/classes/verida_vda_name_client.VeridaNameClient.md +++ /dev/null @@ -1,252 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-name-client](../modules/verida_vda_name_client.md) / VeridaNameClient - -# Class: VeridaNameClient - -[@verida/vda-name-client](../modules/verida_vda_name_client.md).VeridaNameClient - -## Table of contents - -### Constructors - -- [constructor](verida_vda_name_client.VeridaNameClient.md#constructor) - -### Properties - -- [config](verida_vda_name_client.VeridaNameClient.md#config) -- [contract](verida_vda_name_client.VeridaNameClient.md#contract) -- [didAddress](verida_vda_name_client.VeridaNameClient.md#didaddress) -- [network](verida_vda_name_client.VeridaNameClient.md#network) -- [readOnly](verida_vda_name_client.VeridaNameClient.md#readonly) -- [usernameCache](verida_vda_name_client.VeridaNameClient.md#usernamecache) -- [vdaWeb3Client](verida_vda_name_client.VeridaNameClient.md#vdaweb3client) - -### Methods - -- [getDID](verida_vda_name_client.VeridaNameClient.md#getdid) -- [getRegisterSignature](verida_vda_name_client.VeridaNameClient.md#getregistersignature) -- [getUsernames](verida_vda_name_client.VeridaNameClient.md#getusernames) -- [nonceFN](verida_vda_name_client.VeridaNameClient.md#noncefn) -- [register](verida_vda_name_client.VeridaNameClient.md#register) -- [unregister](verida_vda_name_client.VeridaNameClient.md#unregister) - -## Constructors - -### constructor - -• **new VeridaNameClient**(`config`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | [`VdaClientConfig`](../interfaces/verida_vda_name_client._internal_.VdaClientConfig.md) | - -#### Defined in - -[packages/vda-name-client/src/blockchain/blockchainApi.ts:24](https://github.com/verida/verida-js/blob/5040472/packages/vda-name-client/src/blockchain/blockchainApi.ts#L24) - -## Properties - -### config - -• `Private` **config**: [`VdaClientConfig`](../interfaces/verida_vda_name_client._internal_.VdaClientConfig.md) - -#### Defined in - -[packages/vda-name-client/src/blockchain/blockchainApi.ts:13](https://github.com/verida/verida-js/blob/5040472/packages/vda-name-client/src/blockchain/blockchainApi.ts#L13) - -___ - -### contract - -• `Private` `Optional` **contract**: [`Contract`](verida_vda_name_client._internal_.Contract.md) - -#### Defined in - -[packages/vda-name-client/src/blockchain/blockchainApi.ts:20](https://github.com/verida/verida-js/blob/5040472/packages/vda-name-client/src/blockchain/blockchainApi.ts#L20) - -___ - -### didAddress - -• `Private` `Optional` **didAddress**: `string` - -#### Defined in - -[packages/vda-name-client/src/blockchain/blockchainApi.ts:15](https://github.com/verida/verida-js/blob/5040472/packages/vda-name-client/src/blockchain/blockchainApi.ts#L15) - -___ - -### network - -• `Private` **network**: `string` - -#### Defined in - -[packages/vda-name-client/src/blockchain/blockchainApi.ts:14](https://github.com/verida/verida-js/blob/5040472/packages/vda-name-client/src/blockchain/blockchainApi.ts#L14) - -___ - -### readOnly - -• `Private` **readOnly**: `boolean` - -#### Defined in - -[packages/vda-name-client/src/blockchain/blockchainApi.ts:19](https://github.com/verida/verida-js/blob/5040472/packages/vda-name-client/src/blockchain/blockchainApi.ts#L19) - -___ - -### usernameCache - -• `Private` **usernameCache**: [`Record`](../modules/verida_vda_name_client._internal_.md#record)<`string`, `string`\> = `{}` - -#### Defined in - -[packages/vda-name-client/src/blockchain/blockchainApi.ts:22](https://github.com/verida/verida-js/blob/5040472/packages/vda-name-client/src/blockchain/blockchainApi.ts#L22) - -___ - -### vdaWeb3Client - -• `Private` `Optional` **vdaWeb3Client**: [`VeridaContract`](verida_vda_name_client._internal_.VeridaContract.md) - -#### Defined in - -[packages/vda-name-client/src/blockchain/blockchainApi.ts:17](https://github.com/verida/verida-js/blob/5040472/packages/vda-name-client/src/blockchain/blockchainApi.ts#L17) - -## Methods - -### getDID - -▸ **getDID**(`username`): `Promise`<`string`\> - -Return the DID address for a given username - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `username` | `string` | username registered by [register](verida_vda_name_client.VeridaNameClient.md#register) | - -#### Returns - -`Promise`<`string`\> - -DID address - -#### Defined in - -[packages/vda-name-client/src/blockchain/blockchainApi.ts:196](https://github.com/verida/verida-js/blob/5040472/packages/vda-name-client/src/blockchain/blockchainApi.ts#L196) - -___ - -### getRegisterSignature - -▸ `Private` **getRegisterSignature**(`name`, `did`, `signKey`): `Promise`<`string`\> - -Get a signature for {@link BlockchainApi#register} function - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `name` | `string` | Name to register | -| `did` | `string` | DID address | -| `signKey` | `string` | Verida account key to generate signature | - -#### Returns - -`Promise`<`string`\> - -Signature - -#### Defined in - -[packages/vda-name-client/src/blockchain/blockchainApi.ts:87](https://github.com/verida/verida-js/blob/5040472/packages/vda-name-client/src/blockchain/blockchainApi.ts#L87) - -___ - -### getUsernames - -▸ **getUsernames**(`did`): `Promise`<`string`[]\> - -Get the username list of a DID address - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `did` | `string` | DID to lookup the username for | - -#### Returns - -`Promise`<`string`[]\> - -username list - -#### Defined in - -[packages/vda-name-client/src/blockchain/blockchainApi.ts:148](https://github.com/verida/verida-js/blob/5040472/packages/vda-name-client/src/blockchain/blockchainApi.ts#L148) - -___ - -### nonceFN - -▸ **nonceFN**(): `Promise`<`any`\> - -Get a nonce from DIDRegistry contract - -#### Returns - -`Promise`<`any`\> - -nonce of DID - -#### Defined in - -[packages/vda-name-client/src/blockchain/blockchainApi.ts:68](https://github.com/verida/verida-js/blob/5040472/packages/vda-name-client/src/blockchain/blockchainApi.ts#L68) - -___ - -### register - -▸ **register**(`username`): `Promise`<`void`\> - -Register a username to the did address - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `username` | `string` | Name to register | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -[packages/vda-name-client/src/blockchain/blockchainApi.ts:100](https://github.com/verida/verida-js/blob/5040472/packages/vda-name-client/src/blockchain/blockchainApi.ts#L100) - -___ - -### unregister - -▸ **unregister**(`username`): `Promise`<`void`\> - -Unregister a username from the did address - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `username` | `string` | Name to be unregistered | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -[packages/vda-name-client/src/blockchain/blockchainApi.ts:125](https://github.com/verida/verida-js/blob/5040472/packages/vda-name-client/src/blockchain/blockchainApi.ts#L125) diff --git a/docs/api/verida-js/classes/verida_vda_name_client._internal_.AbiCoder.md b/docs/api/verida-js/classes/verida_vda_name_client._internal_.AbiCoder.md deleted file mode 100644 index d20a9a6..0000000 --- a/docs/api/verida-js/classes/verida_vda_name_client._internal_.AbiCoder.md +++ /dev/null @@ -1,183 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-name-client](../modules/verida_vda_name_client.md) / [](../modules/verida_vda_name_client._internal_.md) / AbiCoder - -# Class: AbiCoder - -[@verida/vda-name-client](../modules/verida_vda_name_client.md).[](../modules/verida_vda_name_client._internal_.md).AbiCoder - -## Table of contents - -### Constructors - -- [constructor](verida_vda_name_client._internal_.AbiCoder.md#constructor) - -### Properties - -- [coerceFunc](verida_vda_name_client._internal_.AbiCoder.md#coercefunc) - -### Methods - -- [\_getCoder](verida_vda_name_client._internal_.AbiCoder.md#_getcoder) -- [\_getReader](verida_vda_name_client._internal_.AbiCoder.md#_getreader) -- [\_getWordSize](verida_vda_name_client._internal_.AbiCoder.md#_getwordsize) -- [\_getWriter](verida_vda_name_client._internal_.AbiCoder.md#_getwriter) -- [decode](verida_vda_name_client._internal_.AbiCoder.md#decode) -- [encode](verida_vda_name_client._internal_.AbiCoder.md#encode) -- [getDefaultValue](verida_vda_name_client._internal_.AbiCoder.md#getdefaultvalue) - -## Constructors - -### constructor - -• **new AbiCoder**(`coerceFunc?`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `coerceFunc?` | [`CoerceFunc`](../modules/verida_vda_name_client._internal_.md#coercefunc) | - -#### Defined in - -node_modules/@ethersproject/abi/lib/abi-coder.d.ts:7 - -## Properties - -### coerceFunc - -• `Readonly` **coerceFunc**: [`CoerceFunc`](../modules/verida_vda_name_client._internal_.md#coercefunc) - -#### Defined in - -node_modules/@ethersproject/abi/lib/abi-coder.d.ts:6 - -## Methods - -### \_getCoder - -▸ **_getCoder**(`param`): [`Coder`](verida_vda_name_client._internal_.Coder.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `param` | [`ParamType`](verida_vda_name_client._internal_.ParamType.md) | - -#### Returns - -[`Coder`](verida_vda_name_client._internal_.Coder.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/abi-coder.d.ts:8 - -___ - -### \_getReader - -▸ **_getReader**(`data`, `allowLoose?`): [`Reader`](verida_vda_name_client._internal_.Reader.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `Uint8Array` | -| `allowLoose?` | `boolean` | - -#### Returns - -[`Reader`](verida_vda_name_client._internal_.Reader.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/abi-coder.d.ts:10 - -___ - -### \_getWordSize - -▸ **_getWordSize**(): `number` - -#### Returns - -`number` - -#### Defined in - -node_modules/@ethersproject/abi/lib/abi-coder.d.ts:9 - -___ - -### \_getWriter - -▸ **_getWriter**(): [`Writer`](verida_vda_name_client._internal_.Writer.md) - -#### Returns - -[`Writer`](verida_vda_name_client._internal_.Writer.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/abi-coder.d.ts:11 - -___ - -### decode - -▸ **decode**(`types`, `data`, `loose?`): [`Result`](../interfaces/verida_vda_name_client._internal_.Result.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `types` | readonly (`string` \| [`ParamType`](verida_vda_name_client._internal_.ParamType.md))[] | -| `data` | [`BytesLike`](../modules/verida_vda_name_client._internal_.md#byteslike) | -| `loose?` | `boolean` | - -#### Returns - -[`Result`](../interfaces/verida_vda_name_client._internal_.Result.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/abi-coder.d.ts:14 - -___ - -### encode - -▸ **encode**(`types`, `values`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `types` | readonly (`string` \| [`ParamType`](verida_vda_name_client._internal_.ParamType.md))[] | -| `values` | readonly `any`[] | - -#### Returns - -`string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/abi-coder.d.ts:13 - -___ - -### getDefaultValue - -▸ **getDefaultValue**(`types`): [`Result`](../interfaces/verida_vda_name_client._internal_.Result.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `types` | readonly (`string` \| [`ParamType`](verida_vda_name_client._internal_.ParamType.md))[] | - -#### Returns - -[`Result`](../interfaces/verida_vda_name_client._internal_.Result.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/abi-coder.d.ts:12 diff --git a/docs/api/verida-js/classes/verida_vda_name_client._internal_.BaseContract.md b/docs/api/verida-js/classes/verida_vda_name_client._internal_.BaseContract.md deleted file mode 100644 index ecb053f..0000000 --- a/docs/api/verida-js/classes/verida_vda_name_client._internal_.BaseContract.md +++ /dev/null @@ -1,660 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-name-client](../modules/verida_vda_name_client.md) / [](../modules/verida_vda_name_client._internal_.md) / BaseContract - -# Class: BaseContract - -[@verida/vda-name-client](../modules/verida_vda_name_client.md).[](../modules/verida_vda_name_client._internal_.md).BaseContract - -## Hierarchy - -- **`BaseContract`** - - ↳ [`Contract`](verida_vda_name_client._internal_.Contract.md) - -## Table of contents - -### Constructors - -- [constructor](verida_vda_name_client._internal_.BaseContract.md#constructor) - -### Properties - -- [\_addEventListener](verida_vda_name_client._internal_.BaseContract.md#_addeventlistener) -- [\_deployedPromise](verida_vda_name_client._internal_.BaseContract.md#_deployedpromise) -- [\_getRunningEvent](verida_vda_name_client._internal_.BaseContract.md#_getrunningevent) -- [\_normalizeRunningEvent](verida_vda_name_client._internal_.BaseContract.md#_normalizerunningevent) -- [\_runningEvents](verida_vda_name_client._internal_.BaseContract.md#_runningevents) -- [\_wrappedEmits](verida_vda_name_client._internal_.BaseContract.md#_wrappedemits) -- [address](verida_vda_name_client._internal_.BaseContract.md#address) -- [callStatic](verida_vda_name_client._internal_.BaseContract.md#callstatic) -- [deployTransaction](verida_vda_name_client._internal_.BaseContract.md#deploytransaction) -- [estimateGas](verida_vda_name_client._internal_.BaseContract.md#estimategas) -- [filters](verida_vda_name_client._internal_.BaseContract.md#filters) -- [functions](verida_vda_name_client._internal_.BaseContract.md#functions) -- [interface](verida_vda_name_client._internal_.BaseContract.md#interface) -- [populateTransaction](verida_vda_name_client._internal_.BaseContract.md#populatetransaction) -- [provider](verida_vda_name_client._internal_.BaseContract.md#provider) -- [resolvedAddress](verida_vda_name_client._internal_.BaseContract.md#resolvedaddress) -- [signer](verida_vda_name_client._internal_.BaseContract.md#signer) - -### Methods - -- [\_checkRunningEvents](verida_vda_name_client._internal_.BaseContract.md#_checkrunningevents) -- [\_deployed](verida_vda_name_client._internal_.BaseContract.md#_deployed) -- [\_wrapEvent](verida_vda_name_client._internal_.BaseContract.md#_wrapevent) -- [attach](verida_vda_name_client._internal_.BaseContract.md#attach) -- [connect](verida_vda_name_client._internal_.BaseContract.md#connect) -- [deployed](verida_vda_name_client._internal_.BaseContract.md#deployed) -- [emit](verida_vda_name_client._internal_.BaseContract.md#emit) -- [fallback](verida_vda_name_client._internal_.BaseContract.md#fallback) -- [listenerCount](verida_vda_name_client._internal_.BaseContract.md#listenercount) -- [listeners](verida_vda_name_client._internal_.BaseContract.md#listeners) -- [off](verida_vda_name_client._internal_.BaseContract.md#off) -- [on](verida_vda_name_client._internal_.BaseContract.md#on) -- [once](verida_vda_name_client._internal_.BaseContract.md#once) -- [queryFilter](verida_vda_name_client._internal_.BaseContract.md#queryfilter) -- [removeAllListeners](verida_vda_name_client._internal_.BaseContract.md#removealllisteners) -- [removeListener](verida_vda_name_client._internal_.BaseContract.md#removelistener) -- [getContractAddress](verida_vda_name_client._internal_.BaseContract.md#getcontractaddress) -- [getInterface](verida_vda_name_client._internal_.BaseContract.md#getinterface) -- [isIndexed](verida_vda_name_client._internal_.BaseContract.md#isindexed) - -## Constructors - -### constructor - -• **new BaseContract**(`addressOrName`, `contractInterface`, `signerOrProvider?`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `addressOrName` | `string` | -| `contractInterface` | [`ContractInterface`](../modules/verida_vda_name_client._internal_.md#contractinterface) | -| `signerOrProvider?` | [`Signer`](verida_vda_name_client._internal_.Signer.md) \| [`Provider`](verida_vda_name_client._internal_.Provider.md) | - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:107 - -## Properties - -### \_addEventListener - -• `Private` **\_addEventListener**: `any` - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:123 - -___ - -### \_deployedPromise - -• **\_deployedPromise**: `Promise`<[`Contract`](verida_vda_name_client._internal_.Contract.md)\> - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:100 - -___ - -### \_getRunningEvent - -• `Private` **\_getRunningEvent**: `any` - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:120 - -___ - -### \_normalizeRunningEvent - -• `Private` **\_normalizeRunningEvent**: `any` - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:119 - -___ - -### \_runningEvents - -• **\_runningEvents**: `Object` - -#### Index signature - -▪ [eventTag: `string`]: [`RunningEvent`](verida_vda_name_client._internal_.RunningEvent.md) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:101 - -___ - -### \_wrappedEmits - -• **\_wrappedEmits**: `Object` - -#### Index signature - -▪ [eventTag: `string`]: (...`args`: `any`[]) => `void` - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:104 - -___ - -### address - -• `Readonly` **address**: `string` - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:79 - -___ - -### callStatic - -• `Readonly` **callStatic**: `Object` - -#### Index signature - -▪ [name: `string`]: [`ContractFunction`](../modules/verida_vda_name_client._internal_.md#contractfunction) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:86 - -___ - -### deployTransaction - -• `Readonly` **deployTransaction**: [`TransactionResponse`](../interfaces/verida_vda_name_client._internal_.TransactionResponse.md) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:99 - -___ - -### estimateGas - -• `Readonly` **estimateGas**: `Object` - -#### Index signature - -▪ [name: `string`]: [`ContractFunction`](../modules/verida_vda_name_client._internal_.md#contractfunction)<[`BigNumber`](verida_vda_name_client._internal_.BigNumber.md)\> - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:89 - -___ - -### filters - -• `Readonly` **filters**: `Object` - -#### Index signature - -▪ [name: `string`]: (...`args`: `any`[]) => [`EventFilter`](../modules/verida_vda_name_client._internal_.md#eventfilter) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:95 - -___ - -### functions - -• `Readonly` **functions**: `Object` - -#### Index signature - -▪ [name: `string`]: [`ContractFunction`](../modules/verida_vda_name_client._internal_.md#contractfunction) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:83 - -___ - -### interface - -• `Readonly` **interface**: [`Interface`](verida_vda_name_client._internal_.Interface.md) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:80 - -___ - -### populateTransaction - -• `Readonly` **populateTransaction**: `Object` - -#### Index signature - -▪ [name: `string`]: [`ContractFunction`](../modules/verida_vda_name_client._internal_.md#contractfunction)<[`PopulatedTransaction`](../interfaces/verida_vda_name_client._internal_.PopulatedTransaction.md)\> - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:92 - -___ - -### provider - -• `Readonly` **provider**: [`Provider`](verida_vda_name_client._internal_.Provider.md) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:82 - -___ - -### resolvedAddress - -• `Readonly` **resolvedAddress**: `Promise`<`string`\> - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:98 - -___ - -### signer - -• `Readonly` **signer**: [`Signer`](verida_vda_name_client._internal_.Signer.md) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:81 - -## Methods - -### \_checkRunningEvents - -▸ **_checkRunningEvents**(`runningEvent`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `runningEvent` | [`RunningEvent`](verida_vda_name_client._internal_.RunningEvent.md) | - -#### Returns - -`void` - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:121 - -___ - -### \_deployed - -▸ **_deployed**(`blockTag?`): `Promise`<[`Contract`](verida_vda_name_client._internal_.Contract.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `blockTag?` | [`BlockTag`](../modules/verida_vda_name_client._internal_.md#blocktag) | - -#### Returns - -`Promise`<[`Contract`](verida_vda_name_client._internal_.Contract.md)\> - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:114 - -___ - -### \_wrapEvent - -▸ **_wrapEvent**(`runningEvent`, `log`, `listener`): [`Event`](../interfaces/verida_vda_name_client._internal_.Event.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `runningEvent` | [`RunningEvent`](verida_vda_name_client._internal_.RunningEvent.md) | -| `log` | [`Log`](../interfaces/verida_vda_name_client._internal_.Log.md) | -| `listener` | [`Listener`](../modules/verida_vda_name_client._internal_.md#listener) | - -#### Returns - -[`Event`](../interfaces/verida_vda_name_client._internal_.Event.md) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:122 - -___ - -### attach - -▸ **attach**(`addressOrName`): [`Contract`](verida_vda_name_client._internal_.Contract.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `addressOrName` | `string` | - -#### Returns - -[`Contract`](verida_vda_name_client._internal_.Contract.md) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:117 - -___ - -### connect - -▸ **connect**(`signerOrProvider`): [`Contract`](verida_vda_name_client._internal_.Contract.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `signerOrProvider` | `string` \| [`Signer`](verida_vda_name_client._internal_.Signer.md) \| [`Provider`](verida_vda_name_client._internal_.Provider.md) | - -#### Returns - -[`Contract`](verida_vda_name_client._internal_.Contract.md) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:116 - -___ - -### deployed - -▸ **deployed**(): `Promise`<[`Contract`](verida_vda_name_client._internal_.Contract.md)\> - -#### Returns - -`Promise`<[`Contract`](verida_vda_name_client._internal_.Contract.md)\> - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:113 - -___ - -### emit - -▸ **emit**(`eventName`, ...`args`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | `string` \| [`EventFilter`](../modules/verida_vda_name_client._internal_.md#eventfilter) | -| `...args` | `any`[] | - -#### Returns - -`boolean` - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:127 - -___ - -### fallback - -▸ **fallback**(`overrides?`): `Promise`<[`TransactionResponse`](../interfaces/verida_vda_name_client._internal_.TransactionResponse.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `overrides?` | [`TransactionRequest`](../modules/verida_vda_name_client._internal_.md#transactionrequest) | - -#### Returns - -`Promise`<[`TransactionResponse`](../interfaces/verida_vda_name_client._internal_.TransactionResponse.md)\> - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:115 - -___ - -### listenerCount - -▸ **listenerCount**(`eventName?`): `number` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName?` | `string` \| [`EventFilter`](../modules/verida_vda_name_client._internal_.md#eventfilter) | - -#### Returns - -`number` - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:128 - -___ - -### listeners - -▸ **listeners**(`eventName?`): [`Listener`](../modules/verida_vda_name_client._internal_.md#listener)[] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName?` | `string` \| [`EventFilter`](../modules/verida_vda_name_client._internal_.md#eventfilter) | - -#### Returns - -[`Listener`](../modules/verida_vda_name_client._internal_.md#listener)[] - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:129 - -___ - -### off - -▸ **off**(`eventName`, `listener`): [`BaseContract`](verida_vda_name_client._internal_.BaseContract.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | `string` \| [`EventFilter`](../modules/verida_vda_name_client._internal_.md#eventfilter) | -| `listener` | [`Listener`](../modules/verida_vda_name_client._internal_.md#listener) | - -#### Returns - -[`BaseContract`](verida_vda_name_client._internal_.BaseContract.md) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:131 - -___ - -### on - -▸ **on**(`event`, `listener`): [`BaseContract`](verida_vda_name_client._internal_.BaseContract.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | `string` \| [`EventFilter`](../modules/verida_vda_name_client._internal_.md#eventfilter) | -| `listener` | [`Listener`](../modules/verida_vda_name_client._internal_.md#listener) | - -#### Returns - -[`BaseContract`](verida_vda_name_client._internal_.BaseContract.md) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:125 - -___ - -### once - -▸ **once**(`event`, `listener`): [`BaseContract`](verida_vda_name_client._internal_.BaseContract.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | `string` \| [`EventFilter`](../modules/verida_vda_name_client._internal_.md#eventfilter) | -| `listener` | [`Listener`](../modules/verida_vda_name_client._internal_.md#listener) | - -#### Returns - -[`BaseContract`](verida_vda_name_client._internal_.BaseContract.md) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:126 - -___ - -### queryFilter - -▸ **queryFilter**(`event`, `fromBlockOrBlockhash?`, `toBlock?`): `Promise`<[`Event`](../interfaces/verida_vda_name_client._internal_.Event.md)[]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | `string` \| [`EventFilter`](../modules/verida_vda_name_client._internal_.md#eventfilter) | -| `fromBlockOrBlockhash?` | [`BlockTag`](../modules/verida_vda_name_client._internal_.md#blocktag) | -| `toBlock?` | [`BlockTag`](../modules/verida_vda_name_client._internal_.md#blocktag) | - -#### Returns - -`Promise`<[`Event`](../interfaces/verida_vda_name_client._internal_.Event.md)[]\> - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:124 - -___ - -### removeAllListeners - -▸ **removeAllListeners**(`eventName?`): [`BaseContract`](verida_vda_name_client._internal_.BaseContract.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName?` | `string` \| [`EventFilter`](../modules/verida_vda_name_client._internal_.md#eventfilter) | - -#### Returns - -[`BaseContract`](verida_vda_name_client._internal_.BaseContract.md) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:130 - -___ - -### removeListener - -▸ **removeListener**(`eventName`, `listener`): [`BaseContract`](verida_vda_name_client._internal_.BaseContract.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | `string` \| [`EventFilter`](../modules/verida_vda_name_client._internal_.md#eventfilter) | -| `listener` | [`Listener`](../modules/verida_vda_name_client._internal_.md#listener) | - -#### Returns - -[`BaseContract`](verida_vda_name_client._internal_.BaseContract.md) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:132 - -___ - -### getContractAddress - -▸ `Static` **getContractAddress**(`transaction`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transaction` | `Object` | -| `transaction.from` | `string` | -| `transaction.nonce` | [`BigNumberish`](../modules/verida_vda_name_client._internal_.md#bignumberish) | - -#### Returns - -`string` - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:108 - -___ - -### getInterface - -▸ `Static` **getInterface**(`contractInterface`): [`Interface`](verida_vda_name_client._internal_.Interface.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contractInterface` | [`ContractInterface`](../modules/verida_vda_name_client._internal_.md#contractinterface) | - -#### Returns - -[`Interface`](verida_vda_name_client._internal_.Interface.md) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:112 - -___ - -### isIndexed - -▸ `Static` **isIndexed**(`value`): value is Indexed - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `any` | - -#### Returns - -value is Indexed - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:118 diff --git a/docs/api/verida-js/classes/verida_vda_name_client._internal_.BigNumber.md b/docs/api/verida-js/classes/verida_vda_name_client._internal_.BigNumber.md deleted file mode 100644 index 7177b87..0000000 --- a/docs/api/verida-js/classes/verida_vda_name_client._internal_.BigNumber.md +++ /dev/null @@ -1,631 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-name-client](../modules/verida_vda_name_client.md) / [](../modules/verida_vda_name_client._internal_.md) / BigNumber - -# Class: BigNumber - -[@verida/vda-name-client](../modules/verida_vda_name_client.md).[](../modules/verida_vda_name_client._internal_.md).BigNumber - -## Implements - -- [`Hexable`](../interfaces/verida_vda_name_client._internal_.Hexable.md) - -## Table of contents - -### Constructors - -- [constructor](verida_vda_name_client._internal_.BigNumber.md#constructor) - -### Properties - -- [\_hex](verida_vda_name_client._internal_.BigNumber.md#_hex) -- [\_isBigNumber](verida_vda_name_client._internal_.BigNumber.md#_isbignumber) - -### Methods - -- [abs](verida_vda_name_client._internal_.BigNumber.md#abs) -- [add](verida_vda_name_client._internal_.BigNumber.md#add) -- [and](verida_vda_name_client._internal_.BigNumber.md#and) -- [div](verida_vda_name_client._internal_.BigNumber.md#div) -- [eq](verida_vda_name_client._internal_.BigNumber.md#eq) -- [fromTwos](verida_vda_name_client._internal_.BigNumber.md#fromtwos) -- [gt](verida_vda_name_client._internal_.BigNumber.md#gt) -- [gte](verida_vda_name_client._internal_.BigNumber.md#gte) -- [isNegative](verida_vda_name_client._internal_.BigNumber.md#isnegative) -- [isZero](verida_vda_name_client._internal_.BigNumber.md#iszero) -- [lt](verida_vda_name_client._internal_.BigNumber.md#lt) -- [lte](verida_vda_name_client._internal_.BigNumber.md#lte) -- [mask](verida_vda_name_client._internal_.BigNumber.md#mask) -- [mod](verida_vda_name_client._internal_.BigNumber.md#mod) -- [mul](verida_vda_name_client._internal_.BigNumber.md#mul) -- [or](verida_vda_name_client._internal_.BigNumber.md#or) -- [pow](verida_vda_name_client._internal_.BigNumber.md#pow) -- [shl](verida_vda_name_client._internal_.BigNumber.md#shl) -- [shr](verida_vda_name_client._internal_.BigNumber.md#shr) -- [sub](verida_vda_name_client._internal_.BigNumber.md#sub) -- [toBigInt](verida_vda_name_client._internal_.BigNumber.md#tobigint) -- [toHexString](verida_vda_name_client._internal_.BigNumber.md#tohexstring) -- [toJSON](verida_vda_name_client._internal_.BigNumber.md#tojson) -- [toNumber](verida_vda_name_client._internal_.BigNumber.md#tonumber) -- [toString](verida_vda_name_client._internal_.BigNumber.md#tostring) -- [toTwos](verida_vda_name_client._internal_.BigNumber.md#totwos) -- [xor](verida_vda_name_client._internal_.BigNumber.md#xor) -- [from](verida_vda_name_client._internal_.BigNumber.md#from) -- [isBigNumber](verida_vda_name_client._internal_.BigNumber.md#isbignumber) - -## Constructors - -### constructor - -• **new BigNumber**(`constructorGuard`, `hex`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `constructorGuard` | `any` | -| `hex` | `string` | - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:7 - -## Properties - -### \_hex - -• `Readonly` **\_hex**: `string` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:5 - -___ - -### \_isBigNumber - -• `Readonly` **\_isBigNumber**: `boolean` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:6 - -## Methods - -### abs - -▸ **abs**(): [`BigNumber`](verida_vda_name_client._internal_.BigNumber.md) - -#### Returns - -[`BigNumber`](verida_vda_name_client._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:10 - -___ - -### add - -▸ **add**(`other`): [`BigNumber`](verida_vda_name_client._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_vda_name_client._internal_.md#bignumberish) | - -#### Returns - -[`BigNumber`](verida_vda_name_client._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:11 - -___ - -### and - -▸ **and**(`other`): [`BigNumber`](verida_vda_name_client._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_vda_name_client._internal_.md#bignumberish) | - -#### Returns - -[`BigNumber`](verida_vda_name_client._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:17 - -___ - -### div - -▸ **div**(`other`): [`BigNumber`](verida_vda_name_client._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_vda_name_client._internal_.md#bignumberish) | - -#### Returns - -[`BigNumber`](verida_vda_name_client._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:13 - -___ - -### eq - -▸ **eq**(`other`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_vda_name_client._internal_.md#bignumberish) | - -#### Returns - -`boolean` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:23 - -___ - -### fromTwos - -▸ **fromTwos**(`value`): [`BigNumber`](verida_vda_name_client._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `number` | - -#### Returns - -[`BigNumber`](verida_vda_name_client._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:8 - -___ - -### gt - -▸ **gt**(`other`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_vda_name_client._internal_.md#bignumberish) | - -#### Returns - -`boolean` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:26 - -___ - -### gte - -▸ **gte**(`other`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_vda_name_client._internal_.md#bignumberish) | - -#### Returns - -`boolean` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:27 - -___ - -### isNegative - -▸ **isNegative**(): `boolean` - -#### Returns - -`boolean` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:28 - -___ - -### isZero - -▸ **isZero**(): `boolean` - -#### Returns - -`boolean` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:29 - -___ - -### lt - -▸ **lt**(`other`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_vda_name_client._internal_.md#bignumberish) | - -#### Returns - -`boolean` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:24 - -___ - -### lte - -▸ **lte**(`other`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_vda_name_client._internal_.md#bignumberish) | - -#### Returns - -`boolean` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:25 - -___ - -### mask - -▸ **mask**(`value`): [`BigNumber`](verida_vda_name_client._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `number` | - -#### Returns - -[`BigNumber`](verida_vda_name_client._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:20 - -___ - -### mod - -▸ **mod**(`other`): [`BigNumber`](verida_vda_name_client._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_vda_name_client._internal_.md#bignumberish) | - -#### Returns - -[`BigNumber`](verida_vda_name_client._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:15 - -___ - -### mul - -▸ **mul**(`other`): [`BigNumber`](verida_vda_name_client._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_vda_name_client._internal_.md#bignumberish) | - -#### Returns - -[`BigNumber`](verida_vda_name_client._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:14 - -___ - -### or - -▸ **or**(`other`): [`BigNumber`](verida_vda_name_client._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_vda_name_client._internal_.md#bignumberish) | - -#### Returns - -[`BigNumber`](verida_vda_name_client._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:18 - -___ - -### pow - -▸ **pow**(`other`): [`BigNumber`](verida_vda_name_client._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_vda_name_client._internal_.md#bignumberish) | - -#### Returns - -[`BigNumber`](verida_vda_name_client._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:16 - -___ - -### shl - -▸ **shl**(`value`): [`BigNumber`](verida_vda_name_client._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `number` | - -#### Returns - -[`BigNumber`](verida_vda_name_client._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:21 - -___ - -### shr - -▸ **shr**(`value`): [`BigNumber`](verida_vda_name_client._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `number` | - -#### Returns - -[`BigNumber`](verida_vda_name_client._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:22 - -___ - -### sub - -▸ **sub**(`other`): [`BigNumber`](verida_vda_name_client._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_vda_name_client._internal_.md#bignumberish) | - -#### Returns - -[`BigNumber`](verida_vda_name_client._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:12 - -___ - -### toBigInt - -▸ **toBigInt**(): `bigint` - -#### Returns - -`bigint` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:31 - -___ - -### toHexString - -▸ **toHexString**(): `string` - -#### Returns - -`string` - -#### Implementation of - -[Hexable](../interfaces/verida_vda_name_client._internal_.Hexable.md).[toHexString](../interfaces/verida_vda_name_client._internal_.Hexable.md#tohexstring) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:33 - -___ - -### toJSON - -▸ **toJSON**(`key?`): `any` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `key?` | `string` | - -#### Returns - -`any` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:34 - -___ - -### toNumber - -▸ **toNumber**(): `number` - -#### Returns - -`number` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:30 - -___ - -### toString - -▸ **toString**(): `string` - -#### Returns - -`string` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:32 - -___ - -### toTwos - -▸ **toTwos**(`value`): [`BigNumber`](verida_vda_name_client._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `number` | - -#### Returns - -[`BigNumber`](verida_vda_name_client._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:9 - -___ - -### xor - -▸ **xor**(`other`): [`BigNumber`](verida_vda_name_client._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_vda_name_client._internal_.md#bignumberish) | - -#### Returns - -[`BigNumber`](verida_vda_name_client._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:19 - -___ - -### from - -▸ `Static` **from**(`value`): [`BigNumber`](verida_vda_name_client._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `any` | - -#### Returns - -[`BigNumber`](verida_vda_name_client._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:35 - -___ - -### isBigNumber - -▸ `Static` **isBigNumber**(`value`): value is BigNumber - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `any` | - -#### Returns - -value is BigNumber - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:36 diff --git a/docs/api/verida-js/classes/verida_vda_name_client._internal_.Coder.md b/docs/api/verida-js/classes/verida_vda_name_client._internal_.Coder.md deleted file mode 100644 index bd7ab93..0000000 --- a/docs/api/verida-js/classes/verida_vda_name_client._internal_.Coder.md +++ /dev/null @@ -1,160 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-name-client](../modules/verida_vda_name_client.md) / [](../modules/verida_vda_name_client._internal_.md) / Coder - -# Class: Coder - -[@verida/vda-name-client](../modules/verida_vda_name_client.md).[](../modules/verida_vda_name_client._internal_.md).Coder - -## Table of contents - -### Constructors - -- [constructor](verida_vda_name_client._internal_.Coder.md#constructor) - -### Properties - -- [dynamic](verida_vda_name_client._internal_.Coder.md#dynamic) -- [localName](verida_vda_name_client._internal_.Coder.md#localname) -- [name](verida_vda_name_client._internal_.Coder.md#name) -- [type](verida_vda_name_client._internal_.Coder.md#type) - -### Methods - -- [\_throwError](verida_vda_name_client._internal_.Coder.md#_throwerror) -- [decode](verida_vda_name_client._internal_.Coder.md#decode) -- [defaultValue](verida_vda_name_client._internal_.Coder.md#defaultvalue) -- [encode](verida_vda_name_client._internal_.Coder.md#encode) - -## Constructors - -### constructor - -• **new Coder**(`name`, `type`, `localName`, `dynamic`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` | -| `type` | `string` | -| `localName` | `string` | -| `dynamic` | `boolean` | - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:16 - -## Properties - -### dynamic - -• `Readonly` **dynamic**: `boolean` - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:15 - -___ - -### localName - -• `Readonly` **localName**: `string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:14 - -___ - -### name - -• `Readonly` **name**: `string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:12 - -___ - -### type - -• `Readonly` **type**: `string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:13 - -## Methods - -### \_throwError - -▸ **_throwError**(`message`, `value`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `message` | `string` | -| `value` | `any` | - -#### Returns - -`void` - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:17 - -___ - -### decode - -▸ `Abstract` **decode**(`reader`): `any` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `reader` | [`Reader`](verida_vda_name_client._internal_.Reader.md) | - -#### Returns - -`any` - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:19 - -___ - -### defaultValue - -▸ `Abstract` **defaultValue**(): `any` - -#### Returns - -`any` - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:20 - -___ - -### encode - -▸ `Abstract` **encode**(`writer`, `value`): `number` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `writer` | [`Writer`](verida_vda_name_client._internal_.Writer.md) | -| `value` | `any` | - -#### Returns - -`number` - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:18 diff --git a/docs/api/verida-js/classes/verida_vda_name_client._internal_.ConstructorFragment.md b/docs/api/verida-js/classes/verida_vda_name_client._internal_.ConstructorFragment.md deleted file mode 100644 index a816ac7..0000000 --- a/docs/api/verida-js/classes/verida_vda_name_client._internal_.ConstructorFragment.md +++ /dev/null @@ -1,285 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-name-client](../modules/verida_vda_name_client.md) / [](../modules/verida_vda_name_client._internal_.md) / ConstructorFragment - -# Class: ConstructorFragment - -[@verida/vda-name-client](../modules/verida_vda_name_client.md).[](../modules/verida_vda_name_client._internal_.md).ConstructorFragment - -## Hierarchy - -- [`Fragment`](verida_vda_name_client._internal_.Fragment.md) - - ↳ **`ConstructorFragment`** - - ↳↳ [`FunctionFragment`](verida_vda_name_client._internal_.FunctionFragment.md) - -## Table of contents - -### Constructors - -- [constructor](verida_vda_name_client._internal_.ConstructorFragment.md#constructor) - -### Properties - -- [\_isFragment](verida_vda_name_client._internal_.ConstructorFragment.md#_isfragment) -- [gas](verida_vda_name_client._internal_.ConstructorFragment.md#gas) -- [inputs](verida_vda_name_client._internal_.ConstructorFragment.md#inputs) -- [name](verida_vda_name_client._internal_.ConstructorFragment.md#name) -- [payable](verida_vda_name_client._internal_.ConstructorFragment.md#payable) -- [stateMutability](verida_vda_name_client._internal_.ConstructorFragment.md#statemutability) -- [type](verida_vda_name_client._internal_.ConstructorFragment.md#type) - -### Methods - -- [format](verida_vda_name_client._internal_.ConstructorFragment.md#format) -- [from](verida_vda_name_client._internal_.ConstructorFragment.md#from) -- [fromObject](verida_vda_name_client._internal_.ConstructorFragment.md#fromobject) -- [fromString](verida_vda_name_client._internal_.ConstructorFragment.md#fromstring) -- [isConstructorFragment](verida_vda_name_client._internal_.ConstructorFragment.md#isconstructorfragment) -- [isFragment](verida_vda_name_client._internal_.ConstructorFragment.md#isfragment) - -## Constructors - -### constructor - -• **new ConstructorFragment**(`constructorGuard`, `params`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `constructorGuard` | `any` | -| `params` | `any` | - -#### Inherited from - -[Fragment](verida_vda_name_client._internal_.Fragment.md).[constructor](verida_vda_name_client._internal_.Fragment.md#constructor) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:44 - -## Properties - -### \_isFragment - -• `Readonly` **\_isFragment**: `boolean` - -#### Inherited from - -[Fragment](verida_vda_name_client._internal_.Fragment.md).[_isFragment](verida_vda_name_client._internal_.Fragment.md#_isfragment) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:43 - -___ - -### gas - -• `Optional` **gas**: [`BigNumber`](verida_vda_name_client._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:62 - -___ - -### inputs - -• `Readonly` **inputs**: [`ParamType`](verida_vda_name_client._internal_.ParamType.md)[] - -#### Inherited from - -[Fragment](verida_vda_name_client._internal_.Fragment.md).[inputs](verida_vda_name_client._internal_.Fragment.md#inputs) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:42 - -___ - -### name - -• `Readonly` **name**: `string` - -#### Inherited from - -[Fragment](verida_vda_name_client._internal_.Fragment.md).[name](verida_vda_name_client._internal_.Fragment.md#name) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:41 - -___ - -### payable - -• **payable**: `boolean` - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:61 - -___ - -### stateMutability - -• **stateMutability**: `string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:60 - -___ - -### type - -• `Readonly` **type**: `string` - -#### Inherited from - -[Fragment](verida_vda_name_client._internal_.Fragment.md).[type](verida_vda_name_client._internal_.Fragment.md#type) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:40 - -## Methods - -### format - -▸ **format**(`format?`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `format?` | `string` | - -#### Returns - -`string` - -#### Overrides - -[Fragment](verida_vda_name_client._internal_.Fragment.md).[format](verida_vda_name_client._internal_.Fragment.md#format) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:63 - -___ - -### from - -▸ `Static` **from**(`value`): [`ConstructorFragment`](verida_vda_name_client._internal_.ConstructorFragment.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `string` \| [`JsonFragment`](../interfaces/verida_vda_name_client._internal_.JsonFragment.md) \| [`ConstructorFragment`](verida_vda_name_client._internal_.ConstructorFragment.md) | - -#### Returns - -[`ConstructorFragment`](verida_vda_name_client._internal_.ConstructorFragment.md) - -#### Overrides - -[Fragment](verida_vda_name_client._internal_.Fragment.md).[from](verida_vda_name_client._internal_.Fragment.md#from) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:64 - -___ - -### fromObject - -▸ `Static` **fromObject**(`value`): [`ConstructorFragment`](verida_vda_name_client._internal_.ConstructorFragment.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | [`JsonFragment`](../interfaces/verida_vda_name_client._internal_.JsonFragment.md) \| [`ConstructorFragment`](verida_vda_name_client._internal_.ConstructorFragment.md) | - -#### Returns - -[`ConstructorFragment`](verida_vda_name_client._internal_.ConstructorFragment.md) - -#### Overrides - -[Fragment](verida_vda_name_client._internal_.Fragment.md).[fromObject](verida_vda_name_client._internal_.Fragment.md#fromobject) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:65 - -___ - -### fromString - -▸ `Static` **fromString**(`value`): [`ConstructorFragment`](verida_vda_name_client._internal_.ConstructorFragment.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `string` | - -#### Returns - -[`ConstructorFragment`](verida_vda_name_client._internal_.ConstructorFragment.md) - -#### Overrides - -[Fragment](verida_vda_name_client._internal_.Fragment.md).[fromString](verida_vda_name_client._internal_.Fragment.md#fromstring) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:66 - -___ - -### isConstructorFragment - -▸ `Static` **isConstructorFragment**(`value`): value is ConstructorFragment - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `any` | - -#### Returns - -value is ConstructorFragment - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:67 - -___ - -### isFragment - -▸ `Static` **isFragment**(`value`): value is Fragment - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `any` | - -#### Returns - -value is Fragment - -#### Inherited from - -[Fragment](verida_vda_name_client._internal_.Fragment.md).[isFragment](verida_vda_name_client._internal_.Fragment.md#isfragment) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:49 diff --git a/docs/api/verida-js/classes/verida_vda_name_client._internal_.Contract.md b/docs/api/verida-js/classes/verida_vda_name_client._internal_.Contract.md deleted file mode 100644 index a7fb466..0000000 --- a/docs/api/verida-js/classes/verida_vda_name_client._internal_.Contract.md +++ /dev/null @@ -1,767 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-name-client](../modules/verida_vda_name_client.md) / [](../modules/verida_vda_name_client._internal_.md) / Contract - -# Class: Contract - -[@verida/vda-name-client](../modules/verida_vda_name_client.md).[](../modules/verida_vda_name_client._internal_.md).Contract - -## Hierarchy - -- [`BaseContract`](verida_vda_name_client._internal_.BaseContract.md) - - ↳ **`Contract`** - -## Indexable - -▪ [key: `string`]: [`ContractFunction`](../modules/verida_vda_name_client._internal_.md#contractfunction) \| `any` - -## Table of contents - -### Constructors - -- [constructor](verida_vda_name_client._internal_.Contract.md#constructor) - -### Properties - -- [\_deployedPromise](verida_vda_name_client._internal_.Contract.md#_deployedpromise) -- [\_runningEvents](verida_vda_name_client._internal_.Contract.md#_runningevents) -- [\_wrappedEmits](verida_vda_name_client._internal_.Contract.md#_wrappedemits) -- [address](verida_vda_name_client._internal_.Contract.md#address) -- [callStatic](verida_vda_name_client._internal_.Contract.md#callstatic) -- [deployTransaction](verida_vda_name_client._internal_.Contract.md#deploytransaction) -- [estimateGas](verida_vda_name_client._internal_.Contract.md#estimategas) -- [filters](verida_vda_name_client._internal_.Contract.md#filters) -- [functions](verida_vda_name_client._internal_.Contract.md#functions) -- [interface](verida_vda_name_client._internal_.Contract.md#interface) -- [populateTransaction](verida_vda_name_client._internal_.Contract.md#populatetransaction) -- [provider](verida_vda_name_client._internal_.Contract.md#provider) -- [resolvedAddress](verida_vda_name_client._internal_.Contract.md#resolvedaddress) -- [signer](verida_vda_name_client._internal_.Contract.md#signer) - -### Methods - -- [\_checkRunningEvents](verida_vda_name_client._internal_.Contract.md#_checkrunningevents) -- [\_deployed](verida_vda_name_client._internal_.Contract.md#_deployed) -- [\_wrapEvent](verida_vda_name_client._internal_.Contract.md#_wrapevent) -- [attach](verida_vda_name_client._internal_.Contract.md#attach) -- [connect](verida_vda_name_client._internal_.Contract.md#connect) -- [deployed](verida_vda_name_client._internal_.Contract.md#deployed) -- [emit](verida_vda_name_client._internal_.Contract.md#emit) -- [fallback](verida_vda_name_client._internal_.Contract.md#fallback) -- [listenerCount](verida_vda_name_client._internal_.Contract.md#listenercount) -- [listeners](verida_vda_name_client._internal_.Contract.md#listeners) -- [off](verida_vda_name_client._internal_.Contract.md#off) -- [on](verida_vda_name_client._internal_.Contract.md#on) -- [once](verida_vda_name_client._internal_.Contract.md#once) -- [queryFilter](verida_vda_name_client._internal_.Contract.md#queryfilter) -- [removeAllListeners](verida_vda_name_client._internal_.Contract.md#removealllisteners) -- [removeListener](verida_vda_name_client._internal_.Contract.md#removelistener) -- [getContractAddress](verida_vda_name_client._internal_.Contract.md#getcontractaddress) -- [getInterface](verida_vda_name_client._internal_.Contract.md#getinterface) -- [isIndexed](verida_vda_name_client._internal_.Contract.md#isindexed) - -## Constructors - -### constructor - -• **new Contract**(`addressOrName`, `contractInterface`, `signerOrProvider?`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `addressOrName` | `string` | -| `contractInterface` | [`ContractInterface`](../modules/verida_vda_name_client._internal_.md#contractinterface) | -| `signerOrProvider?` | [`Signer`](verida_vda_name_client._internal_.Signer.md) \| [`Provider`](verida_vda_name_client._internal_.Provider.md) | - -#### Inherited from - -[BaseContract](verida_vda_name_client._internal_.BaseContract.md).[constructor](verida_vda_name_client._internal_.BaseContract.md#constructor) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:107 - -## Properties - -### \_deployedPromise - -• **\_deployedPromise**: `Promise`<[`Contract`](verida_vda_name_client._internal_.Contract.md)\> - -#### Inherited from - -[BaseContract](verida_vda_name_client._internal_.BaseContract.md).[_deployedPromise](verida_vda_name_client._internal_.BaseContract.md#_deployedpromise) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:100 - -___ - -### \_runningEvents - -• **\_runningEvents**: `Object` - -#### Index signature - -▪ [eventTag: `string`]: [`RunningEvent`](verida_vda_name_client._internal_.RunningEvent.md) - -#### Inherited from - -[BaseContract](verida_vda_name_client._internal_.BaseContract.md).[_runningEvents](verida_vda_name_client._internal_.BaseContract.md#_runningevents) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:101 - -___ - -### \_wrappedEmits - -• **\_wrappedEmits**: `Object` - -#### Index signature - -▪ [eventTag: `string`]: (...`args`: `any`[]) => `void` - -#### Inherited from - -[BaseContract](verida_vda_name_client._internal_.BaseContract.md).[_wrappedEmits](verida_vda_name_client._internal_.BaseContract.md#_wrappedemits) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:104 - -___ - -### address - -• `Readonly` **address**: `string` - -#### Inherited from - -[BaseContract](verida_vda_name_client._internal_.BaseContract.md).[address](verida_vda_name_client._internal_.BaseContract.md#address) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:79 - -___ - -### callStatic - -• `Readonly` **callStatic**: `Object` - -#### Index signature - -▪ [name: `string`]: [`ContractFunction`](../modules/verida_vda_name_client._internal_.md#contractfunction) - -#### Inherited from - -[BaseContract](verida_vda_name_client._internal_.BaseContract.md).[callStatic](verida_vda_name_client._internal_.BaseContract.md#callstatic) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:86 - -___ - -### deployTransaction - -• `Readonly` **deployTransaction**: [`TransactionResponse`](../interfaces/verida_vda_name_client._internal_.TransactionResponse.md) - -#### Inherited from - -[BaseContract](verida_vda_name_client._internal_.BaseContract.md).[deployTransaction](verida_vda_name_client._internal_.BaseContract.md#deploytransaction) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:99 - -___ - -### estimateGas - -• `Readonly` **estimateGas**: `Object` - -#### Index signature - -▪ [name: `string`]: [`ContractFunction`](../modules/verida_vda_name_client._internal_.md#contractfunction)<[`BigNumber`](verida_vda_name_client._internal_.BigNumber.md)\> - -#### Inherited from - -[BaseContract](verida_vda_name_client._internal_.BaseContract.md).[estimateGas](verida_vda_name_client._internal_.BaseContract.md#estimategas) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:89 - -___ - -### filters - -• `Readonly` **filters**: `Object` - -#### Index signature - -▪ [name: `string`]: (...`args`: `any`[]) => [`EventFilter`](../modules/verida_vda_name_client._internal_.md#eventfilter) - -#### Inherited from - -[BaseContract](verida_vda_name_client._internal_.BaseContract.md).[filters](verida_vda_name_client._internal_.BaseContract.md#filters) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:95 - -___ - -### functions - -• `Readonly` **functions**: `Object` - -#### Index signature - -▪ [name: `string`]: [`ContractFunction`](../modules/verida_vda_name_client._internal_.md#contractfunction) - -#### Inherited from - -[BaseContract](verida_vda_name_client._internal_.BaseContract.md).[functions](verida_vda_name_client._internal_.BaseContract.md#functions) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:83 - -___ - -### interface - -• `Readonly` **interface**: [`Interface`](verida_vda_name_client._internal_.Interface.md) - -#### Inherited from - -[BaseContract](verida_vda_name_client._internal_.BaseContract.md).[interface](verida_vda_name_client._internal_.BaseContract.md#interface) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:80 - -___ - -### populateTransaction - -• `Readonly` **populateTransaction**: `Object` - -#### Index signature - -▪ [name: `string`]: [`ContractFunction`](../modules/verida_vda_name_client._internal_.md#contractfunction)<[`PopulatedTransaction`](../interfaces/verida_vda_name_client._internal_.PopulatedTransaction.md)\> - -#### Inherited from - -[BaseContract](verida_vda_name_client._internal_.BaseContract.md).[populateTransaction](verida_vda_name_client._internal_.BaseContract.md#populatetransaction) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:92 - -___ - -### provider - -• `Readonly` **provider**: [`Provider`](verida_vda_name_client._internal_.Provider.md) - -#### Inherited from - -[BaseContract](verida_vda_name_client._internal_.BaseContract.md).[provider](verida_vda_name_client._internal_.BaseContract.md#provider) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:82 - -___ - -### resolvedAddress - -• `Readonly` **resolvedAddress**: `Promise`<`string`\> - -#### Inherited from - -[BaseContract](verida_vda_name_client._internal_.BaseContract.md).[resolvedAddress](verida_vda_name_client._internal_.BaseContract.md#resolvedaddress) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:98 - -___ - -### signer - -• `Readonly` **signer**: [`Signer`](verida_vda_name_client._internal_.Signer.md) - -#### Inherited from - -[BaseContract](verida_vda_name_client._internal_.BaseContract.md).[signer](verida_vda_name_client._internal_.BaseContract.md#signer) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:81 - -## Methods - -### \_checkRunningEvents - -▸ **_checkRunningEvents**(`runningEvent`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `runningEvent` | [`RunningEvent`](verida_vda_name_client._internal_.RunningEvent.md) | - -#### Returns - -`void` - -#### Inherited from - -[BaseContract](verida_vda_name_client._internal_.BaseContract.md).[_checkRunningEvents](verida_vda_name_client._internal_.BaseContract.md#_checkrunningevents) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:121 - -___ - -### \_deployed - -▸ **_deployed**(`blockTag?`): `Promise`<[`Contract`](verida_vda_name_client._internal_.Contract.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `blockTag?` | [`BlockTag`](../modules/verida_vda_name_client._internal_.md#blocktag) | - -#### Returns - -`Promise`<[`Contract`](verida_vda_name_client._internal_.Contract.md)\> - -#### Inherited from - -[BaseContract](verida_vda_name_client._internal_.BaseContract.md).[_deployed](verida_vda_name_client._internal_.BaseContract.md#_deployed) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:114 - -___ - -### \_wrapEvent - -▸ **_wrapEvent**(`runningEvent`, `log`, `listener`): [`Event`](../interfaces/verida_vda_name_client._internal_.Event.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `runningEvent` | [`RunningEvent`](verida_vda_name_client._internal_.RunningEvent.md) | -| `log` | [`Log`](../interfaces/verida_vda_name_client._internal_.Log.md) | -| `listener` | [`Listener`](../modules/verida_vda_name_client._internal_.md#listener) | - -#### Returns - -[`Event`](../interfaces/verida_vda_name_client._internal_.Event.md) - -#### Inherited from - -[BaseContract](verida_vda_name_client._internal_.BaseContract.md).[_wrapEvent](verida_vda_name_client._internal_.BaseContract.md#_wrapevent) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:122 - -___ - -### attach - -▸ **attach**(`addressOrName`): [`Contract`](verida_vda_name_client._internal_.Contract.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `addressOrName` | `string` | - -#### Returns - -[`Contract`](verida_vda_name_client._internal_.Contract.md) - -#### Inherited from - -[BaseContract](verida_vda_name_client._internal_.BaseContract.md).[attach](verida_vda_name_client._internal_.BaseContract.md#attach) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:117 - -___ - -### connect - -▸ **connect**(`signerOrProvider`): [`Contract`](verida_vda_name_client._internal_.Contract.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `signerOrProvider` | `string` \| [`Signer`](verida_vda_name_client._internal_.Signer.md) \| [`Provider`](verida_vda_name_client._internal_.Provider.md) | - -#### Returns - -[`Contract`](verida_vda_name_client._internal_.Contract.md) - -#### Inherited from - -[BaseContract](verida_vda_name_client._internal_.BaseContract.md).[connect](verida_vda_name_client._internal_.BaseContract.md#connect) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:116 - -___ - -### deployed - -▸ **deployed**(): `Promise`<[`Contract`](verida_vda_name_client._internal_.Contract.md)\> - -#### Returns - -`Promise`<[`Contract`](verida_vda_name_client._internal_.Contract.md)\> - -#### Inherited from - -[BaseContract](verida_vda_name_client._internal_.BaseContract.md).[deployed](verida_vda_name_client._internal_.BaseContract.md#deployed) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:113 - -___ - -### emit - -▸ **emit**(`eventName`, ...`args`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | `string` \| [`EventFilter`](../modules/verida_vda_name_client._internal_.md#eventfilter) | -| `...args` | `any`[] | - -#### Returns - -`boolean` - -#### Inherited from - -[BaseContract](verida_vda_name_client._internal_.BaseContract.md).[emit](verida_vda_name_client._internal_.BaseContract.md#emit) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:127 - -___ - -### fallback - -▸ **fallback**(`overrides?`): `Promise`<[`TransactionResponse`](../interfaces/verida_vda_name_client._internal_.TransactionResponse.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `overrides?` | [`TransactionRequest`](../modules/verida_vda_name_client._internal_.md#transactionrequest) | - -#### Returns - -`Promise`<[`TransactionResponse`](../interfaces/verida_vda_name_client._internal_.TransactionResponse.md)\> - -#### Inherited from - -[BaseContract](verida_vda_name_client._internal_.BaseContract.md).[fallback](verida_vda_name_client._internal_.BaseContract.md#fallback) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:115 - -___ - -### listenerCount - -▸ **listenerCount**(`eventName?`): `number` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName?` | `string` \| [`EventFilter`](../modules/verida_vda_name_client._internal_.md#eventfilter) | - -#### Returns - -`number` - -#### Inherited from - -[BaseContract](verida_vda_name_client._internal_.BaseContract.md).[listenerCount](verida_vda_name_client._internal_.BaseContract.md#listenercount) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:128 - -___ - -### listeners - -▸ **listeners**(`eventName?`): [`Listener`](../modules/verida_vda_name_client._internal_.md#listener)[] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName?` | `string` \| [`EventFilter`](../modules/verida_vda_name_client._internal_.md#eventfilter) | - -#### Returns - -[`Listener`](../modules/verida_vda_name_client._internal_.md#listener)[] - -#### Inherited from - -[BaseContract](verida_vda_name_client._internal_.BaseContract.md).[listeners](verida_vda_name_client._internal_.BaseContract.md#listeners) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:129 - -___ - -### off - -▸ **off**(`eventName`, `listener`): [`Contract`](verida_vda_name_client._internal_.Contract.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | `string` \| [`EventFilter`](../modules/verida_vda_name_client._internal_.md#eventfilter) | -| `listener` | [`Listener`](../modules/verida_vda_name_client._internal_.md#listener) | - -#### Returns - -[`Contract`](verida_vda_name_client._internal_.Contract.md) - -#### Inherited from - -[BaseContract](verida_vda_name_client._internal_.BaseContract.md).[off](verida_vda_name_client._internal_.BaseContract.md#off) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:131 - -___ - -### on - -▸ **on**(`event`, `listener`): [`Contract`](verida_vda_name_client._internal_.Contract.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | `string` \| [`EventFilter`](../modules/verida_vda_name_client._internal_.md#eventfilter) | -| `listener` | [`Listener`](../modules/verida_vda_name_client._internal_.md#listener) | - -#### Returns - -[`Contract`](verida_vda_name_client._internal_.Contract.md) - -#### Inherited from - -[BaseContract](verida_vda_name_client._internal_.BaseContract.md).[on](verida_vda_name_client._internal_.BaseContract.md#on) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:125 - -___ - -### once - -▸ **once**(`event`, `listener`): [`Contract`](verida_vda_name_client._internal_.Contract.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | `string` \| [`EventFilter`](../modules/verida_vda_name_client._internal_.md#eventfilter) | -| `listener` | [`Listener`](../modules/verida_vda_name_client._internal_.md#listener) | - -#### Returns - -[`Contract`](verida_vda_name_client._internal_.Contract.md) - -#### Inherited from - -[BaseContract](verida_vda_name_client._internal_.BaseContract.md).[once](verida_vda_name_client._internal_.BaseContract.md#once) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:126 - -___ - -### queryFilter - -▸ **queryFilter**(`event`, `fromBlockOrBlockhash?`, `toBlock?`): `Promise`<[`Event`](../interfaces/verida_vda_name_client._internal_.Event.md)[]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | `string` \| [`EventFilter`](../modules/verida_vda_name_client._internal_.md#eventfilter) | -| `fromBlockOrBlockhash?` | [`BlockTag`](../modules/verida_vda_name_client._internal_.md#blocktag) | -| `toBlock?` | [`BlockTag`](../modules/verida_vda_name_client._internal_.md#blocktag) | - -#### Returns - -`Promise`<[`Event`](../interfaces/verida_vda_name_client._internal_.Event.md)[]\> - -#### Inherited from - -[BaseContract](verida_vda_name_client._internal_.BaseContract.md).[queryFilter](verida_vda_name_client._internal_.BaseContract.md#queryfilter) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:124 - -___ - -### removeAllListeners - -▸ **removeAllListeners**(`eventName?`): [`Contract`](verida_vda_name_client._internal_.Contract.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName?` | `string` \| [`EventFilter`](../modules/verida_vda_name_client._internal_.md#eventfilter) | - -#### Returns - -[`Contract`](verida_vda_name_client._internal_.Contract.md) - -#### Inherited from - -[BaseContract](verida_vda_name_client._internal_.BaseContract.md).[removeAllListeners](verida_vda_name_client._internal_.BaseContract.md#removealllisteners) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:130 - -___ - -### removeListener - -▸ **removeListener**(`eventName`, `listener`): [`Contract`](verida_vda_name_client._internal_.Contract.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | `string` \| [`EventFilter`](../modules/verida_vda_name_client._internal_.md#eventfilter) | -| `listener` | [`Listener`](../modules/verida_vda_name_client._internal_.md#listener) | - -#### Returns - -[`Contract`](verida_vda_name_client._internal_.Contract.md) - -#### Inherited from - -[BaseContract](verida_vda_name_client._internal_.BaseContract.md).[removeListener](verida_vda_name_client._internal_.BaseContract.md#removelistener) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:132 - -___ - -### getContractAddress - -▸ `Static` **getContractAddress**(`transaction`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transaction` | `Object` | -| `transaction.from` | `string` | -| `transaction.nonce` | [`BigNumberish`](../modules/verida_vda_name_client._internal_.md#bignumberish) | - -#### Returns - -`string` - -#### Inherited from - -[BaseContract](verida_vda_name_client._internal_.BaseContract.md).[getContractAddress](verida_vda_name_client._internal_.BaseContract.md#getcontractaddress) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:108 - -___ - -### getInterface - -▸ `Static` **getInterface**(`contractInterface`): [`Interface`](verida_vda_name_client._internal_.Interface.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contractInterface` | [`ContractInterface`](../modules/verida_vda_name_client._internal_.md#contractinterface) | - -#### Returns - -[`Interface`](verida_vda_name_client._internal_.Interface.md) - -#### Inherited from - -[BaseContract](verida_vda_name_client._internal_.BaseContract.md).[getInterface](verida_vda_name_client._internal_.BaseContract.md#getinterface) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:112 - -___ - -### isIndexed - -▸ `Static` **isIndexed**(`value`): value is Indexed - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `any` | - -#### Returns - -value is Indexed - -#### Inherited from - -[BaseContract](verida_vda_name_client._internal_.BaseContract.md).[isIndexed](verida_vda_name_client._internal_.BaseContract.md#isindexed) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:118 diff --git a/docs/api/verida-js/classes/verida_vda_name_client._internal_.Description.md b/docs/api/verida-js/classes/verida_vda_name_client._internal_.Description.md deleted file mode 100644 index 86c91de..0000000 --- a/docs/api/verida-js/classes/verida_vda_name_client._internal_.Description.md +++ /dev/null @@ -1,53 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-name-client](../modules/verida_vda_name_client.md) / [](../modules/verida_vda_name_client._internal_.md) / Description - -# Class: Description - -[@verida/vda-name-client](../modules/verida_vda_name_client.md).[](../modules/verida_vda_name_client._internal_.md).Description - -## Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `any` | - -## Hierarchy - -- **`Description`** - - ↳ [`Indexed`](verida_vda_name_client._internal_.Indexed.md) - - ↳ [`TransactionDescription`](verida_vda_name_client._internal_.TransactionDescription.md) - - ↳ [`LogDescription`](verida_vda_name_client._internal_.LogDescription.md) - - ↳ [`ErrorDescription`](verida_vda_name_client._internal_.ErrorDescription.md) - - ↳ [`ForkEvent`](verida_vda_name_client._internal_.ForkEvent.md) - -## Table of contents - -### Constructors - -- [constructor](verida_vda_name_client._internal_.Description.md#constructor) - -## Constructors - -### constructor - -• **new Description**<`T`\>(`info`) - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `any` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `info` | { [K in string \| number \| symbol]: T[K] } | - -#### Defined in - -node_modules/@ethersproject/properties/lib/index.d.ts:13 diff --git a/docs/api/verida-js/classes/verida_vda_name_client._internal_.ErrorDescription.md b/docs/api/verida-js/classes/verida_vda_name_client._internal_.ErrorDescription.md deleted file mode 100644 index ca8b400..0000000 --- a/docs/api/verida-js/classes/verida_vda_name_client._internal_.ErrorDescription.md +++ /dev/null @@ -1,100 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-name-client](../modules/verida_vda_name_client.md) / [](../modules/verida_vda_name_client._internal_.md) / ErrorDescription - -# Class: ErrorDescription - -[@verida/vda-name-client](../modules/verida_vda_name_client.md).[](../modules/verida_vda_name_client._internal_.md).ErrorDescription - -## Hierarchy - -- [`Description`](verida_vda_name_client._internal_.Description.md)<[`ErrorDescription`](verida_vda_name_client._internal_.ErrorDescription.md)\> - - ↳ **`ErrorDescription`** - -## Table of contents - -### Constructors - -- [constructor](verida_vda_name_client._internal_.ErrorDescription.md#constructor) - -### Properties - -- [args](verida_vda_name_client._internal_.ErrorDescription.md#args) -- [errorFragment](verida_vda_name_client._internal_.ErrorDescription.md#errorfragment) -- [name](verida_vda_name_client._internal_.ErrorDescription.md#name) -- [sighash](verida_vda_name_client._internal_.ErrorDescription.md#sighash) -- [signature](verida_vda_name_client._internal_.ErrorDescription.md#signature) - -## Constructors - -### constructor - -• **new ErrorDescription**(`info`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `info` | `Object` | -| `info.args` | [`Result`](../interfaces/verida_vda_name_client._internal_.Result.md) | -| `info.errorFragment` | [`ErrorFragment`](verida_vda_name_client._internal_.ErrorFragment.md) | -| `info.name` | `string` | -| `info.sighash` | `string` | -| `info.signature` | `string` | - -#### Inherited from - -[Description](verida_vda_name_client._internal_.Description.md).[constructor](verida_vda_name_client._internal_.Description.md#constructor) - -#### Defined in - -node_modules/@ethersproject/properties/lib/index.d.ts:13 - -## Properties - -### args - -• `Readonly` **args**: [`Result`](../interfaces/verida_vda_name_client._internal_.Result.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:26 - -___ - -### errorFragment - -• `Readonly` **errorFragment**: [`ErrorFragment`](verida_vda_name_client._internal_.ErrorFragment.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:24 - -___ - -### name - -• `Readonly` **name**: `string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:25 - -___ - -### sighash - -• `Readonly` **sighash**: `string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:28 - -___ - -### signature - -• `Readonly` **signature**: `string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:27 diff --git a/docs/api/verida-js/classes/verida_vda_name_client._internal_.ErrorFragment.md b/docs/api/verida-js/classes/verida_vda_name_client._internal_.ErrorFragment.md deleted file mode 100644 index 257905c..0000000 --- a/docs/api/verida-js/classes/verida_vda_name_client._internal_.ErrorFragment.md +++ /dev/null @@ -1,250 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-name-client](../modules/verida_vda_name_client.md) / [](../modules/verida_vda_name_client._internal_.md) / ErrorFragment - -# Class: ErrorFragment - -[@verida/vda-name-client](../modules/verida_vda_name_client.md).[](../modules/verida_vda_name_client._internal_.md).ErrorFragment - -## Hierarchy - -- [`Fragment`](verida_vda_name_client._internal_.Fragment.md) - - ↳ **`ErrorFragment`** - -## Table of contents - -### Constructors - -- [constructor](verida_vda_name_client._internal_.ErrorFragment.md#constructor) - -### Properties - -- [\_isFragment](verida_vda_name_client._internal_.ErrorFragment.md#_isfragment) -- [inputs](verida_vda_name_client._internal_.ErrorFragment.md#inputs) -- [name](verida_vda_name_client._internal_.ErrorFragment.md#name) -- [type](verida_vda_name_client._internal_.ErrorFragment.md#type) - -### Methods - -- [format](verida_vda_name_client._internal_.ErrorFragment.md#format) -- [from](verida_vda_name_client._internal_.ErrorFragment.md#from) -- [fromObject](verida_vda_name_client._internal_.ErrorFragment.md#fromobject) -- [fromString](verida_vda_name_client._internal_.ErrorFragment.md#fromstring) -- [isErrorFragment](verida_vda_name_client._internal_.ErrorFragment.md#iserrorfragment) -- [isFragment](verida_vda_name_client._internal_.ErrorFragment.md#isfragment) - -## Constructors - -### constructor - -• **new ErrorFragment**(`constructorGuard`, `params`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `constructorGuard` | `any` | -| `params` | `any` | - -#### Inherited from - -[Fragment](verida_vda_name_client._internal_.Fragment.md).[constructor](verida_vda_name_client._internal_.Fragment.md#constructor) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:44 - -## Properties - -### \_isFragment - -• `Readonly` **\_isFragment**: `boolean` - -#### Inherited from - -[Fragment](verida_vda_name_client._internal_.Fragment.md).[_isFragment](verida_vda_name_client._internal_.Fragment.md#_isfragment) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:43 - -___ - -### inputs - -• `Readonly` **inputs**: [`ParamType`](verida_vda_name_client._internal_.ParamType.md)[] - -#### Inherited from - -[Fragment](verida_vda_name_client._internal_.Fragment.md).[inputs](verida_vda_name_client._internal_.Fragment.md#inputs) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:42 - -___ - -### name - -• `Readonly` **name**: `string` - -#### Inherited from - -[Fragment](verida_vda_name_client._internal_.Fragment.md).[name](verida_vda_name_client._internal_.Fragment.md#name) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:41 - -___ - -### type - -• `Readonly` **type**: `string` - -#### Inherited from - -[Fragment](verida_vda_name_client._internal_.Fragment.md).[type](verida_vda_name_client._internal_.Fragment.md#type) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:40 - -## Methods - -### format - -▸ **format**(`format?`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `format?` | `string` | - -#### Returns - -`string` - -#### Overrides - -[Fragment](verida_vda_name_client._internal_.Fragment.md).[format](verida_vda_name_client._internal_.Fragment.md#format) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:79 - -___ - -### from - -▸ `Static` **from**(`value`): [`ErrorFragment`](verida_vda_name_client._internal_.ErrorFragment.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `string` \| [`JsonFragment`](../interfaces/verida_vda_name_client._internal_.JsonFragment.md) \| [`ErrorFragment`](verida_vda_name_client._internal_.ErrorFragment.md) | - -#### Returns - -[`ErrorFragment`](verida_vda_name_client._internal_.ErrorFragment.md) - -#### Overrides - -[Fragment](verida_vda_name_client._internal_.Fragment.md).[from](verida_vda_name_client._internal_.Fragment.md#from) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:80 - -___ - -### fromObject - -▸ `Static` **fromObject**(`value`): [`ErrorFragment`](verida_vda_name_client._internal_.ErrorFragment.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | [`JsonFragment`](../interfaces/verida_vda_name_client._internal_.JsonFragment.md) \| [`ErrorFragment`](verida_vda_name_client._internal_.ErrorFragment.md) | - -#### Returns - -[`ErrorFragment`](verida_vda_name_client._internal_.ErrorFragment.md) - -#### Overrides - -[Fragment](verida_vda_name_client._internal_.Fragment.md).[fromObject](verida_vda_name_client._internal_.Fragment.md#fromobject) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:81 - -___ - -### fromString - -▸ `Static` **fromString**(`value`): [`ErrorFragment`](verida_vda_name_client._internal_.ErrorFragment.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `string` | - -#### Returns - -[`ErrorFragment`](verida_vda_name_client._internal_.ErrorFragment.md) - -#### Overrides - -[Fragment](verida_vda_name_client._internal_.Fragment.md).[fromString](verida_vda_name_client._internal_.Fragment.md#fromstring) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:82 - -___ - -### isErrorFragment - -▸ `Static` **isErrorFragment**(`value`): value is ErrorFragment - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `any` | - -#### Returns - -value is ErrorFragment - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:83 - -___ - -### isFragment - -▸ `Static` **isFragment**(`value`): value is Fragment - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `any` | - -#### Returns - -value is Fragment - -#### Inherited from - -[Fragment](verida_vda_name_client._internal_.Fragment.md).[isFragment](verida_vda_name_client._internal_.Fragment.md#isfragment) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:49 diff --git a/docs/api/verida-js/classes/verida_vda_name_client._internal_.EventFragment.md b/docs/api/verida-js/classes/verida_vda_name_client._internal_.EventFragment.md deleted file mode 100644 index 2b41e74..0000000 --- a/docs/api/verida-js/classes/verida_vda_name_client._internal_.EventFragment.md +++ /dev/null @@ -1,261 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-name-client](../modules/verida_vda_name_client.md) / [](../modules/verida_vda_name_client._internal_.md) / EventFragment - -# Class: EventFragment - -[@verida/vda-name-client](../modules/verida_vda_name_client.md).[](../modules/verida_vda_name_client._internal_.md).EventFragment - -## Hierarchy - -- [`Fragment`](verida_vda_name_client._internal_.Fragment.md) - - ↳ **`EventFragment`** - -## Table of contents - -### Constructors - -- [constructor](verida_vda_name_client._internal_.EventFragment.md#constructor) - -### Properties - -- [\_isFragment](verida_vda_name_client._internal_.EventFragment.md#_isfragment) -- [anonymous](verida_vda_name_client._internal_.EventFragment.md#anonymous) -- [inputs](verida_vda_name_client._internal_.EventFragment.md#inputs) -- [name](verida_vda_name_client._internal_.EventFragment.md#name) -- [type](verida_vda_name_client._internal_.EventFragment.md#type) - -### Methods - -- [format](verida_vda_name_client._internal_.EventFragment.md#format) -- [from](verida_vda_name_client._internal_.EventFragment.md#from) -- [fromObject](verida_vda_name_client._internal_.EventFragment.md#fromobject) -- [fromString](verida_vda_name_client._internal_.EventFragment.md#fromstring) -- [isEventFragment](verida_vda_name_client._internal_.EventFragment.md#iseventfragment) -- [isFragment](verida_vda_name_client._internal_.EventFragment.md#isfragment) - -## Constructors - -### constructor - -• **new EventFragment**(`constructorGuard`, `params`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `constructorGuard` | `any` | -| `params` | `any` | - -#### Inherited from - -[Fragment](verida_vda_name_client._internal_.Fragment.md).[constructor](verida_vda_name_client._internal_.Fragment.md#constructor) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:44 - -## Properties - -### \_isFragment - -• `Readonly` **\_isFragment**: `boolean` - -#### Inherited from - -[Fragment](verida_vda_name_client._internal_.Fragment.md).[_isFragment](verida_vda_name_client._internal_.Fragment.md#_isfragment) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:43 - -___ - -### anonymous - -• `Readonly` **anonymous**: `boolean` - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:52 - -___ - -### inputs - -• `Readonly` **inputs**: [`ParamType`](verida_vda_name_client._internal_.ParamType.md)[] - -#### Inherited from - -[Fragment](verida_vda_name_client._internal_.Fragment.md).[inputs](verida_vda_name_client._internal_.Fragment.md#inputs) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:42 - -___ - -### name - -• `Readonly` **name**: `string` - -#### Inherited from - -[Fragment](verida_vda_name_client._internal_.Fragment.md).[name](verida_vda_name_client._internal_.Fragment.md#name) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:41 - -___ - -### type - -• `Readonly` **type**: `string` - -#### Inherited from - -[Fragment](verida_vda_name_client._internal_.Fragment.md).[type](verida_vda_name_client._internal_.Fragment.md#type) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:40 - -## Methods - -### format - -▸ **format**(`format?`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `format?` | `string` | - -#### Returns - -`string` - -#### Overrides - -[Fragment](verida_vda_name_client._internal_.Fragment.md).[format](verida_vda_name_client._internal_.Fragment.md#format) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:53 - -___ - -### from - -▸ `Static` **from**(`value`): [`EventFragment`](verida_vda_name_client._internal_.EventFragment.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `string` \| [`JsonFragment`](../interfaces/verida_vda_name_client._internal_.JsonFragment.md) \| [`EventFragment`](verida_vda_name_client._internal_.EventFragment.md) | - -#### Returns - -[`EventFragment`](verida_vda_name_client._internal_.EventFragment.md) - -#### Overrides - -[Fragment](verida_vda_name_client._internal_.Fragment.md).[from](verida_vda_name_client._internal_.Fragment.md#from) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:54 - -___ - -### fromObject - -▸ `Static` **fromObject**(`value`): [`EventFragment`](verida_vda_name_client._internal_.EventFragment.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | [`JsonFragment`](../interfaces/verida_vda_name_client._internal_.JsonFragment.md) \| [`EventFragment`](verida_vda_name_client._internal_.EventFragment.md) | - -#### Returns - -[`EventFragment`](verida_vda_name_client._internal_.EventFragment.md) - -#### Overrides - -[Fragment](verida_vda_name_client._internal_.Fragment.md).[fromObject](verida_vda_name_client._internal_.Fragment.md#fromobject) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:55 - -___ - -### fromString - -▸ `Static` **fromString**(`value`): [`EventFragment`](verida_vda_name_client._internal_.EventFragment.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `string` | - -#### Returns - -[`EventFragment`](verida_vda_name_client._internal_.EventFragment.md) - -#### Overrides - -[Fragment](verida_vda_name_client._internal_.Fragment.md).[fromString](verida_vda_name_client._internal_.Fragment.md#fromstring) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:56 - -___ - -### isEventFragment - -▸ `Static` **isEventFragment**(`value`): value is EventFragment - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `any` | - -#### Returns - -value is EventFragment - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:57 - -___ - -### isFragment - -▸ `Static` **isFragment**(`value`): value is Fragment - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `any` | - -#### Returns - -value is Fragment - -#### Inherited from - -[Fragment](verida_vda_name_client._internal_.Fragment.md).[isFragment](verida_vda_name_client._internal_.Fragment.md#isfragment) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:49 diff --git a/docs/api/verida-js/classes/verida_vda_name_client._internal_.ForkEvent.md b/docs/api/verida-js/classes/verida_vda_name_client._internal_.ForkEvent.md deleted file mode 100644 index b81580c..0000000 --- a/docs/api/verida-js/classes/verida_vda_name_client._internal_.ForkEvent.md +++ /dev/null @@ -1,86 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-name-client](../modules/verida_vda_name_client.md) / [](../modules/verida_vda_name_client._internal_.md) / ForkEvent - -# Class: ForkEvent - -[@verida/vda-name-client](../modules/verida_vda_name_client.md).[](../modules/verida_vda_name_client._internal_.md).ForkEvent - -## Hierarchy - -- [`Description`](verida_vda_name_client._internal_.Description.md) - - ↳ **`ForkEvent`** - -## Table of contents - -### Constructors - -- [constructor](verida_vda_name_client._internal_.ForkEvent.md#constructor) - -### Properties - -- [\_isForkEvent](verida_vda_name_client._internal_.ForkEvent.md#_isforkevent) -- [expiry](verida_vda_name_client._internal_.ForkEvent.md#expiry) - -### Methods - -- [isForkEvent](verida_vda_name_client._internal_.ForkEvent.md#isforkevent) - -## Constructors - -### constructor - -• **new ForkEvent**(`info`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `info` | `Object` | - -#### Inherited from - -[Description](verida_vda_name_client._internal_.Description.md).[constructor](verida_vda_name_client._internal_.Description.md#constructor) - -#### Defined in - -node_modules/@ethersproject/properties/lib/index.d.ts:13 - -## Properties - -### \_isForkEvent - -• `Optional` `Readonly` **\_isForkEvent**: `boolean` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:103 - -___ - -### expiry - -• `Readonly` **expiry**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:102 - -## Methods - -### isForkEvent - -▸ `Static` **isForkEvent**(`value`): value is ForkEvent - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `any` | - -#### Returns - -value is ForkEvent - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:104 diff --git a/docs/api/verida-js/classes/verida_vda_name_client._internal_.Fragment.md b/docs/api/verida-js/classes/verida_vda_name_client._internal_.Fragment.md deleted file mode 100644 index 5f2f0ec..0000000 --- a/docs/api/verida-js/classes/verida_vda_name_client._internal_.Fragment.md +++ /dev/null @@ -1,193 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-name-client](../modules/verida_vda_name_client.md) / [](../modules/verida_vda_name_client._internal_.md) / Fragment - -# Class: Fragment - -[@verida/vda-name-client](../modules/verida_vda_name_client.md).[](../modules/verida_vda_name_client._internal_.md).Fragment - -## Hierarchy - -- **`Fragment`** - - ↳ [`ConstructorFragment`](verida_vda_name_client._internal_.ConstructorFragment.md) - - ↳ [`EventFragment`](verida_vda_name_client._internal_.EventFragment.md) - - ↳ [`ErrorFragment`](verida_vda_name_client._internal_.ErrorFragment.md) - -## Table of contents - -### Constructors - -- [constructor](verida_vda_name_client._internal_.Fragment.md#constructor) - -### Properties - -- [\_isFragment](verida_vda_name_client._internal_.Fragment.md#_isfragment) -- [inputs](verida_vda_name_client._internal_.Fragment.md#inputs) -- [name](verida_vda_name_client._internal_.Fragment.md#name) -- [type](verida_vda_name_client._internal_.Fragment.md#type) - -### Methods - -- [format](verida_vda_name_client._internal_.Fragment.md#format) -- [from](verida_vda_name_client._internal_.Fragment.md#from) -- [fromObject](verida_vda_name_client._internal_.Fragment.md#fromobject) -- [fromString](verida_vda_name_client._internal_.Fragment.md#fromstring) -- [isFragment](verida_vda_name_client._internal_.Fragment.md#isfragment) - -## Constructors - -### constructor - -• **new Fragment**(`constructorGuard`, `params`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `constructorGuard` | `any` | -| `params` | `any` | - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:44 - -## Properties - -### \_isFragment - -• `Readonly` **\_isFragment**: `boolean` - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:43 - -___ - -### inputs - -• `Readonly` **inputs**: [`ParamType`](verida_vda_name_client._internal_.ParamType.md)[] - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:42 - -___ - -### name - -• `Readonly` **name**: `string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:41 - -___ - -### type - -• `Readonly` **type**: `string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:40 - -## Methods - -### format - -▸ `Abstract` **format**(`format?`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `format?` | `string` | - -#### Returns - -`string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:45 - -___ - -### from - -▸ `Static` **from**(`value`): [`Fragment`](verida_vda_name_client._internal_.Fragment.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `string` \| [`Fragment`](verida_vda_name_client._internal_.Fragment.md) \| [`JsonFragment`](../interfaces/verida_vda_name_client._internal_.JsonFragment.md) | - -#### Returns - -[`Fragment`](verida_vda_name_client._internal_.Fragment.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:46 - -___ - -### fromObject - -▸ `Static` **fromObject**(`value`): [`Fragment`](verida_vda_name_client._internal_.Fragment.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | [`Fragment`](verida_vda_name_client._internal_.Fragment.md) \| [`JsonFragment`](../interfaces/verida_vda_name_client._internal_.JsonFragment.md) | - -#### Returns - -[`Fragment`](verida_vda_name_client._internal_.Fragment.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:47 - -___ - -### fromString - -▸ `Static` **fromString**(`value`): [`Fragment`](verida_vda_name_client._internal_.Fragment.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `string` | - -#### Returns - -[`Fragment`](verida_vda_name_client._internal_.Fragment.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:48 - -___ - -### isFragment - -▸ `Static` **isFragment**(`value`): value is Fragment - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `any` | - -#### Returns - -value is Fragment - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:49 diff --git a/docs/api/verida-js/classes/verida_vda_name_client._internal_.FunctionFragment.md b/docs/api/verida-js/classes/verida_vda_name_client._internal_.FunctionFragment.md deleted file mode 100644 index 8640874..0000000 --- a/docs/api/verida-js/classes/verida_vda_name_client._internal_.FunctionFragment.md +++ /dev/null @@ -1,342 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-name-client](../modules/verida_vda_name_client.md) / [](../modules/verida_vda_name_client._internal_.md) / FunctionFragment - -# Class: FunctionFragment - -[@verida/vda-name-client](../modules/verida_vda_name_client.md).[](../modules/verida_vda_name_client._internal_.md).FunctionFragment - -## Hierarchy - -- [`ConstructorFragment`](verida_vda_name_client._internal_.ConstructorFragment.md) - - ↳ **`FunctionFragment`** - -## Table of contents - -### Constructors - -- [constructor](verida_vda_name_client._internal_.FunctionFragment.md#constructor) - -### Properties - -- [\_isFragment](verida_vda_name_client._internal_.FunctionFragment.md#_isfragment) -- [constant](verida_vda_name_client._internal_.FunctionFragment.md#constant) -- [gas](verida_vda_name_client._internal_.FunctionFragment.md#gas) -- [inputs](verida_vda_name_client._internal_.FunctionFragment.md#inputs) -- [name](verida_vda_name_client._internal_.FunctionFragment.md#name) -- [outputs](verida_vda_name_client._internal_.FunctionFragment.md#outputs) -- [payable](verida_vda_name_client._internal_.FunctionFragment.md#payable) -- [stateMutability](verida_vda_name_client._internal_.FunctionFragment.md#statemutability) -- [type](verida_vda_name_client._internal_.FunctionFragment.md#type) - -### Methods - -- [format](verida_vda_name_client._internal_.FunctionFragment.md#format) -- [from](verida_vda_name_client._internal_.FunctionFragment.md#from) -- [fromObject](verida_vda_name_client._internal_.FunctionFragment.md#fromobject) -- [fromString](verida_vda_name_client._internal_.FunctionFragment.md#fromstring) -- [isConstructorFragment](verida_vda_name_client._internal_.FunctionFragment.md#isconstructorfragment) -- [isFragment](verida_vda_name_client._internal_.FunctionFragment.md#isfragment) -- [isFunctionFragment](verida_vda_name_client._internal_.FunctionFragment.md#isfunctionfragment) - -## Constructors - -### constructor - -• **new FunctionFragment**(`constructorGuard`, `params`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `constructorGuard` | `any` | -| `params` | `any` | - -#### Inherited from - -[ConstructorFragment](verida_vda_name_client._internal_.ConstructorFragment.md).[constructor](verida_vda_name_client._internal_.ConstructorFragment.md#constructor) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:44 - -## Properties - -### \_isFragment - -• `Readonly` **\_isFragment**: `boolean` - -#### Inherited from - -[ConstructorFragment](verida_vda_name_client._internal_.ConstructorFragment.md).[_isFragment](verida_vda_name_client._internal_.ConstructorFragment.md#_isfragment) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:43 - -___ - -### constant - -• **constant**: `boolean` - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:70 - -___ - -### gas - -• `Optional` **gas**: [`BigNumber`](verida_vda_name_client._internal_.BigNumber.md) - -#### Inherited from - -[ConstructorFragment](verida_vda_name_client._internal_.ConstructorFragment.md).[gas](verida_vda_name_client._internal_.ConstructorFragment.md#gas) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:62 - -___ - -### inputs - -• `Readonly` **inputs**: [`ParamType`](verida_vda_name_client._internal_.ParamType.md)[] - -#### Inherited from - -[ConstructorFragment](verida_vda_name_client._internal_.ConstructorFragment.md).[inputs](verida_vda_name_client._internal_.ConstructorFragment.md#inputs) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:42 - -___ - -### name - -• `Readonly` **name**: `string` - -#### Inherited from - -[ConstructorFragment](verida_vda_name_client._internal_.ConstructorFragment.md).[name](verida_vda_name_client._internal_.ConstructorFragment.md#name) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:41 - -___ - -### outputs - -• `Optional` **outputs**: [`ParamType`](verida_vda_name_client._internal_.ParamType.md)[] - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:71 - -___ - -### payable - -• **payable**: `boolean` - -#### Inherited from - -[ConstructorFragment](verida_vda_name_client._internal_.ConstructorFragment.md).[payable](verida_vda_name_client._internal_.ConstructorFragment.md#payable) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:61 - -___ - -### stateMutability - -• **stateMutability**: `string` - -#### Inherited from - -[ConstructorFragment](verida_vda_name_client._internal_.ConstructorFragment.md).[stateMutability](verida_vda_name_client._internal_.ConstructorFragment.md#statemutability) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:60 - -___ - -### type - -• `Readonly` **type**: `string` - -#### Inherited from - -[ConstructorFragment](verida_vda_name_client._internal_.ConstructorFragment.md).[type](verida_vda_name_client._internal_.ConstructorFragment.md#type) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:40 - -## Methods - -### format - -▸ **format**(`format?`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `format?` | `string` | - -#### Returns - -`string` - -#### Overrides - -[ConstructorFragment](verida_vda_name_client._internal_.ConstructorFragment.md).[format](verida_vda_name_client._internal_.ConstructorFragment.md#format) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:72 - -___ - -### from - -▸ `Static` **from**(`value`): [`FunctionFragment`](verida_vda_name_client._internal_.FunctionFragment.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `string` \| [`JsonFragment`](../interfaces/verida_vda_name_client._internal_.JsonFragment.md) \| [`FunctionFragment`](verida_vda_name_client._internal_.FunctionFragment.md) | - -#### Returns - -[`FunctionFragment`](verida_vda_name_client._internal_.FunctionFragment.md) - -#### Overrides - -[ConstructorFragment](verida_vda_name_client._internal_.ConstructorFragment.md).[from](verida_vda_name_client._internal_.ConstructorFragment.md#from) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:73 - -___ - -### fromObject - -▸ `Static` **fromObject**(`value`): [`FunctionFragment`](verida_vda_name_client._internal_.FunctionFragment.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | [`JsonFragment`](../interfaces/verida_vda_name_client._internal_.JsonFragment.md) \| [`FunctionFragment`](verida_vda_name_client._internal_.FunctionFragment.md) | - -#### Returns - -[`FunctionFragment`](verida_vda_name_client._internal_.FunctionFragment.md) - -#### Overrides - -[ConstructorFragment](verida_vda_name_client._internal_.ConstructorFragment.md).[fromObject](verida_vda_name_client._internal_.ConstructorFragment.md#fromobject) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:74 - -___ - -### fromString - -▸ `Static` **fromString**(`value`): [`FunctionFragment`](verida_vda_name_client._internal_.FunctionFragment.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `string` | - -#### Returns - -[`FunctionFragment`](verida_vda_name_client._internal_.FunctionFragment.md) - -#### Overrides - -[ConstructorFragment](verida_vda_name_client._internal_.ConstructorFragment.md).[fromString](verida_vda_name_client._internal_.ConstructorFragment.md#fromstring) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:75 - -___ - -### isConstructorFragment - -▸ `Static` **isConstructorFragment**(`value`): value is ConstructorFragment - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `any` | - -#### Returns - -value is ConstructorFragment - -#### Inherited from - -[ConstructorFragment](verida_vda_name_client._internal_.ConstructorFragment.md).[isConstructorFragment](verida_vda_name_client._internal_.ConstructorFragment.md#isconstructorfragment) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:67 - -___ - -### isFragment - -▸ `Static` **isFragment**(`value`): value is Fragment - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `any` | - -#### Returns - -value is Fragment - -#### Inherited from - -[ConstructorFragment](verida_vda_name_client._internal_.ConstructorFragment.md).[isFragment](verida_vda_name_client._internal_.ConstructorFragment.md#isfragment) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:49 - -___ - -### isFunctionFragment - -▸ `Static` **isFunctionFragment**(`value`): value is FunctionFragment - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `any` | - -#### Returns - -value is FunctionFragment - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:76 diff --git a/docs/api/verida-js/classes/verida_vda_name_client._internal_.Indexed.md b/docs/api/verida-js/classes/verida_vda_name_client._internal_.Indexed.md deleted file mode 100644 index b04cc6a..0000000 --- a/docs/api/verida-js/classes/verida_vda_name_client._internal_.Indexed.md +++ /dev/null @@ -1,88 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-name-client](../modules/verida_vda_name_client.md) / [](../modules/verida_vda_name_client._internal_.md) / Indexed - -# Class: Indexed - -[@verida/vda-name-client](../modules/verida_vda_name_client.md).[](../modules/verida_vda_name_client._internal_.md).Indexed - -## Hierarchy - -- [`Description`](verida_vda_name_client._internal_.Description.md)<[`Indexed`](verida_vda_name_client._internal_.Indexed.md)\> - - ↳ **`Indexed`** - -## Table of contents - -### Constructors - -- [constructor](verida_vda_name_client._internal_.Indexed.md#constructor) - -### Properties - -- [\_isIndexed](verida_vda_name_client._internal_.Indexed.md#_isindexed) -- [hash](verida_vda_name_client._internal_.Indexed.md#hash) - -### Methods - -- [isIndexed](verida_vda_name_client._internal_.Indexed.md#isindexed) - -## Constructors - -### constructor - -• **new Indexed**(`info`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `info` | `Object` | -| `info._isIndexed` | `boolean` | -| `info.hash` | `string` | - -#### Inherited from - -[Description](verida_vda_name_client._internal_.Description.md).[constructor](verida_vda_name_client._internal_.Description.md#constructor) - -#### Defined in - -node_modules/@ethersproject/properties/lib/index.d.ts:13 - -## Properties - -### \_isIndexed - -• `Readonly` **\_isIndexed**: `boolean` - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:32 - -___ - -### hash - -• `Readonly` **hash**: `string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:31 - -## Methods - -### isIndexed - -▸ `Static` **isIndexed**(`value`): value is Indexed - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `any` | - -#### Returns - -value is Indexed - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:33 diff --git a/docs/api/verida-js/classes/verida_vda_name_client._internal_.Interface.md b/docs/api/verida-js/classes/verida_vda_name_client._internal_.Interface.md deleted file mode 100644 index 3fd64d2..0000000 --- a/docs/api/verida-js/classes/verida_vda_name_client._internal_.Interface.md +++ /dev/null @@ -1,698 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-name-client](../modules/verida_vda_name_client.md) / [](../modules/verida_vda_name_client._internal_.md) / Interface - -# Class: Interface - -[@verida/vda-name-client](../modules/verida_vda_name_client.md).[](../modules/verida_vda_name_client._internal_.md).Interface - -## Table of contents - -### Constructors - -- [constructor](verida_vda_name_client._internal_.Interface.md#constructor) - -### Properties - -- [\_abiCoder](verida_vda_name_client._internal_.Interface.md#_abicoder) -- [\_isInterface](verida_vda_name_client._internal_.Interface.md#_isinterface) -- [deploy](verida_vda_name_client._internal_.Interface.md#deploy) -- [errors](verida_vda_name_client._internal_.Interface.md#errors) -- [events](verida_vda_name_client._internal_.Interface.md#events) -- [fragments](verida_vda_name_client._internal_.Interface.md#fragments) -- [functions](verida_vda_name_client._internal_.Interface.md#functions) -- [structs](verida_vda_name_client._internal_.Interface.md#structs) - -### Methods - -- [\_decodeParams](verida_vda_name_client._internal_.Interface.md#_decodeparams) -- [\_encodeParams](verida_vda_name_client._internal_.Interface.md#_encodeparams) -- [decodeErrorResult](verida_vda_name_client._internal_.Interface.md#decodeerrorresult) -- [decodeEventLog](verida_vda_name_client._internal_.Interface.md#decodeeventlog) -- [decodeFunctionData](verida_vda_name_client._internal_.Interface.md#decodefunctiondata) -- [decodeFunctionResult](verida_vda_name_client._internal_.Interface.md#decodefunctionresult) -- [encodeDeploy](verida_vda_name_client._internal_.Interface.md#encodedeploy) -- [encodeErrorResult](verida_vda_name_client._internal_.Interface.md#encodeerrorresult) -- [encodeEventLog](verida_vda_name_client._internal_.Interface.md#encodeeventlog) -- [encodeFilterTopics](verida_vda_name_client._internal_.Interface.md#encodefiltertopics) -- [encodeFunctionData](verida_vda_name_client._internal_.Interface.md#encodefunctiondata) -- [encodeFunctionResult](verida_vda_name_client._internal_.Interface.md#encodefunctionresult) -- [format](verida_vda_name_client._internal_.Interface.md#format) -- [getError](verida_vda_name_client._internal_.Interface.md#geterror) -- [getEvent](verida_vda_name_client._internal_.Interface.md#getevent) -- [getEventTopic](verida_vda_name_client._internal_.Interface.md#geteventtopic) -- [getFunction](verida_vda_name_client._internal_.Interface.md#getfunction) -- [getSighash](verida_vda_name_client._internal_.Interface.md#getsighash) -- [parseError](verida_vda_name_client._internal_.Interface.md#parseerror) -- [parseLog](verida_vda_name_client._internal_.Interface.md#parselog) -- [parseTransaction](verida_vda_name_client._internal_.Interface.md#parsetransaction) -- [getAbiCoder](verida_vda_name_client._internal_.Interface.md#getabicoder) -- [getAddress](verida_vda_name_client._internal_.Interface.md#getaddress) -- [getEventTopic](verida_vda_name_client._internal_.Interface.md#geteventtopic) -- [getSighash](verida_vda_name_client._internal_.Interface.md#getsighash) -- [isInterface](verida_vda_name_client._internal_.Interface.md#isinterface) - -## Constructors - -### constructor - -• **new Interface**(`fragments`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `fragments` | `string` \| readonly (`string` \| [`Fragment`](verida_vda_name_client._internal_.Fragment.md) \| [`JsonFragment`](../interfaces/verida_vda_name_client._internal_.JsonFragment.md))[] | - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:52 - -## Properties - -### \_abiCoder - -• `Readonly` **\_abiCoder**: [`AbiCoder`](verida_vda_name_client._internal_.AbiCoder.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:50 - -___ - -### \_isInterface - -• `Readonly` **\_isInterface**: `boolean` - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:51 - -___ - -### deploy - -• `Readonly` **deploy**: [`ConstructorFragment`](verida_vda_name_client._internal_.ConstructorFragment.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:49 - -___ - -### errors - -• `Readonly` **errors**: `Object` - -#### Index signature - -▪ [name: `string`]: [`ErrorFragment`](verida_vda_name_client._internal_.ErrorFragment.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:37 - -___ - -### events - -• `Readonly` **events**: `Object` - -#### Index signature - -▪ [name: `string`]: [`EventFragment`](verida_vda_name_client._internal_.EventFragment.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:40 - -___ - -### fragments - -• `Readonly` **fragments**: readonly [`Fragment`](verida_vda_name_client._internal_.Fragment.md)[] - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:36 - -___ - -### functions - -• `Readonly` **functions**: `Object` - -#### Index signature - -▪ [name: `string`]: [`FunctionFragment`](verida_vda_name_client._internal_.FunctionFragment.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:43 - -___ - -### structs - -• `Readonly` **structs**: `Object` - -#### Index signature - -▪ [name: `string`]: `any` - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:46 - -## Methods - -### \_decodeParams - -▸ **_decodeParams**(`params`, `data`): [`Result`](../interfaces/verida_vda_name_client._internal_.Result.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `params` | readonly [`ParamType`](verida_vda_name_client._internal_.ParamType.md)[] | -| `data` | [`BytesLike`](../modules/verida_vda_name_client._internal_.md#byteslike) | - -#### Returns - -[`Result`](../interfaces/verida_vda_name_client._internal_.Result.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:63 - -___ - -### \_encodeParams - -▸ **_encodeParams**(`params`, `values`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `params` | readonly [`ParamType`](verida_vda_name_client._internal_.ParamType.md)[] | -| `values` | readonly `any`[] | - -#### Returns - -`string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:64 - -___ - -### decodeErrorResult - -▸ **decodeErrorResult**(`fragment`, `data`): [`Result`](../interfaces/verida_vda_name_client._internal_.Result.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `fragment` | `string` \| [`ErrorFragment`](verida_vda_name_client._internal_.ErrorFragment.md) | -| `data` | [`BytesLike`](../modules/verida_vda_name_client._internal_.md#byteslike) | - -#### Returns - -[`Result`](../interfaces/verida_vda_name_client._internal_.Result.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:66 - -___ - -### decodeEventLog - -▸ **decodeEventLog**(`eventFragment`, `data`, `topics?`): [`Result`](../interfaces/verida_vda_name_client._internal_.Result.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventFragment` | `string` \| [`EventFragment`](verida_vda_name_client._internal_.EventFragment.md) | -| `data` | [`BytesLike`](../modules/verida_vda_name_client._internal_.md#byteslike) | -| `topics?` | readonly `string`[] | - -#### Returns - -[`Result`](../interfaces/verida_vda_name_client._internal_.Result.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:77 - -___ - -### decodeFunctionData - -▸ **decodeFunctionData**(`functionFragment`, `data`): [`Result`](../interfaces/verida_vda_name_client._internal_.Result.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `functionFragment` | `string` \| [`FunctionFragment`](verida_vda_name_client._internal_.FunctionFragment.md) | -| `data` | [`BytesLike`](../modules/verida_vda_name_client._internal_.md#byteslike) | - -#### Returns - -[`Result`](../interfaces/verida_vda_name_client._internal_.Result.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:68 - -___ - -### decodeFunctionResult - -▸ **decodeFunctionResult**(`functionFragment`, `data`): [`Result`](../interfaces/verida_vda_name_client._internal_.Result.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `functionFragment` | `string` \| [`FunctionFragment`](verida_vda_name_client._internal_.FunctionFragment.md) | -| `data` | [`BytesLike`](../modules/verida_vda_name_client._internal_.md#byteslike) | - -#### Returns - -[`Result`](../interfaces/verida_vda_name_client._internal_.Result.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:70 - -___ - -### encodeDeploy - -▸ **encodeDeploy**(`values?`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `values?` | readonly `any`[] | - -#### Returns - -`string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:65 - -___ - -### encodeErrorResult - -▸ **encodeErrorResult**(`fragment`, `values?`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `fragment` | `string` \| [`ErrorFragment`](verida_vda_name_client._internal_.ErrorFragment.md) | -| `values?` | readonly `any`[] | - -#### Returns - -`string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:67 - -___ - -### encodeEventLog - -▸ **encodeEventLog**(`eventFragment`, `values`): `Object` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventFragment` | `string` \| [`EventFragment`](verida_vda_name_client._internal_.EventFragment.md) | -| `values` | readonly `any`[] | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `data` | `string` | -| `topics` | `string`[] | - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:73 - -___ - -### encodeFilterTopics - -▸ **encodeFilterTopics**(`eventFragment`, `values`): (`string` \| `string`[])[] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventFragment` | `string` \| [`EventFragment`](verida_vda_name_client._internal_.EventFragment.md) | -| `values` | readonly `any`[] | - -#### Returns - -(`string` \| `string`[])[] - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:72 - -___ - -### encodeFunctionData - -▸ **encodeFunctionData**(`functionFragment`, `values?`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `functionFragment` | `string` \| [`FunctionFragment`](verida_vda_name_client._internal_.FunctionFragment.md) | -| `values?` | readonly `any`[] | - -#### Returns - -`string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:69 - -___ - -### encodeFunctionResult - -▸ **encodeFunctionResult**(`functionFragment`, `values?`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `functionFragment` | `string` \| [`FunctionFragment`](verida_vda_name_client._internal_.FunctionFragment.md) | -| `values?` | readonly `any`[] | - -#### Returns - -`string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:71 - -___ - -### format - -▸ **format**(`format?`): `string` \| `string`[] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `format?` | `string` | - -#### Returns - -`string` \| `string`[] - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:53 - -___ - -### getError - -▸ **getError**(`nameOrSignatureOrSighash`): [`ErrorFragment`](verida_vda_name_client._internal_.ErrorFragment.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `nameOrSignatureOrSighash` | `string` | - -#### Returns - -[`ErrorFragment`](verida_vda_name_client._internal_.ErrorFragment.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:60 - -___ - -### getEvent - -▸ **getEvent**(`nameOrSignatureOrTopic`): [`EventFragment`](verida_vda_name_client._internal_.EventFragment.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `nameOrSignatureOrTopic` | `string` | - -#### Returns - -[`EventFragment`](verida_vda_name_client._internal_.EventFragment.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:59 - -___ - -### getEventTopic - -▸ **getEventTopic**(`eventFragment`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventFragment` | `string` \| [`EventFragment`](verida_vda_name_client._internal_.EventFragment.md) | - -#### Returns - -`string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:62 - -___ - -### getFunction - -▸ **getFunction**(`nameOrSignatureOrSighash`): [`FunctionFragment`](verida_vda_name_client._internal_.FunctionFragment.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `nameOrSignatureOrSighash` | `string` | - -#### Returns - -[`FunctionFragment`](verida_vda_name_client._internal_.FunctionFragment.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:58 - -___ - -### getSighash - -▸ **getSighash**(`fragment`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `fragment` | `string` \| [`ErrorFragment`](verida_vda_name_client._internal_.ErrorFragment.md) \| [`FunctionFragment`](verida_vda_name_client._internal_.FunctionFragment.md) | - -#### Returns - -`string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:61 - -___ - -### parseError - -▸ **parseError**(`data`): [`ErrorDescription`](verida_vda_name_client._internal_.ErrorDescription.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | [`BytesLike`](../modules/verida_vda_name_client._internal_.md#byteslike) | - -#### Returns - -[`ErrorDescription`](verida_vda_name_client._internal_.ErrorDescription.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:86 - -___ - -### parseLog - -▸ **parseLog**(`log`): [`LogDescription`](verida_vda_name_client._internal_.LogDescription.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `log` | `Object` | -| `log.data` | `string` | -| `log.topics` | `string`[] | - -#### Returns - -[`LogDescription`](verida_vda_name_client._internal_.LogDescription.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:82 - -___ - -### parseTransaction - -▸ **parseTransaction**(`tx`): [`TransactionDescription`](verida_vda_name_client._internal_.TransactionDescription.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `tx` | `Object` | -| `tx.data` | `string` | -| `tx.value?` | [`BigNumberish`](../modules/verida_vda_name_client._internal_.md#bignumberish) | - -#### Returns - -[`TransactionDescription`](verida_vda_name_client._internal_.TransactionDescription.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:78 - -___ - -### getAbiCoder - -▸ `Static` **getAbiCoder**(): [`AbiCoder`](verida_vda_name_client._internal_.AbiCoder.md) - -#### Returns - -[`AbiCoder`](verida_vda_name_client._internal_.AbiCoder.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:54 - -___ - -### getAddress - -▸ `Static` **getAddress**(`address`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `address` | `string` | - -#### Returns - -`string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:55 - -___ - -### getEventTopic - -▸ `Static` **getEventTopic**(`eventFragment`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventFragment` | [`EventFragment`](verida_vda_name_client._internal_.EventFragment.md) | - -#### Returns - -`string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:57 - -___ - -### getSighash - -▸ `Static` **getSighash**(`fragment`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `fragment` | [`ErrorFragment`](verida_vda_name_client._internal_.ErrorFragment.md) \| [`FunctionFragment`](verida_vda_name_client._internal_.FunctionFragment.md) | - -#### Returns - -`string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:56 - -___ - -### isInterface - -▸ `Static` **isInterface**(`value`): value is Interface - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `any` | - -#### Returns - -value is Interface - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:87 diff --git a/docs/api/verida-js/classes/verida_vda_name_client._internal_.LogDescription.md b/docs/api/verida-js/classes/verida_vda_name_client._internal_.LogDescription.md deleted file mode 100644 index 130b2a6..0000000 --- a/docs/api/verida-js/classes/verida_vda_name_client._internal_.LogDescription.md +++ /dev/null @@ -1,100 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-name-client](../modules/verida_vda_name_client.md) / [](../modules/verida_vda_name_client._internal_.md) / LogDescription - -# Class: LogDescription - -[@verida/vda-name-client](../modules/verida_vda_name_client.md).[](../modules/verida_vda_name_client._internal_.md).LogDescription - -## Hierarchy - -- [`Description`](verida_vda_name_client._internal_.Description.md)<[`LogDescription`](verida_vda_name_client._internal_.LogDescription.md)\> - - ↳ **`LogDescription`** - -## Table of contents - -### Constructors - -- [constructor](verida_vda_name_client._internal_.LogDescription.md#constructor) - -### Properties - -- [args](verida_vda_name_client._internal_.LogDescription.md#args) -- [eventFragment](verida_vda_name_client._internal_.LogDescription.md#eventfragment) -- [name](verida_vda_name_client._internal_.LogDescription.md#name) -- [signature](verida_vda_name_client._internal_.LogDescription.md#signature) -- [topic](verida_vda_name_client._internal_.LogDescription.md#topic) - -## Constructors - -### constructor - -• **new LogDescription**(`info`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `info` | `Object` | -| `info.args` | [`Result`](../interfaces/verida_vda_name_client._internal_.Result.md) | -| `info.eventFragment` | [`EventFragment`](verida_vda_name_client._internal_.EventFragment.md) | -| `info.name` | `string` | -| `info.signature` | `string` | -| `info.topic` | `string` | - -#### Inherited from - -[Description](verida_vda_name_client._internal_.Description.md).[constructor](verida_vda_name_client._internal_.Description.md#constructor) - -#### Defined in - -node_modules/@ethersproject/properties/lib/index.d.ts:13 - -## Properties - -### args - -• `Readonly` **args**: [`Result`](../interfaces/verida_vda_name_client._internal_.Result.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:13 - -___ - -### eventFragment - -• `Readonly` **eventFragment**: [`EventFragment`](verida_vda_name_client._internal_.EventFragment.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:9 - -___ - -### name - -• `Readonly` **name**: `string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:10 - -___ - -### signature - -• `Readonly` **signature**: `string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:11 - -___ - -### topic - -• `Readonly` **topic**: `string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:12 diff --git a/docs/api/verida-js/classes/verida_vda_name_client._internal_.ParamType.md b/docs/api/verida-js/classes/verida_vda_name_client._internal_.ParamType.md deleted file mode 100644 index 8c70a9d..0000000 --- a/docs/api/verida-js/classes/verida_vda_name_client._internal_.ParamType.md +++ /dev/null @@ -1,229 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-name-client](../modules/verida_vda_name_client.md) / [](../modules/verida_vda_name_client._internal_.md) / ParamType - -# Class: ParamType - -[@verida/vda-name-client](../modules/verida_vda_name_client.md).[](../modules/verida_vda_name_client._internal_.md).ParamType - -## Table of contents - -### Constructors - -- [constructor](verida_vda_name_client._internal_.ParamType.md#constructor) - -### Properties - -- [\_isParamType](verida_vda_name_client._internal_.ParamType.md#_isparamtype) -- [arrayChildren](verida_vda_name_client._internal_.ParamType.md#arraychildren) -- [arrayLength](verida_vda_name_client._internal_.ParamType.md#arraylength) -- [baseType](verida_vda_name_client._internal_.ParamType.md#basetype) -- [components](verida_vda_name_client._internal_.ParamType.md#components) -- [indexed](verida_vda_name_client._internal_.ParamType.md#indexed) -- [name](verida_vda_name_client._internal_.ParamType.md#name) -- [type](verida_vda_name_client._internal_.ParamType.md#type) - -### Methods - -- [format](verida_vda_name_client._internal_.ParamType.md#format) -- [from](verida_vda_name_client._internal_.ParamType.md#from) -- [fromObject](verida_vda_name_client._internal_.ParamType.md#fromobject) -- [fromString](verida_vda_name_client._internal_.ParamType.md#fromstring) -- [isParamType](verida_vda_name_client._internal_.ParamType.md#isparamtype) - -## Constructors - -### constructor - -• **new ParamType**(`constructorGuard`, `params`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `constructorGuard` | `any` | -| `params` | `any` | - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:32 - -## Properties - -### \_isParamType - -• `Readonly` **\_isParamType**: `boolean` - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:31 - -___ - -### arrayChildren - -• `Readonly` **arrayChildren**: [`ParamType`](verida_vda_name_client._internal_.ParamType.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:30 - -___ - -### arrayLength - -• `Readonly` **arrayLength**: `number` - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:29 - -___ - -### baseType - -• `Readonly` **baseType**: `string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:26 - -___ - -### components - -• `Readonly` **components**: [`ParamType`](verida_vda_name_client._internal_.ParamType.md)[] - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:28 - -___ - -### indexed - -• `Readonly` **indexed**: `boolean` - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:27 - -___ - -### name - -• `Readonly` **name**: `string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:24 - -___ - -### type - -• `Readonly` **type**: `string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:25 - -## Methods - -### format - -▸ **format**(`format?`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `format?` | `string` | - -#### Returns - -`string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:33 - -___ - -### from - -▸ `Static` **from**(`value`, `allowIndexed?`): [`ParamType`](verida_vda_name_client._internal_.ParamType.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `string` \| [`ParamType`](verida_vda_name_client._internal_.ParamType.md) \| [`JsonFragmentType`](../interfaces/verida_vda_name_client._internal_.JsonFragmentType.md) | -| `allowIndexed?` | `boolean` | - -#### Returns - -[`ParamType`](verida_vda_name_client._internal_.ParamType.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:34 - -___ - -### fromObject - -▸ `Static` **fromObject**(`value`): [`ParamType`](verida_vda_name_client._internal_.ParamType.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | [`ParamType`](verida_vda_name_client._internal_.ParamType.md) \| [`JsonFragmentType`](../interfaces/verida_vda_name_client._internal_.JsonFragmentType.md) | - -#### Returns - -[`ParamType`](verida_vda_name_client._internal_.ParamType.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:35 - -___ - -### fromString - -▸ `Static` **fromString**(`value`, `allowIndexed?`): [`ParamType`](verida_vda_name_client._internal_.ParamType.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `string` | -| `allowIndexed?` | `boolean` | - -#### Returns - -[`ParamType`](verida_vda_name_client._internal_.ParamType.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:36 - -___ - -### isParamType - -▸ `Static` **isParamType**(`value`): value is ParamType - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `any` | - -#### Returns - -value is ParamType - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:37 diff --git a/docs/api/verida-js/classes/verida_vda_name_client._internal_.Provider.md b/docs/api/verida-js/classes/verida_vda_name_client._internal_.Provider.md deleted file mode 100644 index 738e69c..0000000 --- a/docs/api/verida-js/classes/verida_vda_name_client._internal_.Provider.md +++ /dev/null @@ -1,645 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-name-client](../modules/verida_vda_name_client.md) / [](../modules/verida_vda_name_client._internal_.md) / Provider - -# Class: Provider - -[@verida/vda-name-client](../modules/verida_vda_name_client.md).[](../modules/verida_vda_name_client._internal_.md).Provider - -## Implements - -- [`OnceBlockable`](../interfaces/verida_vda_name_client._internal_.OnceBlockable.md) - -## Table of contents - -### Constructors - -- [constructor](verida_vda_name_client._internal_.Provider.md#constructor) - -### Properties - -- [\_isProvider](verida_vda_name_client._internal_.Provider.md#_isprovider) - -### Methods - -- [addListener](verida_vda_name_client._internal_.Provider.md#addlistener) -- [call](verida_vda_name_client._internal_.Provider.md#call) -- [emit](verida_vda_name_client._internal_.Provider.md#emit) -- [estimateGas](verida_vda_name_client._internal_.Provider.md#estimategas) -- [getBalance](verida_vda_name_client._internal_.Provider.md#getbalance) -- [getBlock](verida_vda_name_client._internal_.Provider.md#getblock) -- [getBlockNumber](verida_vda_name_client._internal_.Provider.md#getblocknumber) -- [getBlockWithTransactions](verida_vda_name_client._internal_.Provider.md#getblockwithtransactions) -- [getCode](verida_vda_name_client._internal_.Provider.md#getcode) -- [getFeeData](verida_vda_name_client._internal_.Provider.md#getfeedata) -- [getGasPrice](verida_vda_name_client._internal_.Provider.md#getgasprice) -- [getLogs](verida_vda_name_client._internal_.Provider.md#getlogs) -- [getNetwork](verida_vda_name_client._internal_.Provider.md#getnetwork) -- [getStorageAt](verida_vda_name_client._internal_.Provider.md#getstorageat) -- [getTransaction](verida_vda_name_client._internal_.Provider.md#gettransaction) -- [getTransactionCount](verida_vda_name_client._internal_.Provider.md#gettransactioncount) -- [getTransactionReceipt](verida_vda_name_client._internal_.Provider.md#gettransactionreceipt) -- [listenerCount](verida_vda_name_client._internal_.Provider.md#listenercount) -- [listeners](verida_vda_name_client._internal_.Provider.md#listeners) -- [lookupAddress](verida_vda_name_client._internal_.Provider.md#lookupaddress) -- [off](verida_vda_name_client._internal_.Provider.md#off) -- [on](verida_vda_name_client._internal_.Provider.md#on) -- [once](verida_vda_name_client._internal_.Provider.md#once) -- [removeAllListeners](verida_vda_name_client._internal_.Provider.md#removealllisteners) -- [removeListener](verida_vda_name_client._internal_.Provider.md#removelistener) -- [resolveName](verida_vda_name_client._internal_.Provider.md#resolvename) -- [sendTransaction](verida_vda_name_client._internal_.Provider.md#sendtransaction) -- [waitForTransaction](verida_vda_name_client._internal_.Provider.md#waitfortransaction) -- [isProvider](verida_vda_name_client._internal_.Provider.md#isprovider) - -## Constructors - -### constructor - -• **new Provider**() - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:153 - -## Properties - -### \_isProvider - -• `Readonly` **\_isProvider**: `boolean` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:152 - -## Methods - -### addListener - -▸ **addListener**(`eventName`, `listener`): [`Provider`](verida_vda_name_client._internal_.Provider.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | [`EventType`](../modules/verida_vda_name_client._internal_.md#eventtype) | -| `listener` | [`Listener`](../modules/verida_vda_name_client._internal_.md#listener) | - -#### Returns - -[`Provider`](verida_vda_name_client._internal_.Provider.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:149 - -___ - -### call - -▸ `Abstract` **call**(`transaction`, `blockTag?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transaction` | [`Deferrable`](../modules/verida_vda_name_client._internal_.md#deferrable)<[`TransactionRequest`](../modules/verida_vda_name_client._internal_.md#transactionrequest)\> | -| `blockTag?` | [`BlockTag`](../modules/verida_vda_name_client._internal_.md#blocktag) \| `Promise`<[`BlockTag`](../modules/verida_vda_name_client._internal_.md#blocktag)\> | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:133 - -___ - -### emit - -▸ `Abstract` **emit**(`eventName`, ...`args`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | [`EventType`](../modules/verida_vda_name_client._internal_.md#eventtype) | -| `...args` | `any`[] | - -#### Returns - -`boolean` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:144 - -___ - -### estimateGas - -▸ `Abstract` **estimateGas**(`transaction`): `Promise`<[`BigNumber`](verida_vda_name_client._internal_.BigNumber.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transaction` | [`Deferrable`](../modules/verida_vda_name_client._internal_.md#deferrable)<[`TransactionRequest`](../modules/verida_vda_name_client._internal_.md#transactionrequest)\> | - -#### Returns - -`Promise`<[`BigNumber`](verida_vda_name_client._internal_.BigNumber.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:134 - -___ - -### getBalance - -▸ `Abstract` **getBalance**(`addressOrName`, `blockTag?`): `Promise`<[`BigNumber`](verida_vda_name_client._internal_.BigNumber.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `addressOrName` | `string` \| `Promise`<`string`\> | -| `blockTag?` | [`BlockTag`](../modules/verida_vda_name_client._internal_.md#blocktag) \| `Promise`<[`BlockTag`](../modules/verida_vda_name_client._internal_.md#blocktag)\> | - -#### Returns - -`Promise`<[`BigNumber`](verida_vda_name_client._internal_.BigNumber.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:128 - -___ - -### getBlock - -▸ `Abstract` **getBlock**(`blockHashOrBlockTag`): `Promise`<[`Block`](../interfaces/verida_vda_name_client._internal_.Block.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `blockHashOrBlockTag` | [`BlockTag`](../modules/verida_vda_name_client._internal_.md#blocktag) \| `Promise`<[`BlockTag`](../modules/verida_vda_name_client._internal_.md#blocktag)\> | - -#### Returns - -`Promise`<[`Block`](../interfaces/verida_vda_name_client._internal_.Block.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:135 - -___ - -### getBlockNumber - -▸ `Abstract` **getBlockNumber**(): `Promise`<`number`\> - -#### Returns - -`Promise`<`number`\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:125 - -___ - -### getBlockWithTransactions - -▸ `Abstract` **getBlockWithTransactions**(`blockHashOrBlockTag`): `Promise`<[`BlockWithTransactions`](../interfaces/verida_vda_name_client._internal_.BlockWithTransactions.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `blockHashOrBlockTag` | [`BlockTag`](../modules/verida_vda_name_client._internal_.md#blocktag) \| `Promise`<[`BlockTag`](../modules/verida_vda_name_client._internal_.md#blocktag)\> | - -#### Returns - -`Promise`<[`BlockWithTransactions`](../interfaces/verida_vda_name_client._internal_.BlockWithTransactions.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:136 - -___ - -### getCode - -▸ `Abstract` **getCode**(`addressOrName`, `blockTag?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `addressOrName` | `string` \| `Promise`<`string`\> | -| `blockTag?` | [`BlockTag`](../modules/verida_vda_name_client._internal_.md#blocktag) \| `Promise`<[`BlockTag`](../modules/verida_vda_name_client._internal_.md#blocktag)\> | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:130 - -___ - -### getFeeData - -▸ **getFeeData**(): `Promise`<[`FeeData`](../interfaces/verida_vda_name_client._internal_.FeeData.md)\> - -#### Returns - -`Promise`<[`FeeData`](../interfaces/verida_vda_name_client._internal_.FeeData.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:127 - -___ - -### getGasPrice - -▸ `Abstract` **getGasPrice**(): `Promise`<[`BigNumber`](verida_vda_name_client._internal_.BigNumber.md)\> - -#### Returns - -`Promise`<[`BigNumber`](verida_vda_name_client._internal_.BigNumber.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:126 - -___ - -### getLogs - -▸ `Abstract` **getLogs**(`filter`): `Promise`<[`Log`](../interfaces/verida_vda_name_client._internal_.Log.md)[]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `filter` | [`Filter`](../interfaces/verida_vda_name_client._internal_.Filter.md) | - -#### Returns - -`Promise`<[`Log`](../interfaces/verida_vda_name_client._internal_.Log.md)[]\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:139 - -___ - -### getNetwork - -▸ `Abstract` **getNetwork**(): `Promise`<[`Network`](../modules/verida_vda_name_client._internal_.md#network)\> - -#### Returns - -`Promise`<[`Network`](../modules/verida_vda_name_client._internal_.md#network)\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:124 - -___ - -### getStorageAt - -▸ `Abstract` **getStorageAt**(`addressOrName`, `position`, `blockTag?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `addressOrName` | `string` \| `Promise`<`string`\> | -| `position` | [`BigNumberish`](../modules/verida_vda_name_client._internal_.md#bignumberish) \| `Promise`<[`BigNumberish`](../modules/verida_vda_name_client._internal_.md#bignumberish)\> | -| `blockTag?` | [`BlockTag`](../modules/verida_vda_name_client._internal_.md#blocktag) \| `Promise`<[`BlockTag`](../modules/verida_vda_name_client._internal_.md#blocktag)\> | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:131 - -___ - -### getTransaction - -▸ `Abstract` **getTransaction**(`transactionHash`): `Promise`<[`TransactionResponse`](../interfaces/verida_vda_name_client._internal_.TransactionResponse.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transactionHash` | `string` | - -#### Returns - -`Promise`<[`TransactionResponse`](../interfaces/verida_vda_name_client._internal_.TransactionResponse.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:137 - -___ - -### getTransactionCount - -▸ `Abstract` **getTransactionCount**(`addressOrName`, `blockTag?`): `Promise`<`number`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `addressOrName` | `string` \| `Promise`<`string`\> | -| `blockTag?` | [`BlockTag`](../modules/verida_vda_name_client._internal_.md#blocktag) \| `Promise`<[`BlockTag`](../modules/verida_vda_name_client._internal_.md#blocktag)\> | - -#### Returns - -`Promise`<`number`\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:129 - -___ - -### getTransactionReceipt - -▸ `Abstract` **getTransactionReceipt**(`transactionHash`): `Promise`<[`TransactionReceipt`](../interfaces/verida_vda_name_client._internal_.TransactionReceipt.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transactionHash` | `string` | - -#### Returns - -`Promise`<[`TransactionReceipt`](../interfaces/verida_vda_name_client._internal_.TransactionReceipt.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:138 - -___ - -### listenerCount - -▸ `Abstract` **listenerCount**(`eventName?`): `number` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName?` | [`EventType`](../modules/verida_vda_name_client._internal_.md#eventtype) | - -#### Returns - -`number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:145 - -___ - -### listeners - -▸ `Abstract` **listeners**(`eventName?`): [`Listener`](../modules/verida_vda_name_client._internal_.md#listener)[] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName?` | [`EventType`](../modules/verida_vda_name_client._internal_.md#eventtype) | - -#### Returns - -[`Listener`](../modules/verida_vda_name_client._internal_.md#listener)[] - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:146 - -___ - -### lookupAddress - -▸ `Abstract` **lookupAddress**(`address`): `Promise`<``null`` \| `string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `address` | `string` \| `Promise`<`string`\> | - -#### Returns - -`Promise`<``null`` \| `string`\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:141 - -___ - -### off - -▸ `Abstract` **off**(`eventName`, `listener?`): [`Provider`](verida_vda_name_client._internal_.Provider.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | [`EventType`](../modules/verida_vda_name_client._internal_.md#eventtype) | -| `listener?` | [`Listener`](../modules/verida_vda_name_client._internal_.md#listener) | - -#### Returns - -[`Provider`](verida_vda_name_client._internal_.Provider.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:147 - -___ - -### on - -▸ `Abstract` **on**(`eventName`, `listener`): [`Provider`](verida_vda_name_client._internal_.Provider.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | [`EventType`](../modules/verida_vda_name_client._internal_.md#eventtype) | -| `listener` | [`Listener`](../modules/verida_vda_name_client._internal_.md#listener) | - -#### Returns - -[`Provider`](verida_vda_name_client._internal_.Provider.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:142 - -___ - -### once - -▸ `Abstract` **once**(`eventName`, `listener`): [`Provider`](verida_vda_name_client._internal_.Provider.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | [`EventType`](../modules/verida_vda_name_client._internal_.md#eventtype) | -| `listener` | [`Listener`](../modules/verida_vda_name_client._internal_.md#listener) | - -#### Returns - -[`Provider`](verida_vda_name_client._internal_.Provider.md) - -#### Implementation of - -[OnceBlockable](../interfaces/verida_vda_name_client._internal_.OnceBlockable.md).[once](../interfaces/verida_vda_name_client._internal_.OnceBlockable.md#once) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:143 - -___ - -### removeAllListeners - -▸ `Abstract` **removeAllListeners**(`eventName?`): [`Provider`](verida_vda_name_client._internal_.Provider.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName?` | [`EventType`](../modules/verida_vda_name_client._internal_.md#eventtype) | - -#### Returns - -[`Provider`](verida_vda_name_client._internal_.Provider.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:148 - -___ - -### removeListener - -▸ **removeListener**(`eventName`, `listener`): [`Provider`](verida_vda_name_client._internal_.Provider.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | [`EventType`](../modules/verida_vda_name_client._internal_.md#eventtype) | -| `listener` | [`Listener`](../modules/verida_vda_name_client._internal_.md#listener) | - -#### Returns - -[`Provider`](verida_vda_name_client._internal_.Provider.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:150 - -___ - -### resolveName - -▸ `Abstract` **resolveName**(`name`): `Promise`<``null`` \| `string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` \| `Promise`<`string`\> | - -#### Returns - -`Promise`<``null`` \| `string`\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:140 - -___ - -### sendTransaction - -▸ `Abstract` **sendTransaction**(`signedTransaction`): `Promise`<[`TransactionResponse`](../interfaces/verida_vda_name_client._internal_.TransactionResponse.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `signedTransaction` | `string` \| `Promise`<`string`\> | - -#### Returns - -`Promise`<[`TransactionResponse`](../interfaces/verida_vda_name_client._internal_.TransactionResponse.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:132 - -___ - -### waitForTransaction - -▸ `Abstract` **waitForTransaction**(`transactionHash`, `confirmations?`, `timeout?`): `Promise`<[`TransactionReceipt`](../interfaces/verida_vda_name_client._internal_.TransactionReceipt.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transactionHash` | `string` | -| `confirmations?` | `number` | -| `timeout?` | `number` | - -#### Returns - -`Promise`<[`TransactionReceipt`](../interfaces/verida_vda_name_client._internal_.TransactionReceipt.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:151 - -___ - -### isProvider - -▸ `Static` **isProvider**(`value`): value is Provider - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `any` | - -#### Returns - -value is Provider - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:154 diff --git a/docs/api/verida-js/classes/verida_vda_name_client._internal_.Reader.md b/docs/api/verida-js/classes/verida_vda_name_client._internal_.Reader.md deleted file mode 100644 index cbc8fb6..0000000 --- a/docs/api/verida-js/classes/verida_vda_name_client._internal_.Reader.md +++ /dev/null @@ -1,249 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-name-client](../modules/verida_vda_name_client.md) / [](../modules/verida_vda_name_client._internal_.md) / Reader - -# Class: Reader - -[@verida/vda-name-client](../modules/verida_vda_name_client.md).[](../modules/verida_vda_name_client._internal_.md).Reader - -## Table of contents - -### Constructors - -- [constructor](verida_vda_name_client._internal_.Reader.md#constructor) - -### Properties - -- [\_coerceFunc](verida_vda_name_client._internal_.Reader.md#_coercefunc) -- [\_data](verida_vda_name_client._internal_.Reader.md#_data) -- [\_offset](verida_vda_name_client._internal_.Reader.md#_offset) -- [allowLoose](verida_vda_name_client._internal_.Reader.md#allowloose) -- [wordSize](verida_vda_name_client._internal_.Reader.md#wordsize) - -### Accessors - -- [consumed](verida_vda_name_client._internal_.Reader.md#consumed) -- [data](verida_vda_name_client._internal_.Reader.md#data) - -### Methods - -- [\_peekBytes](verida_vda_name_client._internal_.Reader.md#_peekbytes) -- [coerce](verida_vda_name_client._internal_.Reader.md#coerce) -- [readBytes](verida_vda_name_client._internal_.Reader.md#readbytes) -- [readValue](verida_vda_name_client._internal_.Reader.md#readvalue) -- [subReader](verida_vda_name_client._internal_.Reader.md#subreader) -- [coerce](verida_vda_name_client._internal_.Reader.md#coerce) - -## Constructors - -### constructor - -• **new Reader**(`data`, `wordSize?`, `coerceFunc?`, `allowLoose?`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | [`BytesLike`](../modules/verida_vda_name_client._internal_.md#byteslike) | -| `wordSize?` | `number` | -| `coerceFunc?` | [`CoerceFunc`](../modules/verida_vda_name_client._internal_.md#coercefunc) | -| `allowLoose?` | `boolean` | - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:43 - -## Properties - -### \_coerceFunc - -• `Readonly` **\_coerceFunc**: [`CoerceFunc`](../modules/verida_vda_name_client._internal_.md#coercefunc) - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:41 - -___ - -### \_data - -• `Readonly` **\_data**: `Uint8Array` - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:40 - -___ - -### \_offset - -• **\_offset**: `number` - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:42 - -___ - -### allowLoose - -• `Readonly` **allowLoose**: `boolean` - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:39 - -___ - -### wordSize - -• `Readonly` **wordSize**: `number` - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:38 - -## Accessors - -### consumed - -• `get` **consumed**(): `number` - -#### Returns - -`number` - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:45 - -___ - -### data - -• `get` **data**(): `string` - -#### Returns - -`string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:44 - -## Methods - -### \_peekBytes - -▸ **_peekBytes**(`offset`, `length`, `loose?`): `Uint8Array` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `offset` | `number` | -| `length` | `number` | -| `loose?` | `boolean` | - -#### Returns - -`Uint8Array` - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:48 - -___ - -### coerce - -▸ **coerce**(`name`, `value`): `any` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` | -| `value` | `any` | - -#### Returns - -`any` - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:47 - -___ - -### readBytes - -▸ **readBytes**(`length`, `loose?`): `Uint8Array` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `length` | `number` | -| `loose?` | `boolean` | - -#### Returns - -`Uint8Array` - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:50 - -___ - -### readValue - -▸ **readValue**(): [`BigNumber`](verida_vda_name_client._internal_.BigNumber.md) - -#### Returns - -[`BigNumber`](verida_vda_name_client._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:51 - -___ - -### subReader - -▸ **subReader**(`offset`): [`Reader`](verida_vda_name_client._internal_.Reader.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `offset` | `number` | - -#### Returns - -[`Reader`](verida_vda_name_client._internal_.Reader.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:49 - -___ - -### coerce - -▸ `Static` **coerce**(`name`, `value`): `any` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` | -| `value` | `any` | - -#### Returns - -`any` - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:46 diff --git a/docs/api/verida-js/classes/verida_vda_name_client._internal_.RunningEvent.md b/docs/api/verida-js/classes/verida_vda_name_client._internal_.RunningEvent.md deleted file mode 100644 index f24ce77..0000000 --- a/docs/api/verida-js/classes/verida_vda_name_client._internal_.RunningEvent.md +++ /dev/null @@ -1,218 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-name-client](../modules/verida_vda_name_client.md) / [](../modules/verida_vda_name_client._internal_.md) / RunningEvent - -# Class: RunningEvent - -[@verida/vda-name-client](../modules/verida_vda_name_client.md).[](../modules/verida_vda_name_client._internal_.md).RunningEvent - -## Table of contents - -### Constructors - -- [constructor](verida_vda_name_client._internal_.RunningEvent.md#constructor) - -### Properties - -- [\_listeners](verida_vda_name_client._internal_.RunningEvent.md#_listeners) -- [filter](verida_vda_name_client._internal_.RunningEvent.md#filter) -- [tag](verida_vda_name_client._internal_.RunningEvent.md#tag) - -### Methods - -- [addListener](verida_vda_name_client._internal_.RunningEvent.md#addlistener) -- [getEmit](verida_vda_name_client._internal_.RunningEvent.md#getemit) -- [listenerCount](verida_vda_name_client._internal_.RunningEvent.md#listenercount) -- [listeners](verida_vda_name_client._internal_.RunningEvent.md#listeners) -- [prepareEvent](verida_vda_name_client._internal_.RunningEvent.md#prepareevent) -- [removeAllListeners](verida_vda_name_client._internal_.RunningEvent.md#removealllisteners) -- [removeListener](verida_vda_name_client._internal_.RunningEvent.md#removelistener) -- [run](verida_vda_name_client._internal_.RunningEvent.md#run) - -## Constructors - -### constructor - -• **new RunningEvent**(`tag`, `filter`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `tag` | `string` | -| `filter` | [`EventFilter`](../modules/verida_vda_name_client._internal_.md#eventfilter) | - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:67 - -## Properties - -### \_listeners - -• `Private` **\_listeners**: `any` - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:66 - -___ - -### filter - -• `Readonly` **filter**: [`EventFilter`](../modules/verida_vda_name_client._internal_.md#eventfilter) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:65 - -___ - -### tag - -• `Readonly` **tag**: `string` - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:64 - -## Methods - -### addListener - -▸ **addListener**(`listener`, `once`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `listener` | [`Listener`](../modules/verida_vda_name_client._internal_.md#listener) | -| `once` | `boolean` | - -#### Returns - -`void` - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:68 - -___ - -### getEmit - -▸ **getEmit**(`event`): `any`[] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | [`Event`](../interfaces/verida_vda_name_client._internal_.Event.md) | - -#### Returns - -`any`[] - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:75 - -___ - -### listenerCount - -▸ **listenerCount**(): `number` - -#### Returns - -`number` - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:72 - -___ - -### listeners - -▸ **listeners**(): [`Listener`](../modules/verida_vda_name_client._internal_.md#listener)[] - -#### Returns - -[`Listener`](../modules/verida_vda_name_client._internal_.md#listener)[] - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:71 - -___ - -### prepareEvent - -▸ **prepareEvent**(`event`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | [`Event`](../interfaces/verida_vda_name_client._internal_.Event.md) | - -#### Returns - -`void` - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:74 - -___ - -### removeAllListeners - -▸ **removeAllListeners**(): `void` - -#### Returns - -`void` - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:70 - -___ - -### removeListener - -▸ **removeListener**(`listener`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `listener` | [`Listener`](../modules/verida_vda_name_client._internal_.md#listener) | - -#### Returns - -`void` - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:69 - -___ - -### run - -▸ **run**(`args`): `number` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `args` | `any`[] | - -#### Returns - -`number` - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:73 diff --git a/docs/api/verida-js/classes/verida_vda_name_client._internal_.Signer.md b/docs/api/verida-js/classes/verida_vda_name_client._internal_.Signer.md deleted file mode 100644 index b6e6421..0000000 --- a/docs/api/verida-js/classes/verida_vda_name_client._internal_.Signer.md +++ /dev/null @@ -1,383 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-name-client](../modules/verida_vda_name_client.md) / [](../modules/verida_vda_name_client._internal_.md) / Signer - -# Class: Signer - -[@verida/vda-name-client](../modules/verida_vda_name_client.md).[](../modules/verida_vda_name_client._internal_.md).Signer - -## Table of contents - -### Constructors - -- [constructor](verida_vda_name_client._internal_.Signer.md#constructor) - -### Properties - -- [\_isSigner](verida_vda_name_client._internal_.Signer.md#_issigner) -- [provider](verida_vda_name_client._internal_.Signer.md#provider) - -### Methods - -- [\_checkProvider](verida_vda_name_client._internal_.Signer.md#_checkprovider) -- [call](verida_vda_name_client._internal_.Signer.md#call) -- [checkTransaction](verida_vda_name_client._internal_.Signer.md#checktransaction) -- [connect](verida_vda_name_client._internal_.Signer.md#connect) -- [estimateGas](verida_vda_name_client._internal_.Signer.md#estimategas) -- [getAddress](verida_vda_name_client._internal_.Signer.md#getaddress) -- [getBalance](verida_vda_name_client._internal_.Signer.md#getbalance) -- [getChainId](verida_vda_name_client._internal_.Signer.md#getchainid) -- [getFeeData](verida_vda_name_client._internal_.Signer.md#getfeedata) -- [getGasPrice](verida_vda_name_client._internal_.Signer.md#getgasprice) -- [getTransactionCount](verida_vda_name_client._internal_.Signer.md#gettransactioncount) -- [populateTransaction](verida_vda_name_client._internal_.Signer.md#populatetransaction) -- [resolveName](verida_vda_name_client._internal_.Signer.md#resolvename) -- [sendTransaction](verida_vda_name_client._internal_.Signer.md#sendtransaction) -- [signMessage](verida_vda_name_client._internal_.Signer.md#signmessage) -- [signTransaction](verida_vda_name_client._internal_.Signer.md#signtransaction) -- [isSigner](verida_vda_name_client._internal_.Signer.md#issigner) - -## Constructors - -### constructor - -• **new Signer**() - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:30 - -## Properties - -### \_isSigner - -• `Readonly` **\_isSigner**: `boolean` - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:29 - -___ - -### provider - -• `Optional` `Readonly` **provider**: [`Provider`](verida_vda_name_client._internal_.Provider.md) - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:24 - -## Methods - -### \_checkProvider - -▸ **_checkProvider**(`operation?`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `operation?` | `string` | - -#### Returns - -`void` - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:42 - -___ - -### call - -▸ **call**(`transaction`, `blockTag?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transaction` | [`Deferrable`](../modules/verida_vda_name_client._internal_.md#deferrable)<[`TransactionRequest`](../modules/verida_vda_name_client._internal_.md#transactionrequest)\> | -| `blockTag?` | [`BlockTag`](../modules/verida_vda_name_client._internal_.md#blocktag) | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:34 - -___ - -### checkTransaction - -▸ **checkTransaction**(`transaction`): [`Deferrable`](../modules/verida_vda_name_client._internal_.md#deferrable)<[`TransactionRequest`](../modules/verida_vda_name_client._internal_.md#transactionrequest)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transaction` | [`Deferrable`](../modules/verida_vda_name_client._internal_.md#deferrable)<[`TransactionRequest`](../modules/verida_vda_name_client._internal_.md#transactionrequest)\> | - -#### Returns - -[`Deferrable`](../modules/verida_vda_name_client._internal_.md#deferrable)<[`TransactionRequest`](../modules/verida_vda_name_client._internal_.md#transactionrequest)\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:40 - -___ - -### connect - -▸ `Abstract` **connect**(`provider`): [`Signer`](verida_vda_name_client._internal_.Signer.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `provider` | [`Provider`](verida_vda_name_client._internal_.Provider.md) | - -#### Returns - -[`Signer`](verida_vda_name_client._internal_.Signer.md) - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:28 - -___ - -### estimateGas - -▸ **estimateGas**(`transaction`): `Promise`<[`BigNumber`](verida_vda_name_client._internal_.BigNumber.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transaction` | [`Deferrable`](../modules/verida_vda_name_client._internal_.md#deferrable)<[`TransactionRequest`](../modules/verida_vda_name_client._internal_.md#transactionrequest)\> | - -#### Returns - -`Promise`<[`BigNumber`](verida_vda_name_client._internal_.BigNumber.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:33 - -___ - -### getAddress - -▸ `Abstract` **getAddress**(): `Promise`<`string`\> - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:25 - -___ - -### getBalance - -▸ **getBalance**(`blockTag?`): `Promise`<[`BigNumber`](verida_vda_name_client._internal_.BigNumber.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `blockTag?` | [`BlockTag`](../modules/verida_vda_name_client._internal_.md#blocktag) | - -#### Returns - -`Promise`<[`BigNumber`](verida_vda_name_client._internal_.BigNumber.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:31 - -___ - -### getChainId - -▸ **getChainId**(): `Promise`<`number`\> - -#### Returns - -`Promise`<`number`\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:36 - -___ - -### getFeeData - -▸ **getFeeData**(): `Promise`<[`FeeData`](../interfaces/verida_vda_name_client._internal_.FeeData.md)\> - -#### Returns - -`Promise`<[`FeeData`](../interfaces/verida_vda_name_client._internal_.FeeData.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:38 - -___ - -### getGasPrice - -▸ **getGasPrice**(): `Promise`<[`BigNumber`](verida_vda_name_client._internal_.BigNumber.md)\> - -#### Returns - -`Promise`<[`BigNumber`](verida_vda_name_client._internal_.BigNumber.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:37 - -___ - -### getTransactionCount - -▸ **getTransactionCount**(`blockTag?`): `Promise`<`number`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `blockTag?` | [`BlockTag`](../modules/verida_vda_name_client._internal_.md#blocktag) | - -#### Returns - -`Promise`<`number`\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:32 - -___ - -### populateTransaction - -▸ **populateTransaction**(`transaction`): `Promise`<[`TransactionRequest`](../modules/verida_vda_name_client._internal_.md#transactionrequest)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transaction` | [`Deferrable`](../modules/verida_vda_name_client._internal_.md#deferrable)<[`TransactionRequest`](../modules/verida_vda_name_client._internal_.md#transactionrequest)\> | - -#### Returns - -`Promise`<[`TransactionRequest`](../modules/verida_vda_name_client._internal_.md#transactionrequest)\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:41 - -___ - -### resolveName - -▸ **resolveName**(`name`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:39 - -___ - -### sendTransaction - -▸ **sendTransaction**(`transaction`): `Promise`<[`TransactionResponse`](../interfaces/verida_vda_name_client._internal_.TransactionResponse.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transaction` | [`Deferrable`](../modules/verida_vda_name_client._internal_.md#deferrable)<[`TransactionRequest`](../modules/verida_vda_name_client._internal_.md#transactionrequest)\> | - -#### Returns - -`Promise`<[`TransactionResponse`](../interfaces/verida_vda_name_client._internal_.TransactionResponse.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:35 - -___ - -### signMessage - -▸ `Abstract` **signMessage**(`message`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `message` | `string` \| [`Bytes`](../modules/verida_vda_name_client._internal_.md#bytes) | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:26 - -___ - -### signTransaction - -▸ `Abstract` **signTransaction**(`transaction`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transaction` | [`Deferrable`](../modules/verida_vda_name_client._internal_.md#deferrable)<[`TransactionRequest`](../modules/verida_vda_name_client._internal_.md#transactionrequest)\> | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:27 - -___ - -### isSigner - -▸ `Static` **isSigner**(`value`): value is Signer - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `any` | - -#### Returns - -value is Signer - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:43 diff --git a/docs/api/verida-js/classes/verida_vda_name_client._internal_.TransactionDescription.md b/docs/api/verida-js/classes/verida_vda_name_client._internal_.TransactionDescription.md deleted file mode 100644 index f589a47..0000000 --- a/docs/api/verida-js/classes/verida_vda_name_client._internal_.TransactionDescription.md +++ /dev/null @@ -1,112 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-name-client](../modules/verida_vda_name_client.md) / [](../modules/verida_vda_name_client._internal_.md) / TransactionDescription - -# Class: TransactionDescription - -[@verida/vda-name-client](../modules/verida_vda_name_client.md).[](../modules/verida_vda_name_client._internal_.md).TransactionDescription - -## Hierarchy - -- [`Description`](verida_vda_name_client._internal_.Description.md)<[`TransactionDescription`](verida_vda_name_client._internal_.TransactionDescription.md)\> - - ↳ **`TransactionDescription`** - -## Table of contents - -### Constructors - -- [constructor](verida_vda_name_client._internal_.TransactionDescription.md#constructor) - -### Properties - -- [args](verida_vda_name_client._internal_.TransactionDescription.md#args) -- [functionFragment](verida_vda_name_client._internal_.TransactionDescription.md#functionfragment) -- [name](verida_vda_name_client._internal_.TransactionDescription.md#name) -- [sighash](verida_vda_name_client._internal_.TransactionDescription.md#sighash) -- [signature](verida_vda_name_client._internal_.TransactionDescription.md#signature) -- [value](verida_vda_name_client._internal_.TransactionDescription.md#value) - -## Constructors - -### constructor - -• **new TransactionDescription**(`info`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `info` | `Object` | -| `info.args` | [`Result`](../interfaces/verida_vda_name_client._internal_.Result.md) | -| `info.functionFragment` | [`FunctionFragment`](verida_vda_name_client._internal_.FunctionFragment.md) | -| `info.name` | `string` | -| `info.sighash` | `string` | -| `info.signature` | `string` | -| `info.value` | [`BigNumber`](verida_vda_name_client._internal_.BigNumber.md) | - -#### Inherited from - -[Description](verida_vda_name_client._internal_.Description.md).[constructor](verida_vda_name_client._internal_.Description.md#constructor) - -#### Defined in - -node_modules/@ethersproject/properties/lib/index.d.ts:13 - -## Properties - -### args - -• `Readonly` **args**: [`Result`](../interfaces/verida_vda_name_client._internal_.Result.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:18 - -___ - -### functionFragment - -• `Readonly` **functionFragment**: [`FunctionFragment`](verida_vda_name_client._internal_.FunctionFragment.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:16 - -___ - -### name - -• `Readonly` **name**: `string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:17 - -___ - -### sighash - -• `Readonly` **sighash**: `string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:20 - -___ - -### signature - -• `Readonly` **signature**: `string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:19 - -___ - -### value - -• `Readonly` **value**: [`BigNumber`](verida_vda_name_client._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:21 diff --git a/docs/api/verida-js/classes/verida_vda_name_client._internal_.VeridaContract.md b/docs/api/verida-js/classes/verida_vda_name_client._internal_.VeridaContract.md deleted file mode 100644 index a50900e..0000000 --- a/docs/api/verida-js/classes/verida_vda_name_client._internal_.VeridaContract.md +++ /dev/null @@ -1,199 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-name-client](../modules/verida_vda_name_client.md) / [](../modules/verida_vda_name_client._internal_.md) / VeridaContract - -# Class: VeridaContract - -[@verida/vda-name-client](../modules/verida_vda_name_client.md).[](../modules/verida_vda_name_client._internal_.md).VeridaContract - -Class representing any Verida Smart Contrat - -## Indexable - -▪ [key: `string`]: `any` - -Need such fields to add sub methods in constructor - -## Table of contents - -### Constructors - -- [constructor](verida_vda_name_client._internal_.VeridaContract.md#constructor) - -### Properties - -- [callMethod](verida_vda_name_client._internal_.VeridaContract.md#callmethod) -- [contract](verida_vda_name_client._internal_.VeridaContract.md#contract) -- [endPoint](verida_vda_name_client._internal_.VeridaContract.md#endpoint) -- [gaslessPostConfig](verida_vda_name_client._internal_.VeridaContract.md#gaslesspostconfig) -- [gaslessServerConfig](verida_vda_name_client._internal_.VeridaContract.md#gaslessserverconfig) -- [server](verida_vda_name_client._internal_.VeridaContract.md#server) -- [signer](verida_vda_name_client._internal_.VeridaContract.md#signer) -- [type](verida_vda_name_client._internal_.VeridaContract.md#type) -- [web3Config](verida_vda_name_client._internal_.VeridaContract.md#web3config) - -### Methods - -- [attachContract](verida_vda_name_client._internal_.VeridaContract.md#attachcontract) - -## Constructors - -### constructor - -• **new VeridaContract**(`type`, `config`) - -Create Verida smart contract instance. Add member functions of contract as parameters. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `type` | [`Web3CallType`](../modules/verida_vda_name_client._internal_.md#web3calltype) | interaction mode | -| `config` | [`VeridaWeb3Config`](../modules/verida_vda_name_client._internal_.md#veridaweb3config) | configuration for creating VeridaContract instance | - -#### Defined in - -packages/vda-web3-client/build/src/VeridaContractBase.d.ts:31 - -## Properties - -### callMethod - -• `Protected` **callMethod**: (`methodName`: `string`, `methodType`: `string`, `params`: `any`, `gasConfig?`: [`Web3GasConfiguration`](../interfaces/verida_vda_name_client._internal_.Web3GasConfiguration.md)) => `Promise`<[`VdaTransactionResult`](../interfaces/verida_vda_name_client._internal_.VdaTransactionResult.md)\> - -#### Type declaration - -▸ (`methodName`, `methodType`, `params`, `gasConfig?`): `Promise`<[`VdaTransactionResult`](../interfaces/verida_vda_name_client._internal_.VdaTransactionResult.md)\> - -Perform smart contract interaction. Called by member function that were created in constructor. - -##### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `methodName` | `string` | Calling method name of smart contract. From ABI. | -| `methodType` | `string` | Method type. Shows whether method in smart contract is Call function or not. | -| `params` | `any` | Parameters used to make interaction with smart contract : Array | -| `gasConfig?` | [`Web3GasConfiguration`](../interfaces/verida_vda_name_client._internal_.Web3GasConfiguration.md) | Gas configuration. Only available for non-view functions in Web3 mode | - -##### Returns - -`Promise`<[`VdaTransactionResult`](../interfaces/verida_vda_name_client._internal_.VdaTransactionResult.md)\> - -- Response from smart contract interaction - -#### Defined in - -packages/vda-web3-client/build/src/VeridaContractBase.d.ts:46 - -___ - -### contract - -• `Protected` `Optional` **contract**: [`Contract`](verida_vda_name_client._internal_.Contract.md) - -Contract instance used in web3 mode - -#### Defined in - -packages/vda-web3-client/build/src/VeridaContractBase.d.ts:13 - -___ - -### endPoint - -• `Protected` `Optional` **endPoint**: `string` - -endpoint url : Need to be defined in sub class constructor - -#### Defined in - -packages/vda-web3-client/build/src/VeridaContractBase.d.ts:18 - -___ - -### gaslessPostConfig - -• `Protected` `Optional` **gaslessPostConfig**: [`Web3GaslessPostConfig`](../interfaces/verida_vda_name_client._internal_.Web3GaslessPostConfig.md) - -#### Defined in - -packages/vda-web3-client/build/src/VeridaContractBase.d.ts:25 - -___ - -### gaslessServerConfig - -• `Protected` `Optional` **gaslessServerConfig**: [`Web3GaslessRequestConfig`](../interfaces/verida_vda_name_client._internal_.Web3GaslessRequestConfig.md) - -Configuration for gasless mode - -#### Defined in - -packages/vda-web3-client/build/src/VeridaContractBase.d.ts:24 - -___ - -### server - -• `Protected` **server**: `any` - -Axios instance used in gasless mode - -#### Defined in - -packages/vda-web3-client/build/src/VeridaContractBase.d.ts:16 - -___ - -### signer - -• `Protected` `Optional` **signer**: [`Signer`](verida_vda_name_client._internal_.Signer.md) - -#### Defined in - -packages/vda-web3-client/build/src/VeridaContractBase.d.ts:14 - -___ - -### type - -• `Protected` **type**: [`Web3CallType`](../modules/verida_vda_name_client._internal_.md#web3calltype) - -Smart contract interaction mode - -#### Defined in - -packages/vda-web3-client/build/src/VeridaContractBase.d.ts:11 - -___ - -### web3Config - -• `Protected` `Optional` **web3Config**: [`Web3SelfTransactionConfig`](../interfaces/verida_vda_name_client._internal_.Web3SelfTransactionConfig.md) - -Configuration for web3 mode - -#### Defined in - -packages/vda-web3-client/build/src/VeridaContractBase.d.ts:22 - -## Methods - -### attachContract - -▸ `Protected` **attachContract**(`controller?`): `Promise`<[`Contract`](verida_vda_name_client._internal_.Contract.md)\> - -Connect signer to contract to sign transactions. Called in web3 mode only - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `controller?` | `string` \| `Promise`<`string`\> | : Wallet public address | - -#### Returns - -`Promise`<[`Contract`](verida_vda_name_client._internal_.Contract.md)\> - -#### Defined in - -packages/vda-web3-client/build/src/VeridaContractBase.d.ts:37 diff --git a/docs/api/verida-js/classes/verida_vda_name_client._internal_.Writer.md b/docs/api/verida-js/classes/verida_vda_name_client._internal_.Writer.md deleted file mode 100644 index f2f95cb..0000000 --- a/docs/api/verida-js/classes/verida_vda_name_client._internal_.Writer.md +++ /dev/null @@ -1,242 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-name-client](../modules/verida_vda_name_client.md) / [](../modules/verida_vda_name_client._internal_.md) / Writer - -# Class: Writer - -[@verida/vda-name-client](../modules/verida_vda_name_client.md).[](../modules/verida_vda_name_client._internal_.md).Writer - -## Table of contents - -### Constructors - -- [constructor](verida_vda_name_client._internal_.Writer.md#constructor) - -### Properties - -- [\_data](verida_vda_name_client._internal_.Writer.md#_data) -- [\_dataLength](verida_vda_name_client._internal_.Writer.md#_datalength) -- [\_padding](verida_vda_name_client._internal_.Writer.md#_padding) -- [wordSize](verida_vda_name_client._internal_.Writer.md#wordsize) - -### Accessors - -- [data](verida_vda_name_client._internal_.Writer.md#data) -- [length](verida_vda_name_client._internal_.Writer.md#length) - -### Methods - -- [\_getValue](verida_vda_name_client._internal_.Writer.md#_getvalue) -- [\_writeData](verida_vda_name_client._internal_.Writer.md#_writedata) -- [appendWriter](verida_vda_name_client._internal_.Writer.md#appendwriter) -- [writeBytes](verida_vda_name_client._internal_.Writer.md#writebytes) -- [writeUpdatableValue](verida_vda_name_client._internal_.Writer.md#writeupdatablevalue) -- [writeValue](verida_vda_name_client._internal_.Writer.md#writevalue) - -## Constructors - -### constructor - -• **new Writer**(`wordSize?`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `wordSize?` | `number` | - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:27 - -## Properties - -### \_data - -• **\_data**: `Uint8Array`[] - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:24 - -___ - -### \_dataLength - -• **\_dataLength**: `number` - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:25 - -___ - -### \_padding - -• **\_padding**: `Uint8Array` - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:26 - -___ - -### wordSize - -• `Readonly` **wordSize**: `number` - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:23 - -## Accessors - -### data - -• `get` **data**(): `string` - -#### Returns - -`string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:28 - -___ - -### length - -• `get` **length**(): `number` - -#### Returns - -`number` - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:29 - -## Methods - -### \_getValue - -▸ **_getValue**(`value`): `Uint8Array` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | [`BigNumberish`](../modules/verida_vda_name_client._internal_.md#bignumberish) | - -#### Returns - -`Uint8Array` - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:33 - -___ - -### \_writeData - -▸ **_writeData**(`data`): `number` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `Uint8Array` | - -#### Returns - -`number` - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:30 - -___ - -### appendWriter - -▸ **appendWriter**(`writer`): `number` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `writer` | [`Writer`](verida_vda_name_client._internal_.Writer.md) | - -#### Returns - -`number` - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:31 - -___ - -### writeBytes - -▸ **writeBytes**(`value`): `number` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | [`BytesLike`](../modules/verida_vda_name_client._internal_.md#byteslike) | - -#### Returns - -`number` - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:32 - -___ - -### writeUpdatableValue - -▸ **writeUpdatableValue**(): (`value`: [`BigNumberish`](../modules/verida_vda_name_client._internal_.md#bignumberish)) => `void` - -#### Returns - -`fn` - -▸ (`value`): `void` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | [`BigNumberish`](../modules/verida_vda_name_client._internal_.md#bignumberish) | - -##### Returns - -`void` - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:35 - -___ - -### writeValue - -▸ **writeValue**(`value`): `number` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | [`BigNumberish`](../modules/verida_vda_name_client._internal_.md#bignumberish) | - -#### Returns - -`number` - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:34 diff --git a/docs/api/verida-js/classes/verida_vda_sbt_client.VeridaSBTClient.md b/docs/api/verida-js/classes/verida_vda_sbt_client.VeridaSBTClient.md deleted file mode 100644 index 2a7c831..0000000 --- a/docs/api/verida-js/classes/verida_vda_sbt_client.VeridaSBTClient.md +++ /dev/null @@ -1,363 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-sbt-client](../modules/verida_vda_sbt_client.md) / VeridaSBTClient - -# Class: VeridaSBTClient - -[@verida/vda-sbt-client](../modules/verida_vda_sbt_client.md).VeridaSBTClient - -## Table of contents - -### Constructors - -- [constructor](verida_vda_sbt_client.VeridaSBTClient.md#constructor) - -### Properties - -- [config](verida_vda_sbt_client.VeridaSBTClient.md#config) -- [contract](verida_vda_sbt_client.VeridaSBTClient.md#contract) -- [didAddress](verida_vda_sbt_client.VeridaSBTClient.md#didaddress) -- [network](verida_vda_sbt_client.VeridaSBTClient.md#network) -- [readOnly](verida_vda_sbt_client.VeridaSBTClient.md#readonly) -- [vdaWeb3Client](verida_vda_sbt_client.VeridaSBTClient.md#vdaweb3client) - -### Methods - -- [burnSBT](verida_vda_sbt_client.VeridaSBTClient.md#burnsbt) -- [claimSBT](verida_vda_sbt_client.VeridaSBTClient.md#claimsbt) -- [getClaimedSBTList](verida_vda_sbt_client.VeridaSBTClient.md#getclaimedsbtlist) -- [getTrustedSignerAddresses](verida_vda_sbt_client.VeridaSBTClient.md#gettrustedsigneraddresses) -- [isLocked](verida_vda_sbt_client.VeridaSBTClient.md#islocked) -- [isSBTClaimed](verida_vda_sbt_client.VeridaSBTClient.md#issbtclaimed) -- [nonceFN](verida_vda_sbt_client.VeridaSBTClient.md#noncefn) -- [ownerOf](verida_vda_sbt_client.VeridaSBTClient.md#ownerof) -- [tokenInfo](verida_vda_sbt_client.VeridaSBTClient.md#tokeninfo) -- [tokenURI](verida_vda_sbt_client.VeridaSBTClient.md#tokenuri) -- [totalSupply](verida_vda_sbt_client.VeridaSBTClient.md#totalsupply) - -## Constructors - -### constructor - -• **new VeridaSBTClient**(`config`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | [`VdaClientConfig`](../interfaces/verida_vda_sbt_client._internal_.VdaClientConfig.md) | - -#### Defined in - -[packages/vda-sbt-client/src/blockchain/blockchainApi.ts:24](https://github.com/verida/verida-js/blob/5040472/packages/vda-sbt-client/src/blockchain/blockchainApi.ts#L24) - -## Properties - -### config - -• `Private` **config**: [`VdaClientConfig`](../interfaces/verida_vda_sbt_client._internal_.VdaClientConfig.md) - -#### Defined in - -[packages/vda-sbt-client/src/blockchain/blockchainApi.ts:16](https://github.com/verida/verida-js/blob/5040472/packages/vda-sbt-client/src/blockchain/blockchainApi.ts#L16) - -___ - -### contract - -• `Private` `Optional` **contract**: [`Contract`](verida_vda_sbt_client._internal_.Contract.md) - -#### Defined in - -[packages/vda-sbt-client/src/blockchain/blockchainApi.ts:22](https://github.com/verida/verida-js/blob/5040472/packages/vda-sbt-client/src/blockchain/blockchainApi.ts#L22) - -___ - -### didAddress - -• `Private` `Optional` **didAddress**: `string` - -#### Defined in - -[packages/vda-sbt-client/src/blockchain/blockchainApi.ts:18](https://github.com/verida/verida-js/blob/5040472/packages/vda-sbt-client/src/blockchain/blockchainApi.ts#L18) - -___ - -### network - -• `Private` **network**: `string` - -#### Defined in - -[packages/vda-sbt-client/src/blockchain/blockchainApi.ts:17](https://github.com/verida/verida-js/blob/5040472/packages/vda-sbt-client/src/blockchain/blockchainApi.ts#L17) - -___ - -### readOnly - -• `Private` **readOnly**: `boolean` - -#### Defined in - -[packages/vda-sbt-client/src/blockchain/blockchainApi.ts:20](https://github.com/verida/verida-js/blob/5040472/packages/vda-sbt-client/src/blockchain/blockchainApi.ts#L20) - -___ - -### vdaWeb3Client - -• `Private` `Optional` **vdaWeb3Client**: [`VeridaContract`](verida_vda_sbt_client._internal_.VeridaContract.md) - -#### Defined in - -[packages/vda-sbt-client/src/blockchain/blockchainApi.ts:21](https://github.com/verida/verida-js/blob/5040472/packages/vda-sbt-client/src/blockchain/blockchainApi.ts#L21) - -## Methods - -### burnSBT - -▸ **burnSBT**(`tokenId`): `Promise`<`any`\> - -Burn SBT by tokenId. Only can burn in web3 mode. -Tokens claimed to the DID addresses are available to be burnt. -Not able to remove other's tokens. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `tokenId` | [`BigNumberish`](../modules/verida_vda_sbt_client._internal_.md#bignumberish) | SBT tokenId | - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -[packages/vda-sbt-client/src/blockchain/blockchainApi.ts:351](https://github.com/verida/verida-js/blob/5040472/packages/vda-sbt-client/src/blockchain/blockchainApi.ts#L351) - -___ - -### claimSBT - -▸ **claimSBT**(`sbtType`, `uniqueId`, `sbtURI`, `recipientAddress`, `signedProof`, `signerContextProof`): `Promise`<`number`\> - -Claim a SBT type to requested user - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `sbtType` | `string` | Unique type of SBT. ie: `twitter` | -| `uniqueId` | `string` | Unique ID of SBT. ie: Twitter Account ID | -| `sbtURI` | `string` | Token URI containing token metadata | -| `recipientAddress` | `string` | Blockchain wallet address to receive the SBT (ie: 0xabc123....) | -| `signedProof` | `string` | Signature generated by trusted signer that has signed a proof that this SBT can be minted (`${sbtType}-${uniqueId}-${sbtOwnerDidAddress}`] | -| `signerContextProof` | `string` | This is the proof from the trusted signer's DID Document proving the DID controls the context signing key that signed the SBT data. | - -#### Returns - -`Promise`<`number`\> - -Minted token ID - -#### Defined in - -[packages/vda-sbt-client/src/blockchain/blockchainApi.ts:192](https://github.com/verida/verida-js/blob/5040472/packages/vda-sbt-client/src/blockchain/blockchainApi.ts#L192) - -___ - -### getClaimedSBTList - -▸ **getClaimedSBTList**(`claimer`): `Promise`<`any`\> - -Returns the claimed tokenID list of a wallet address - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `claimer` | `string` | Wallet address that owns the SBTs | - -#### Returns - -`Promise`<`any`\> - -Token ID list - -#### Defined in - -[packages/vda-sbt-client/src/blockchain/blockchainApi.ts:294](https://github.com/verida/verida-js/blob/5040472/packages/vda-sbt-client/src/blockchain/blockchainApi.ts#L294) - -___ - -### getTrustedSignerAddresses - -▸ **getTrustedSignerAddresses**(): `Promise`<`any`\> - -Get the list of trusted signer addresses - -#### Returns - -`Promise`<`any`\> - -list of addresses - -#### Defined in - -[packages/vda-sbt-client/src/blockchain/blockchainApi.ts:161](https://github.com/verida/verida-js/blob/5040472/packages/vda-sbt-client/src/blockchain/blockchainApi.ts#L161) - -___ - -### isLocked - -▸ **isLocked**(`tokenId`): `Promise`<`any`\> - -Check whether inputed tokenId is locked - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `tokenId` | [`BigNumberish`](../modules/verida_vda_sbt_client._internal_.md#bignumberish) | Token ID | - -#### Returns - -`Promise`<`any`\> - -true if tokenID is locked - -#### Defined in - -[packages/vda-sbt-client/src/blockchain/blockchainApi.ts:110](https://github.com/verida/verida-js/blob/5040472/packages/vda-sbt-client/src/blockchain/blockchainApi.ts#L110) - -___ - -### isSBTClaimed - -▸ **isSBTClaimed**(`claimer`, `sbtType`, `uniqueId`): `Promise`<`any`\> - -Check whether SBT claimed for given type & uniqueId - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `claimer` | `string` | Wallet address that owns the SBT | -| `sbtType` | `string` | SBT type | -| `uniqueId` | `string` | Unique id for type. Ex : twitter account id | - -#### Returns - -`Promise`<`any`\> - -true if SBT claimed - -#### Defined in - -[packages/vda-sbt-client/src/blockchain/blockchainApi.ts:263](https://github.com/verida/verida-js/blob/5040472/packages/vda-sbt-client/src/blockchain/blockchainApi.ts#L263) - -___ - -### nonceFN - -▸ **nonceFN**(): `Promise`<`any`\> - -Get a nonce from SBT contract - -#### Returns - -`Promise`<`any`\> - -nonce of DID - -#### Defined in - -[packages/vda-sbt-client/src/blockchain/blockchainApi.ts:67](https://github.com/verida/verida-js/blob/5040472/packages/vda-sbt-client/src/blockchain/blockchainApi.ts#L67) - -___ - -### ownerOf - -▸ **ownerOf**(`tokenId`): `Promise`<`any`\> - -Get the owner address of token - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `tokenId` | [`BigNumberish`](../modules/verida_vda_sbt_client._internal_.md#bignumberish) | SBT tokenId | - -#### Returns - -`Promise`<`any`\> - -owner address of the token - -#### Defined in - -[packages/vda-sbt-client/src/blockchain/blockchainApi.ts:370](https://github.com/verida/verida-js/blob/5040472/packages/vda-sbt-client/src/blockchain/blockchainApi.ts#L370) - -___ - -### tokenInfo - -▸ **tokenInfo**(`tokenId`): `Promise`<`any`\> - -Get the SBT type & uniqueId from tokenId - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `tokenId` | [`BigNumberish`](../modules/verida_vda_sbt_client._internal_.md#bignumberish) | SBT tokenId | - -#### Returns - -`Promise`<`any`\> - -string array of SBT type & uniqueId - -#### Defined in - -[packages/vda-sbt-client/src/blockchain/blockchainApi.ts:322](https://github.com/verida/verida-js/blob/5040472/packages/vda-sbt-client/src/blockchain/blockchainApi.ts#L322) - -___ - -### tokenURI - -▸ **tokenURI**(`tokenId`): `Promise`<`any`\> - -Return the tokenURI matched to tokenId - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `tokenId` | [`BigNumberish`](../modules/verida_vda_sbt_client._internal_.md#bignumberish) | tokenId | - -#### Returns - -`Promise`<`any`\> - -tokenURI from SBT contract - -#### Defined in - -[packages/vda-sbt-client/src/blockchain/blockchainApi.ts:84](https://github.com/verida/verida-js/blob/5040472/packages/vda-sbt-client/src/blockchain/blockchainApi.ts#L84) - -___ - -### totalSupply - -▸ **totalSupply**(): `Promise`<`any`\> - -Get the total number of tokens - -#### Returns - -`Promise`<`any`\> - -total number of tokens minted. It includes the burnt tokens. - -#### Defined in - -[packages/vda-sbt-client/src/blockchain/blockchainApi.ts:136](https://github.com/verida/verida-js/blob/5040472/packages/vda-sbt-client/src/blockchain/blockchainApi.ts#L136) diff --git a/docs/api/verida-js/classes/verida_vda_sbt_client._internal_.AbiCoder.md b/docs/api/verida-js/classes/verida_vda_sbt_client._internal_.AbiCoder.md deleted file mode 100644 index bf0af42..0000000 --- a/docs/api/verida-js/classes/verida_vda_sbt_client._internal_.AbiCoder.md +++ /dev/null @@ -1,183 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-sbt-client](../modules/verida_vda_sbt_client.md) / [](../modules/verida_vda_sbt_client._internal_.md) / AbiCoder - -# Class: AbiCoder - -[@verida/vda-sbt-client](../modules/verida_vda_sbt_client.md).[](../modules/verida_vda_sbt_client._internal_.md).AbiCoder - -## Table of contents - -### Constructors - -- [constructor](verida_vda_sbt_client._internal_.AbiCoder.md#constructor) - -### Properties - -- [coerceFunc](verida_vda_sbt_client._internal_.AbiCoder.md#coercefunc) - -### Methods - -- [\_getCoder](verida_vda_sbt_client._internal_.AbiCoder.md#_getcoder) -- [\_getReader](verida_vda_sbt_client._internal_.AbiCoder.md#_getreader) -- [\_getWordSize](verida_vda_sbt_client._internal_.AbiCoder.md#_getwordsize) -- [\_getWriter](verida_vda_sbt_client._internal_.AbiCoder.md#_getwriter) -- [decode](verida_vda_sbt_client._internal_.AbiCoder.md#decode) -- [encode](verida_vda_sbt_client._internal_.AbiCoder.md#encode) -- [getDefaultValue](verida_vda_sbt_client._internal_.AbiCoder.md#getdefaultvalue) - -## Constructors - -### constructor - -• **new AbiCoder**(`coerceFunc?`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `coerceFunc?` | [`CoerceFunc`](../modules/verida_vda_sbt_client._internal_.md#coercefunc) | - -#### Defined in - -node_modules/@ethersproject/abi/lib/abi-coder.d.ts:7 - -## Properties - -### coerceFunc - -• `Readonly` **coerceFunc**: [`CoerceFunc`](../modules/verida_vda_sbt_client._internal_.md#coercefunc) - -#### Defined in - -node_modules/@ethersproject/abi/lib/abi-coder.d.ts:6 - -## Methods - -### \_getCoder - -▸ **_getCoder**(`param`): [`Coder`](verida_vda_sbt_client._internal_.Coder.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `param` | [`ParamType`](verida_vda_sbt_client._internal_.ParamType.md) | - -#### Returns - -[`Coder`](verida_vda_sbt_client._internal_.Coder.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/abi-coder.d.ts:8 - -___ - -### \_getReader - -▸ **_getReader**(`data`, `allowLoose?`): [`Reader`](verida_vda_sbt_client._internal_.Reader.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `Uint8Array` | -| `allowLoose?` | `boolean` | - -#### Returns - -[`Reader`](verida_vda_sbt_client._internal_.Reader.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/abi-coder.d.ts:10 - -___ - -### \_getWordSize - -▸ **_getWordSize**(): `number` - -#### Returns - -`number` - -#### Defined in - -node_modules/@ethersproject/abi/lib/abi-coder.d.ts:9 - -___ - -### \_getWriter - -▸ **_getWriter**(): [`Writer`](verida_vda_sbt_client._internal_.Writer.md) - -#### Returns - -[`Writer`](verida_vda_sbt_client._internal_.Writer.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/abi-coder.d.ts:11 - -___ - -### decode - -▸ **decode**(`types`, `data`, `loose?`): [`Result`](../interfaces/verida_vda_sbt_client._internal_.Result.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `types` | readonly (`string` \| [`ParamType`](verida_vda_sbt_client._internal_.ParamType.md))[] | -| `data` | [`BytesLike`](../modules/verida_vda_sbt_client._internal_.md#byteslike) | -| `loose?` | `boolean` | - -#### Returns - -[`Result`](../interfaces/verida_vda_sbt_client._internal_.Result.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/abi-coder.d.ts:14 - -___ - -### encode - -▸ **encode**(`types`, `values`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `types` | readonly (`string` \| [`ParamType`](verida_vda_sbt_client._internal_.ParamType.md))[] | -| `values` | readonly `any`[] | - -#### Returns - -`string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/abi-coder.d.ts:13 - -___ - -### getDefaultValue - -▸ **getDefaultValue**(`types`): [`Result`](../interfaces/verida_vda_sbt_client._internal_.Result.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `types` | readonly (`string` \| [`ParamType`](verida_vda_sbt_client._internal_.ParamType.md))[] | - -#### Returns - -[`Result`](../interfaces/verida_vda_sbt_client._internal_.Result.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/abi-coder.d.ts:12 diff --git a/docs/api/verida-js/classes/verida_vda_sbt_client._internal_.BaseContract.md b/docs/api/verida-js/classes/verida_vda_sbt_client._internal_.BaseContract.md deleted file mode 100644 index 476f4bf..0000000 --- a/docs/api/verida-js/classes/verida_vda_sbt_client._internal_.BaseContract.md +++ /dev/null @@ -1,660 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-sbt-client](../modules/verida_vda_sbt_client.md) / [](../modules/verida_vda_sbt_client._internal_.md) / BaseContract - -# Class: BaseContract - -[@verida/vda-sbt-client](../modules/verida_vda_sbt_client.md).[](../modules/verida_vda_sbt_client._internal_.md).BaseContract - -## Hierarchy - -- **`BaseContract`** - - ↳ [`Contract`](verida_vda_sbt_client._internal_.Contract.md) - -## Table of contents - -### Constructors - -- [constructor](verida_vda_sbt_client._internal_.BaseContract.md#constructor) - -### Properties - -- [\_addEventListener](verida_vda_sbt_client._internal_.BaseContract.md#_addeventlistener) -- [\_deployedPromise](verida_vda_sbt_client._internal_.BaseContract.md#_deployedpromise) -- [\_getRunningEvent](verida_vda_sbt_client._internal_.BaseContract.md#_getrunningevent) -- [\_normalizeRunningEvent](verida_vda_sbt_client._internal_.BaseContract.md#_normalizerunningevent) -- [\_runningEvents](verida_vda_sbt_client._internal_.BaseContract.md#_runningevents) -- [\_wrappedEmits](verida_vda_sbt_client._internal_.BaseContract.md#_wrappedemits) -- [address](verida_vda_sbt_client._internal_.BaseContract.md#address) -- [callStatic](verida_vda_sbt_client._internal_.BaseContract.md#callstatic) -- [deployTransaction](verida_vda_sbt_client._internal_.BaseContract.md#deploytransaction) -- [estimateGas](verida_vda_sbt_client._internal_.BaseContract.md#estimategas) -- [filters](verida_vda_sbt_client._internal_.BaseContract.md#filters) -- [functions](verida_vda_sbt_client._internal_.BaseContract.md#functions) -- [interface](verida_vda_sbt_client._internal_.BaseContract.md#interface) -- [populateTransaction](verida_vda_sbt_client._internal_.BaseContract.md#populatetransaction) -- [provider](verida_vda_sbt_client._internal_.BaseContract.md#provider) -- [resolvedAddress](verida_vda_sbt_client._internal_.BaseContract.md#resolvedaddress) -- [signer](verida_vda_sbt_client._internal_.BaseContract.md#signer) - -### Methods - -- [\_checkRunningEvents](verida_vda_sbt_client._internal_.BaseContract.md#_checkrunningevents) -- [\_deployed](verida_vda_sbt_client._internal_.BaseContract.md#_deployed) -- [\_wrapEvent](verida_vda_sbt_client._internal_.BaseContract.md#_wrapevent) -- [attach](verida_vda_sbt_client._internal_.BaseContract.md#attach) -- [connect](verida_vda_sbt_client._internal_.BaseContract.md#connect) -- [deployed](verida_vda_sbt_client._internal_.BaseContract.md#deployed) -- [emit](verida_vda_sbt_client._internal_.BaseContract.md#emit) -- [fallback](verida_vda_sbt_client._internal_.BaseContract.md#fallback) -- [listenerCount](verida_vda_sbt_client._internal_.BaseContract.md#listenercount) -- [listeners](verida_vda_sbt_client._internal_.BaseContract.md#listeners) -- [off](verida_vda_sbt_client._internal_.BaseContract.md#off) -- [on](verida_vda_sbt_client._internal_.BaseContract.md#on) -- [once](verida_vda_sbt_client._internal_.BaseContract.md#once) -- [queryFilter](verida_vda_sbt_client._internal_.BaseContract.md#queryfilter) -- [removeAllListeners](verida_vda_sbt_client._internal_.BaseContract.md#removealllisteners) -- [removeListener](verida_vda_sbt_client._internal_.BaseContract.md#removelistener) -- [getContractAddress](verida_vda_sbt_client._internal_.BaseContract.md#getcontractaddress) -- [getInterface](verida_vda_sbt_client._internal_.BaseContract.md#getinterface) -- [isIndexed](verida_vda_sbt_client._internal_.BaseContract.md#isindexed) - -## Constructors - -### constructor - -• **new BaseContract**(`addressOrName`, `contractInterface`, `signerOrProvider?`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `addressOrName` | `string` | -| `contractInterface` | [`ContractInterface`](../modules/verida_vda_sbt_client._internal_.md#contractinterface) | -| `signerOrProvider?` | [`Signer`](verida_vda_sbt_client._internal_.Signer.md) \| [`Provider`](verida_vda_sbt_client._internal_.Provider.md) | - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:107 - -## Properties - -### \_addEventListener - -• `Private` **\_addEventListener**: `any` - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:123 - -___ - -### \_deployedPromise - -• **\_deployedPromise**: `Promise`<[`Contract`](verida_vda_sbt_client._internal_.Contract.md)\> - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:100 - -___ - -### \_getRunningEvent - -• `Private` **\_getRunningEvent**: `any` - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:120 - -___ - -### \_normalizeRunningEvent - -• `Private` **\_normalizeRunningEvent**: `any` - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:119 - -___ - -### \_runningEvents - -• **\_runningEvents**: `Object` - -#### Index signature - -▪ [eventTag: `string`]: [`RunningEvent`](verida_vda_sbt_client._internal_.RunningEvent.md) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:101 - -___ - -### \_wrappedEmits - -• **\_wrappedEmits**: `Object` - -#### Index signature - -▪ [eventTag: `string`]: (...`args`: `any`[]) => `void` - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:104 - -___ - -### address - -• `Readonly` **address**: `string` - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:79 - -___ - -### callStatic - -• `Readonly` **callStatic**: `Object` - -#### Index signature - -▪ [name: `string`]: [`ContractFunction`](../modules/verida_vda_sbt_client._internal_.md#contractfunction) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:86 - -___ - -### deployTransaction - -• `Readonly` **deployTransaction**: [`TransactionResponse`](../interfaces/verida_vda_sbt_client._internal_.TransactionResponse.md) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:99 - -___ - -### estimateGas - -• `Readonly` **estimateGas**: `Object` - -#### Index signature - -▪ [name: `string`]: [`ContractFunction`](../modules/verida_vda_sbt_client._internal_.md#contractfunction)<[`BigNumber`](verida_vda_sbt_client._internal_.BigNumber.md)\> - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:89 - -___ - -### filters - -• `Readonly` **filters**: `Object` - -#### Index signature - -▪ [name: `string`]: (...`args`: `any`[]) => [`EventFilter`](../modules/verida_vda_sbt_client._internal_.md#eventfilter) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:95 - -___ - -### functions - -• `Readonly` **functions**: `Object` - -#### Index signature - -▪ [name: `string`]: [`ContractFunction`](../modules/verida_vda_sbt_client._internal_.md#contractfunction) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:83 - -___ - -### interface - -• `Readonly` **interface**: [`Interface`](verida_vda_sbt_client._internal_.Interface.md) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:80 - -___ - -### populateTransaction - -• `Readonly` **populateTransaction**: `Object` - -#### Index signature - -▪ [name: `string`]: [`ContractFunction`](../modules/verida_vda_sbt_client._internal_.md#contractfunction)<[`PopulatedTransaction`](../interfaces/verida_vda_sbt_client._internal_.PopulatedTransaction.md)\> - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:92 - -___ - -### provider - -• `Readonly` **provider**: [`Provider`](verida_vda_sbt_client._internal_.Provider.md) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:82 - -___ - -### resolvedAddress - -• `Readonly` **resolvedAddress**: `Promise`<`string`\> - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:98 - -___ - -### signer - -• `Readonly` **signer**: [`Signer`](verida_vda_sbt_client._internal_.Signer.md) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:81 - -## Methods - -### \_checkRunningEvents - -▸ **_checkRunningEvents**(`runningEvent`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `runningEvent` | [`RunningEvent`](verida_vda_sbt_client._internal_.RunningEvent.md) | - -#### Returns - -`void` - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:121 - -___ - -### \_deployed - -▸ **_deployed**(`blockTag?`): `Promise`<[`Contract`](verida_vda_sbt_client._internal_.Contract.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `blockTag?` | [`BlockTag`](../modules/verida_vda_sbt_client._internal_.md#blocktag) | - -#### Returns - -`Promise`<[`Contract`](verida_vda_sbt_client._internal_.Contract.md)\> - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:114 - -___ - -### \_wrapEvent - -▸ **_wrapEvent**(`runningEvent`, `log`, `listener`): [`Event`](../interfaces/verida_vda_sbt_client._internal_.Event.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `runningEvent` | [`RunningEvent`](verida_vda_sbt_client._internal_.RunningEvent.md) | -| `log` | [`Log`](../interfaces/verida_vda_sbt_client._internal_.Log.md) | -| `listener` | [`Listener`](../modules/verida_vda_sbt_client._internal_.md#listener) | - -#### Returns - -[`Event`](../interfaces/verida_vda_sbt_client._internal_.Event.md) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:122 - -___ - -### attach - -▸ **attach**(`addressOrName`): [`Contract`](verida_vda_sbt_client._internal_.Contract.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `addressOrName` | `string` | - -#### Returns - -[`Contract`](verida_vda_sbt_client._internal_.Contract.md) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:117 - -___ - -### connect - -▸ **connect**(`signerOrProvider`): [`Contract`](verida_vda_sbt_client._internal_.Contract.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `signerOrProvider` | `string` \| [`Signer`](verida_vda_sbt_client._internal_.Signer.md) \| [`Provider`](verida_vda_sbt_client._internal_.Provider.md) | - -#### Returns - -[`Contract`](verida_vda_sbt_client._internal_.Contract.md) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:116 - -___ - -### deployed - -▸ **deployed**(): `Promise`<[`Contract`](verida_vda_sbt_client._internal_.Contract.md)\> - -#### Returns - -`Promise`<[`Contract`](verida_vda_sbt_client._internal_.Contract.md)\> - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:113 - -___ - -### emit - -▸ **emit**(`eventName`, ...`args`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | `string` \| [`EventFilter`](../modules/verida_vda_sbt_client._internal_.md#eventfilter) | -| `...args` | `any`[] | - -#### Returns - -`boolean` - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:127 - -___ - -### fallback - -▸ **fallback**(`overrides?`): `Promise`<[`TransactionResponse`](../interfaces/verida_vda_sbt_client._internal_.TransactionResponse.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `overrides?` | [`TransactionRequest`](../modules/verida_vda_sbt_client._internal_.md#transactionrequest) | - -#### Returns - -`Promise`<[`TransactionResponse`](../interfaces/verida_vda_sbt_client._internal_.TransactionResponse.md)\> - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:115 - -___ - -### listenerCount - -▸ **listenerCount**(`eventName?`): `number` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName?` | `string` \| [`EventFilter`](../modules/verida_vda_sbt_client._internal_.md#eventfilter) | - -#### Returns - -`number` - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:128 - -___ - -### listeners - -▸ **listeners**(`eventName?`): [`Listener`](../modules/verida_vda_sbt_client._internal_.md#listener)[] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName?` | `string` \| [`EventFilter`](../modules/verida_vda_sbt_client._internal_.md#eventfilter) | - -#### Returns - -[`Listener`](../modules/verida_vda_sbt_client._internal_.md#listener)[] - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:129 - -___ - -### off - -▸ **off**(`eventName`, `listener`): [`BaseContract`](verida_vda_sbt_client._internal_.BaseContract.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | `string` \| [`EventFilter`](../modules/verida_vda_sbt_client._internal_.md#eventfilter) | -| `listener` | [`Listener`](../modules/verida_vda_sbt_client._internal_.md#listener) | - -#### Returns - -[`BaseContract`](verida_vda_sbt_client._internal_.BaseContract.md) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:131 - -___ - -### on - -▸ **on**(`event`, `listener`): [`BaseContract`](verida_vda_sbt_client._internal_.BaseContract.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | `string` \| [`EventFilter`](../modules/verida_vda_sbt_client._internal_.md#eventfilter) | -| `listener` | [`Listener`](../modules/verida_vda_sbt_client._internal_.md#listener) | - -#### Returns - -[`BaseContract`](verida_vda_sbt_client._internal_.BaseContract.md) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:125 - -___ - -### once - -▸ **once**(`event`, `listener`): [`BaseContract`](verida_vda_sbt_client._internal_.BaseContract.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | `string` \| [`EventFilter`](../modules/verida_vda_sbt_client._internal_.md#eventfilter) | -| `listener` | [`Listener`](../modules/verida_vda_sbt_client._internal_.md#listener) | - -#### Returns - -[`BaseContract`](verida_vda_sbt_client._internal_.BaseContract.md) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:126 - -___ - -### queryFilter - -▸ **queryFilter**(`event`, `fromBlockOrBlockhash?`, `toBlock?`): `Promise`<[`Event`](../interfaces/verida_vda_sbt_client._internal_.Event.md)[]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | `string` \| [`EventFilter`](../modules/verida_vda_sbt_client._internal_.md#eventfilter) | -| `fromBlockOrBlockhash?` | [`BlockTag`](../modules/verida_vda_sbt_client._internal_.md#blocktag) | -| `toBlock?` | [`BlockTag`](../modules/verida_vda_sbt_client._internal_.md#blocktag) | - -#### Returns - -`Promise`<[`Event`](../interfaces/verida_vda_sbt_client._internal_.Event.md)[]\> - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:124 - -___ - -### removeAllListeners - -▸ **removeAllListeners**(`eventName?`): [`BaseContract`](verida_vda_sbt_client._internal_.BaseContract.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName?` | `string` \| [`EventFilter`](../modules/verida_vda_sbt_client._internal_.md#eventfilter) | - -#### Returns - -[`BaseContract`](verida_vda_sbt_client._internal_.BaseContract.md) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:130 - -___ - -### removeListener - -▸ **removeListener**(`eventName`, `listener`): [`BaseContract`](verida_vda_sbt_client._internal_.BaseContract.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | `string` \| [`EventFilter`](../modules/verida_vda_sbt_client._internal_.md#eventfilter) | -| `listener` | [`Listener`](../modules/verida_vda_sbt_client._internal_.md#listener) | - -#### Returns - -[`BaseContract`](verida_vda_sbt_client._internal_.BaseContract.md) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:132 - -___ - -### getContractAddress - -▸ `Static` **getContractAddress**(`transaction`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transaction` | `Object` | -| `transaction.from` | `string` | -| `transaction.nonce` | [`BigNumberish`](../modules/verida_vda_sbt_client._internal_.md#bignumberish) | - -#### Returns - -`string` - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:108 - -___ - -### getInterface - -▸ `Static` **getInterface**(`contractInterface`): [`Interface`](verida_vda_sbt_client._internal_.Interface.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contractInterface` | [`ContractInterface`](../modules/verida_vda_sbt_client._internal_.md#contractinterface) | - -#### Returns - -[`Interface`](verida_vda_sbt_client._internal_.Interface.md) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:112 - -___ - -### isIndexed - -▸ `Static` **isIndexed**(`value`): value is Indexed - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `any` | - -#### Returns - -value is Indexed - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:118 diff --git a/docs/api/verida-js/classes/verida_vda_sbt_client._internal_.BigNumber.md b/docs/api/verida-js/classes/verida_vda_sbt_client._internal_.BigNumber.md deleted file mode 100644 index 59c15f4..0000000 --- a/docs/api/verida-js/classes/verida_vda_sbt_client._internal_.BigNumber.md +++ /dev/null @@ -1,631 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-sbt-client](../modules/verida_vda_sbt_client.md) / [](../modules/verida_vda_sbt_client._internal_.md) / BigNumber - -# Class: BigNumber - -[@verida/vda-sbt-client](../modules/verida_vda_sbt_client.md).[](../modules/verida_vda_sbt_client._internal_.md).BigNumber - -## Implements - -- [`Hexable`](../interfaces/verida_vda_sbt_client._internal_.Hexable.md) - -## Table of contents - -### Constructors - -- [constructor](verida_vda_sbt_client._internal_.BigNumber.md#constructor) - -### Properties - -- [\_hex](verida_vda_sbt_client._internal_.BigNumber.md#_hex) -- [\_isBigNumber](verida_vda_sbt_client._internal_.BigNumber.md#_isbignumber) - -### Methods - -- [abs](verida_vda_sbt_client._internal_.BigNumber.md#abs) -- [add](verida_vda_sbt_client._internal_.BigNumber.md#add) -- [and](verida_vda_sbt_client._internal_.BigNumber.md#and) -- [div](verida_vda_sbt_client._internal_.BigNumber.md#div) -- [eq](verida_vda_sbt_client._internal_.BigNumber.md#eq) -- [fromTwos](verida_vda_sbt_client._internal_.BigNumber.md#fromtwos) -- [gt](verida_vda_sbt_client._internal_.BigNumber.md#gt) -- [gte](verida_vda_sbt_client._internal_.BigNumber.md#gte) -- [isNegative](verida_vda_sbt_client._internal_.BigNumber.md#isnegative) -- [isZero](verida_vda_sbt_client._internal_.BigNumber.md#iszero) -- [lt](verida_vda_sbt_client._internal_.BigNumber.md#lt) -- [lte](verida_vda_sbt_client._internal_.BigNumber.md#lte) -- [mask](verida_vda_sbt_client._internal_.BigNumber.md#mask) -- [mod](verida_vda_sbt_client._internal_.BigNumber.md#mod) -- [mul](verida_vda_sbt_client._internal_.BigNumber.md#mul) -- [or](verida_vda_sbt_client._internal_.BigNumber.md#or) -- [pow](verida_vda_sbt_client._internal_.BigNumber.md#pow) -- [shl](verida_vda_sbt_client._internal_.BigNumber.md#shl) -- [shr](verida_vda_sbt_client._internal_.BigNumber.md#shr) -- [sub](verida_vda_sbt_client._internal_.BigNumber.md#sub) -- [toBigInt](verida_vda_sbt_client._internal_.BigNumber.md#tobigint) -- [toHexString](verida_vda_sbt_client._internal_.BigNumber.md#tohexstring) -- [toJSON](verida_vda_sbt_client._internal_.BigNumber.md#tojson) -- [toNumber](verida_vda_sbt_client._internal_.BigNumber.md#tonumber) -- [toString](verida_vda_sbt_client._internal_.BigNumber.md#tostring) -- [toTwos](verida_vda_sbt_client._internal_.BigNumber.md#totwos) -- [xor](verida_vda_sbt_client._internal_.BigNumber.md#xor) -- [from](verida_vda_sbt_client._internal_.BigNumber.md#from) -- [isBigNumber](verida_vda_sbt_client._internal_.BigNumber.md#isbignumber) - -## Constructors - -### constructor - -• **new BigNumber**(`constructorGuard`, `hex`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `constructorGuard` | `any` | -| `hex` | `string` | - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:7 - -## Properties - -### \_hex - -• `Readonly` **\_hex**: `string` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:5 - -___ - -### \_isBigNumber - -• `Readonly` **\_isBigNumber**: `boolean` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:6 - -## Methods - -### abs - -▸ **abs**(): [`BigNumber`](verida_vda_sbt_client._internal_.BigNumber.md) - -#### Returns - -[`BigNumber`](verida_vda_sbt_client._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:10 - -___ - -### add - -▸ **add**(`other`): [`BigNumber`](verida_vda_sbt_client._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_vda_sbt_client._internal_.md#bignumberish) | - -#### Returns - -[`BigNumber`](verida_vda_sbt_client._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:11 - -___ - -### and - -▸ **and**(`other`): [`BigNumber`](verida_vda_sbt_client._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_vda_sbt_client._internal_.md#bignumberish) | - -#### Returns - -[`BigNumber`](verida_vda_sbt_client._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:17 - -___ - -### div - -▸ **div**(`other`): [`BigNumber`](verida_vda_sbt_client._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_vda_sbt_client._internal_.md#bignumberish) | - -#### Returns - -[`BigNumber`](verida_vda_sbt_client._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:13 - -___ - -### eq - -▸ **eq**(`other`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_vda_sbt_client._internal_.md#bignumberish) | - -#### Returns - -`boolean` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:23 - -___ - -### fromTwos - -▸ **fromTwos**(`value`): [`BigNumber`](verida_vda_sbt_client._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `number` | - -#### Returns - -[`BigNumber`](verida_vda_sbt_client._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:8 - -___ - -### gt - -▸ **gt**(`other`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_vda_sbt_client._internal_.md#bignumberish) | - -#### Returns - -`boolean` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:26 - -___ - -### gte - -▸ **gte**(`other`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_vda_sbt_client._internal_.md#bignumberish) | - -#### Returns - -`boolean` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:27 - -___ - -### isNegative - -▸ **isNegative**(): `boolean` - -#### Returns - -`boolean` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:28 - -___ - -### isZero - -▸ **isZero**(): `boolean` - -#### Returns - -`boolean` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:29 - -___ - -### lt - -▸ **lt**(`other`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_vda_sbt_client._internal_.md#bignumberish) | - -#### Returns - -`boolean` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:24 - -___ - -### lte - -▸ **lte**(`other`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_vda_sbt_client._internal_.md#bignumberish) | - -#### Returns - -`boolean` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:25 - -___ - -### mask - -▸ **mask**(`value`): [`BigNumber`](verida_vda_sbt_client._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `number` | - -#### Returns - -[`BigNumber`](verida_vda_sbt_client._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:20 - -___ - -### mod - -▸ **mod**(`other`): [`BigNumber`](verida_vda_sbt_client._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_vda_sbt_client._internal_.md#bignumberish) | - -#### Returns - -[`BigNumber`](verida_vda_sbt_client._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:15 - -___ - -### mul - -▸ **mul**(`other`): [`BigNumber`](verida_vda_sbt_client._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_vda_sbt_client._internal_.md#bignumberish) | - -#### Returns - -[`BigNumber`](verida_vda_sbt_client._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:14 - -___ - -### or - -▸ **or**(`other`): [`BigNumber`](verida_vda_sbt_client._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_vda_sbt_client._internal_.md#bignumberish) | - -#### Returns - -[`BigNumber`](verida_vda_sbt_client._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:18 - -___ - -### pow - -▸ **pow**(`other`): [`BigNumber`](verida_vda_sbt_client._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_vda_sbt_client._internal_.md#bignumberish) | - -#### Returns - -[`BigNumber`](verida_vda_sbt_client._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:16 - -___ - -### shl - -▸ **shl**(`value`): [`BigNumber`](verida_vda_sbt_client._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `number` | - -#### Returns - -[`BigNumber`](verida_vda_sbt_client._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:21 - -___ - -### shr - -▸ **shr**(`value`): [`BigNumber`](verida_vda_sbt_client._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `number` | - -#### Returns - -[`BigNumber`](verida_vda_sbt_client._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:22 - -___ - -### sub - -▸ **sub**(`other`): [`BigNumber`](verida_vda_sbt_client._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_vda_sbt_client._internal_.md#bignumberish) | - -#### Returns - -[`BigNumber`](verida_vda_sbt_client._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:12 - -___ - -### toBigInt - -▸ **toBigInt**(): `bigint` - -#### Returns - -`bigint` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:31 - -___ - -### toHexString - -▸ **toHexString**(): `string` - -#### Returns - -`string` - -#### Implementation of - -[Hexable](../interfaces/verida_vda_sbt_client._internal_.Hexable.md).[toHexString](../interfaces/verida_vda_sbt_client._internal_.Hexable.md#tohexstring) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:33 - -___ - -### toJSON - -▸ **toJSON**(`key?`): `any` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `key?` | `string` | - -#### Returns - -`any` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:34 - -___ - -### toNumber - -▸ **toNumber**(): `number` - -#### Returns - -`number` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:30 - -___ - -### toString - -▸ **toString**(): `string` - -#### Returns - -`string` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:32 - -___ - -### toTwos - -▸ **toTwos**(`value`): [`BigNumber`](verida_vda_sbt_client._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `number` | - -#### Returns - -[`BigNumber`](verida_vda_sbt_client._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:9 - -___ - -### xor - -▸ **xor**(`other`): [`BigNumber`](verida_vda_sbt_client._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_vda_sbt_client._internal_.md#bignumberish) | - -#### Returns - -[`BigNumber`](verida_vda_sbt_client._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:19 - -___ - -### from - -▸ `Static` **from**(`value`): [`BigNumber`](verida_vda_sbt_client._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `any` | - -#### Returns - -[`BigNumber`](verida_vda_sbt_client._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:35 - -___ - -### isBigNumber - -▸ `Static` **isBigNumber**(`value`): value is BigNumber - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `any` | - -#### Returns - -value is BigNumber - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:36 diff --git a/docs/api/verida-js/classes/verida_vda_sbt_client._internal_.Coder.md b/docs/api/verida-js/classes/verida_vda_sbt_client._internal_.Coder.md deleted file mode 100644 index adb405c..0000000 --- a/docs/api/verida-js/classes/verida_vda_sbt_client._internal_.Coder.md +++ /dev/null @@ -1,160 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-sbt-client](../modules/verida_vda_sbt_client.md) / [](../modules/verida_vda_sbt_client._internal_.md) / Coder - -# Class: Coder - -[@verida/vda-sbt-client](../modules/verida_vda_sbt_client.md).[](../modules/verida_vda_sbt_client._internal_.md).Coder - -## Table of contents - -### Constructors - -- [constructor](verida_vda_sbt_client._internal_.Coder.md#constructor) - -### Properties - -- [dynamic](verida_vda_sbt_client._internal_.Coder.md#dynamic) -- [localName](verida_vda_sbt_client._internal_.Coder.md#localname) -- [name](verida_vda_sbt_client._internal_.Coder.md#name) -- [type](verida_vda_sbt_client._internal_.Coder.md#type) - -### Methods - -- [\_throwError](verida_vda_sbt_client._internal_.Coder.md#_throwerror) -- [decode](verida_vda_sbt_client._internal_.Coder.md#decode) -- [defaultValue](verida_vda_sbt_client._internal_.Coder.md#defaultvalue) -- [encode](verida_vda_sbt_client._internal_.Coder.md#encode) - -## Constructors - -### constructor - -• **new Coder**(`name`, `type`, `localName`, `dynamic`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` | -| `type` | `string` | -| `localName` | `string` | -| `dynamic` | `boolean` | - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:16 - -## Properties - -### dynamic - -• `Readonly` **dynamic**: `boolean` - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:15 - -___ - -### localName - -• `Readonly` **localName**: `string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:14 - -___ - -### name - -• `Readonly` **name**: `string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:12 - -___ - -### type - -• `Readonly` **type**: `string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:13 - -## Methods - -### \_throwError - -▸ **_throwError**(`message`, `value`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `message` | `string` | -| `value` | `any` | - -#### Returns - -`void` - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:17 - -___ - -### decode - -▸ `Abstract` **decode**(`reader`): `any` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `reader` | [`Reader`](verida_vda_sbt_client._internal_.Reader.md) | - -#### Returns - -`any` - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:19 - -___ - -### defaultValue - -▸ `Abstract` **defaultValue**(): `any` - -#### Returns - -`any` - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:20 - -___ - -### encode - -▸ `Abstract` **encode**(`writer`, `value`): `number` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `writer` | [`Writer`](verida_vda_sbt_client._internal_.Writer.md) | -| `value` | `any` | - -#### Returns - -`number` - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:18 diff --git a/docs/api/verida-js/classes/verida_vda_sbt_client._internal_.ConstructorFragment.md b/docs/api/verida-js/classes/verida_vda_sbt_client._internal_.ConstructorFragment.md deleted file mode 100644 index 7ef6458..0000000 --- a/docs/api/verida-js/classes/verida_vda_sbt_client._internal_.ConstructorFragment.md +++ /dev/null @@ -1,285 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-sbt-client](../modules/verida_vda_sbt_client.md) / [](../modules/verida_vda_sbt_client._internal_.md) / ConstructorFragment - -# Class: ConstructorFragment - -[@verida/vda-sbt-client](../modules/verida_vda_sbt_client.md).[](../modules/verida_vda_sbt_client._internal_.md).ConstructorFragment - -## Hierarchy - -- [`Fragment`](verida_vda_sbt_client._internal_.Fragment.md) - - ↳ **`ConstructorFragment`** - - ↳↳ [`FunctionFragment`](verida_vda_sbt_client._internal_.FunctionFragment.md) - -## Table of contents - -### Constructors - -- [constructor](verida_vda_sbt_client._internal_.ConstructorFragment.md#constructor) - -### Properties - -- [\_isFragment](verida_vda_sbt_client._internal_.ConstructorFragment.md#_isfragment) -- [gas](verida_vda_sbt_client._internal_.ConstructorFragment.md#gas) -- [inputs](verida_vda_sbt_client._internal_.ConstructorFragment.md#inputs) -- [name](verida_vda_sbt_client._internal_.ConstructorFragment.md#name) -- [payable](verida_vda_sbt_client._internal_.ConstructorFragment.md#payable) -- [stateMutability](verida_vda_sbt_client._internal_.ConstructorFragment.md#statemutability) -- [type](verida_vda_sbt_client._internal_.ConstructorFragment.md#type) - -### Methods - -- [format](verida_vda_sbt_client._internal_.ConstructorFragment.md#format) -- [from](verida_vda_sbt_client._internal_.ConstructorFragment.md#from) -- [fromObject](verida_vda_sbt_client._internal_.ConstructorFragment.md#fromobject) -- [fromString](verida_vda_sbt_client._internal_.ConstructorFragment.md#fromstring) -- [isConstructorFragment](verida_vda_sbt_client._internal_.ConstructorFragment.md#isconstructorfragment) -- [isFragment](verida_vda_sbt_client._internal_.ConstructorFragment.md#isfragment) - -## Constructors - -### constructor - -• **new ConstructorFragment**(`constructorGuard`, `params`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `constructorGuard` | `any` | -| `params` | `any` | - -#### Inherited from - -[Fragment](verida_vda_sbt_client._internal_.Fragment.md).[constructor](verida_vda_sbt_client._internal_.Fragment.md#constructor) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:44 - -## Properties - -### \_isFragment - -• `Readonly` **\_isFragment**: `boolean` - -#### Inherited from - -[Fragment](verida_vda_sbt_client._internal_.Fragment.md).[_isFragment](verida_vda_sbt_client._internal_.Fragment.md#_isfragment) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:43 - -___ - -### gas - -• `Optional` **gas**: [`BigNumber`](verida_vda_sbt_client._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:62 - -___ - -### inputs - -• `Readonly` **inputs**: [`ParamType`](verida_vda_sbt_client._internal_.ParamType.md)[] - -#### Inherited from - -[Fragment](verida_vda_sbt_client._internal_.Fragment.md).[inputs](verida_vda_sbt_client._internal_.Fragment.md#inputs) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:42 - -___ - -### name - -• `Readonly` **name**: `string` - -#### Inherited from - -[Fragment](verida_vda_sbt_client._internal_.Fragment.md).[name](verida_vda_sbt_client._internal_.Fragment.md#name) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:41 - -___ - -### payable - -• **payable**: `boolean` - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:61 - -___ - -### stateMutability - -• **stateMutability**: `string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:60 - -___ - -### type - -• `Readonly` **type**: `string` - -#### Inherited from - -[Fragment](verida_vda_sbt_client._internal_.Fragment.md).[type](verida_vda_sbt_client._internal_.Fragment.md#type) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:40 - -## Methods - -### format - -▸ **format**(`format?`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `format?` | `string` | - -#### Returns - -`string` - -#### Overrides - -[Fragment](verida_vda_sbt_client._internal_.Fragment.md).[format](verida_vda_sbt_client._internal_.Fragment.md#format) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:63 - -___ - -### from - -▸ `Static` **from**(`value`): [`ConstructorFragment`](verida_vda_sbt_client._internal_.ConstructorFragment.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `string` \| [`JsonFragment`](../interfaces/verida_vda_sbt_client._internal_.JsonFragment.md) \| [`ConstructorFragment`](verida_vda_sbt_client._internal_.ConstructorFragment.md) | - -#### Returns - -[`ConstructorFragment`](verida_vda_sbt_client._internal_.ConstructorFragment.md) - -#### Overrides - -[Fragment](verida_vda_sbt_client._internal_.Fragment.md).[from](verida_vda_sbt_client._internal_.Fragment.md#from) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:64 - -___ - -### fromObject - -▸ `Static` **fromObject**(`value`): [`ConstructorFragment`](verida_vda_sbt_client._internal_.ConstructorFragment.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | [`JsonFragment`](../interfaces/verida_vda_sbt_client._internal_.JsonFragment.md) \| [`ConstructorFragment`](verida_vda_sbt_client._internal_.ConstructorFragment.md) | - -#### Returns - -[`ConstructorFragment`](verida_vda_sbt_client._internal_.ConstructorFragment.md) - -#### Overrides - -[Fragment](verida_vda_sbt_client._internal_.Fragment.md).[fromObject](verida_vda_sbt_client._internal_.Fragment.md#fromobject) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:65 - -___ - -### fromString - -▸ `Static` **fromString**(`value`): [`ConstructorFragment`](verida_vda_sbt_client._internal_.ConstructorFragment.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `string` | - -#### Returns - -[`ConstructorFragment`](verida_vda_sbt_client._internal_.ConstructorFragment.md) - -#### Overrides - -[Fragment](verida_vda_sbt_client._internal_.Fragment.md).[fromString](verida_vda_sbt_client._internal_.Fragment.md#fromstring) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:66 - -___ - -### isConstructorFragment - -▸ `Static` **isConstructorFragment**(`value`): value is ConstructorFragment - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `any` | - -#### Returns - -value is ConstructorFragment - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:67 - -___ - -### isFragment - -▸ `Static` **isFragment**(`value`): value is Fragment - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `any` | - -#### Returns - -value is Fragment - -#### Inherited from - -[Fragment](verida_vda_sbt_client._internal_.Fragment.md).[isFragment](verida_vda_sbt_client._internal_.Fragment.md#isfragment) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:49 diff --git a/docs/api/verida-js/classes/verida_vda_sbt_client._internal_.Contract.md b/docs/api/verida-js/classes/verida_vda_sbt_client._internal_.Contract.md deleted file mode 100644 index fa92666..0000000 --- a/docs/api/verida-js/classes/verida_vda_sbt_client._internal_.Contract.md +++ /dev/null @@ -1,767 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-sbt-client](../modules/verida_vda_sbt_client.md) / [](../modules/verida_vda_sbt_client._internal_.md) / Contract - -# Class: Contract - -[@verida/vda-sbt-client](../modules/verida_vda_sbt_client.md).[](../modules/verida_vda_sbt_client._internal_.md).Contract - -## Hierarchy - -- [`BaseContract`](verida_vda_sbt_client._internal_.BaseContract.md) - - ↳ **`Contract`** - -## Indexable - -▪ [key: `string`]: [`ContractFunction`](../modules/verida_vda_sbt_client._internal_.md#contractfunction) \| `any` - -## Table of contents - -### Constructors - -- [constructor](verida_vda_sbt_client._internal_.Contract.md#constructor) - -### Properties - -- [\_deployedPromise](verida_vda_sbt_client._internal_.Contract.md#_deployedpromise) -- [\_runningEvents](verida_vda_sbt_client._internal_.Contract.md#_runningevents) -- [\_wrappedEmits](verida_vda_sbt_client._internal_.Contract.md#_wrappedemits) -- [address](verida_vda_sbt_client._internal_.Contract.md#address) -- [callStatic](verida_vda_sbt_client._internal_.Contract.md#callstatic) -- [deployTransaction](verida_vda_sbt_client._internal_.Contract.md#deploytransaction) -- [estimateGas](verida_vda_sbt_client._internal_.Contract.md#estimategas) -- [filters](verida_vda_sbt_client._internal_.Contract.md#filters) -- [functions](verida_vda_sbt_client._internal_.Contract.md#functions) -- [interface](verida_vda_sbt_client._internal_.Contract.md#interface) -- [populateTransaction](verida_vda_sbt_client._internal_.Contract.md#populatetransaction) -- [provider](verida_vda_sbt_client._internal_.Contract.md#provider) -- [resolvedAddress](verida_vda_sbt_client._internal_.Contract.md#resolvedaddress) -- [signer](verida_vda_sbt_client._internal_.Contract.md#signer) - -### Methods - -- [\_checkRunningEvents](verida_vda_sbt_client._internal_.Contract.md#_checkrunningevents) -- [\_deployed](verida_vda_sbt_client._internal_.Contract.md#_deployed) -- [\_wrapEvent](verida_vda_sbt_client._internal_.Contract.md#_wrapevent) -- [attach](verida_vda_sbt_client._internal_.Contract.md#attach) -- [connect](verida_vda_sbt_client._internal_.Contract.md#connect) -- [deployed](verida_vda_sbt_client._internal_.Contract.md#deployed) -- [emit](verida_vda_sbt_client._internal_.Contract.md#emit) -- [fallback](verida_vda_sbt_client._internal_.Contract.md#fallback) -- [listenerCount](verida_vda_sbt_client._internal_.Contract.md#listenercount) -- [listeners](verida_vda_sbt_client._internal_.Contract.md#listeners) -- [off](verida_vda_sbt_client._internal_.Contract.md#off) -- [on](verida_vda_sbt_client._internal_.Contract.md#on) -- [once](verida_vda_sbt_client._internal_.Contract.md#once) -- [queryFilter](verida_vda_sbt_client._internal_.Contract.md#queryfilter) -- [removeAllListeners](verida_vda_sbt_client._internal_.Contract.md#removealllisteners) -- [removeListener](verida_vda_sbt_client._internal_.Contract.md#removelistener) -- [getContractAddress](verida_vda_sbt_client._internal_.Contract.md#getcontractaddress) -- [getInterface](verida_vda_sbt_client._internal_.Contract.md#getinterface) -- [isIndexed](verida_vda_sbt_client._internal_.Contract.md#isindexed) - -## Constructors - -### constructor - -• **new Contract**(`addressOrName`, `contractInterface`, `signerOrProvider?`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `addressOrName` | `string` | -| `contractInterface` | [`ContractInterface`](../modules/verida_vda_sbt_client._internal_.md#contractinterface) | -| `signerOrProvider?` | [`Signer`](verida_vda_sbt_client._internal_.Signer.md) \| [`Provider`](verida_vda_sbt_client._internal_.Provider.md) | - -#### Inherited from - -[BaseContract](verida_vda_sbt_client._internal_.BaseContract.md).[constructor](verida_vda_sbt_client._internal_.BaseContract.md#constructor) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:107 - -## Properties - -### \_deployedPromise - -• **\_deployedPromise**: `Promise`<[`Contract`](verida_vda_sbt_client._internal_.Contract.md)\> - -#### Inherited from - -[BaseContract](verida_vda_sbt_client._internal_.BaseContract.md).[_deployedPromise](verida_vda_sbt_client._internal_.BaseContract.md#_deployedpromise) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:100 - -___ - -### \_runningEvents - -• **\_runningEvents**: `Object` - -#### Index signature - -▪ [eventTag: `string`]: [`RunningEvent`](verida_vda_sbt_client._internal_.RunningEvent.md) - -#### Inherited from - -[BaseContract](verida_vda_sbt_client._internal_.BaseContract.md).[_runningEvents](verida_vda_sbt_client._internal_.BaseContract.md#_runningevents) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:101 - -___ - -### \_wrappedEmits - -• **\_wrappedEmits**: `Object` - -#### Index signature - -▪ [eventTag: `string`]: (...`args`: `any`[]) => `void` - -#### Inherited from - -[BaseContract](verida_vda_sbt_client._internal_.BaseContract.md).[_wrappedEmits](verida_vda_sbt_client._internal_.BaseContract.md#_wrappedemits) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:104 - -___ - -### address - -• `Readonly` **address**: `string` - -#### Inherited from - -[BaseContract](verida_vda_sbt_client._internal_.BaseContract.md).[address](verida_vda_sbt_client._internal_.BaseContract.md#address) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:79 - -___ - -### callStatic - -• `Readonly` **callStatic**: `Object` - -#### Index signature - -▪ [name: `string`]: [`ContractFunction`](../modules/verida_vda_sbt_client._internal_.md#contractfunction) - -#### Inherited from - -[BaseContract](verida_vda_sbt_client._internal_.BaseContract.md).[callStatic](verida_vda_sbt_client._internal_.BaseContract.md#callstatic) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:86 - -___ - -### deployTransaction - -• `Readonly` **deployTransaction**: [`TransactionResponse`](../interfaces/verida_vda_sbt_client._internal_.TransactionResponse.md) - -#### Inherited from - -[BaseContract](verida_vda_sbt_client._internal_.BaseContract.md).[deployTransaction](verida_vda_sbt_client._internal_.BaseContract.md#deploytransaction) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:99 - -___ - -### estimateGas - -• `Readonly` **estimateGas**: `Object` - -#### Index signature - -▪ [name: `string`]: [`ContractFunction`](../modules/verida_vda_sbt_client._internal_.md#contractfunction)<[`BigNumber`](verida_vda_sbt_client._internal_.BigNumber.md)\> - -#### Inherited from - -[BaseContract](verida_vda_sbt_client._internal_.BaseContract.md).[estimateGas](verida_vda_sbt_client._internal_.BaseContract.md#estimategas) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:89 - -___ - -### filters - -• `Readonly` **filters**: `Object` - -#### Index signature - -▪ [name: `string`]: (...`args`: `any`[]) => [`EventFilter`](../modules/verida_vda_sbt_client._internal_.md#eventfilter) - -#### Inherited from - -[BaseContract](verida_vda_sbt_client._internal_.BaseContract.md).[filters](verida_vda_sbt_client._internal_.BaseContract.md#filters) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:95 - -___ - -### functions - -• `Readonly` **functions**: `Object` - -#### Index signature - -▪ [name: `string`]: [`ContractFunction`](../modules/verida_vda_sbt_client._internal_.md#contractfunction) - -#### Inherited from - -[BaseContract](verida_vda_sbt_client._internal_.BaseContract.md).[functions](verida_vda_sbt_client._internal_.BaseContract.md#functions) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:83 - -___ - -### interface - -• `Readonly` **interface**: [`Interface`](verida_vda_sbt_client._internal_.Interface.md) - -#### Inherited from - -[BaseContract](verida_vda_sbt_client._internal_.BaseContract.md).[interface](verida_vda_sbt_client._internal_.BaseContract.md#interface) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:80 - -___ - -### populateTransaction - -• `Readonly` **populateTransaction**: `Object` - -#### Index signature - -▪ [name: `string`]: [`ContractFunction`](../modules/verida_vda_sbt_client._internal_.md#contractfunction)<[`PopulatedTransaction`](../interfaces/verida_vda_sbt_client._internal_.PopulatedTransaction.md)\> - -#### Inherited from - -[BaseContract](verida_vda_sbt_client._internal_.BaseContract.md).[populateTransaction](verida_vda_sbt_client._internal_.BaseContract.md#populatetransaction) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:92 - -___ - -### provider - -• `Readonly` **provider**: [`Provider`](verida_vda_sbt_client._internal_.Provider.md) - -#### Inherited from - -[BaseContract](verida_vda_sbt_client._internal_.BaseContract.md).[provider](verida_vda_sbt_client._internal_.BaseContract.md#provider) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:82 - -___ - -### resolvedAddress - -• `Readonly` **resolvedAddress**: `Promise`<`string`\> - -#### Inherited from - -[BaseContract](verida_vda_sbt_client._internal_.BaseContract.md).[resolvedAddress](verida_vda_sbt_client._internal_.BaseContract.md#resolvedaddress) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:98 - -___ - -### signer - -• `Readonly` **signer**: [`Signer`](verida_vda_sbt_client._internal_.Signer.md) - -#### Inherited from - -[BaseContract](verida_vda_sbt_client._internal_.BaseContract.md).[signer](verida_vda_sbt_client._internal_.BaseContract.md#signer) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:81 - -## Methods - -### \_checkRunningEvents - -▸ **_checkRunningEvents**(`runningEvent`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `runningEvent` | [`RunningEvent`](verida_vda_sbt_client._internal_.RunningEvent.md) | - -#### Returns - -`void` - -#### Inherited from - -[BaseContract](verida_vda_sbt_client._internal_.BaseContract.md).[_checkRunningEvents](verida_vda_sbt_client._internal_.BaseContract.md#_checkrunningevents) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:121 - -___ - -### \_deployed - -▸ **_deployed**(`blockTag?`): `Promise`<[`Contract`](verida_vda_sbt_client._internal_.Contract.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `blockTag?` | [`BlockTag`](../modules/verida_vda_sbt_client._internal_.md#blocktag) | - -#### Returns - -`Promise`<[`Contract`](verida_vda_sbt_client._internal_.Contract.md)\> - -#### Inherited from - -[BaseContract](verida_vda_sbt_client._internal_.BaseContract.md).[_deployed](verida_vda_sbt_client._internal_.BaseContract.md#_deployed) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:114 - -___ - -### \_wrapEvent - -▸ **_wrapEvent**(`runningEvent`, `log`, `listener`): [`Event`](../interfaces/verida_vda_sbt_client._internal_.Event.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `runningEvent` | [`RunningEvent`](verida_vda_sbt_client._internal_.RunningEvent.md) | -| `log` | [`Log`](../interfaces/verida_vda_sbt_client._internal_.Log.md) | -| `listener` | [`Listener`](../modules/verida_vda_sbt_client._internal_.md#listener) | - -#### Returns - -[`Event`](../interfaces/verida_vda_sbt_client._internal_.Event.md) - -#### Inherited from - -[BaseContract](verida_vda_sbt_client._internal_.BaseContract.md).[_wrapEvent](verida_vda_sbt_client._internal_.BaseContract.md#_wrapevent) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:122 - -___ - -### attach - -▸ **attach**(`addressOrName`): [`Contract`](verida_vda_sbt_client._internal_.Contract.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `addressOrName` | `string` | - -#### Returns - -[`Contract`](verida_vda_sbt_client._internal_.Contract.md) - -#### Inherited from - -[BaseContract](verida_vda_sbt_client._internal_.BaseContract.md).[attach](verida_vda_sbt_client._internal_.BaseContract.md#attach) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:117 - -___ - -### connect - -▸ **connect**(`signerOrProvider`): [`Contract`](verida_vda_sbt_client._internal_.Contract.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `signerOrProvider` | `string` \| [`Signer`](verida_vda_sbt_client._internal_.Signer.md) \| [`Provider`](verida_vda_sbt_client._internal_.Provider.md) | - -#### Returns - -[`Contract`](verida_vda_sbt_client._internal_.Contract.md) - -#### Inherited from - -[BaseContract](verida_vda_sbt_client._internal_.BaseContract.md).[connect](verida_vda_sbt_client._internal_.BaseContract.md#connect) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:116 - -___ - -### deployed - -▸ **deployed**(): `Promise`<[`Contract`](verida_vda_sbt_client._internal_.Contract.md)\> - -#### Returns - -`Promise`<[`Contract`](verida_vda_sbt_client._internal_.Contract.md)\> - -#### Inherited from - -[BaseContract](verida_vda_sbt_client._internal_.BaseContract.md).[deployed](verida_vda_sbt_client._internal_.BaseContract.md#deployed) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:113 - -___ - -### emit - -▸ **emit**(`eventName`, ...`args`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | `string` \| [`EventFilter`](../modules/verida_vda_sbt_client._internal_.md#eventfilter) | -| `...args` | `any`[] | - -#### Returns - -`boolean` - -#### Inherited from - -[BaseContract](verida_vda_sbt_client._internal_.BaseContract.md).[emit](verida_vda_sbt_client._internal_.BaseContract.md#emit) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:127 - -___ - -### fallback - -▸ **fallback**(`overrides?`): `Promise`<[`TransactionResponse`](../interfaces/verida_vda_sbt_client._internal_.TransactionResponse.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `overrides?` | [`TransactionRequest`](../modules/verida_vda_sbt_client._internal_.md#transactionrequest) | - -#### Returns - -`Promise`<[`TransactionResponse`](../interfaces/verida_vda_sbt_client._internal_.TransactionResponse.md)\> - -#### Inherited from - -[BaseContract](verida_vda_sbt_client._internal_.BaseContract.md).[fallback](verida_vda_sbt_client._internal_.BaseContract.md#fallback) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:115 - -___ - -### listenerCount - -▸ **listenerCount**(`eventName?`): `number` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName?` | `string` \| [`EventFilter`](../modules/verida_vda_sbt_client._internal_.md#eventfilter) | - -#### Returns - -`number` - -#### Inherited from - -[BaseContract](verida_vda_sbt_client._internal_.BaseContract.md).[listenerCount](verida_vda_sbt_client._internal_.BaseContract.md#listenercount) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:128 - -___ - -### listeners - -▸ **listeners**(`eventName?`): [`Listener`](../modules/verida_vda_sbt_client._internal_.md#listener)[] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName?` | `string` \| [`EventFilter`](../modules/verida_vda_sbt_client._internal_.md#eventfilter) | - -#### Returns - -[`Listener`](../modules/verida_vda_sbt_client._internal_.md#listener)[] - -#### Inherited from - -[BaseContract](verida_vda_sbt_client._internal_.BaseContract.md).[listeners](verida_vda_sbt_client._internal_.BaseContract.md#listeners) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:129 - -___ - -### off - -▸ **off**(`eventName`, `listener`): [`Contract`](verida_vda_sbt_client._internal_.Contract.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | `string` \| [`EventFilter`](../modules/verida_vda_sbt_client._internal_.md#eventfilter) | -| `listener` | [`Listener`](../modules/verida_vda_sbt_client._internal_.md#listener) | - -#### Returns - -[`Contract`](verida_vda_sbt_client._internal_.Contract.md) - -#### Inherited from - -[BaseContract](verida_vda_sbt_client._internal_.BaseContract.md).[off](verida_vda_sbt_client._internal_.BaseContract.md#off) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:131 - -___ - -### on - -▸ **on**(`event`, `listener`): [`Contract`](verida_vda_sbt_client._internal_.Contract.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | `string` \| [`EventFilter`](../modules/verida_vda_sbt_client._internal_.md#eventfilter) | -| `listener` | [`Listener`](../modules/verida_vda_sbt_client._internal_.md#listener) | - -#### Returns - -[`Contract`](verida_vda_sbt_client._internal_.Contract.md) - -#### Inherited from - -[BaseContract](verida_vda_sbt_client._internal_.BaseContract.md).[on](verida_vda_sbt_client._internal_.BaseContract.md#on) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:125 - -___ - -### once - -▸ **once**(`event`, `listener`): [`Contract`](verida_vda_sbt_client._internal_.Contract.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | `string` \| [`EventFilter`](../modules/verida_vda_sbt_client._internal_.md#eventfilter) | -| `listener` | [`Listener`](../modules/verida_vda_sbt_client._internal_.md#listener) | - -#### Returns - -[`Contract`](verida_vda_sbt_client._internal_.Contract.md) - -#### Inherited from - -[BaseContract](verida_vda_sbt_client._internal_.BaseContract.md).[once](verida_vda_sbt_client._internal_.BaseContract.md#once) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:126 - -___ - -### queryFilter - -▸ **queryFilter**(`event`, `fromBlockOrBlockhash?`, `toBlock?`): `Promise`<[`Event`](../interfaces/verida_vda_sbt_client._internal_.Event.md)[]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | `string` \| [`EventFilter`](../modules/verida_vda_sbt_client._internal_.md#eventfilter) | -| `fromBlockOrBlockhash?` | [`BlockTag`](../modules/verida_vda_sbt_client._internal_.md#blocktag) | -| `toBlock?` | [`BlockTag`](../modules/verida_vda_sbt_client._internal_.md#blocktag) | - -#### Returns - -`Promise`<[`Event`](../interfaces/verida_vda_sbt_client._internal_.Event.md)[]\> - -#### Inherited from - -[BaseContract](verida_vda_sbt_client._internal_.BaseContract.md).[queryFilter](verida_vda_sbt_client._internal_.BaseContract.md#queryfilter) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:124 - -___ - -### removeAllListeners - -▸ **removeAllListeners**(`eventName?`): [`Contract`](verida_vda_sbt_client._internal_.Contract.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName?` | `string` \| [`EventFilter`](../modules/verida_vda_sbt_client._internal_.md#eventfilter) | - -#### Returns - -[`Contract`](verida_vda_sbt_client._internal_.Contract.md) - -#### Inherited from - -[BaseContract](verida_vda_sbt_client._internal_.BaseContract.md).[removeAllListeners](verida_vda_sbt_client._internal_.BaseContract.md#removealllisteners) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:130 - -___ - -### removeListener - -▸ **removeListener**(`eventName`, `listener`): [`Contract`](verida_vda_sbt_client._internal_.Contract.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | `string` \| [`EventFilter`](../modules/verida_vda_sbt_client._internal_.md#eventfilter) | -| `listener` | [`Listener`](../modules/verida_vda_sbt_client._internal_.md#listener) | - -#### Returns - -[`Contract`](verida_vda_sbt_client._internal_.Contract.md) - -#### Inherited from - -[BaseContract](verida_vda_sbt_client._internal_.BaseContract.md).[removeListener](verida_vda_sbt_client._internal_.BaseContract.md#removelistener) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:132 - -___ - -### getContractAddress - -▸ `Static` **getContractAddress**(`transaction`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transaction` | `Object` | -| `transaction.from` | `string` | -| `transaction.nonce` | [`BigNumberish`](../modules/verida_vda_sbt_client._internal_.md#bignumberish) | - -#### Returns - -`string` - -#### Inherited from - -[BaseContract](verida_vda_sbt_client._internal_.BaseContract.md).[getContractAddress](verida_vda_sbt_client._internal_.BaseContract.md#getcontractaddress) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:108 - -___ - -### getInterface - -▸ `Static` **getInterface**(`contractInterface`): [`Interface`](verida_vda_sbt_client._internal_.Interface.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contractInterface` | [`ContractInterface`](../modules/verida_vda_sbt_client._internal_.md#contractinterface) | - -#### Returns - -[`Interface`](verida_vda_sbt_client._internal_.Interface.md) - -#### Inherited from - -[BaseContract](verida_vda_sbt_client._internal_.BaseContract.md).[getInterface](verida_vda_sbt_client._internal_.BaseContract.md#getinterface) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:112 - -___ - -### isIndexed - -▸ `Static` **isIndexed**(`value`): value is Indexed - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `any` | - -#### Returns - -value is Indexed - -#### Inherited from - -[BaseContract](verida_vda_sbt_client._internal_.BaseContract.md).[isIndexed](verida_vda_sbt_client._internal_.BaseContract.md#isindexed) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:118 diff --git a/docs/api/verida-js/classes/verida_vda_sbt_client._internal_.Description.md b/docs/api/verida-js/classes/verida_vda_sbt_client._internal_.Description.md deleted file mode 100644 index 4c3f7cf..0000000 --- a/docs/api/verida-js/classes/verida_vda_sbt_client._internal_.Description.md +++ /dev/null @@ -1,53 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-sbt-client](../modules/verida_vda_sbt_client.md) / [](../modules/verida_vda_sbt_client._internal_.md) / Description - -# Class: Description - -[@verida/vda-sbt-client](../modules/verida_vda_sbt_client.md).[](../modules/verida_vda_sbt_client._internal_.md).Description - -## Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `any` | - -## Hierarchy - -- **`Description`** - - ↳ [`Indexed`](verida_vda_sbt_client._internal_.Indexed.md) - - ↳ [`TransactionDescription`](verida_vda_sbt_client._internal_.TransactionDescription.md) - - ↳ [`LogDescription`](verida_vda_sbt_client._internal_.LogDescription.md) - - ↳ [`ErrorDescription`](verida_vda_sbt_client._internal_.ErrorDescription.md) - - ↳ [`ForkEvent`](verida_vda_sbt_client._internal_.ForkEvent.md) - -## Table of contents - -### Constructors - -- [constructor](verida_vda_sbt_client._internal_.Description.md#constructor) - -## Constructors - -### constructor - -• **new Description**<`T`\>(`info`) - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `any` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `info` | { [K in string \| number \| symbol]: T[K] } | - -#### Defined in - -node_modules/@ethersproject/properties/lib/index.d.ts:13 diff --git a/docs/api/verida-js/classes/verida_vda_sbt_client._internal_.ErrorDescription.md b/docs/api/verida-js/classes/verida_vda_sbt_client._internal_.ErrorDescription.md deleted file mode 100644 index f2312c1..0000000 --- a/docs/api/verida-js/classes/verida_vda_sbt_client._internal_.ErrorDescription.md +++ /dev/null @@ -1,100 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-sbt-client](../modules/verida_vda_sbt_client.md) / [](../modules/verida_vda_sbt_client._internal_.md) / ErrorDescription - -# Class: ErrorDescription - -[@verida/vda-sbt-client](../modules/verida_vda_sbt_client.md).[](../modules/verida_vda_sbt_client._internal_.md).ErrorDescription - -## Hierarchy - -- [`Description`](verida_vda_sbt_client._internal_.Description.md)<[`ErrorDescription`](verida_vda_sbt_client._internal_.ErrorDescription.md)\> - - ↳ **`ErrorDescription`** - -## Table of contents - -### Constructors - -- [constructor](verida_vda_sbt_client._internal_.ErrorDescription.md#constructor) - -### Properties - -- [args](verida_vda_sbt_client._internal_.ErrorDescription.md#args) -- [errorFragment](verida_vda_sbt_client._internal_.ErrorDescription.md#errorfragment) -- [name](verida_vda_sbt_client._internal_.ErrorDescription.md#name) -- [sighash](verida_vda_sbt_client._internal_.ErrorDescription.md#sighash) -- [signature](verida_vda_sbt_client._internal_.ErrorDescription.md#signature) - -## Constructors - -### constructor - -• **new ErrorDescription**(`info`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `info` | `Object` | -| `info.args` | [`Result`](../interfaces/verida_vda_sbt_client._internal_.Result.md) | -| `info.errorFragment` | [`ErrorFragment`](verida_vda_sbt_client._internal_.ErrorFragment.md) | -| `info.name` | `string` | -| `info.sighash` | `string` | -| `info.signature` | `string` | - -#### Inherited from - -[Description](verida_vda_sbt_client._internal_.Description.md).[constructor](verida_vda_sbt_client._internal_.Description.md#constructor) - -#### Defined in - -node_modules/@ethersproject/properties/lib/index.d.ts:13 - -## Properties - -### args - -• `Readonly` **args**: [`Result`](../interfaces/verida_vda_sbt_client._internal_.Result.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:26 - -___ - -### errorFragment - -• `Readonly` **errorFragment**: [`ErrorFragment`](verida_vda_sbt_client._internal_.ErrorFragment.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:24 - -___ - -### name - -• `Readonly` **name**: `string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:25 - -___ - -### sighash - -• `Readonly` **sighash**: `string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:28 - -___ - -### signature - -• `Readonly` **signature**: `string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:27 diff --git a/docs/api/verida-js/classes/verida_vda_sbt_client._internal_.ErrorFragment.md b/docs/api/verida-js/classes/verida_vda_sbt_client._internal_.ErrorFragment.md deleted file mode 100644 index d16a158..0000000 --- a/docs/api/verida-js/classes/verida_vda_sbt_client._internal_.ErrorFragment.md +++ /dev/null @@ -1,250 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-sbt-client](../modules/verida_vda_sbt_client.md) / [](../modules/verida_vda_sbt_client._internal_.md) / ErrorFragment - -# Class: ErrorFragment - -[@verida/vda-sbt-client](../modules/verida_vda_sbt_client.md).[](../modules/verida_vda_sbt_client._internal_.md).ErrorFragment - -## Hierarchy - -- [`Fragment`](verida_vda_sbt_client._internal_.Fragment.md) - - ↳ **`ErrorFragment`** - -## Table of contents - -### Constructors - -- [constructor](verida_vda_sbt_client._internal_.ErrorFragment.md#constructor) - -### Properties - -- [\_isFragment](verida_vda_sbt_client._internal_.ErrorFragment.md#_isfragment) -- [inputs](verida_vda_sbt_client._internal_.ErrorFragment.md#inputs) -- [name](verida_vda_sbt_client._internal_.ErrorFragment.md#name) -- [type](verida_vda_sbt_client._internal_.ErrorFragment.md#type) - -### Methods - -- [format](verida_vda_sbt_client._internal_.ErrorFragment.md#format) -- [from](verida_vda_sbt_client._internal_.ErrorFragment.md#from) -- [fromObject](verida_vda_sbt_client._internal_.ErrorFragment.md#fromobject) -- [fromString](verida_vda_sbt_client._internal_.ErrorFragment.md#fromstring) -- [isErrorFragment](verida_vda_sbt_client._internal_.ErrorFragment.md#iserrorfragment) -- [isFragment](verida_vda_sbt_client._internal_.ErrorFragment.md#isfragment) - -## Constructors - -### constructor - -• **new ErrorFragment**(`constructorGuard`, `params`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `constructorGuard` | `any` | -| `params` | `any` | - -#### Inherited from - -[Fragment](verida_vda_sbt_client._internal_.Fragment.md).[constructor](verida_vda_sbt_client._internal_.Fragment.md#constructor) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:44 - -## Properties - -### \_isFragment - -• `Readonly` **\_isFragment**: `boolean` - -#### Inherited from - -[Fragment](verida_vda_sbt_client._internal_.Fragment.md).[_isFragment](verida_vda_sbt_client._internal_.Fragment.md#_isfragment) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:43 - -___ - -### inputs - -• `Readonly` **inputs**: [`ParamType`](verida_vda_sbt_client._internal_.ParamType.md)[] - -#### Inherited from - -[Fragment](verida_vda_sbt_client._internal_.Fragment.md).[inputs](verida_vda_sbt_client._internal_.Fragment.md#inputs) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:42 - -___ - -### name - -• `Readonly` **name**: `string` - -#### Inherited from - -[Fragment](verida_vda_sbt_client._internal_.Fragment.md).[name](verida_vda_sbt_client._internal_.Fragment.md#name) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:41 - -___ - -### type - -• `Readonly` **type**: `string` - -#### Inherited from - -[Fragment](verida_vda_sbt_client._internal_.Fragment.md).[type](verida_vda_sbt_client._internal_.Fragment.md#type) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:40 - -## Methods - -### format - -▸ **format**(`format?`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `format?` | `string` | - -#### Returns - -`string` - -#### Overrides - -[Fragment](verida_vda_sbt_client._internal_.Fragment.md).[format](verida_vda_sbt_client._internal_.Fragment.md#format) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:79 - -___ - -### from - -▸ `Static` **from**(`value`): [`ErrorFragment`](verida_vda_sbt_client._internal_.ErrorFragment.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `string` \| [`JsonFragment`](../interfaces/verida_vda_sbt_client._internal_.JsonFragment.md) \| [`ErrorFragment`](verida_vda_sbt_client._internal_.ErrorFragment.md) | - -#### Returns - -[`ErrorFragment`](verida_vda_sbt_client._internal_.ErrorFragment.md) - -#### Overrides - -[Fragment](verida_vda_sbt_client._internal_.Fragment.md).[from](verida_vda_sbt_client._internal_.Fragment.md#from) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:80 - -___ - -### fromObject - -▸ `Static` **fromObject**(`value`): [`ErrorFragment`](verida_vda_sbt_client._internal_.ErrorFragment.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | [`JsonFragment`](../interfaces/verida_vda_sbt_client._internal_.JsonFragment.md) \| [`ErrorFragment`](verida_vda_sbt_client._internal_.ErrorFragment.md) | - -#### Returns - -[`ErrorFragment`](verida_vda_sbt_client._internal_.ErrorFragment.md) - -#### Overrides - -[Fragment](verida_vda_sbt_client._internal_.Fragment.md).[fromObject](verida_vda_sbt_client._internal_.Fragment.md#fromobject) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:81 - -___ - -### fromString - -▸ `Static` **fromString**(`value`): [`ErrorFragment`](verida_vda_sbt_client._internal_.ErrorFragment.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `string` | - -#### Returns - -[`ErrorFragment`](verida_vda_sbt_client._internal_.ErrorFragment.md) - -#### Overrides - -[Fragment](verida_vda_sbt_client._internal_.Fragment.md).[fromString](verida_vda_sbt_client._internal_.Fragment.md#fromstring) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:82 - -___ - -### isErrorFragment - -▸ `Static` **isErrorFragment**(`value`): value is ErrorFragment - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `any` | - -#### Returns - -value is ErrorFragment - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:83 - -___ - -### isFragment - -▸ `Static` **isFragment**(`value`): value is Fragment - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `any` | - -#### Returns - -value is Fragment - -#### Inherited from - -[Fragment](verida_vda_sbt_client._internal_.Fragment.md).[isFragment](verida_vda_sbt_client._internal_.Fragment.md#isfragment) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:49 diff --git a/docs/api/verida-js/classes/verida_vda_sbt_client._internal_.EventFragment.md b/docs/api/verida-js/classes/verida_vda_sbt_client._internal_.EventFragment.md deleted file mode 100644 index ad44939..0000000 --- a/docs/api/verida-js/classes/verida_vda_sbt_client._internal_.EventFragment.md +++ /dev/null @@ -1,261 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-sbt-client](../modules/verida_vda_sbt_client.md) / [](../modules/verida_vda_sbt_client._internal_.md) / EventFragment - -# Class: EventFragment - -[@verida/vda-sbt-client](../modules/verida_vda_sbt_client.md).[](../modules/verida_vda_sbt_client._internal_.md).EventFragment - -## Hierarchy - -- [`Fragment`](verida_vda_sbt_client._internal_.Fragment.md) - - ↳ **`EventFragment`** - -## Table of contents - -### Constructors - -- [constructor](verida_vda_sbt_client._internal_.EventFragment.md#constructor) - -### Properties - -- [\_isFragment](verida_vda_sbt_client._internal_.EventFragment.md#_isfragment) -- [anonymous](verida_vda_sbt_client._internal_.EventFragment.md#anonymous) -- [inputs](verida_vda_sbt_client._internal_.EventFragment.md#inputs) -- [name](verida_vda_sbt_client._internal_.EventFragment.md#name) -- [type](verida_vda_sbt_client._internal_.EventFragment.md#type) - -### Methods - -- [format](verida_vda_sbt_client._internal_.EventFragment.md#format) -- [from](verida_vda_sbt_client._internal_.EventFragment.md#from) -- [fromObject](verida_vda_sbt_client._internal_.EventFragment.md#fromobject) -- [fromString](verida_vda_sbt_client._internal_.EventFragment.md#fromstring) -- [isEventFragment](verida_vda_sbt_client._internal_.EventFragment.md#iseventfragment) -- [isFragment](verida_vda_sbt_client._internal_.EventFragment.md#isfragment) - -## Constructors - -### constructor - -• **new EventFragment**(`constructorGuard`, `params`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `constructorGuard` | `any` | -| `params` | `any` | - -#### Inherited from - -[Fragment](verida_vda_sbt_client._internal_.Fragment.md).[constructor](verida_vda_sbt_client._internal_.Fragment.md#constructor) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:44 - -## Properties - -### \_isFragment - -• `Readonly` **\_isFragment**: `boolean` - -#### Inherited from - -[Fragment](verida_vda_sbt_client._internal_.Fragment.md).[_isFragment](verida_vda_sbt_client._internal_.Fragment.md#_isfragment) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:43 - -___ - -### anonymous - -• `Readonly` **anonymous**: `boolean` - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:52 - -___ - -### inputs - -• `Readonly` **inputs**: [`ParamType`](verida_vda_sbt_client._internal_.ParamType.md)[] - -#### Inherited from - -[Fragment](verida_vda_sbt_client._internal_.Fragment.md).[inputs](verida_vda_sbt_client._internal_.Fragment.md#inputs) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:42 - -___ - -### name - -• `Readonly` **name**: `string` - -#### Inherited from - -[Fragment](verida_vda_sbt_client._internal_.Fragment.md).[name](verida_vda_sbt_client._internal_.Fragment.md#name) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:41 - -___ - -### type - -• `Readonly` **type**: `string` - -#### Inherited from - -[Fragment](verida_vda_sbt_client._internal_.Fragment.md).[type](verida_vda_sbt_client._internal_.Fragment.md#type) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:40 - -## Methods - -### format - -▸ **format**(`format?`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `format?` | `string` | - -#### Returns - -`string` - -#### Overrides - -[Fragment](verida_vda_sbt_client._internal_.Fragment.md).[format](verida_vda_sbt_client._internal_.Fragment.md#format) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:53 - -___ - -### from - -▸ `Static` **from**(`value`): [`EventFragment`](verida_vda_sbt_client._internal_.EventFragment.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `string` \| [`JsonFragment`](../interfaces/verida_vda_sbt_client._internal_.JsonFragment.md) \| [`EventFragment`](verida_vda_sbt_client._internal_.EventFragment.md) | - -#### Returns - -[`EventFragment`](verida_vda_sbt_client._internal_.EventFragment.md) - -#### Overrides - -[Fragment](verida_vda_sbt_client._internal_.Fragment.md).[from](verida_vda_sbt_client._internal_.Fragment.md#from) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:54 - -___ - -### fromObject - -▸ `Static` **fromObject**(`value`): [`EventFragment`](verida_vda_sbt_client._internal_.EventFragment.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | [`JsonFragment`](../interfaces/verida_vda_sbt_client._internal_.JsonFragment.md) \| [`EventFragment`](verida_vda_sbt_client._internal_.EventFragment.md) | - -#### Returns - -[`EventFragment`](verida_vda_sbt_client._internal_.EventFragment.md) - -#### Overrides - -[Fragment](verida_vda_sbt_client._internal_.Fragment.md).[fromObject](verida_vda_sbt_client._internal_.Fragment.md#fromobject) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:55 - -___ - -### fromString - -▸ `Static` **fromString**(`value`): [`EventFragment`](verida_vda_sbt_client._internal_.EventFragment.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `string` | - -#### Returns - -[`EventFragment`](verida_vda_sbt_client._internal_.EventFragment.md) - -#### Overrides - -[Fragment](verida_vda_sbt_client._internal_.Fragment.md).[fromString](verida_vda_sbt_client._internal_.Fragment.md#fromstring) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:56 - -___ - -### isEventFragment - -▸ `Static` **isEventFragment**(`value`): value is EventFragment - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `any` | - -#### Returns - -value is EventFragment - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:57 - -___ - -### isFragment - -▸ `Static` **isFragment**(`value`): value is Fragment - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `any` | - -#### Returns - -value is Fragment - -#### Inherited from - -[Fragment](verida_vda_sbt_client._internal_.Fragment.md).[isFragment](verida_vda_sbt_client._internal_.Fragment.md#isfragment) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:49 diff --git a/docs/api/verida-js/classes/verida_vda_sbt_client._internal_.ForkEvent.md b/docs/api/verida-js/classes/verida_vda_sbt_client._internal_.ForkEvent.md deleted file mode 100644 index 61f1e15..0000000 --- a/docs/api/verida-js/classes/verida_vda_sbt_client._internal_.ForkEvent.md +++ /dev/null @@ -1,86 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-sbt-client](../modules/verida_vda_sbt_client.md) / [](../modules/verida_vda_sbt_client._internal_.md) / ForkEvent - -# Class: ForkEvent - -[@verida/vda-sbt-client](../modules/verida_vda_sbt_client.md).[](../modules/verida_vda_sbt_client._internal_.md).ForkEvent - -## Hierarchy - -- [`Description`](verida_vda_sbt_client._internal_.Description.md) - - ↳ **`ForkEvent`** - -## Table of contents - -### Constructors - -- [constructor](verida_vda_sbt_client._internal_.ForkEvent.md#constructor) - -### Properties - -- [\_isForkEvent](verida_vda_sbt_client._internal_.ForkEvent.md#_isforkevent) -- [expiry](verida_vda_sbt_client._internal_.ForkEvent.md#expiry) - -### Methods - -- [isForkEvent](verida_vda_sbt_client._internal_.ForkEvent.md#isforkevent) - -## Constructors - -### constructor - -• **new ForkEvent**(`info`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `info` | `Object` | - -#### Inherited from - -[Description](verida_vda_sbt_client._internal_.Description.md).[constructor](verida_vda_sbt_client._internal_.Description.md#constructor) - -#### Defined in - -node_modules/@ethersproject/properties/lib/index.d.ts:13 - -## Properties - -### \_isForkEvent - -• `Optional` `Readonly` **\_isForkEvent**: `boolean` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:103 - -___ - -### expiry - -• `Readonly` **expiry**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:102 - -## Methods - -### isForkEvent - -▸ `Static` **isForkEvent**(`value`): value is ForkEvent - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `any` | - -#### Returns - -value is ForkEvent - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:104 diff --git a/docs/api/verida-js/classes/verida_vda_sbt_client._internal_.Fragment.md b/docs/api/verida-js/classes/verida_vda_sbt_client._internal_.Fragment.md deleted file mode 100644 index 63a1401..0000000 --- a/docs/api/verida-js/classes/verida_vda_sbt_client._internal_.Fragment.md +++ /dev/null @@ -1,193 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-sbt-client](../modules/verida_vda_sbt_client.md) / [](../modules/verida_vda_sbt_client._internal_.md) / Fragment - -# Class: Fragment - -[@verida/vda-sbt-client](../modules/verida_vda_sbt_client.md).[](../modules/verida_vda_sbt_client._internal_.md).Fragment - -## Hierarchy - -- **`Fragment`** - - ↳ [`ConstructorFragment`](verida_vda_sbt_client._internal_.ConstructorFragment.md) - - ↳ [`EventFragment`](verida_vda_sbt_client._internal_.EventFragment.md) - - ↳ [`ErrorFragment`](verida_vda_sbt_client._internal_.ErrorFragment.md) - -## Table of contents - -### Constructors - -- [constructor](verida_vda_sbt_client._internal_.Fragment.md#constructor) - -### Properties - -- [\_isFragment](verida_vda_sbt_client._internal_.Fragment.md#_isfragment) -- [inputs](verida_vda_sbt_client._internal_.Fragment.md#inputs) -- [name](verida_vda_sbt_client._internal_.Fragment.md#name) -- [type](verida_vda_sbt_client._internal_.Fragment.md#type) - -### Methods - -- [format](verida_vda_sbt_client._internal_.Fragment.md#format) -- [from](verida_vda_sbt_client._internal_.Fragment.md#from) -- [fromObject](verida_vda_sbt_client._internal_.Fragment.md#fromobject) -- [fromString](verida_vda_sbt_client._internal_.Fragment.md#fromstring) -- [isFragment](verida_vda_sbt_client._internal_.Fragment.md#isfragment) - -## Constructors - -### constructor - -• **new Fragment**(`constructorGuard`, `params`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `constructorGuard` | `any` | -| `params` | `any` | - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:44 - -## Properties - -### \_isFragment - -• `Readonly` **\_isFragment**: `boolean` - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:43 - -___ - -### inputs - -• `Readonly` **inputs**: [`ParamType`](verida_vda_sbt_client._internal_.ParamType.md)[] - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:42 - -___ - -### name - -• `Readonly` **name**: `string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:41 - -___ - -### type - -• `Readonly` **type**: `string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:40 - -## Methods - -### format - -▸ `Abstract` **format**(`format?`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `format?` | `string` | - -#### Returns - -`string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:45 - -___ - -### from - -▸ `Static` **from**(`value`): [`Fragment`](verida_vda_sbt_client._internal_.Fragment.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `string` \| [`Fragment`](verida_vda_sbt_client._internal_.Fragment.md) \| [`JsonFragment`](../interfaces/verida_vda_sbt_client._internal_.JsonFragment.md) | - -#### Returns - -[`Fragment`](verida_vda_sbt_client._internal_.Fragment.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:46 - -___ - -### fromObject - -▸ `Static` **fromObject**(`value`): [`Fragment`](verida_vda_sbt_client._internal_.Fragment.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | [`Fragment`](verida_vda_sbt_client._internal_.Fragment.md) \| [`JsonFragment`](../interfaces/verida_vda_sbt_client._internal_.JsonFragment.md) | - -#### Returns - -[`Fragment`](verida_vda_sbt_client._internal_.Fragment.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:47 - -___ - -### fromString - -▸ `Static` **fromString**(`value`): [`Fragment`](verida_vda_sbt_client._internal_.Fragment.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `string` | - -#### Returns - -[`Fragment`](verida_vda_sbt_client._internal_.Fragment.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:48 - -___ - -### isFragment - -▸ `Static` **isFragment**(`value`): value is Fragment - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `any` | - -#### Returns - -value is Fragment - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:49 diff --git a/docs/api/verida-js/classes/verida_vda_sbt_client._internal_.FunctionFragment.md b/docs/api/verida-js/classes/verida_vda_sbt_client._internal_.FunctionFragment.md deleted file mode 100644 index 7739d99..0000000 --- a/docs/api/verida-js/classes/verida_vda_sbt_client._internal_.FunctionFragment.md +++ /dev/null @@ -1,342 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-sbt-client](../modules/verida_vda_sbt_client.md) / [](../modules/verida_vda_sbt_client._internal_.md) / FunctionFragment - -# Class: FunctionFragment - -[@verida/vda-sbt-client](../modules/verida_vda_sbt_client.md).[](../modules/verida_vda_sbt_client._internal_.md).FunctionFragment - -## Hierarchy - -- [`ConstructorFragment`](verida_vda_sbt_client._internal_.ConstructorFragment.md) - - ↳ **`FunctionFragment`** - -## Table of contents - -### Constructors - -- [constructor](verida_vda_sbt_client._internal_.FunctionFragment.md#constructor) - -### Properties - -- [\_isFragment](verida_vda_sbt_client._internal_.FunctionFragment.md#_isfragment) -- [constant](verida_vda_sbt_client._internal_.FunctionFragment.md#constant) -- [gas](verida_vda_sbt_client._internal_.FunctionFragment.md#gas) -- [inputs](verida_vda_sbt_client._internal_.FunctionFragment.md#inputs) -- [name](verida_vda_sbt_client._internal_.FunctionFragment.md#name) -- [outputs](verida_vda_sbt_client._internal_.FunctionFragment.md#outputs) -- [payable](verida_vda_sbt_client._internal_.FunctionFragment.md#payable) -- [stateMutability](verida_vda_sbt_client._internal_.FunctionFragment.md#statemutability) -- [type](verida_vda_sbt_client._internal_.FunctionFragment.md#type) - -### Methods - -- [format](verida_vda_sbt_client._internal_.FunctionFragment.md#format) -- [from](verida_vda_sbt_client._internal_.FunctionFragment.md#from) -- [fromObject](verida_vda_sbt_client._internal_.FunctionFragment.md#fromobject) -- [fromString](verida_vda_sbt_client._internal_.FunctionFragment.md#fromstring) -- [isConstructorFragment](verida_vda_sbt_client._internal_.FunctionFragment.md#isconstructorfragment) -- [isFragment](verida_vda_sbt_client._internal_.FunctionFragment.md#isfragment) -- [isFunctionFragment](verida_vda_sbt_client._internal_.FunctionFragment.md#isfunctionfragment) - -## Constructors - -### constructor - -• **new FunctionFragment**(`constructorGuard`, `params`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `constructorGuard` | `any` | -| `params` | `any` | - -#### Inherited from - -[ConstructorFragment](verida_vda_sbt_client._internal_.ConstructorFragment.md).[constructor](verida_vda_sbt_client._internal_.ConstructorFragment.md#constructor) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:44 - -## Properties - -### \_isFragment - -• `Readonly` **\_isFragment**: `boolean` - -#### Inherited from - -[ConstructorFragment](verida_vda_sbt_client._internal_.ConstructorFragment.md).[_isFragment](verida_vda_sbt_client._internal_.ConstructorFragment.md#_isfragment) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:43 - -___ - -### constant - -• **constant**: `boolean` - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:70 - -___ - -### gas - -• `Optional` **gas**: [`BigNumber`](verida_vda_sbt_client._internal_.BigNumber.md) - -#### Inherited from - -[ConstructorFragment](verida_vda_sbt_client._internal_.ConstructorFragment.md).[gas](verida_vda_sbt_client._internal_.ConstructorFragment.md#gas) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:62 - -___ - -### inputs - -• `Readonly` **inputs**: [`ParamType`](verida_vda_sbt_client._internal_.ParamType.md)[] - -#### Inherited from - -[ConstructorFragment](verida_vda_sbt_client._internal_.ConstructorFragment.md).[inputs](verida_vda_sbt_client._internal_.ConstructorFragment.md#inputs) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:42 - -___ - -### name - -• `Readonly` **name**: `string` - -#### Inherited from - -[ConstructorFragment](verida_vda_sbt_client._internal_.ConstructorFragment.md).[name](verida_vda_sbt_client._internal_.ConstructorFragment.md#name) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:41 - -___ - -### outputs - -• `Optional` **outputs**: [`ParamType`](verida_vda_sbt_client._internal_.ParamType.md)[] - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:71 - -___ - -### payable - -• **payable**: `boolean` - -#### Inherited from - -[ConstructorFragment](verida_vda_sbt_client._internal_.ConstructorFragment.md).[payable](verida_vda_sbt_client._internal_.ConstructorFragment.md#payable) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:61 - -___ - -### stateMutability - -• **stateMutability**: `string` - -#### Inherited from - -[ConstructorFragment](verida_vda_sbt_client._internal_.ConstructorFragment.md).[stateMutability](verida_vda_sbt_client._internal_.ConstructorFragment.md#statemutability) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:60 - -___ - -### type - -• `Readonly` **type**: `string` - -#### Inherited from - -[ConstructorFragment](verida_vda_sbt_client._internal_.ConstructorFragment.md).[type](verida_vda_sbt_client._internal_.ConstructorFragment.md#type) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:40 - -## Methods - -### format - -▸ **format**(`format?`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `format?` | `string` | - -#### Returns - -`string` - -#### Overrides - -[ConstructorFragment](verida_vda_sbt_client._internal_.ConstructorFragment.md).[format](verida_vda_sbt_client._internal_.ConstructorFragment.md#format) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:72 - -___ - -### from - -▸ `Static` **from**(`value`): [`FunctionFragment`](verida_vda_sbt_client._internal_.FunctionFragment.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `string` \| [`JsonFragment`](../interfaces/verida_vda_sbt_client._internal_.JsonFragment.md) \| [`FunctionFragment`](verida_vda_sbt_client._internal_.FunctionFragment.md) | - -#### Returns - -[`FunctionFragment`](verida_vda_sbt_client._internal_.FunctionFragment.md) - -#### Overrides - -[ConstructorFragment](verida_vda_sbt_client._internal_.ConstructorFragment.md).[from](verida_vda_sbt_client._internal_.ConstructorFragment.md#from) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:73 - -___ - -### fromObject - -▸ `Static` **fromObject**(`value`): [`FunctionFragment`](verida_vda_sbt_client._internal_.FunctionFragment.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | [`JsonFragment`](../interfaces/verida_vda_sbt_client._internal_.JsonFragment.md) \| [`FunctionFragment`](verida_vda_sbt_client._internal_.FunctionFragment.md) | - -#### Returns - -[`FunctionFragment`](verida_vda_sbt_client._internal_.FunctionFragment.md) - -#### Overrides - -[ConstructorFragment](verida_vda_sbt_client._internal_.ConstructorFragment.md).[fromObject](verida_vda_sbt_client._internal_.ConstructorFragment.md#fromobject) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:74 - -___ - -### fromString - -▸ `Static` **fromString**(`value`): [`FunctionFragment`](verida_vda_sbt_client._internal_.FunctionFragment.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `string` | - -#### Returns - -[`FunctionFragment`](verida_vda_sbt_client._internal_.FunctionFragment.md) - -#### Overrides - -[ConstructorFragment](verida_vda_sbt_client._internal_.ConstructorFragment.md).[fromString](verida_vda_sbt_client._internal_.ConstructorFragment.md#fromstring) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:75 - -___ - -### isConstructorFragment - -▸ `Static` **isConstructorFragment**(`value`): value is ConstructorFragment - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `any` | - -#### Returns - -value is ConstructorFragment - -#### Inherited from - -[ConstructorFragment](verida_vda_sbt_client._internal_.ConstructorFragment.md).[isConstructorFragment](verida_vda_sbt_client._internal_.ConstructorFragment.md#isconstructorfragment) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:67 - -___ - -### isFragment - -▸ `Static` **isFragment**(`value`): value is Fragment - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `any` | - -#### Returns - -value is Fragment - -#### Inherited from - -[ConstructorFragment](verida_vda_sbt_client._internal_.ConstructorFragment.md).[isFragment](verida_vda_sbt_client._internal_.ConstructorFragment.md#isfragment) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:49 - -___ - -### isFunctionFragment - -▸ `Static` **isFunctionFragment**(`value`): value is FunctionFragment - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `any` | - -#### Returns - -value is FunctionFragment - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:76 diff --git a/docs/api/verida-js/classes/verida_vda_sbt_client._internal_.Indexed.md b/docs/api/verida-js/classes/verida_vda_sbt_client._internal_.Indexed.md deleted file mode 100644 index 2a21989..0000000 --- a/docs/api/verida-js/classes/verida_vda_sbt_client._internal_.Indexed.md +++ /dev/null @@ -1,88 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-sbt-client](../modules/verida_vda_sbt_client.md) / [](../modules/verida_vda_sbt_client._internal_.md) / Indexed - -# Class: Indexed - -[@verida/vda-sbt-client](../modules/verida_vda_sbt_client.md).[](../modules/verida_vda_sbt_client._internal_.md).Indexed - -## Hierarchy - -- [`Description`](verida_vda_sbt_client._internal_.Description.md)<[`Indexed`](verida_vda_sbt_client._internal_.Indexed.md)\> - - ↳ **`Indexed`** - -## Table of contents - -### Constructors - -- [constructor](verida_vda_sbt_client._internal_.Indexed.md#constructor) - -### Properties - -- [\_isIndexed](verida_vda_sbt_client._internal_.Indexed.md#_isindexed) -- [hash](verida_vda_sbt_client._internal_.Indexed.md#hash) - -### Methods - -- [isIndexed](verida_vda_sbt_client._internal_.Indexed.md#isindexed) - -## Constructors - -### constructor - -• **new Indexed**(`info`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `info` | `Object` | -| `info._isIndexed` | `boolean` | -| `info.hash` | `string` | - -#### Inherited from - -[Description](verida_vda_sbt_client._internal_.Description.md).[constructor](verida_vda_sbt_client._internal_.Description.md#constructor) - -#### Defined in - -node_modules/@ethersproject/properties/lib/index.d.ts:13 - -## Properties - -### \_isIndexed - -• `Readonly` **\_isIndexed**: `boolean` - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:32 - -___ - -### hash - -• `Readonly` **hash**: `string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:31 - -## Methods - -### isIndexed - -▸ `Static` **isIndexed**(`value`): value is Indexed - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `any` | - -#### Returns - -value is Indexed - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:33 diff --git a/docs/api/verida-js/classes/verida_vda_sbt_client._internal_.Interface.md b/docs/api/verida-js/classes/verida_vda_sbt_client._internal_.Interface.md deleted file mode 100644 index 5daa661..0000000 --- a/docs/api/verida-js/classes/verida_vda_sbt_client._internal_.Interface.md +++ /dev/null @@ -1,698 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-sbt-client](../modules/verida_vda_sbt_client.md) / [](../modules/verida_vda_sbt_client._internal_.md) / Interface - -# Class: Interface - -[@verida/vda-sbt-client](../modules/verida_vda_sbt_client.md).[](../modules/verida_vda_sbt_client._internal_.md).Interface - -## Table of contents - -### Constructors - -- [constructor](verida_vda_sbt_client._internal_.Interface.md#constructor) - -### Properties - -- [\_abiCoder](verida_vda_sbt_client._internal_.Interface.md#_abicoder) -- [\_isInterface](verida_vda_sbt_client._internal_.Interface.md#_isinterface) -- [deploy](verida_vda_sbt_client._internal_.Interface.md#deploy) -- [errors](verida_vda_sbt_client._internal_.Interface.md#errors) -- [events](verida_vda_sbt_client._internal_.Interface.md#events) -- [fragments](verida_vda_sbt_client._internal_.Interface.md#fragments) -- [functions](verida_vda_sbt_client._internal_.Interface.md#functions) -- [structs](verida_vda_sbt_client._internal_.Interface.md#structs) - -### Methods - -- [\_decodeParams](verida_vda_sbt_client._internal_.Interface.md#_decodeparams) -- [\_encodeParams](verida_vda_sbt_client._internal_.Interface.md#_encodeparams) -- [decodeErrorResult](verida_vda_sbt_client._internal_.Interface.md#decodeerrorresult) -- [decodeEventLog](verida_vda_sbt_client._internal_.Interface.md#decodeeventlog) -- [decodeFunctionData](verida_vda_sbt_client._internal_.Interface.md#decodefunctiondata) -- [decodeFunctionResult](verida_vda_sbt_client._internal_.Interface.md#decodefunctionresult) -- [encodeDeploy](verida_vda_sbt_client._internal_.Interface.md#encodedeploy) -- [encodeErrorResult](verida_vda_sbt_client._internal_.Interface.md#encodeerrorresult) -- [encodeEventLog](verida_vda_sbt_client._internal_.Interface.md#encodeeventlog) -- [encodeFilterTopics](verida_vda_sbt_client._internal_.Interface.md#encodefiltertopics) -- [encodeFunctionData](verida_vda_sbt_client._internal_.Interface.md#encodefunctiondata) -- [encodeFunctionResult](verida_vda_sbt_client._internal_.Interface.md#encodefunctionresult) -- [format](verida_vda_sbt_client._internal_.Interface.md#format) -- [getError](verida_vda_sbt_client._internal_.Interface.md#geterror) -- [getEvent](verida_vda_sbt_client._internal_.Interface.md#getevent) -- [getEventTopic](verida_vda_sbt_client._internal_.Interface.md#geteventtopic) -- [getFunction](verida_vda_sbt_client._internal_.Interface.md#getfunction) -- [getSighash](verida_vda_sbt_client._internal_.Interface.md#getsighash) -- [parseError](verida_vda_sbt_client._internal_.Interface.md#parseerror) -- [parseLog](verida_vda_sbt_client._internal_.Interface.md#parselog) -- [parseTransaction](verida_vda_sbt_client._internal_.Interface.md#parsetransaction) -- [getAbiCoder](verida_vda_sbt_client._internal_.Interface.md#getabicoder) -- [getAddress](verida_vda_sbt_client._internal_.Interface.md#getaddress) -- [getEventTopic](verida_vda_sbt_client._internal_.Interface.md#geteventtopic) -- [getSighash](verida_vda_sbt_client._internal_.Interface.md#getsighash) -- [isInterface](verida_vda_sbt_client._internal_.Interface.md#isinterface) - -## Constructors - -### constructor - -• **new Interface**(`fragments`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `fragments` | `string` \| readonly (`string` \| [`Fragment`](verida_vda_sbt_client._internal_.Fragment.md) \| [`JsonFragment`](../interfaces/verida_vda_sbt_client._internal_.JsonFragment.md))[] | - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:52 - -## Properties - -### \_abiCoder - -• `Readonly` **\_abiCoder**: [`AbiCoder`](verida_vda_sbt_client._internal_.AbiCoder.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:50 - -___ - -### \_isInterface - -• `Readonly` **\_isInterface**: `boolean` - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:51 - -___ - -### deploy - -• `Readonly` **deploy**: [`ConstructorFragment`](verida_vda_sbt_client._internal_.ConstructorFragment.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:49 - -___ - -### errors - -• `Readonly` **errors**: `Object` - -#### Index signature - -▪ [name: `string`]: [`ErrorFragment`](verida_vda_sbt_client._internal_.ErrorFragment.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:37 - -___ - -### events - -• `Readonly` **events**: `Object` - -#### Index signature - -▪ [name: `string`]: [`EventFragment`](verida_vda_sbt_client._internal_.EventFragment.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:40 - -___ - -### fragments - -• `Readonly` **fragments**: readonly [`Fragment`](verida_vda_sbt_client._internal_.Fragment.md)[] - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:36 - -___ - -### functions - -• `Readonly` **functions**: `Object` - -#### Index signature - -▪ [name: `string`]: [`FunctionFragment`](verida_vda_sbt_client._internal_.FunctionFragment.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:43 - -___ - -### structs - -• `Readonly` **structs**: `Object` - -#### Index signature - -▪ [name: `string`]: `any` - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:46 - -## Methods - -### \_decodeParams - -▸ **_decodeParams**(`params`, `data`): [`Result`](../interfaces/verida_vda_sbt_client._internal_.Result.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `params` | readonly [`ParamType`](verida_vda_sbt_client._internal_.ParamType.md)[] | -| `data` | [`BytesLike`](../modules/verida_vda_sbt_client._internal_.md#byteslike) | - -#### Returns - -[`Result`](../interfaces/verida_vda_sbt_client._internal_.Result.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:63 - -___ - -### \_encodeParams - -▸ **_encodeParams**(`params`, `values`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `params` | readonly [`ParamType`](verida_vda_sbt_client._internal_.ParamType.md)[] | -| `values` | readonly `any`[] | - -#### Returns - -`string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:64 - -___ - -### decodeErrorResult - -▸ **decodeErrorResult**(`fragment`, `data`): [`Result`](../interfaces/verida_vda_sbt_client._internal_.Result.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `fragment` | `string` \| [`ErrorFragment`](verida_vda_sbt_client._internal_.ErrorFragment.md) | -| `data` | [`BytesLike`](../modules/verida_vda_sbt_client._internal_.md#byteslike) | - -#### Returns - -[`Result`](../interfaces/verida_vda_sbt_client._internal_.Result.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:66 - -___ - -### decodeEventLog - -▸ **decodeEventLog**(`eventFragment`, `data`, `topics?`): [`Result`](../interfaces/verida_vda_sbt_client._internal_.Result.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventFragment` | `string` \| [`EventFragment`](verida_vda_sbt_client._internal_.EventFragment.md) | -| `data` | [`BytesLike`](../modules/verida_vda_sbt_client._internal_.md#byteslike) | -| `topics?` | readonly `string`[] | - -#### Returns - -[`Result`](../interfaces/verida_vda_sbt_client._internal_.Result.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:77 - -___ - -### decodeFunctionData - -▸ **decodeFunctionData**(`functionFragment`, `data`): [`Result`](../interfaces/verida_vda_sbt_client._internal_.Result.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `functionFragment` | `string` \| [`FunctionFragment`](verida_vda_sbt_client._internal_.FunctionFragment.md) | -| `data` | [`BytesLike`](../modules/verida_vda_sbt_client._internal_.md#byteslike) | - -#### Returns - -[`Result`](../interfaces/verida_vda_sbt_client._internal_.Result.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:68 - -___ - -### decodeFunctionResult - -▸ **decodeFunctionResult**(`functionFragment`, `data`): [`Result`](../interfaces/verida_vda_sbt_client._internal_.Result.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `functionFragment` | `string` \| [`FunctionFragment`](verida_vda_sbt_client._internal_.FunctionFragment.md) | -| `data` | [`BytesLike`](../modules/verida_vda_sbt_client._internal_.md#byteslike) | - -#### Returns - -[`Result`](../interfaces/verida_vda_sbt_client._internal_.Result.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:70 - -___ - -### encodeDeploy - -▸ **encodeDeploy**(`values?`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `values?` | readonly `any`[] | - -#### Returns - -`string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:65 - -___ - -### encodeErrorResult - -▸ **encodeErrorResult**(`fragment`, `values?`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `fragment` | `string` \| [`ErrorFragment`](verida_vda_sbt_client._internal_.ErrorFragment.md) | -| `values?` | readonly `any`[] | - -#### Returns - -`string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:67 - -___ - -### encodeEventLog - -▸ **encodeEventLog**(`eventFragment`, `values`): `Object` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventFragment` | `string` \| [`EventFragment`](verida_vda_sbt_client._internal_.EventFragment.md) | -| `values` | readonly `any`[] | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `data` | `string` | -| `topics` | `string`[] | - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:73 - -___ - -### encodeFilterTopics - -▸ **encodeFilterTopics**(`eventFragment`, `values`): (`string` \| `string`[])[] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventFragment` | `string` \| [`EventFragment`](verida_vda_sbt_client._internal_.EventFragment.md) | -| `values` | readonly `any`[] | - -#### Returns - -(`string` \| `string`[])[] - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:72 - -___ - -### encodeFunctionData - -▸ **encodeFunctionData**(`functionFragment`, `values?`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `functionFragment` | `string` \| [`FunctionFragment`](verida_vda_sbt_client._internal_.FunctionFragment.md) | -| `values?` | readonly `any`[] | - -#### Returns - -`string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:69 - -___ - -### encodeFunctionResult - -▸ **encodeFunctionResult**(`functionFragment`, `values?`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `functionFragment` | `string` \| [`FunctionFragment`](verida_vda_sbt_client._internal_.FunctionFragment.md) | -| `values?` | readonly `any`[] | - -#### Returns - -`string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:71 - -___ - -### format - -▸ **format**(`format?`): `string` \| `string`[] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `format?` | `string` | - -#### Returns - -`string` \| `string`[] - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:53 - -___ - -### getError - -▸ **getError**(`nameOrSignatureOrSighash`): [`ErrorFragment`](verida_vda_sbt_client._internal_.ErrorFragment.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `nameOrSignatureOrSighash` | `string` | - -#### Returns - -[`ErrorFragment`](verida_vda_sbt_client._internal_.ErrorFragment.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:60 - -___ - -### getEvent - -▸ **getEvent**(`nameOrSignatureOrTopic`): [`EventFragment`](verida_vda_sbt_client._internal_.EventFragment.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `nameOrSignatureOrTopic` | `string` | - -#### Returns - -[`EventFragment`](verida_vda_sbt_client._internal_.EventFragment.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:59 - -___ - -### getEventTopic - -▸ **getEventTopic**(`eventFragment`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventFragment` | `string` \| [`EventFragment`](verida_vda_sbt_client._internal_.EventFragment.md) | - -#### Returns - -`string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:62 - -___ - -### getFunction - -▸ **getFunction**(`nameOrSignatureOrSighash`): [`FunctionFragment`](verida_vda_sbt_client._internal_.FunctionFragment.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `nameOrSignatureOrSighash` | `string` | - -#### Returns - -[`FunctionFragment`](verida_vda_sbt_client._internal_.FunctionFragment.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:58 - -___ - -### getSighash - -▸ **getSighash**(`fragment`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `fragment` | `string` \| [`ErrorFragment`](verida_vda_sbt_client._internal_.ErrorFragment.md) \| [`FunctionFragment`](verida_vda_sbt_client._internal_.FunctionFragment.md) | - -#### Returns - -`string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:61 - -___ - -### parseError - -▸ **parseError**(`data`): [`ErrorDescription`](verida_vda_sbt_client._internal_.ErrorDescription.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | [`BytesLike`](../modules/verida_vda_sbt_client._internal_.md#byteslike) | - -#### Returns - -[`ErrorDescription`](verida_vda_sbt_client._internal_.ErrorDescription.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:86 - -___ - -### parseLog - -▸ **parseLog**(`log`): [`LogDescription`](verida_vda_sbt_client._internal_.LogDescription.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `log` | `Object` | -| `log.data` | `string` | -| `log.topics` | `string`[] | - -#### Returns - -[`LogDescription`](verida_vda_sbt_client._internal_.LogDescription.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:82 - -___ - -### parseTransaction - -▸ **parseTransaction**(`tx`): [`TransactionDescription`](verida_vda_sbt_client._internal_.TransactionDescription.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `tx` | `Object` | -| `tx.data` | `string` | -| `tx.value?` | [`BigNumberish`](../modules/verida_vda_sbt_client._internal_.md#bignumberish) | - -#### Returns - -[`TransactionDescription`](verida_vda_sbt_client._internal_.TransactionDescription.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:78 - -___ - -### getAbiCoder - -▸ `Static` **getAbiCoder**(): [`AbiCoder`](verida_vda_sbt_client._internal_.AbiCoder.md) - -#### Returns - -[`AbiCoder`](verida_vda_sbt_client._internal_.AbiCoder.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:54 - -___ - -### getAddress - -▸ `Static` **getAddress**(`address`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `address` | `string` | - -#### Returns - -`string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:55 - -___ - -### getEventTopic - -▸ `Static` **getEventTopic**(`eventFragment`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventFragment` | [`EventFragment`](verida_vda_sbt_client._internal_.EventFragment.md) | - -#### Returns - -`string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:57 - -___ - -### getSighash - -▸ `Static` **getSighash**(`fragment`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `fragment` | [`ErrorFragment`](verida_vda_sbt_client._internal_.ErrorFragment.md) \| [`FunctionFragment`](verida_vda_sbt_client._internal_.FunctionFragment.md) | - -#### Returns - -`string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:56 - -___ - -### isInterface - -▸ `Static` **isInterface**(`value`): value is Interface - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `any` | - -#### Returns - -value is Interface - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:87 diff --git a/docs/api/verida-js/classes/verida_vda_sbt_client._internal_.LogDescription.md b/docs/api/verida-js/classes/verida_vda_sbt_client._internal_.LogDescription.md deleted file mode 100644 index 89ee773..0000000 --- a/docs/api/verida-js/classes/verida_vda_sbt_client._internal_.LogDescription.md +++ /dev/null @@ -1,100 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-sbt-client](../modules/verida_vda_sbt_client.md) / [](../modules/verida_vda_sbt_client._internal_.md) / LogDescription - -# Class: LogDescription - -[@verida/vda-sbt-client](../modules/verida_vda_sbt_client.md).[](../modules/verida_vda_sbt_client._internal_.md).LogDescription - -## Hierarchy - -- [`Description`](verida_vda_sbt_client._internal_.Description.md)<[`LogDescription`](verida_vda_sbt_client._internal_.LogDescription.md)\> - - ↳ **`LogDescription`** - -## Table of contents - -### Constructors - -- [constructor](verida_vda_sbt_client._internal_.LogDescription.md#constructor) - -### Properties - -- [args](verida_vda_sbt_client._internal_.LogDescription.md#args) -- [eventFragment](verida_vda_sbt_client._internal_.LogDescription.md#eventfragment) -- [name](verida_vda_sbt_client._internal_.LogDescription.md#name) -- [signature](verida_vda_sbt_client._internal_.LogDescription.md#signature) -- [topic](verida_vda_sbt_client._internal_.LogDescription.md#topic) - -## Constructors - -### constructor - -• **new LogDescription**(`info`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `info` | `Object` | -| `info.args` | [`Result`](../interfaces/verida_vda_sbt_client._internal_.Result.md) | -| `info.eventFragment` | [`EventFragment`](verida_vda_sbt_client._internal_.EventFragment.md) | -| `info.name` | `string` | -| `info.signature` | `string` | -| `info.topic` | `string` | - -#### Inherited from - -[Description](verida_vda_sbt_client._internal_.Description.md).[constructor](verida_vda_sbt_client._internal_.Description.md#constructor) - -#### Defined in - -node_modules/@ethersproject/properties/lib/index.d.ts:13 - -## Properties - -### args - -• `Readonly` **args**: [`Result`](../interfaces/verida_vda_sbt_client._internal_.Result.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:13 - -___ - -### eventFragment - -• `Readonly` **eventFragment**: [`EventFragment`](verida_vda_sbt_client._internal_.EventFragment.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:9 - -___ - -### name - -• `Readonly` **name**: `string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:10 - -___ - -### signature - -• `Readonly` **signature**: `string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:11 - -___ - -### topic - -• `Readonly` **topic**: `string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:12 diff --git a/docs/api/verida-js/classes/verida_vda_sbt_client._internal_.ParamType.md b/docs/api/verida-js/classes/verida_vda_sbt_client._internal_.ParamType.md deleted file mode 100644 index 10ff4a8..0000000 --- a/docs/api/verida-js/classes/verida_vda_sbt_client._internal_.ParamType.md +++ /dev/null @@ -1,229 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-sbt-client](../modules/verida_vda_sbt_client.md) / [](../modules/verida_vda_sbt_client._internal_.md) / ParamType - -# Class: ParamType - -[@verida/vda-sbt-client](../modules/verida_vda_sbt_client.md).[](../modules/verida_vda_sbt_client._internal_.md).ParamType - -## Table of contents - -### Constructors - -- [constructor](verida_vda_sbt_client._internal_.ParamType.md#constructor) - -### Properties - -- [\_isParamType](verida_vda_sbt_client._internal_.ParamType.md#_isparamtype) -- [arrayChildren](verida_vda_sbt_client._internal_.ParamType.md#arraychildren) -- [arrayLength](verida_vda_sbt_client._internal_.ParamType.md#arraylength) -- [baseType](verida_vda_sbt_client._internal_.ParamType.md#basetype) -- [components](verida_vda_sbt_client._internal_.ParamType.md#components) -- [indexed](verida_vda_sbt_client._internal_.ParamType.md#indexed) -- [name](verida_vda_sbt_client._internal_.ParamType.md#name) -- [type](verida_vda_sbt_client._internal_.ParamType.md#type) - -### Methods - -- [format](verida_vda_sbt_client._internal_.ParamType.md#format) -- [from](verida_vda_sbt_client._internal_.ParamType.md#from) -- [fromObject](verida_vda_sbt_client._internal_.ParamType.md#fromobject) -- [fromString](verida_vda_sbt_client._internal_.ParamType.md#fromstring) -- [isParamType](verida_vda_sbt_client._internal_.ParamType.md#isparamtype) - -## Constructors - -### constructor - -• **new ParamType**(`constructorGuard`, `params`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `constructorGuard` | `any` | -| `params` | `any` | - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:32 - -## Properties - -### \_isParamType - -• `Readonly` **\_isParamType**: `boolean` - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:31 - -___ - -### arrayChildren - -• `Readonly` **arrayChildren**: [`ParamType`](verida_vda_sbt_client._internal_.ParamType.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:30 - -___ - -### arrayLength - -• `Readonly` **arrayLength**: `number` - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:29 - -___ - -### baseType - -• `Readonly` **baseType**: `string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:26 - -___ - -### components - -• `Readonly` **components**: [`ParamType`](verida_vda_sbt_client._internal_.ParamType.md)[] - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:28 - -___ - -### indexed - -• `Readonly` **indexed**: `boolean` - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:27 - -___ - -### name - -• `Readonly` **name**: `string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:24 - -___ - -### type - -• `Readonly` **type**: `string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:25 - -## Methods - -### format - -▸ **format**(`format?`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `format?` | `string` | - -#### Returns - -`string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:33 - -___ - -### from - -▸ `Static` **from**(`value`, `allowIndexed?`): [`ParamType`](verida_vda_sbt_client._internal_.ParamType.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `string` \| [`ParamType`](verida_vda_sbt_client._internal_.ParamType.md) \| [`JsonFragmentType`](../interfaces/verida_vda_sbt_client._internal_.JsonFragmentType.md) | -| `allowIndexed?` | `boolean` | - -#### Returns - -[`ParamType`](verida_vda_sbt_client._internal_.ParamType.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:34 - -___ - -### fromObject - -▸ `Static` **fromObject**(`value`): [`ParamType`](verida_vda_sbt_client._internal_.ParamType.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | [`ParamType`](verida_vda_sbt_client._internal_.ParamType.md) \| [`JsonFragmentType`](../interfaces/verida_vda_sbt_client._internal_.JsonFragmentType.md) | - -#### Returns - -[`ParamType`](verida_vda_sbt_client._internal_.ParamType.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:35 - -___ - -### fromString - -▸ `Static` **fromString**(`value`, `allowIndexed?`): [`ParamType`](verida_vda_sbt_client._internal_.ParamType.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `string` | -| `allowIndexed?` | `boolean` | - -#### Returns - -[`ParamType`](verida_vda_sbt_client._internal_.ParamType.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:36 - -___ - -### isParamType - -▸ `Static` **isParamType**(`value`): value is ParamType - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `any` | - -#### Returns - -value is ParamType - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:37 diff --git a/docs/api/verida-js/classes/verida_vda_sbt_client._internal_.Provider.md b/docs/api/verida-js/classes/verida_vda_sbt_client._internal_.Provider.md deleted file mode 100644 index 86949a5..0000000 --- a/docs/api/verida-js/classes/verida_vda_sbt_client._internal_.Provider.md +++ /dev/null @@ -1,645 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-sbt-client](../modules/verida_vda_sbt_client.md) / [](../modules/verida_vda_sbt_client._internal_.md) / Provider - -# Class: Provider - -[@verida/vda-sbt-client](../modules/verida_vda_sbt_client.md).[](../modules/verida_vda_sbt_client._internal_.md).Provider - -## Implements - -- [`OnceBlockable`](../interfaces/verida_vda_sbt_client._internal_.OnceBlockable.md) - -## Table of contents - -### Constructors - -- [constructor](verida_vda_sbt_client._internal_.Provider.md#constructor) - -### Properties - -- [\_isProvider](verida_vda_sbt_client._internal_.Provider.md#_isprovider) - -### Methods - -- [addListener](verida_vda_sbt_client._internal_.Provider.md#addlistener) -- [call](verida_vda_sbt_client._internal_.Provider.md#call) -- [emit](verida_vda_sbt_client._internal_.Provider.md#emit) -- [estimateGas](verida_vda_sbt_client._internal_.Provider.md#estimategas) -- [getBalance](verida_vda_sbt_client._internal_.Provider.md#getbalance) -- [getBlock](verida_vda_sbt_client._internal_.Provider.md#getblock) -- [getBlockNumber](verida_vda_sbt_client._internal_.Provider.md#getblocknumber) -- [getBlockWithTransactions](verida_vda_sbt_client._internal_.Provider.md#getblockwithtransactions) -- [getCode](verida_vda_sbt_client._internal_.Provider.md#getcode) -- [getFeeData](verida_vda_sbt_client._internal_.Provider.md#getfeedata) -- [getGasPrice](verida_vda_sbt_client._internal_.Provider.md#getgasprice) -- [getLogs](verida_vda_sbt_client._internal_.Provider.md#getlogs) -- [getNetwork](verida_vda_sbt_client._internal_.Provider.md#getnetwork) -- [getStorageAt](verida_vda_sbt_client._internal_.Provider.md#getstorageat) -- [getTransaction](verida_vda_sbt_client._internal_.Provider.md#gettransaction) -- [getTransactionCount](verida_vda_sbt_client._internal_.Provider.md#gettransactioncount) -- [getTransactionReceipt](verida_vda_sbt_client._internal_.Provider.md#gettransactionreceipt) -- [listenerCount](verida_vda_sbt_client._internal_.Provider.md#listenercount) -- [listeners](verida_vda_sbt_client._internal_.Provider.md#listeners) -- [lookupAddress](verida_vda_sbt_client._internal_.Provider.md#lookupaddress) -- [off](verida_vda_sbt_client._internal_.Provider.md#off) -- [on](verida_vda_sbt_client._internal_.Provider.md#on) -- [once](verida_vda_sbt_client._internal_.Provider.md#once) -- [removeAllListeners](verida_vda_sbt_client._internal_.Provider.md#removealllisteners) -- [removeListener](verida_vda_sbt_client._internal_.Provider.md#removelistener) -- [resolveName](verida_vda_sbt_client._internal_.Provider.md#resolvename) -- [sendTransaction](verida_vda_sbt_client._internal_.Provider.md#sendtransaction) -- [waitForTransaction](verida_vda_sbt_client._internal_.Provider.md#waitfortransaction) -- [isProvider](verida_vda_sbt_client._internal_.Provider.md#isprovider) - -## Constructors - -### constructor - -• **new Provider**() - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:153 - -## Properties - -### \_isProvider - -• `Readonly` **\_isProvider**: `boolean` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:152 - -## Methods - -### addListener - -▸ **addListener**(`eventName`, `listener`): [`Provider`](verida_vda_sbt_client._internal_.Provider.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | [`EventType`](../modules/verida_vda_sbt_client._internal_.md#eventtype) | -| `listener` | [`Listener`](../modules/verida_vda_sbt_client._internal_.md#listener) | - -#### Returns - -[`Provider`](verida_vda_sbt_client._internal_.Provider.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:149 - -___ - -### call - -▸ `Abstract` **call**(`transaction`, `blockTag?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transaction` | [`Deferrable`](../modules/verida_vda_sbt_client._internal_.md#deferrable)<[`TransactionRequest`](../modules/verida_vda_sbt_client._internal_.md#transactionrequest)\> | -| `blockTag?` | [`BlockTag`](../modules/verida_vda_sbt_client._internal_.md#blocktag) \| `Promise`<[`BlockTag`](../modules/verida_vda_sbt_client._internal_.md#blocktag)\> | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:133 - -___ - -### emit - -▸ `Abstract` **emit**(`eventName`, ...`args`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | [`EventType`](../modules/verida_vda_sbt_client._internal_.md#eventtype) | -| `...args` | `any`[] | - -#### Returns - -`boolean` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:144 - -___ - -### estimateGas - -▸ `Abstract` **estimateGas**(`transaction`): `Promise`<[`BigNumber`](verida_vda_sbt_client._internal_.BigNumber.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transaction` | [`Deferrable`](../modules/verida_vda_sbt_client._internal_.md#deferrable)<[`TransactionRequest`](../modules/verida_vda_sbt_client._internal_.md#transactionrequest)\> | - -#### Returns - -`Promise`<[`BigNumber`](verida_vda_sbt_client._internal_.BigNumber.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:134 - -___ - -### getBalance - -▸ `Abstract` **getBalance**(`addressOrName`, `blockTag?`): `Promise`<[`BigNumber`](verida_vda_sbt_client._internal_.BigNumber.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `addressOrName` | `string` \| `Promise`<`string`\> | -| `blockTag?` | [`BlockTag`](../modules/verida_vda_sbt_client._internal_.md#blocktag) \| `Promise`<[`BlockTag`](../modules/verida_vda_sbt_client._internal_.md#blocktag)\> | - -#### Returns - -`Promise`<[`BigNumber`](verida_vda_sbt_client._internal_.BigNumber.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:128 - -___ - -### getBlock - -▸ `Abstract` **getBlock**(`blockHashOrBlockTag`): `Promise`<[`Block`](../interfaces/verida_vda_sbt_client._internal_.Block.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `blockHashOrBlockTag` | [`BlockTag`](../modules/verida_vda_sbt_client._internal_.md#blocktag) \| `Promise`<[`BlockTag`](../modules/verida_vda_sbt_client._internal_.md#blocktag)\> | - -#### Returns - -`Promise`<[`Block`](../interfaces/verida_vda_sbt_client._internal_.Block.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:135 - -___ - -### getBlockNumber - -▸ `Abstract` **getBlockNumber**(): `Promise`<`number`\> - -#### Returns - -`Promise`<`number`\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:125 - -___ - -### getBlockWithTransactions - -▸ `Abstract` **getBlockWithTransactions**(`blockHashOrBlockTag`): `Promise`<[`BlockWithTransactions`](../interfaces/verida_vda_sbt_client._internal_.BlockWithTransactions.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `blockHashOrBlockTag` | [`BlockTag`](../modules/verida_vda_sbt_client._internal_.md#blocktag) \| `Promise`<[`BlockTag`](../modules/verida_vda_sbt_client._internal_.md#blocktag)\> | - -#### Returns - -`Promise`<[`BlockWithTransactions`](../interfaces/verida_vda_sbt_client._internal_.BlockWithTransactions.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:136 - -___ - -### getCode - -▸ `Abstract` **getCode**(`addressOrName`, `blockTag?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `addressOrName` | `string` \| `Promise`<`string`\> | -| `blockTag?` | [`BlockTag`](../modules/verida_vda_sbt_client._internal_.md#blocktag) \| `Promise`<[`BlockTag`](../modules/verida_vda_sbt_client._internal_.md#blocktag)\> | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:130 - -___ - -### getFeeData - -▸ **getFeeData**(): `Promise`<[`FeeData`](../interfaces/verida_vda_sbt_client._internal_.FeeData.md)\> - -#### Returns - -`Promise`<[`FeeData`](../interfaces/verida_vda_sbt_client._internal_.FeeData.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:127 - -___ - -### getGasPrice - -▸ `Abstract` **getGasPrice**(): `Promise`<[`BigNumber`](verida_vda_sbt_client._internal_.BigNumber.md)\> - -#### Returns - -`Promise`<[`BigNumber`](verida_vda_sbt_client._internal_.BigNumber.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:126 - -___ - -### getLogs - -▸ `Abstract` **getLogs**(`filter`): `Promise`<[`Log`](../interfaces/verida_vda_sbt_client._internal_.Log.md)[]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `filter` | [`Filter`](../interfaces/verida_vda_sbt_client._internal_.Filter.md) | - -#### Returns - -`Promise`<[`Log`](../interfaces/verida_vda_sbt_client._internal_.Log.md)[]\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:139 - -___ - -### getNetwork - -▸ `Abstract` **getNetwork**(): `Promise`<[`Network`](../modules/verida_vda_sbt_client._internal_.md#network)\> - -#### Returns - -`Promise`<[`Network`](../modules/verida_vda_sbt_client._internal_.md#network)\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:124 - -___ - -### getStorageAt - -▸ `Abstract` **getStorageAt**(`addressOrName`, `position`, `blockTag?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `addressOrName` | `string` \| `Promise`<`string`\> | -| `position` | [`BigNumberish`](../modules/verida_vda_sbt_client._internal_.md#bignumberish) \| `Promise`<[`BigNumberish`](../modules/verida_vda_sbt_client._internal_.md#bignumberish)\> | -| `blockTag?` | [`BlockTag`](../modules/verida_vda_sbt_client._internal_.md#blocktag) \| `Promise`<[`BlockTag`](../modules/verida_vda_sbt_client._internal_.md#blocktag)\> | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:131 - -___ - -### getTransaction - -▸ `Abstract` **getTransaction**(`transactionHash`): `Promise`<[`TransactionResponse`](../interfaces/verida_vda_sbt_client._internal_.TransactionResponse.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transactionHash` | `string` | - -#### Returns - -`Promise`<[`TransactionResponse`](../interfaces/verida_vda_sbt_client._internal_.TransactionResponse.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:137 - -___ - -### getTransactionCount - -▸ `Abstract` **getTransactionCount**(`addressOrName`, `blockTag?`): `Promise`<`number`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `addressOrName` | `string` \| `Promise`<`string`\> | -| `blockTag?` | [`BlockTag`](../modules/verida_vda_sbt_client._internal_.md#blocktag) \| `Promise`<[`BlockTag`](../modules/verida_vda_sbt_client._internal_.md#blocktag)\> | - -#### Returns - -`Promise`<`number`\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:129 - -___ - -### getTransactionReceipt - -▸ `Abstract` **getTransactionReceipt**(`transactionHash`): `Promise`<[`TransactionReceipt`](../interfaces/verida_vda_sbt_client._internal_.TransactionReceipt.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transactionHash` | `string` | - -#### Returns - -`Promise`<[`TransactionReceipt`](../interfaces/verida_vda_sbt_client._internal_.TransactionReceipt.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:138 - -___ - -### listenerCount - -▸ `Abstract` **listenerCount**(`eventName?`): `number` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName?` | [`EventType`](../modules/verida_vda_sbt_client._internal_.md#eventtype) | - -#### Returns - -`number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:145 - -___ - -### listeners - -▸ `Abstract` **listeners**(`eventName?`): [`Listener`](../modules/verida_vda_sbt_client._internal_.md#listener)[] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName?` | [`EventType`](../modules/verida_vda_sbt_client._internal_.md#eventtype) | - -#### Returns - -[`Listener`](../modules/verida_vda_sbt_client._internal_.md#listener)[] - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:146 - -___ - -### lookupAddress - -▸ `Abstract` **lookupAddress**(`address`): `Promise`<``null`` \| `string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `address` | `string` \| `Promise`<`string`\> | - -#### Returns - -`Promise`<``null`` \| `string`\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:141 - -___ - -### off - -▸ `Abstract` **off**(`eventName`, `listener?`): [`Provider`](verida_vda_sbt_client._internal_.Provider.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | [`EventType`](../modules/verida_vda_sbt_client._internal_.md#eventtype) | -| `listener?` | [`Listener`](../modules/verida_vda_sbt_client._internal_.md#listener) | - -#### Returns - -[`Provider`](verida_vda_sbt_client._internal_.Provider.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:147 - -___ - -### on - -▸ `Abstract` **on**(`eventName`, `listener`): [`Provider`](verida_vda_sbt_client._internal_.Provider.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | [`EventType`](../modules/verida_vda_sbt_client._internal_.md#eventtype) | -| `listener` | [`Listener`](../modules/verida_vda_sbt_client._internal_.md#listener) | - -#### Returns - -[`Provider`](verida_vda_sbt_client._internal_.Provider.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:142 - -___ - -### once - -▸ `Abstract` **once**(`eventName`, `listener`): [`Provider`](verida_vda_sbt_client._internal_.Provider.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | [`EventType`](../modules/verida_vda_sbt_client._internal_.md#eventtype) | -| `listener` | [`Listener`](../modules/verida_vda_sbt_client._internal_.md#listener) | - -#### Returns - -[`Provider`](verida_vda_sbt_client._internal_.Provider.md) - -#### Implementation of - -[OnceBlockable](../interfaces/verida_vda_sbt_client._internal_.OnceBlockable.md).[once](../interfaces/verida_vda_sbt_client._internal_.OnceBlockable.md#once) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:143 - -___ - -### removeAllListeners - -▸ `Abstract` **removeAllListeners**(`eventName?`): [`Provider`](verida_vda_sbt_client._internal_.Provider.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName?` | [`EventType`](../modules/verida_vda_sbt_client._internal_.md#eventtype) | - -#### Returns - -[`Provider`](verida_vda_sbt_client._internal_.Provider.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:148 - -___ - -### removeListener - -▸ **removeListener**(`eventName`, `listener`): [`Provider`](verida_vda_sbt_client._internal_.Provider.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | [`EventType`](../modules/verida_vda_sbt_client._internal_.md#eventtype) | -| `listener` | [`Listener`](../modules/verida_vda_sbt_client._internal_.md#listener) | - -#### Returns - -[`Provider`](verida_vda_sbt_client._internal_.Provider.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:150 - -___ - -### resolveName - -▸ `Abstract` **resolveName**(`name`): `Promise`<``null`` \| `string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` \| `Promise`<`string`\> | - -#### Returns - -`Promise`<``null`` \| `string`\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:140 - -___ - -### sendTransaction - -▸ `Abstract` **sendTransaction**(`signedTransaction`): `Promise`<[`TransactionResponse`](../interfaces/verida_vda_sbt_client._internal_.TransactionResponse.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `signedTransaction` | `string` \| `Promise`<`string`\> | - -#### Returns - -`Promise`<[`TransactionResponse`](../interfaces/verida_vda_sbt_client._internal_.TransactionResponse.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:132 - -___ - -### waitForTransaction - -▸ `Abstract` **waitForTransaction**(`transactionHash`, `confirmations?`, `timeout?`): `Promise`<[`TransactionReceipt`](../interfaces/verida_vda_sbt_client._internal_.TransactionReceipt.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transactionHash` | `string` | -| `confirmations?` | `number` | -| `timeout?` | `number` | - -#### Returns - -`Promise`<[`TransactionReceipt`](../interfaces/verida_vda_sbt_client._internal_.TransactionReceipt.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:151 - -___ - -### isProvider - -▸ `Static` **isProvider**(`value`): value is Provider - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `any` | - -#### Returns - -value is Provider - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:154 diff --git a/docs/api/verida-js/classes/verida_vda_sbt_client._internal_.Reader.md b/docs/api/verida-js/classes/verida_vda_sbt_client._internal_.Reader.md deleted file mode 100644 index 52498b5..0000000 --- a/docs/api/verida-js/classes/verida_vda_sbt_client._internal_.Reader.md +++ /dev/null @@ -1,249 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-sbt-client](../modules/verida_vda_sbt_client.md) / [](../modules/verida_vda_sbt_client._internal_.md) / Reader - -# Class: Reader - -[@verida/vda-sbt-client](../modules/verida_vda_sbt_client.md).[](../modules/verida_vda_sbt_client._internal_.md).Reader - -## Table of contents - -### Constructors - -- [constructor](verida_vda_sbt_client._internal_.Reader.md#constructor) - -### Properties - -- [\_coerceFunc](verida_vda_sbt_client._internal_.Reader.md#_coercefunc) -- [\_data](verida_vda_sbt_client._internal_.Reader.md#_data) -- [\_offset](verida_vda_sbt_client._internal_.Reader.md#_offset) -- [allowLoose](verida_vda_sbt_client._internal_.Reader.md#allowloose) -- [wordSize](verida_vda_sbt_client._internal_.Reader.md#wordsize) - -### Accessors - -- [consumed](verida_vda_sbt_client._internal_.Reader.md#consumed) -- [data](verida_vda_sbt_client._internal_.Reader.md#data) - -### Methods - -- [\_peekBytes](verida_vda_sbt_client._internal_.Reader.md#_peekbytes) -- [coerce](verida_vda_sbt_client._internal_.Reader.md#coerce) -- [readBytes](verida_vda_sbt_client._internal_.Reader.md#readbytes) -- [readValue](verida_vda_sbt_client._internal_.Reader.md#readvalue) -- [subReader](verida_vda_sbt_client._internal_.Reader.md#subreader) -- [coerce](verida_vda_sbt_client._internal_.Reader.md#coerce) - -## Constructors - -### constructor - -• **new Reader**(`data`, `wordSize?`, `coerceFunc?`, `allowLoose?`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | [`BytesLike`](../modules/verida_vda_sbt_client._internal_.md#byteslike) | -| `wordSize?` | `number` | -| `coerceFunc?` | [`CoerceFunc`](../modules/verida_vda_sbt_client._internal_.md#coercefunc) | -| `allowLoose?` | `boolean` | - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:43 - -## Properties - -### \_coerceFunc - -• `Readonly` **\_coerceFunc**: [`CoerceFunc`](../modules/verida_vda_sbt_client._internal_.md#coercefunc) - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:41 - -___ - -### \_data - -• `Readonly` **\_data**: `Uint8Array` - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:40 - -___ - -### \_offset - -• **\_offset**: `number` - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:42 - -___ - -### allowLoose - -• `Readonly` **allowLoose**: `boolean` - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:39 - -___ - -### wordSize - -• `Readonly` **wordSize**: `number` - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:38 - -## Accessors - -### consumed - -• `get` **consumed**(): `number` - -#### Returns - -`number` - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:45 - -___ - -### data - -• `get` **data**(): `string` - -#### Returns - -`string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:44 - -## Methods - -### \_peekBytes - -▸ **_peekBytes**(`offset`, `length`, `loose?`): `Uint8Array` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `offset` | `number` | -| `length` | `number` | -| `loose?` | `boolean` | - -#### Returns - -`Uint8Array` - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:48 - -___ - -### coerce - -▸ **coerce**(`name`, `value`): `any` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` | -| `value` | `any` | - -#### Returns - -`any` - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:47 - -___ - -### readBytes - -▸ **readBytes**(`length`, `loose?`): `Uint8Array` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `length` | `number` | -| `loose?` | `boolean` | - -#### Returns - -`Uint8Array` - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:50 - -___ - -### readValue - -▸ **readValue**(): [`BigNumber`](verida_vda_sbt_client._internal_.BigNumber.md) - -#### Returns - -[`BigNumber`](verida_vda_sbt_client._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:51 - -___ - -### subReader - -▸ **subReader**(`offset`): [`Reader`](verida_vda_sbt_client._internal_.Reader.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `offset` | `number` | - -#### Returns - -[`Reader`](verida_vda_sbt_client._internal_.Reader.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:49 - -___ - -### coerce - -▸ `Static` **coerce**(`name`, `value`): `any` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` | -| `value` | `any` | - -#### Returns - -`any` - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:46 diff --git a/docs/api/verida-js/classes/verida_vda_sbt_client._internal_.RunningEvent.md b/docs/api/verida-js/classes/verida_vda_sbt_client._internal_.RunningEvent.md deleted file mode 100644 index 5e1ceca..0000000 --- a/docs/api/verida-js/classes/verida_vda_sbt_client._internal_.RunningEvent.md +++ /dev/null @@ -1,218 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-sbt-client](../modules/verida_vda_sbt_client.md) / [](../modules/verida_vda_sbt_client._internal_.md) / RunningEvent - -# Class: RunningEvent - -[@verida/vda-sbt-client](../modules/verida_vda_sbt_client.md).[](../modules/verida_vda_sbt_client._internal_.md).RunningEvent - -## Table of contents - -### Constructors - -- [constructor](verida_vda_sbt_client._internal_.RunningEvent.md#constructor) - -### Properties - -- [\_listeners](verida_vda_sbt_client._internal_.RunningEvent.md#_listeners) -- [filter](verida_vda_sbt_client._internal_.RunningEvent.md#filter) -- [tag](verida_vda_sbt_client._internal_.RunningEvent.md#tag) - -### Methods - -- [addListener](verida_vda_sbt_client._internal_.RunningEvent.md#addlistener) -- [getEmit](verida_vda_sbt_client._internal_.RunningEvent.md#getemit) -- [listenerCount](verida_vda_sbt_client._internal_.RunningEvent.md#listenercount) -- [listeners](verida_vda_sbt_client._internal_.RunningEvent.md#listeners) -- [prepareEvent](verida_vda_sbt_client._internal_.RunningEvent.md#prepareevent) -- [removeAllListeners](verida_vda_sbt_client._internal_.RunningEvent.md#removealllisteners) -- [removeListener](verida_vda_sbt_client._internal_.RunningEvent.md#removelistener) -- [run](verida_vda_sbt_client._internal_.RunningEvent.md#run) - -## Constructors - -### constructor - -• **new RunningEvent**(`tag`, `filter`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `tag` | `string` | -| `filter` | [`EventFilter`](../modules/verida_vda_sbt_client._internal_.md#eventfilter) | - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:67 - -## Properties - -### \_listeners - -• `Private` **\_listeners**: `any` - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:66 - -___ - -### filter - -• `Readonly` **filter**: [`EventFilter`](../modules/verida_vda_sbt_client._internal_.md#eventfilter) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:65 - -___ - -### tag - -• `Readonly` **tag**: `string` - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:64 - -## Methods - -### addListener - -▸ **addListener**(`listener`, `once`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `listener` | [`Listener`](../modules/verida_vda_sbt_client._internal_.md#listener) | -| `once` | `boolean` | - -#### Returns - -`void` - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:68 - -___ - -### getEmit - -▸ **getEmit**(`event`): `any`[] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | [`Event`](../interfaces/verida_vda_sbt_client._internal_.Event.md) | - -#### Returns - -`any`[] - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:75 - -___ - -### listenerCount - -▸ **listenerCount**(): `number` - -#### Returns - -`number` - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:72 - -___ - -### listeners - -▸ **listeners**(): [`Listener`](../modules/verida_vda_sbt_client._internal_.md#listener)[] - -#### Returns - -[`Listener`](../modules/verida_vda_sbt_client._internal_.md#listener)[] - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:71 - -___ - -### prepareEvent - -▸ **prepareEvent**(`event`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | [`Event`](../interfaces/verida_vda_sbt_client._internal_.Event.md) | - -#### Returns - -`void` - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:74 - -___ - -### removeAllListeners - -▸ **removeAllListeners**(): `void` - -#### Returns - -`void` - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:70 - -___ - -### removeListener - -▸ **removeListener**(`listener`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `listener` | [`Listener`](../modules/verida_vda_sbt_client._internal_.md#listener) | - -#### Returns - -`void` - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:69 - -___ - -### run - -▸ **run**(`args`): `number` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `args` | `any`[] | - -#### Returns - -`number` - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:73 diff --git a/docs/api/verida-js/classes/verida_vda_sbt_client._internal_.Signer.md b/docs/api/verida-js/classes/verida_vda_sbt_client._internal_.Signer.md deleted file mode 100644 index 869ee8f..0000000 --- a/docs/api/verida-js/classes/verida_vda_sbt_client._internal_.Signer.md +++ /dev/null @@ -1,383 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-sbt-client](../modules/verida_vda_sbt_client.md) / [](../modules/verida_vda_sbt_client._internal_.md) / Signer - -# Class: Signer - -[@verida/vda-sbt-client](../modules/verida_vda_sbt_client.md).[](../modules/verida_vda_sbt_client._internal_.md).Signer - -## Table of contents - -### Constructors - -- [constructor](verida_vda_sbt_client._internal_.Signer.md#constructor) - -### Properties - -- [\_isSigner](verida_vda_sbt_client._internal_.Signer.md#_issigner) -- [provider](verida_vda_sbt_client._internal_.Signer.md#provider) - -### Methods - -- [\_checkProvider](verida_vda_sbt_client._internal_.Signer.md#_checkprovider) -- [call](verida_vda_sbt_client._internal_.Signer.md#call) -- [checkTransaction](verida_vda_sbt_client._internal_.Signer.md#checktransaction) -- [connect](verida_vda_sbt_client._internal_.Signer.md#connect) -- [estimateGas](verida_vda_sbt_client._internal_.Signer.md#estimategas) -- [getAddress](verida_vda_sbt_client._internal_.Signer.md#getaddress) -- [getBalance](verida_vda_sbt_client._internal_.Signer.md#getbalance) -- [getChainId](verida_vda_sbt_client._internal_.Signer.md#getchainid) -- [getFeeData](verida_vda_sbt_client._internal_.Signer.md#getfeedata) -- [getGasPrice](verida_vda_sbt_client._internal_.Signer.md#getgasprice) -- [getTransactionCount](verida_vda_sbt_client._internal_.Signer.md#gettransactioncount) -- [populateTransaction](verida_vda_sbt_client._internal_.Signer.md#populatetransaction) -- [resolveName](verida_vda_sbt_client._internal_.Signer.md#resolvename) -- [sendTransaction](verida_vda_sbt_client._internal_.Signer.md#sendtransaction) -- [signMessage](verida_vda_sbt_client._internal_.Signer.md#signmessage) -- [signTransaction](verida_vda_sbt_client._internal_.Signer.md#signtransaction) -- [isSigner](verida_vda_sbt_client._internal_.Signer.md#issigner) - -## Constructors - -### constructor - -• **new Signer**() - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:30 - -## Properties - -### \_isSigner - -• `Readonly` **\_isSigner**: `boolean` - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:29 - -___ - -### provider - -• `Optional` `Readonly` **provider**: [`Provider`](verida_vda_sbt_client._internal_.Provider.md) - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:24 - -## Methods - -### \_checkProvider - -▸ **_checkProvider**(`operation?`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `operation?` | `string` | - -#### Returns - -`void` - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:42 - -___ - -### call - -▸ **call**(`transaction`, `blockTag?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transaction` | [`Deferrable`](../modules/verida_vda_sbt_client._internal_.md#deferrable)<[`TransactionRequest`](../modules/verida_vda_sbt_client._internal_.md#transactionrequest)\> | -| `blockTag?` | [`BlockTag`](../modules/verida_vda_sbt_client._internal_.md#blocktag) | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:34 - -___ - -### checkTransaction - -▸ **checkTransaction**(`transaction`): [`Deferrable`](../modules/verida_vda_sbt_client._internal_.md#deferrable)<[`TransactionRequest`](../modules/verida_vda_sbt_client._internal_.md#transactionrequest)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transaction` | [`Deferrable`](../modules/verida_vda_sbt_client._internal_.md#deferrable)<[`TransactionRequest`](../modules/verida_vda_sbt_client._internal_.md#transactionrequest)\> | - -#### Returns - -[`Deferrable`](../modules/verida_vda_sbt_client._internal_.md#deferrable)<[`TransactionRequest`](../modules/verida_vda_sbt_client._internal_.md#transactionrequest)\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:40 - -___ - -### connect - -▸ `Abstract` **connect**(`provider`): [`Signer`](verida_vda_sbt_client._internal_.Signer.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `provider` | [`Provider`](verida_vda_sbt_client._internal_.Provider.md) | - -#### Returns - -[`Signer`](verida_vda_sbt_client._internal_.Signer.md) - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:28 - -___ - -### estimateGas - -▸ **estimateGas**(`transaction`): `Promise`<[`BigNumber`](verida_vda_sbt_client._internal_.BigNumber.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transaction` | [`Deferrable`](../modules/verida_vda_sbt_client._internal_.md#deferrable)<[`TransactionRequest`](../modules/verida_vda_sbt_client._internal_.md#transactionrequest)\> | - -#### Returns - -`Promise`<[`BigNumber`](verida_vda_sbt_client._internal_.BigNumber.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:33 - -___ - -### getAddress - -▸ `Abstract` **getAddress**(): `Promise`<`string`\> - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:25 - -___ - -### getBalance - -▸ **getBalance**(`blockTag?`): `Promise`<[`BigNumber`](verida_vda_sbt_client._internal_.BigNumber.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `blockTag?` | [`BlockTag`](../modules/verida_vda_sbt_client._internal_.md#blocktag) | - -#### Returns - -`Promise`<[`BigNumber`](verida_vda_sbt_client._internal_.BigNumber.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:31 - -___ - -### getChainId - -▸ **getChainId**(): `Promise`<`number`\> - -#### Returns - -`Promise`<`number`\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:36 - -___ - -### getFeeData - -▸ **getFeeData**(): `Promise`<[`FeeData`](../interfaces/verida_vda_sbt_client._internal_.FeeData.md)\> - -#### Returns - -`Promise`<[`FeeData`](../interfaces/verida_vda_sbt_client._internal_.FeeData.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:38 - -___ - -### getGasPrice - -▸ **getGasPrice**(): `Promise`<[`BigNumber`](verida_vda_sbt_client._internal_.BigNumber.md)\> - -#### Returns - -`Promise`<[`BigNumber`](verida_vda_sbt_client._internal_.BigNumber.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:37 - -___ - -### getTransactionCount - -▸ **getTransactionCount**(`blockTag?`): `Promise`<`number`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `blockTag?` | [`BlockTag`](../modules/verida_vda_sbt_client._internal_.md#blocktag) | - -#### Returns - -`Promise`<`number`\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:32 - -___ - -### populateTransaction - -▸ **populateTransaction**(`transaction`): `Promise`<[`TransactionRequest`](../modules/verida_vda_sbt_client._internal_.md#transactionrequest)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transaction` | [`Deferrable`](../modules/verida_vda_sbt_client._internal_.md#deferrable)<[`TransactionRequest`](../modules/verida_vda_sbt_client._internal_.md#transactionrequest)\> | - -#### Returns - -`Promise`<[`TransactionRequest`](../modules/verida_vda_sbt_client._internal_.md#transactionrequest)\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:41 - -___ - -### resolveName - -▸ **resolveName**(`name`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:39 - -___ - -### sendTransaction - -▸ **sendTransaction**(`transaction`): `Promise`<[`TransactionResponse`](../interfaces/verida_vda_sbt_client._internal_.TransactionResponse.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transaction` | [`Deferrable`](../modules/verida_vda_sbt_client._internal_.md#deferrable)<[`TransactionRequest`](../modules/verida_vda_sbt_client._internal_.md#transactionrequest)\> | - -#### Returns - -`Promise`<[`TransactionResponse`](../interfaces/verida_vda_sbt_client._internal_.TransactionResponse.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:35 - -___ - -### signMessage - -▸ `Abstract` **signMessage**(`message`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `message` | `string` \| [`Bytes`](../modules/verida_vda_sbt_client._internal_.md#bytes) | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:26 - -___ - -### signTransaction - -▸ `Abstract` **signTransaction**(`transaction`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transaction` | [`Deferrable`](../modules/verida_vda_sbt_client._internal_.md#deferrable)<[`TransactionRequest`](../modules/verida_vda_sbt_client._internal_.md#transactionrequest)\> | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:27 - -___ - -### isSigner - -▸ `Static` **isSigner**(`value`): value is Signer - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `any` | - -#### Returns - -value is Signer - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:43 diff --git a/docs/api/verida-js/classes/verida_vda_sbt_client._internal_.TransactionDescription.md b/docs/api/verida-js/classes/verida_vda_sbt_client._internal_.TransactionDescription.md deleted file mode 100644 index 1f254c9..0000000 --- a/docs/api/verida-js/classes/verida_vda_sbt_client._internal_.TransactionDescription.md +++ /dev/null @@ -1,112 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-sbt-client](../modules/verida_vda_sbt_client.md) / [](../modules/verida_vda_sbt_client._internal_.md) / TransactionDescription - -# Class: TransactionDescription - -[@verida/vda-sbt-client](../modules/verida_vda_sbt_client.md).[](../modules/verida_vda_sbt_client._internal_.md).TransactionDescription - -## Hierarchy - -- [`Description`](verida_vda_sbt_client._internal_.Description.md)<[`TransactionDescription`](verida_vda_sbt_client._internal_.TransactionDescription.md)\> - - ↳ **`TransactionDescription`** - -## Table of contents - -### Constructors - -- [constructor](verida_vda_sbt_client._internal_.TransactionDescription.md#constructor) - -### Properties - -- [args](verida_vda_sbt_client._internal_.TransactionDescription.md#args) -- [functionFragment](verida_vda_sbt_client._internal_.TransactionDescription.md#functionfragment) -- [name](verida_vda_sbt_client._internal_.TransactionDescription.md#name) -- [sighash](verida_vda_sbt_client._internal_.TransactionDescription.md#sighash) -- [signature](verida_vda_sbt_client._internal_.TransactionDescription.md#signature) -- [value](verida_vda_sbt_client._internal_.TransactionDescription.md#value) - -## Constructors - -### constructor - -• **new TransactionDescription**(`info`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `info` | `Object` | -| `info.args` | [`Result`](../interfaces/verida_vda_sbt_client._internal_.Result.md) | -| `info.functionFragment` | [`FunctionFragment`](verida_vda_sbt_client._internal_.FunctionFragment.md) | -| `info.name` | `string` | -| `info.sighash` | `string` | -| `info.signature` | `string` | -| `info.value` | [`BigNumber`](verida_vda_sbt_client._internal_.BigNumber.md) | - -#### Inherited from - -[Description](verida_vda_sbt_client._internal_.Description.md).[constructor](verida_vda_sbt_client._internal_.Description.md#constructor) - -#### Defined in - -node_modules/@ethersproject/properties/lib/index.d.ts:13 - -## Properties - -### args - -• `Readonly` **args**: [`Result`](../interfaces/verida_vda_sbt_client._internal_.Result.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:18 - -___ - -### functionFragment - -• `Readonly` **functionFragment**: [`FunctionFragment`](verida_vda_sbt_client._internal_.FunctionFragment.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:16 - -___ - -### name - -• `Readonly` **name**: `string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:17 - -___ - -### sighash - -• `Readonly` **sighash**: `string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:20 - -___ - -### signature - -• `Readonly` **signature**: `string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:19 - -___ - -### value - -• `Readonly` **value**: [`BigNumber`](verida_vda_sbt_client._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:21 diff --git a/docs/api/verida-js/classes/verida_vda_sbt_client._internal_.VeridaContract.md b/docs/api/verida-js/classes/verida_vda_sbt_client._internal_.VeridaContract.md deleted file mode 100644 index e39c856..0000000 --- a/docs/api/verida-js/classes/verida_vda_sbt_client._internal_.VeridaContract.md +++ /dev/null @@ -1,199 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-sbt-client](../modules/verida_vda_sbt_client.md) / [](../modules/verida_vda_sbt_client._internal_.md) / VeridaContract - -# Class: VeridaContract - -[@verida/vda-sbt-client](../modules/verida_vda_sbt_client.md).[](../modules/verida_vda_sbt_client._internal_.md).VeridaContract - -Class representing any Verida Smart Contrat - -## Indexable - -▪ [key: `string`]: `any` - -Need such fields to add sub methods in constructor - -## Table of contents - -### Constructors - -- [constructor](verida_vda_sbt_client._internal_.VeridaContract.md#constructor) - -### Properties - -- [callMethod](verida_vda_sbt_client._internal_.VeridaContract.md#callmethod) -- [contract](verida_vda_sbt_client._internal_.VeridaContract.md#contract) -- [endPoint](verida_vda_sbt_client._internal_.VeridaContract.md#endpoint) -- [gaslessPostConfig](verida_vda_sbt_client._internal_.VeridaContract.md#gaslesspostconfig) -- [gaslessServerConfig](verida_vda_sbt_client._internal_.VeridaContract.md#gaslessserverconfig) -- [server](verida_vda_sbt_client._internal_.VeridaContract.md#server) -- [signer](verida_vda_sbt_client._internal_.VeridaContract.md#signer) -- [type](verida_vda_sbt_client._internal_.VeridaContract.md#type) -- [web3Config](verida_vda_sbt_client._internal_.VeridaContract.md#web3config) - -### Methods - -- [attachContract](verida_vda_sbt_client._internal_.VeridaContract.md#attachcontract) - -## Constructors - -### constructor - -• **new VeridaContract**(`type`, `config`) - -Create Verida smart contract instance. Add member functions of contract as parameters. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `type` | [`Web3CallType`](../modules/verida_vda_sbt_client._internal_.md#web3calltype) | interaction mode | -| `config` | [`VeridaWeb3Config`](../modules/verida_vda_sbt_client._internal_.md#veridaweb3config) | configuration for creating VeridaContract instance | - -#### Defined in - -packages/vda-web3-client/build/src/VeridaContractBase.d.ts:31 - -## Properties - -### callMethod - -• `Protected` **callMethod**: (`methodName`: `string`, `methodType`: `string`, `params`: `any`, `gasConfig?`: [`Web3GasConfiguration`](../interfaces/verida_vda_sbt_client._internal_.Web3GasConfiguration.md)) => `Promise`<[`VdaTransactionResult`](../interfaces/verida_vda_sbt_client._internal_.VdaTransactionResult.md)\> - -#### Type declaration - -▸ (`methodName`, `methodType`, `params`, `gasConfig?`): `Promise`<[`VdaTransactionResult`](../interfaces/verida_vda_sbt_client._internal_.VdaTransactionResult.md)\> - -Perform smart contract interaction. Called by member function that were created in constructor. - -##### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `methodName` | `string` | Calling method name of smart contract. From ABI. | -| `methodType` | `string` | Method type. Shows whether method in smart contract is Call function or not. | -| `params` | `any` | Parameters used to make interaction with smart contract : Array | -| `gasConfig?` | [`Web3GasConfiguration`](../interfaces/verida_vda_sbt_client._internal_.Web3GasConfiguration.md) | Gas configuration. Only available for non-view functions in Web3 mode | - -##### Returns - -`Promise`<[`VdaTransactionResult`](../interfaces/verida_vda_sbt_client._internal_.VdaTransactionResult.md)\> - -- Response from smart contract interaction - -#### Defined in - -packages/vda-web3-client/build/src/VeridaContractBase.d.ts:46 - -___ - -### contract - -• `Protected` `Optional` **contract**: [`Contract`](verida_vda_sbt_client._internal_.Contract.md) - -Contract instance used in web3 mode - -#### Defined in - -packages/vda-web3-client/build/src/VeridaContractBase.d.ts:13 - -___ - -### endPoint - -• `Protected` `Optional` **endPoint**: `string` - -endpoint url : Need to be defined in sub class constructor - -#### Defined in - -packages/vda-web3-client/build/src/VeridaContractBase.d.ts:18 - -___ - -### gaslessPostConfig - -• `Protected` `Optional` **gaslessPostConfig**: [`Web3GaslessPostConfig`](../interfaces/verida_vda_sbt_client._internal_.Web3GaslessPostConfig.md) - -#### Defined in - -packages/vda-web3-client/build/src/VeridaContractBase.d.ts:25 - -___ - -### gaslessServerConfig - -• `Protected` `Optional` **gaslessServerConfig**: [`Web3GaslessRequestConfig`](../interfaces/verida_vda_sbt_client._internal_.Web3GaslessRequestConfig.md) - -Configuration for gasless mode - -#### Defined in - -packages/vda-web3-client/build/src/VeridaContractBase.d.ts:24 - -___ - -### server - -• `Protected` **server**: `any` - -Axios instance used in gasless mode - -#### Defined in - -packages/vda-web3-client/build/src/VeridaContractBase.d.ts:16 - -___ - -### signer - -• `Protected` `Optional` **signer**: [`Signer`](verida_vda_sbt_client._internal_.Signer.md) - -#### Defined in - -packages/vda-web3-client/build/src/VeridaContractBase.d.ts:14 - -___ - -### type - -• `Protected` **type**: [`Web3CallType`](../modules/verida_vda_sbt_client._internal_.md#web3calltype) - -Smart contract interaction mode - -#### Defined in - -packages/vda-web3-client/build/src/VeridaContractBase.d.ts:11 - -___ - -### web3Config - -• `Protected` `Optional` **web3Config**: [`Web3SelfTransactionConfig`](../interfaces/verida_vda_sbt_client._internal_.Web3SelfTransactionConfig.md) - -Configuration for web3 mode - -#### Defined in - -packages/vda-web3-client/build/src/VeridaContractBase.d.ts:22 - -## Methods - -### attachContract - -▸ `Protected` **attachContract**(`controller?`): `Promise`<[`Contract`](verida_vda_sbt_client._internal_.Contract.md)\> - -Connect signer to contract to sign transactions. Called in web3 mode only - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `controller?` | `string` \| `Promise`<`string`\> | : Wallet public address | - -#### Returns - -`Promise`<[`Contract`](verida_vda_sbt_client._internal_.Contract.md)\> - -#### Defined in - -packages/vda-web3-client/build/src/VeridaContractBase.d.ts:37 diff --git a/docs/api/verida-js/classes/verida_vda_sbt_client._internal_.Writer.md b/docs/api/verida-js/classes/verida_vda_sbt_client._internal_.Writer.md deleted file mode 100644 index 84fb25d..0000000 --- a/docs/api/verida-js/classes/verida_vda_sbt_client._internal_.Writer.md +++ /dev/null @@ -1,242 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-sbt-client](../modules/verida_vda_sbt_client.md) / [](../modules/verida_vda_sbt_client._internal_.md) / Writer - -# Class: Writer - -[@verida/vda-sbt-client](../modules/verida_vda_sbt_client.md).[](../modules/verida_vda_sbt_client._internal_.md).Writer - -## Table of contents - -### Constructors - -- [constructor](verida_vda_sbt_client._internal_.Writer.md#constructor) - -### Properties - -- [\_data](verida_vda_sbt_client._internal_.Writer.md#_data) -- [\_dataLength](verida_vda_sbt_client._internal_.Writer.md#_datalength) -- [\_padding](verida_vda_sbt_client._internal_.Writer.md#_padding) -- [wordSize](verida_vda_sbt_client._internal_.Writer.md#wordsize) - -### Accessors - -- [data](verida_vda_sbt_client._internal_.Writer.md#data) -- [length](verida_vda_sbt_client._internal_.Writer.md#length) - -### Methods - -- [\_getValue](verida_vda_sbt_client._internal_.Writer.md#_getvalue) -- [\_writeData](verida_vda_sbt_client._internal_.Writer.md#_writedata) -- [appendWriter](verida_vda_sbt_client._internal_.Writer.md#appendwriter) -- [writeBytes](verida_vda_sbt_client._internal_.Writer.md#writebytes) -- [writeUpdatableValue](verida_vda_sbt_client._internal_.Writer.md#writeupdatablevalue) -- [writeValue](verida_vda_sbt_client._internal_.Writer.md#writevalue) - -## Constructors - -### constructor - -• **new Writer**(`wordSize?`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `wordSize?` | `number` | - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:27 - -## Properties - -### \_data - -• **\_data**: `Uint8Array`[] - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:24 - -___ - -### \_dataLength - -• **\_dataLength**: `number` - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:25 - -___ - -### \_padding - -• **\_padding**: `Uint8Array` - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:26 - -___ - -### wordSize - -• `Readonly` **wordSize**: `number` - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:23 - -## Accessors - -### data - -• `get` **data**(): `string` - -#### Returns - -`string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:28 - -___ - -### length - -• `get` **length**(): `number` - -#### Returns - -`number` - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:29 - -## Methods - -### \_getValue - -▸ **_getValue**(`value`): `Uint8Array` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | [`BigNumberish`](../modules/verida_vda_sbt_client._internal_.md#bignumberish) | - -#### Returns - -`Uint8Array` - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:33 - -___ - -### \_writeData - -▸ **_writeData**(`data`): `number` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `Uint8Array` | - -#### Returns - -`number` - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:30 - -___ - -### appendWriter - -▸ **appendWriter**(`writer`): `number` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `writer` | [`Writer`](verida_vda_sbt_client._internal_.Writer.md) | - -#### Returns - -`number` - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:31 - -___ - -### writeBytes - -▸ **writeBytes**(`value`): `number` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | [`BytesLike`](../modules/verida_vda_sbt_client._internal_.md#byteslike) | - -#### Returns - -`number` - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:32 - -___ - -### writeUpdatableValue - -▸ **writeUpdatableValue**(): (`value`: [`BigNumberish`](../modules/verida_vda_sbt_client._internal_.md#bignumberish)) => `void` - -#### Returns - -`fn` - -▸ (`value`): `void` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | [`BigNumberish`](../modules/verida_vda_sbt_client._internal_.md#bignumberish) | - -##### Returns - -`void` - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:35 - -___ - -### writeValue - -▸ **writeValue**(`value`): `number` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | [`BigNumberish`](../modules/verida_vda_sbt_client._internal_.md#bignumberish) | - -#### Returns - -`number` - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:34 diff --git a/docs/api/verida-js/classes/verida_verifiable_credentials.Credentials.md b/docs/api/verida-js/classes/verida_verifiable_credentials.Credentials.md deleted file mode 100644 index 719f43e..0000000 --- a/docs/api/verida-js/classes/verida_verifiable_credentials.Credentials.md +++ /dev/null @@ -1,345 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / Credentials - -# Class: Credentials - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).Credentials - -A bare minimum class implementing the creation and verification of -Verifiable Credentials and Verifiable Presentations represented as -DID-JWT's - -## Table of contents - -### Constructors - -- [constructor](verida_verifiable_credentials.Credentials.md#constructor) - -### Properties - -- [errors](verida_verifiable_credentials.Credentials.md#errors) - -### Methods - -- [buildProofs](verida_verifiable_credentials.Credentials.md#buildproofs) -- [createCredentialJWT](verida_verifiable_credentials.Credentials.md#createcredentialjwt) -- [createIssuer](verida_verifiable_credentials.Credentials.md#createissuer) -- [createVerifiableCredential](verida_verifiable_credentials.Credentials.md#createverifiablecredential) -- [createVerifiableCredentialRecord](verida_verifiable_credentials.Credentials.md#createverifiablecredentialrecord) -- [createVerifiablePresentation](verida_verifiable_credentials.Credentials.md#createverifiablepresentation) -- [getContextInfo](verida_verifiable_credentials.Credentials.md#getcontextinfo) -- [getCredentialSchema](verida_verifiable_credentials.Credentials.md#getcredentialschema) -- [getErrors](verida_verifiable_credentials.Credentials.md#geterrors) -- [getProofStrings](verida_verifiable_credentials.Credentials.md#getproofstrings) -- [verifyCredential](verida_verifiable_credentials.Credentials.md#verifycredential) -- [getResolver](verida_verifiable_credentials.Credentials.md#getresolver) -- [verifyPresentation](verida_verifiable_credentials.Credentials.md#verifypresentation) - -## Constructors - -### constructor - -• **new Credentials**() - -## Properties - -### errors - -• `Private` **errors**: `string`[] = `[]` - -#### Defined in - -[packages/verifiable-credentials/src/credentials.ts:27](https://github.com/verida/verida-js/blob/5040472/packages/verifiable-credentials/src/credentials.ts#L27) - -## Methods - -### buildProofs - -▸ `Private` **buildProofs**(`proofs`, `data`, `privateSignKey?`): `Object` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `proofs` | [`Record`](../modules/verida_verifiable_credentials._internal_.md#record)<`string`, `string`[]\> | -| `data` | [`Record`](../modules/verida_verifiable_credentials._internal_.md#record)<`string`, `string` \| `object`\> | -| `privateSignKey?` | `Uint8Array` | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `payloadProofs` | `any` | -| `proofStrings` | `any` | - -#### Defined in - -[packages/verifiable-credentials/src/credentials.ts:319](https://github.com/verida/verida-js/blob/5040472/packages/verifiable-credentials/src/credentials.ts#L319) - -___ - -### createCredentialJWT - -▸ **createCredentialJWT**(`data`): `Promise`<`string`\> - -Create a new credential DID-JWT for a given object. - -A new property `didJwtVc` is added to the data and included in the response - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | [`CreateCredentialJWT`](../interfaces/verida_verifiable_credentials.CreateCredentialJWT.md) | - -#### Returns - -`Promise`<`string`\> - -A string DID-JWT representation - -#### Defined in - -[packages/verifiable-credentials/src/credentials.ts:203](https://github.com/verida/verida-js/blob/5040472/packages/verifiable-credentials/src/credentials.ts#L203) - -___ - -### createIssuer - -▸ **createIssuer**(`context`): `Promise`<[`Issuer`](../interfaces/verida_verifiable_credentials._internal_.Issuer.md)\> - -Create an Issuer object that can issue Verifiable Credentials - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `context` | [`IContext`](../interfaces/verida_verifiable_credentials._internal_.IContext.md) | - -#### Returns - -`Promise`<[`Issuer`](../interfaces/verida_verifiable_credentials._internal_.Issuer.md)\> - -Verifiable Credential Issuer - -#### Defined in - -[packages/verifiable-credentials/src/credentials.ts:168](https://github.com/verida/verida-js/blob/5040472/packages/verifiable-credentials/src/credentials.ts#L168) - -___ - -### createVerifiableCredential - -▸ **createVerifiableCredential**(`vc`, `issuer`): `Promise`<`string`\> - -Create a verifiable credential. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `vc` | `any` | JSON representing a verifiable credential | -| `issuer` | `any` | A credential issuer object obtained by calling `createIssuer(user)` | - -#### Returns - -`Promise`<`string`\> - -DID-JWT representation of the Verifiable Credential - -#### Defined in - -[packages/verifiable-credentials/src/credentials.ts:42](https://github.com/verida/verida-js/blob/5040472/packages/verifiable-credentials/src/credentials.ts#L42) - -___ - -### createVerifiableCredentialRecord - -▸ **createVerifiableCredentialRecord**(`createCredentialData`, `name`, `summary?`, `icon?`): `Promise`<[`VeridaCredentialRecord`](../interfaces/verida_verifiable_credentials.VeridaCredentialRecord.md)\> - -Create a Verifiable Credential record that can be saved into the -credential datastore. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `createCredentialData` | [`CreateCredentialJWT`](../interfaces/verida_verifiable_credentials.CreateCredentialJWT.md) | -| `name` | `string` | -| `summary?` | `string` | -| `icon?` | `string` | - -#### Returns - -`Promise`<[`VeridaCredentialRecord`](../interfaces/verida_verifiable_credentials.VeridaCredentialRecord.md)\> - -#### Defined in - -[packages/verifiable-credentials/src/credentials.ts:61](https://github.com/verida/verida-js/blob/5040472/packages/verifiable-credentials/src/credentials.ts#L61) - -___ - -### createVerifiablePresentation - -▸ **createVerifiablePresentation**(`vcJwts`, `context`, `issuer?`): `Promise`<`string`\> - -Create a verifiable presentation that combines an array of Verifiable -Credential DID-JWT's - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `vcJwts` | `string`[] | Array of Verifiable Credential DID-JWT's | -| `context` | [`IContext`](../interfaces/verida_verifiable_credentials._internal_.IContext.md) | - | -| `issuer?` | `any` | A credential issuer object obtained by calling `createIssuer(user)` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -[packages/verifiable-credentials/src/credentials.ts:89](https://github.com/verida/verida-js/blob/5040472/packages/verifiable-credentials/src/credentials.ts#L89) - -___ - -### getContextInfo - -▸ **getContextInfo**(`context`): `Promise`<{ `did`: `string` ; `privateKey`: `any` = keys.signPrivateKey }\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `context` | [`IContext`](../interfaces/verida_verifiable_credentials._internal_.IContext.md) | - -#### Returns - -`Promise`<{ `did`: `string` ; `privateKey`: `any` = keys.signPrivateKey }\> - -#### Defined in - -[packages/verifiable-credentials/src/credentials.ts:181](https://github.com/verida/verida-js/blob/5040472/packages/verifiable-credentials/src/credentials.ts#L181) - -___ - -### getCredentialSchema - -▸ **getCredentialSchema**(`schemaUrl`): `Promise`<[`VeridaCredentialSchema`](../interfaces/verida_verifiable_credentials.VeridaCredentialSchema.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schemaUrl` | `string` | - -#### Returns - -`Promise`<[`VeridaCredentialSchema`](../interfaces/verida_verifiable_credentials.VeridaCredentialSchema.md)\> - -#### Defined in - -[packages/verifiable-credentials/src/credentials.ts:299](https://github.com/verida/verida-js/blob/5040472/packages/verifiable-credentials/src/credentials.ts#L299) - -___ - -### getErrors - -▸ **getErrors**(): `string`[] - -#### Returns - -`string`[] - -#### Defined in - -[packages/verifiable-credentials/src/credentials.ts:295](https://github.com/verida/verida-js/blob/5040472/packages/verifiable-credentials/src/credentials.ts#L295) - -___ - -### getProofStrings - -▸ **getProofStrings**(`credential`): `Promise`<[`Record`](../modules/verida_verifiable_credentials._internal_.md#record)<`string`, `string`[]\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `credential` | [`VeridaCredentialRecord`](../interfaces/verida_verifiable_credentials.VeridaCredentialRecord.md) | - -#### Returns - -`Promise`<[`Record`](../modules/verida_verifiable_credentials._internal_.md#record)<`string`, `string`[]\>\> - -#### Defined in - -[packages/verifiable-credentials/src/credentials.ts:309](https://github.com/verida/verida-js/blob/5040472/packages/verifiable-credentials/src/credentials.ts#L309) - -___ - -### verifyCredential - -▸ **verifyCredential**(`vcJwt`, `resolverConfig?`, `currentDateTime?`): `Promise`<`any`\> - -Verify a Verifiable Credential DID-JWT - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `vcJwt` | `string` | | -| `resolverConfig?` | [`Web3ResolverConfigurationOptions`](../interfaces/verida_verifiable_credentials._internal_.Web3ResolverConfigurationOptions.md) | - | -| `currentDateTime?` | `string` | to allow the client to migrate cases where the datetime is incorrect on the local computer | - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -[packages/verifiable-credentials/src/credentials.ts:127](https://github.com/verida/verida-js/blob/5040472/packages/verifiable-credentials/src/credentials.ts#L127) - -___ - -### getResolver - -▸ `Static` `Private` **getResolver**(`resolverConfig?`): `any` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `resolverConfig?` | [`Web3ResolverConfigurationOptions`](../interfaces/verida_verifiable_credentials._internal_.Web3ResolverConfigurationOptions.md) | - -#### Returns - -`any` - -#### Defined in - -[packages/verifiable-credentials/src/credentials.ts:289](https://github.com/verida/verida-js/blob/5040472/packages/verifiable-credentials/src/credentials.ts#L289) - -___ - -### verifyPresentation - -▸ `Static` **verifyPresentation**(`vpJwt`, `resolverConfig`): `Promise`<`any`\> - -Verify a Verifiable Presentation DID-JWT - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `vpJwt` | `string` | -| `resolverConfig` | [`Web3ResolverConfigurationOptions`](../interfaces/verida_verifiable_credentials._internal_.Web3ResolverConfigurationOptions.md) | - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -[packages/verifiable-credentials/src/credentials.ts:115](https://github.com/verida/verida-js/blob/5040472/packages/verifiable-credentials/src/credentials.ts#L115) diff --git a/docs/api/verida-js/classes/verida_verifiable_credentials.SharingCredential.md b/docs/api/verida-js/classes/verida_verifiable_credentials.SharingCredential.md deleted file mode 100644 index a35ffd9..0000000 --- a/docs/api/verida-js/classes/verida_verifiable_credentials.SharingCredential.md +++ /dev/null @@ -1,93 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / SharingCredential - -# Class: SharingCredential - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).SharingCredential - -## Table of contents - -### Constructors - -- [constructor](verida_verifiable_credentials.SharingCredential.md#constructor) - -### Properties - -- [context](verida_verifiable_credentials.SharingCredential.md#context) - -### Methods - -- [issueEncryptedPresentation](verida_verifiable_credentials.SharingCredential.md#issueencryptedpresentation) -- [issuePublicPresentation](verida_verifiable_credentials.SharingCredential.md#issuepublicpresentation) - -## Constructors - -### constructor - -• **new SharingCredential**(`context`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `context` | [`IContext`](../interfaces/verida_verifiable_credentials._internal_.IContext.md) | - -#### Defined in - -[packages/verifiable-credentials/src/sharing-credential.ts:21](https://github.com/verida/verida-js/blob/5040472/packages/verifiable-credentials/src/sharing-credential.ts#L21) - -## Properties - -### context - -• **context**: [`IContext`](../interfaces/verida_verifiable_credentials._internal_.IContext.md) - -#### Defined in - -[packages/verifiable-credentials/src/sharing-credential.ts:19](https://github.com/verida/verida-js/blob/5040472/packages/verifiable-credentials/src/sharing-credential.ts#L19) - -## Methods - -### issueEncryptedPresentation - -▸ **issueEncryptedPresentation**(`didJwtVc`): `Promise`<`any`\> - -Method to encrypt and issue credential - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `didJwtVc` | `any` | - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -[packages/verifiable-credentials/src/sharing-credential.ts:30](https://github.com/verida/verida-js/blob/5040472/packages/verifiable-credentials/src/sharing-credential.ts#L30) - -___ - -### issuePublicPresentation - -▸ **issuePublicPresentation**(`did`, `didJwtVc`, `contextName`, `options`): `Promise`<`unknown`\> - - Method for for publishing an encrypted credential data - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did` | `string` | -| `didJwtVc` | `any` | -| `contextName` | `string` | -| `options` | `any` | - -#### Returns - -`Promise`<`unknown`\> - -#### Defined in - -[packages/verifiable-credentials/src/sharing-credential.ts:52](https://github.com/verida/verida-js/blob/5040472/packages/verifiable-credentials/src/sharing-credential.ts#L52) diff --git a/docs/api/verida-js/classes/verida_verifiable_credentials._internal_.Ajv2020.md b/docs/api/verida-js/classes/verida_verifiable_credentials._internal_.Ajv2020.md deleted file mode 100644 index 857c993..0000000 --- a/docs/api/verida-js/classes/verida_verifiable_credentials._internal_.Ajv2020.md +++ /dev/null @@ -1,1047 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / Ajv2020 - -# Class: Ajv2020 - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md).Ajv2020 - -## Hierarchy - -- [`default`](verida_verifiable_credentials._internal_.default-4.md) - - ↳ **`Ajv2020`** - -## Table of contents - -### Constructors - -- [constructor](verida_verifiable_credentials._internal_.Ajv2020.md#constructor) - -### Properties - -- [RULES](verida_verifiable_credentials._internal_.Ajv2020.md#rules) -- [\_compilations](verida_verifiable_credentials._internal_.Ajv2020.md#_compilations) -- [errors](verida_verifiable_credentials._internal_.Ajv2020.md#errors) -- [formats](verida_verifiable_credentials._internal_.Ajv2020.md#formats) -- [logger](verida_verifiable_credentials._internal_.Ajv2020.md#logger) -- [opts](verida_verifiable_credentials._internal_.Ajv2020.md#opts) -- [refs](verida_verifiable_credentials._internal_.Ajv2020.md#refs) -- [schemas](verida_verifiable_credentials._internal_.Ajv2020.md#schemas) -- [scope](verida_verifiable_credentials._internal_.Ajv2020.md#scope) -- [MissingRefError](verida_verifiable_credentials._internal_.Ajv2020.md#missingreferror) -- [ValidationError](verida_verifiable_credentials._internal_.Ajv2020.md#validationerror) - -### Methods - -- [$dataMetaSchema](verida_verifiable_credentials._internal_.Ajv2020.md#$datametaschema) -- [\_addDefaultMetaSchema](verida_verifiable_credentials._internal_.Ajv2020.md#_adddefaultmetaschema) -- [\_addSchema](verida_verifiable_credentials._internal_.Ajv2020.md#_addschema) -- [\_addVocabularies](verida_verifiable_credentials._internal_.Ajv2020.md#_addvocabularies) -- [addFormat](verida_verifiable_credentials._internal_.Ajv2020.md#addformat) -- [addKeyword](verida_verifiable_credentials._internal_.Ajv2020.md#addkeyword) -- [addMetaSchema](verida_verifiable_credentials._internal_.Ajv2020.md#addmetaschema) -- [addSchema](verida_verifiable_credentials._internal_.Ajv2020.md#addschema) -- [addVocabulary](verida_verifiable_credentials._internal_.Ajv2020.md#addvocabulary) -- [compile](verida_verifiable_credentials._internal_.Ajv2020.md#compile) -- [compileAsync](verida_verifiable_credentials._internal_.Ajv2020.md#compileasync) -- [defaultMeta](verida_verifiable_credentials._internal_.Ajv2020.md#defaultmeta) -- [errorsText](verida_verifiable_credentials._internal_.Ajv2020.md#errorstext) -- [getKeyword](verida_verifiable_credentials._internal_.Ajv2020.md#getkeyword) -- [getSchema](verida_verifiable_credentials._internal_.Ajv2020.md#getschema) -- [removeKeyword](verida_verifiable_credentials._internal_.Ajv2020.md#removekeyword) -- [removeSchema](verida_verifiable_credentials._internal_.Ajv2020.md#removeschema) -- [validate](verida_verifiable_credentials._internal_.Ajv2020.md#validate) -- [validateSchema](verida_verifiable_credentials._internal_.Ajv2020.md#validateschema) - -## Constructors - -### constructor - -• **new Ajv2020**(`opts?`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `opts?` | [`Options`](../modules/verida_verifiable_credentials._internal_.md#options) | - -#### Overrides - -[default](verida_verifiable_credentials._internal_.default-4.md).[constructor](verida_verifiable_credentials._internal_.default-4.md#constructor) - -#### Defined in - -node_modules/ajv/dist/2020.d.ts:4 - -## Properties - -### RULES - -• `Readonly` **RULES**: [`ValidationRules`](../interfaces/verida_verifiable_credentials._internal_.ValidationRules.md) - -#### Inherited from - -[default](verida_verifiable_credentials._internal_.default-4.md).[RULES](verida_verifiable_credentials._internal_.default-4.md#rules) - -#### Defined in - -node_modules/ajv/dist/core.d.ts:116 - -___ - -### \_compilations - -• `Readonly` **\_compilations**: `Set`<[`SchemaEnv`](verida_verifiable_credentials._internal_.SchemaEnv.md)\> - -#### Inherited from - -[default](verida_verifiable_credentials._internal_.default-4.md).[_compilations](verida_verifiable_credentials._internal_.default-4.md#_compilations) - -#### Defined in - -node_modules/ajv/dist/core.d.ts:117 - -___ - -### errors - -• `Optional` **errors**: ``null`` \| [`ErrorObject`](../interfaces/verida_verifiable_credentials._internal_.ErrorObject.md)<`string`, [`Record`](../modules/verida_verifiable_credentials._internal_.md#record)<`string`, `any`\>, `unknown`\>[] - -#### Inherited from - -[default](verida_verifiable_credentials._internal_.default-4.md).[errors](verida_verifiable_credentials._internal_.default-4.md#errors) - -#### Defined in - -node_modules/ajv/dist/core.d.ts:104 - -___ - -### formats - -• `Readonly` **formats**: `Object` - -#### Inherited from - -[default](verida_verifiable_credentials._internal_.default-4.md).[formats](verida_verifiable_credentials._internal_.default-4.md#formats) - -#### Defined in - -node_modules/ajv/dist/core.d.ts:113 - -___ - -### logger - -• **logger**: [`Logger`](../interfaces/verida_verifiable_credentials._internal_.Logger.md) - -#### Inherited from - -[default](verida_verifiable_credentials._internal_.default-4.md).[logger](verida_verifiable_credentials._internal_.default-4.md#logger) - -#### Defined in - -node_modules/ajv/dist/core.d.ts:105 - -___ - -### opts - -• **opts**: [`InstanceOptions`](../modules/verida_verifiable_credentials._internal_.md#instanceoptions) - -#### Inherited from - -[default](verida_verifiable_credentials._internal_.default-4.md).[opts](verida_verifiable_credentials._internal_.default-4.md#opts) - -#### Defined in - -node_modules/ajv/dist/core.d.ts:103 - -___ - -### refs - -• `Readonly` **refs**: `Object` - -#### Inherited from - -[default](verida_verifiable_credentials._internal_.default-4.md).[refs](verida_verifiable_credentials._internal_.default-4.md#refs) - -#### Defined in - -node_modules/ajv/dist/core.d.ts:110 - -___ - -### schemas - -• `Readonly` **schemas**: `Object` - -#### Inherited from - -[default](verida_verifiable_credentials._internal_.default-4.md).[schemas](verida_verifiable_credentials._internal_.default-4.md#schemas) - -#### Defined in - -node_modules/ajv/dist/core.d.ts:107 - -___ - -### scope - -• `Readonly` **scope**: [`ValueScope`](verida_verifiable_credentials._internal_.ValueScope.md) - -#### Inherited from - -[default](verida_verifiable_credentials._internal_.default-4.md).[scope](verida_verifiable_credentials._internal_.default-4.md#scope) - -#### Defined in - -node_modules/ajv/dist/core.d.ts:106 - -___ - -### MissingRefError - -▪ `Static` **MissingRefError**: typeof [`default`](verida_verifiable_credentials._internal_.default-6.md) - -#### Inherited from - -[default](verida_verifiable_credentials._internal_.default-4.md).[MissingRefError](verida_verifiable_credentials._internal_.default-4.md#missingreferror) - -#### Defined in - -node_modules/ajv/dist/core.d.ts:122 - -___ - -### ValidationError - -▪ `Static` **ValidationError**: typeof [`default`](verida_verifiable_credentials._internal_.default-5.md) - -#### Inherited from - -[default](verida_verifiable_credentials._internal_.default-4.md).[ValidationError](verida_verifiable_credentials._internal_.default-4.md#validationerror) - -#### Defined in - -node_modules/ajv/dist/core.d.ts:121 - -## Methods - -### $dataMetaSchema - -▸ **$dataMetaSchema**(`metaSchema`, `keywordsJsonPointers`): [`AnySchemaObject`](../modules/verida_verifiable_credentials._internal_.md#anyschemaobject) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `metaSchema` | [`AnySchemaObject`](../modules/verida_verifiable_credentials._internal_.md#anyschemaobject) | -| `keywordsJsonPointers` | `string`[] | - -#### Returns - -[`AnySchemaObject`](../modules/verida_verifiable_credentials._internal_.md#anyschemaobject) - -#### Inherited from - -[default](verida_verifiable_credentials._internal_.default-4.md).[$dataMetaSchema](verida_verifiable_credentials._internal_.default-4.md#$datametaschema) - -#### Defined in - -node_modules/ajv/dist/core.d.ts:159 - -___ - -### \_addDefaultMetaSchema - -▸ **_addDefaultMetaSchema**(): `void` - -#### Returns - -`void` - -#### Overrides - -[default](verida_verifiable_credentials._internal_.default-4.md).[_addDefaultMetaSchema](verida_verifiable_credentials._internal_.default-4.md#_adddefaultmetaschema) - -#### Defined in - -node_modules/ajv/dist/2020.d.ts:6 - -___ - -### \_addSchema - -▸ **_addSchema**(`schema`, `meta?`, `baseId?`, `validateSchema?`, `addSchema?`): [`SchemaEnv`](verida_verifiable_credentials._internal_.SchemaEnv.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schema` | [`AnySchema`](../modules/verida_verifiable_credentials._internal_.md#anyschema) | -| `meta?` | `boolean` | -| `baseId?` | `string` | -| `validateSchema?` | `boolean` \| ``"log"`` | -| `addSchema?` | `boolean` | - -#### Returns - -[`SchemaEnv`](verida_verifiable_credentials._internal_.SchemaEnv.md) - -#### Inherited from - -[default](verida_verifiable_credentials._internal_.default-4.md).[_addSchema](verida_verifiable_credentials._internal_.default-4.md#_addschema) - -#### Defined in - -node_modules/ajv/dist/core.d.ts:161 - -___ - -### \_addVocabularies - -▸ **_addVocabularies**(): `void` - -#### Returns - -`void` - -#### Overrides - -[default](verida_verifiable_credentials._internal_.default-4.md).[_addVocabularies](verida_verifiable_credentials._internal_.default-4.md#_addvocabularies) - -#### Defined in - -node_modules/ajv/dist/2020.d.ts:5 - -___ - -### addFormat - -▸ **addFormat**(`name`, `format`): [`default`](verida_verifiable_credentials._internal_.default-4.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` | -| `format` | [`Format`](../modules/verida_verifiable_credentials._internal_.md#format) | - -#### Returns - -[`default`](verida_verifiable_credentials._internal_.default-4.md) - -#### Inherited from - -[default](verida_verifiable_credentials._internal_.default-4.md).[addFormat](verida_verifiable_credentials._internal_.default-4.md#addformat) - -#### Defined in - -node_modules/ajv/dist/core.d.ts:156 - -___ - -### addKeyword - -▸ **addKeyword**(`kwdOrDef`, `def?`): [`default`](verida_verifiable_credentials._internal_.default-4.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `kwdOrDef` | `string` \| [`KeywordDefinition`](../modules/verida_verifiable_credentials._internal_.md#keyworddefinition) | -| `def?` | [`KeywordDefinition`](../modules/verida_verifiable_credentials._internal_.md#keyworddefinition) | - -#### Returns - -[`default`](verida_verifiable_credentials._internal_.default-4.md) - -#### Inherited from - -[default](verida_verifiable_credentials._internal_.default-4.md).[addKeyword](verida_verifiable_credentials._internal_.default-4.md#addkeyword) - -#### Defined in - -node_modules/ajv/dist/core.d.ts:153 - -___ - -### addMetaSchema - -▸ **addMetaSchema**(`schema`, `key?`, `_validateSchema?`): [`default`](verida_verifiable_credentials._internal_.default-4.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schema` | [`AnySchemaObject`](../modules/verida_verifiable_credentials._internal_.md#anyschemaobject) | -| `key?` | `string` | -| `_validateSchema?` | `boolean` \| ``"log"`` | - -#### Returns - -[`default`](verida_verifiable_credentials._internal_.default-4.md) - -#### Inherited from - -[default](verida_verifiable_credentials._internal_.default-4.md).[addMetaSchema](verida_verifiable_credentials._internal_.default-4.md#addmetaschema) - -#### Defined in - -node_modules/ajv/dist/core.d.ts:147 - -___ - -### addSchema - -▸ **addSchema**(`schema`, `key?`, `_meta?`, `_validateSchema?`): [`default`](verida_verifiable_credentials._internal_.default-4.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schema` | [`AnySchema`](../modules/verida_verifiable_credentials._internal_.md#anyschema) \| [`AnySchema`](../modules/verida_verifiable_credentials._internal_.md#anyschema)[] | -| `key?` | `string` | -| `_meta?` | `boolean` | -| `_validateSchema?` | `boolean` \| ``"log"`` | - -#### Returns - -[`default`](verida_verifiable_credentials._internal_.default-4.md) - -#### Inherited from - -[default](verida_verifiable_credentials._internal_.default-4.md).[addSchema](verida_verifiable_credentials._internal_.default-4.md#addschema) - -#### Defined in - -node_modules/ajv/dist/core.d.ts:143 - -___ - -### addVocabulary - -▸ **addVocabulary**(`definitions`): [`default`](verida_verifiable_credentials._internal_.default-4.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `definitions` | [`Vocabulary`](../modules/verida_verifiable_credentials._internal_.md#vocabulary) | - -#### Returns - -[`default`](verida_verifiable_credentials._internal_.default-4.md) - -#### Inherited from - -[default](verida_verifiable_credentials._internal_.default-4.md).[addVocabulary](verida_verifiable_credentials._internal_.default-4.md#addvocabulary) - -#### Defined in - -node_modules/ajv/dist/core.d.ts:152 - -___ - -### compile - -▸ **compile**<`T`\>(`schema`, `_meta?`): [`ValidateFunction`](../interfaces/verida_verifiable_credentials._internal_.ValidateFunction.md)<`T`\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `unknown` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schema` | [`Schema`](../modules/verida_verifiable_credentials._internal_.md#schema) \| [`UncheckedJSONSchemaType`](../modules/verida_verifiable_credentials._internal_.md#uncheckedjsonschematype)<`T`, ``false``\> | -| `_meta?` | `boolean` | - -#### Returns - -[`ValidateFunction`](../interfaces/verida_verifiable_credentials._internal_.ValidateFunction.md)<`T`\> - -#### Inherited from - -[default](verida_verifiable_credentials._internal_.default-4.md).[compile](verida_verifiable_credentials._internal_.default-4.md#compile) - -#### Defined in - -node_modules/ajv/dist/core.d.ts:134 - -▸ **compile**<`T`\>(`schema`, `_meta?`): [`ValidateFunction`](../interfaces/verida_verifiable_credentials._internal_.ValidateFunction.md)<`T`\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `unknown` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schema` | [`JTDSchemaType`](../modules/verida_verifiable_credentials._internal_.md#jtdschematype)<`T`, [`Record`](../modules/verida_verifiable_credentials._internal_.md#record)<`string`, `never`\>\> | -| `_meta?` | `boolean` | - -#### Returns - -[`ValidateFunction`](../interfaces/verida_verifiable_credentials._internal_.ValidateFunction.md)<`T`\> - -#### Inherited from - -[default](verida_verifiable_credentials._internal_.default-4.md).[compile](verida_verifiable_credentials._internal_.default-4.md#compile) - -#### Defined in - -node_modules/ajv/dist/core.d.ts:135 - -▸ **compile**<`N`, `T`\>(`schema`, `_meta?`): [`ValidateFunction`](../interfaces/verida_verifiable_credentials._internal_.ValidateFunction.md)<[`JTDDataType`](../modules/verida_verifiable_credentials._internal_.md#jtddatatype)<`T`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `N` | extends `never` | -| `T` | extends [`SomeJTDSchemaType`](../modules/verida_verifiable_credentials._internal_.md#somejtdschematype) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schema` | `T` | -| `_meta?` | `boolean` | - -#### Returns - -[`ValidateFunction`](../interfaces/verida_verifiable_credentials._internal_.ValidateFunction.md)<[`JTDDataType`](../modules/verida_verifiable_credentials._internal_.md#jtddatatype)<`T`\>\> - -#### Inherited from - -[default](verida_verifiable_credentials._internal_.default-4.md).[compile](verida_verifiable_credentials._internal_.default-4.md#compile) - -#### Defined in - -node_modules/ajv/dist/core.d.ts:136 - -▸ **compile**<`T`\>(`schema`, `_meta?`): [`AsyncValidateFunction`](../interfaces/verida_verifiable_credentials._internal_.AsyncValidateFunction.md)<`T`\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `unknown` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schema` | [`AsyncSchema`](../interfaces/verida_verifiable_credentials._internal_.AsyncSchema.md) | -| `_meta?` | `boolean` | - -#### Returns - -[`AsyncValidateFunction`](../interfaces/verida_verifiable_credentials._internal_.AsyncValidateFunction.md)<`T`\> - -#### Inherited from - -[default](verida_verifiable_credentials._internal_.default-4.md).[compile](verida_verifiable_credentials._internal_.default-4.md#compile) - -#### Defined in - -node_modules/ajv/dist/core.d.ts:137 - -▸ **compile**<`T`\>(`schema`, `_meta?`): [`AnyValidateFunction`](../modules/verida_verifiable_credentials._internal_.md#anyvalidatefunction)<`T`\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `unknown` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schema` | [`AnySchema`](../modules/verida_verifiable_credentials._internal_.md#anyschema) | -| `_meta?` | `boolean` | - -#### Returns - -[`AnyValidateFunction`](../modules/verida_verifiable_credentials._internal_.md#anyvalidatefunction)<`T`\> - -#### Inherited from - -[default](verida_verifiable_credentials._internal_.default-4.md).[compile](verida_verifiable_credentials._internal_.default-4.md#compile) - -#### Defined in - -node_modules/ajv/dist/core.d.ts:138 - -___ - -### compileAsync - -▸ **compileAsync**<`T`\>(`schema`, `_meta?`): `Promise`<[`ValidateFunction`](../interfaces/verida_verifiable_credentials._internal_.ValidateFunction.md)<`T`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `unknown` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schema` | [`SchemaObject`](../interfaces/verida_verifiable_credentials._internal_.SchemaObject.md) \| [`UncheckedJSONSchemaType`](../modules/verida_verifiable_credentials._internal_.md#uncheckedjsonschematype)<`T`, ``false``\> | -| `_meta?` | `boolean` | - -#### Returns - -`Promise`<[`ValidateFunction`](../interfaces/verida_verifiable_credentials._internal_.ValidateFunction.md)<`T`\>\> - -#### Inherited from - -[default](verida_verifiable_credentials._internal_.default-4.md).[compileAsync](verida_verifiable_credentials._internal_.default-4.md#compileasync) - -#### Defined in - -node_modules/ajv/dist/core.d.ts:139 - -▸ **compileAsync**<`T`\>(`schema`, `_meta?`): `Promise`<[`ValidateFunction`](../interfaces/verida_verifiable_credentials._internal_.ValidateFunction.md)<`T`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `unknown` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schema` | [`JTDSchemaType`](../modules/verida_verifiable_credentials._internal_.md#jtdschematype)<`T`, [`Record`](../modules/verida_verifiable_credentials._internal_.md#record)<`string`, `never`\>\> | -| `_meta?` | `boolean` | - -#### Returns - -`Promise`<[`ValidateFunction`](../interfaces/verida_verifiable_credentials._internal_.ValidateFunction.md)<`T`\>\> - -#### Inherited from - -[default](verida_verifiable_credentials._internal_.default-4.md).[compileAsync](verida_verifiable_credentials._internal_.default-4.md#compileasync) - -#### Defined in - -node_modules/ajv/dist/core.d.ts:140 - -▸ **compileAsync**<`T`\>(`schema`, `meta?`): `Promise`<[`AsyncValidateFunction`](../interfaces/verida_verifiable_credentials._internal_.AsyncValidateFunction.md)<`T`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `unknown` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schema` | [`AsyncSchema`](../interfaces/verida_verifiable_credentials._internal_.AsyncSchema.md) | -| `meta?` | `boolean` | - -#### Returns - -`Promise`<[`AsyncValidateFunction`](../interfaces/verida_verifiable_credentials._internal_.AsyncValidateFunction.md)<`T`\>\> - -#### Inherited from - -[default](verida_verifiable_credentials._internal_.default-4.md).[compileAsync](verida_verifiable_credentials._internal_.default-4.md#compileasync) - -#### Defined in - -node_modules/ajv/dist/core.d.ts:141 - -▸ **compileAsync**<`T`\>(`schema`, `meta?`): `Promise`<[`AnyValidateFunction`](../modules/verida_verifiable_credentials._internal_.md#anyvalidatefunction)<`T`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `unknown` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schema` | [`AnySchemaObject`](../modules/verida_verifiable_credentials._internal_.md#anyschemaobject) | -| `meta?` | `boolean` | - -#### Returns - -`Promise`<[`AnyValidateFunction`](../modules/verida_verifiable_credentials._internal_.md#anyvalidatefunction)<`T`\>\> - -#### Inherited from - -[default](verida_verifiable_credentials._internal_.default-4.md).[compileAsync](verida_verifiable_credentials._internal_.default-4.md#compileasync) - -#### Defined in - -node_modules/ajv/dist/core.d.ts:142 - -___ - -### defaultMeta - -▸ **defaultMeta**(): `undefined` \| `string` \| [`AnySchemaObject`](../modules/verida_verifiable_credentials._internal_.md#anyschemaobject) - -#### Returns - -`undefined` \| `string` \| [`AnySchemaObject`](../modules/verida_verifiable_credentials._internal_.md#anyschemaobject) - -#### Overrides - -[default](verida_verifiable_credentials._internal_.default-4.md).[defaultMeta](verida_verifiable_credentials._internal_.default-4.md#defaultmeta) - -#### Defined in - -node_modules/ajv/dist/2020.d.ts:7 - -___ - -### errorsText - -▸ **errorsText**(`errors?`, `__namedParameters?`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `errors?` | ``null`` \| [`ErrorObject`](../interfaces/verida_verifiable_credentials._internal_.ErrorObject.md)<`string`, [`Record`](../modules/verida_verifiable_credentials._internal_.md#record)<`string`, `any`\>, `unknown`\>[] | -| `__namedParameters?` | [`ErrorsTextOptions`](../interfaces/verida_verifiable_credentials._internal_.ErrorsTextOptions.md) | - -#### Returns - -`string` - -#### Inherited from - -[default](verida_verifiable_credentials._internal_.default-4.md).[errorsText](verida_verifiable_credentials._internal_.default-4.md#errorstext) - -#### Defined in - -node_modules/ajv/dist/core.d.ts:157 - -___ - -### getKeyword - -▸ **getKeyword**(`keyword`): `boolean` \| [`AddedKeywordDefinition`](../modules/verida_verifiable_credentials._internal_.md#addedkeyworddefinition) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `keyword` | `string` | - -#### Returns - -`boolean` \| [`AddedKeywordDefinition`](../modules/verida_verifiable_credentials._internal_.md#addedkeyworddefinition) - -#### Inherited from - -[default](verida_verifiable_credentials._internal_.default-4.md).[getKeyword](verida_verifiable_credentials._internal_.default-4.md#getkeyword) - -#### Defined in - -node_modules/ajv/dist/core.d.ts:154 - -___ - -### getSchema - -▸ **getSchema**<`T`\>(`keyRef`): `undefined` \| [`AnyValidateFunction`](../modules/verida_verifiable_credentials._internal_.md#anyvalidatefunction)<`T`\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `unknown` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `keyRef` | `string` | - -#### Returns - -`undefined` \| [`AnyValidateFunction`](../modules/verida_verifiable_credentials._internal_.md#anyvalidatefunction)<`T`\> - -#### Inherited from - -[default](verida_verifiable_credentials._internal_.default-4.md).[getSchema](verida_verifiable_credentials._internal_.default-4.md#getschema) - -#### Defined in - -node_modules/ajv/dist/core.d.ts:150 - -___ - -### removeKeyword - -▸ **removeKeyword**(`keyword`): [`default`](verida_verifiable_credentials._internal_.default-4.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `keyword` | `string` | - -#### Returns - -[`default`](verida_verifiable_credentials._internal_.default-4.md) - -#### Inherited from - -[default](verida_verifiable_credentials._internal_.default-4.md).[removeKeyword](verida_verifiable_credentials._internal_.default-4.md#removekeyword) - -#### Defined in - -node_modules/ajv/dist/core.d.ts:155 - -___ - -### removeSchema - -▸ **removeSchema**(`schemaKeyRef?`): [`default`](verida_verifiable_credentials._internal_.default-4.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schemaKeyRef?` | `string` \| `RegExp` \| [`AnySchema`](../modules/verida_verifiable_credentials._internal_.md#anyschema) | - -#### Returns - -[`default`](verida_verifiable_credentials._internal_.default-4.md) - -#### Inherited from - -[default](verida_verifiable_credentials._internal_.default-4.md).[removeSchema](verida_verifiable_credentials._internal_.default-4.md#removeschema) - -#### Defined in - -node_modules/ajv/dist/core.d.ts:151 - -___ - -### validate - -▸ **validate**(`schema`, `data`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schema` | `string` \| [`Schema`](../modules/verida_verifiable_credentials._internal_.md#schema) | -| `data` | `unknown` | - -#### Returns - -`boolean` - -#### Inherited from - -[default](verida_verifiable_credentials._internal_.default-4.md).[validate](verida_verifiable_credentials._internal_.default-4.md#validate) - -#### Defined in - -node_modules/ajv/dist/core.d.ts:127 - -▸ **validate**(`schemaKeyRef`, `data`): `boolean` \| `Promise`<`unknown`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schemaKeyRef` | `string` \| [`AnySchema`](../modules/verida_verifiable_credentials._internal_.md#anyschema) | -| `data` | `unknown` | - -#### Returns - -`boolean` \| `Promise`<`unknown`\> - -#### Inherited from - -[default](verida_verifiable_credentials._internal_.default-4.md).[validate](verida_verifiable_credentials._internal_.default-4.md#validate) - -#### Defined in - -node_modules/ajv/dist/core.d.ts:128 - -▸ **validate**<`T`\>(`schema`, `data`): data is T - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schema` | `string` \| [`Schema`](../modules/verida_verifiable_credentials._internal_.md#schema) \| [`UncheckedJSONSchemaType`](../modules/verida_verifiable_credentials._internal_.md#uncheckedjsonschematype)<`T`, ``false``\> | -| `data` | `unknown` | - -#### Returns - -data is T - -#### Inherited from - -[default](verida_verifiable_credentials._internal_.default-4.md).[validate](verida_verifiable_credentials._internal_.default-4.md#validate) - -#### Defined in - -node_modules/ajv/dist/core.d.ts:129 - -▸ **validate**<`T`\>(`schema`, `data`): data is T - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schema` | [`JTDSchemaType`](../modules/verida_verifiable_credentials._internal_.md#jtdschematype)<`T`, [`Record`](../modules/verida_verifiable_credentials._internal_.md#record)<`string`, `never`\>\> | -| `data` | `unknown` | - -#### Returns - -data is T - -#### Inherited from - -[default](verida_verifiable_credentials._internal_.default-4.md).[validate](verida_verifiable_credentials._internal_.default-4.md#validate) - -#### Defined in - -node_modules/ajv/dist/core.d.ts:130 - -▸ **validate**<`N`, `T`\>(`schema`, `data`): data is JTDDataType - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `N` | extends `never` | -| `T` | extends [`SomeJTDSchemaType`](../modules/verida_verifiable_credentials._internal_.md#somejtdschematype) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schema` | `T` | -| `data` | `unknown` | - -#### Returns - -data is JTDDataType - -#### Inherited from - -[default](verida_verifiable_credentials._internal_.default-4.md).[validate](verida_verifiable_credentials._internal_.default-4.md#validate) - -#### Defined in - -node_modules/ajv/dist/core.d.ts:131 - -▸ **validate**<`T`\>(`schema`, `data`): `Promise`<`T`\> - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schema` | [`AsyncSchema`](../interfaces/verida_verifiable_credentials._internal_.AsyncSchema.md) | -| `data` | `unknown` | - -#### Returns - -`Promise`<`T`\> - -#### Inherited from - -[default](verida_verifiable_credentials._internal_.default-4.md).[validate](verida_verifiable_credentials._internal_.default-4.md#validate) - -#### Defined in - -node_modules/ajv/dist/core.d.ts:132 - -▸ **validate**<`T`\>(`schemaKeyRef`, `data`): data is T \| Promise - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schemaKeyRef` | `string` \| [`AnySchema`](../modules/verida_verifiable_credentials._internal_.md#anyschema) | -| `data` | `unknown` | - -#### Returns - -data is T \| Promise - -#### Inherited from - -[default](verida_verifiable_credentials._internal_.default-4.md).[validate](verida_verifiable_credentials._internal_.default-4.md#validate) - -#### Defined in - -node_modules/ajv/dist/core.d.ts:133 - -___ - -### validateSchema - -▸ **validateSchema**(`schema`, `throwOrLogError?`): `boolean` \| `Promise`<`unknown`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schema` | [`AnySchema`](../modules/verida_verifiable_credentials._internal_.md#anyschema) | -| `throwOrLogError?` | `boolean` | - -#### Returns - -`boolean` \| `Promise`<`unknown`\> - -#### Inherited from - -[default](verida_verifiable_credentials._internal_.default-4.md).[validateSchema](verida_verifiable_credentials._internal_.default-4.md#validateschema) - -#### Defined in - -node_modules/ajv/dist/core.d.ts:149 diff --git a/docs/api/verida-js/classes/verida_verifiable_credentials._internal_.Client.md b/docs/api/verida-js/classes/verida_verifiable_credentials._internal_.Client.md deleted file mode 100644 index 27cf36d..0000000 --- a/docs/api/verida-js/classes/verida_verifiable_credentials._internal_.Client.md +++ /dev/null @@ -1,335 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / Client - -# Class: Client - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md).Client - -## Table of contents - -### Constructors - -- [constructor](verida_verifiable_credentials._internal_.Client.md#constructor) - -### Properties - -- [account](verida_verifiable_credentials._internal_.Client.md#account) -- [config](verida_verifiable_credentials._internal_.Client.md#config) -- [did](verida_verifiable_credentials._internal_.Client.md#did) -- [didClient](verida_verifiable_credentials._internal_.Client.md#didclient) -- [didContextManager](verida_verifiable_credentials._internal_.Client.md#didcontextmanager) -- [environment](verida_verifiable_credentials._internal_.Client.md#environment) - -### Methods - -- [connect](verida_verifiable_credentials._internal_.Client.md#connect) -- [getConfig](verida_verifiable_credentials._internal_.Client.md#getconfig) -- [getContextConfig](verida_verifiable_credentials._internal_.Client.md#getcontextconfig) -- [getSchema](verida_verifiable_credentials._internal_.Client.md#getschema) -- [getValidDataSignatures](verida_verifiable_credentials._internal_.Client.md#getvaliddatasignatures) -- [isConnected](verida_verifiable_credentials._internal_.Client.md#isconnected) -- [openContext](verida_verifiable_credentials._internal_.Client.md#opencontext) -- [openExternalContext](verida_verifiable_credentials._internal_.Client.md#openexternalcontext) -- [openPublicProfile](verida_verifiable_credentials._internal_.Client.md#openpublicprofile) - -## Constructors - -### constructor - -• **new Client**(`userConfig?`) - -Create a client connection to the Verida network - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `userConfig?` | [`ClientConfig`](../interfaces/verida_verifiable_credentials._internal_.ClientConfig.md) | ClientConfig Configuration for establishing a connection to the Verida network | - -#### Defined in - -packages/client-ts/dist/client.d.ts:42 - -## Properties - -### account - -• `Private` `Optional` **account**: `any` - -Connected account instance - -#### Defined in - -packages/client-ts/dist/client.d.ts:24 - -___ - -### config - -• `Private` **config**: `any` - -Current configuration for this client - -#### Defined in - -packages/client-ts/dist/client.d.ts:36 - -___ - -### did - -• `Private` `Optional` **did**: `any` - -DID of connected account - -#### Defined in - -packages/client-ts/dist/client.d.ts:28 - -___ - -### didClient - -• **didClient**: [`default`](verida_verifiable_credentials._internal_.default-1.md) - -Connection to the Verida DID Registry - -#### Defined in - -packages/client-ts/dist/client.d.ts:16 - -___ - -### didContextManager - -• `Private` **didContextManager**: `any` - -Helper instance to manage DID contexts - -#### Defined in - -packages/client-ts/dist/client.d.ts:20 - -___ - -### environment - -• `Private` **environment**: `any` - -Currently selected environment - -#### Defined in - -packages/client-ts/dist/client.d.ts:32 - -## Methods - -### connect - -▸ **connect**(`account`): `Promise`<`void`\> - -Connect an Account to this client. - -Sets the account owner who can then create storage contexts, -authenticate with databases, send messages etc. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `account` | [`default`](verida_verifiable_credentials._internal_.default.md) | AccountInterface | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -packages/client-ts/dist/client.d.ts:51 - -___ - -### getConfig - -▸ **getConfig**(): [`DefaultClientConfig`](../interfaces/verida_verifiable_credentials._internal_.DefaultClientConfig.md) - -#### Returns - -[`DefaultClientConfig`](../interfaces/verida_verifiable_credentials._internal_.DefaultClientConfig.md) - -#### Defined in - -packages/client-ts/dist/client.d.ts:83 - -___ - -### getContextConfig - -▸ **getContextConfig**(`did`, `contextName`): `Promise`<`undefined` \| [`SecureContextConfig`](../interfaces/verida_verifiable_credentials._internal_.SecureContextConfig.md)\> - -Get the storage configuration of an application context for a given DID. - -This provides the public details about the database, storage and messaging endpoints stored on did-client/did-document for the requested `did`. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `did` | `string` | | -| `contextName` | `string` | The name of the context OR a context hash (starting with 0x) | - -#### Returns - -`Promise`<`undefined` \| [`SecureContextConfig`](../interfaces/verida_verifiable_credentials._internal_.SecureContextConfig.md)\> - -SecureContextConfig | undefined - -#### Defined in - -packages/client-ts/dist/client.d.ts:82 - -___ - -### getSchema - -▸ **getSchema**(`schemaUri`): `Promise`<[`Schema`](verida_verifiable_credentials._internal_.Schema.md)\> - -Get a Schama instance by URL. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `schemaUri` | `string` | URL of the schema | - -#### Returns - -`Promise`<[`Schema`](verida_verifiable_credentials._internal_.Schema.md)\> - -Schema A schema object - -#### Defined in - -packages/client-ts/dist/client.d.ts:114 - -___ - -### getValidDataSignatures - -▸ **getValidDataSignatures**(`data`, `did?`): `Promise`<`string`[]\> - -Get the valid data signatures for a given database record. - -Iterates through all the signatures attached to a database record and validates each signature. - -Only returns the signatures that are valid. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `data` | `any` | A single database record | -| `did?` | `string` | An optional did to filter the results by | - -#### Returns - -`Promise`<`string`[]\> - -string[] Array of DIDs that have validly signed the data - -#### Defined in - -packages/client-ts/dist/client.d.ts:107 - -___ - -### isConnected - -▸ **isConnected**(): `boolean` - -Check if an account is connected to this client. - -#### Returns - -`boolean` - -boolean True of an account is connected - -#### Defined in - -packages/client-ts/dist/client.d.ts:57 - -___ - -### openContext - -▸ **openContext**(`contextName`, `forceCreate?`): `Promise`<`undefined` \| [`Context`](verida_verifiable_credentials._internal_.Context.md)\> - -Open a storage context for the current account. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `contextName` | `string` | string Name of the `context` to open. | -| `forceCreate?` | `boolean` | boolean If the `context` doesn't already exist for the connected account, create it. Depending on the type of `Account` connected, this may open a prompt for the user to confirm (and sign). | - -#### Returns - -`Promise`<`undefined` \| [`Context`](verida_verifiable_credentials._internal_.Context.md)\> - -Context | undefined - -#### Defined in - -packages/client-ts/dist/client.d.ts:65 - -___ - -### openExternalContext - -▸ **openExternalContext**(`contextName`, `did`): `Promise`<[`Context`](verida_verifiable_credentials._internal_.Context.md)\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `contextName` | `string` | The name of the context OR a context hash (starting with 0x) | -| `did` | `string` | | - -#### Returns - -`Promise`<[`Context`](verida_verifiable_credentials._internal_.Context.md)\> - -#### Defined in - -packages/client-ts/dist/client.d.ts:72 - -___ - -### openPublicProfile - -▸ **openPublicProfile**(`did`, `contextName`, `profileName?`): `Promise`<`undefined` \| [`Profile`](verida_verifiable_credentials._internal_.Profile.md)\> - -Open the public profile of any user in read only mode. - -Every application context has the ability to have it's own public profiles. - -You most likely want to request the `Verida: Vault` context. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did` | `string` | -| `contextName` | `string` | -| `profileName?` | `string` | - -#### Returns - -`Promise`<`undefined` \| [`Profile`](verida_verifiable_credentials._internal_.Profile.md)\> - -`` - -#### Defined in - -packages/client-ts/dist/client.d.ts:95 diff --git a/docs/api/verida-js/classes/verida_verifiable_credentials._internal_.CodeGen.md b/docs/api/verida-js/classes/verida_verifiable_credentials._internal_.CodeGen.md deleted file mode 100644 index 7f05051..0000000 --- a/docs/api/verida-js/classes/verida_verifiable_credentials._internal_.CodeGen.md +++ /dev/null @@ -1,913 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / CodeGen - -# Class: CodeGen - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md).CodeGen - -## Table of contents - -### Constructors - -- [constructor](verida_verifiable_credentials._internal_.CodeGen.md#constructor) - -### Properties - -- [\_blockNode](verida_verifiable_credentials._internal_.CodeGen.md#_blocknode) -- [\_blockStarts](verida_verifiable_credentials._internal_.CodeGen.md#_blockstarts) -- [\_constants](verida_verifiable_credentials._internal_.CodeGen.md#_constants) -- [\_def](verida_verifiable_credentials._internal_.CodeGen.md#_def) -- [\_elseNode](verida_verifiable_credentials._internal_.CodeGen.md#_elsenode) -- [\_endBlockNode](verida_verifiable_credentials._internal_.CodeGen.md#_endblocknode) -- [\_extScope](verida_verifiable_credentials._internal_.CodeGen.md#_extscope) -- [\_for](verida_verifiable_credentials._internal_.CodeGen.md#_for) -- [\_leafNode](verida_verifiable_credentials._internal_.CodeGen.md#_leafnode) -- [\_nodes](verida_verifiable_credentials._internal_.CodeGen.md#_nodes) -- [\_scope](verida_verifiable_credentials._internal_.CodeGen.md#_scope) -- [\_values](verida_verifiable_credentials._internal_.CodeGen.md#_values) -- [opts](verida_verifiable_credentials._internal_.CodeGen.md#opts) - -### Accessors - -- [\_currNode](verida_verifiable_credentials._internal_.CodeGen.md#_currnode) -- [\_root](verida_verifiable_credentials._internal_.CodeGen.md#_root) - -### Methods - -- [add](verida_verifiable_credentials._internal_.CodeGen.md#add) -- [assign](verida_verifiable_credentials._internal_.CodeGen.md#assign) -- [block](verida_verifiable_credentials._internal_.CodeGen.md#block) -- [break](verida_verifiable_credentials._internal_.CodeGen.md#break) -- [code](verida_verifiable_credentials._internal_.CodeGen.md#code) -- [const](verida_verifiable_credentials._internal_.CodeGen.md#const) -- [else](verida_verifiable_credentials._internal_.CodeGen.md#else) -- [elseIf](verida_verifiable_credentials._internal_.CodeGen.md#elseif) -- [endBlock](verida_verifiable_credentials._internal_.CodeGen.md#endblock) -- [endFor](verida_verifiable_credentials._internal_.CodeGen.md#endfor) -- [endFunc](verida_verifiable_credentials._internal_.CodeGen.md#endfunc) -- [endIf](verida_verifiable_credentials._internal_.CodeGen.md#endif) -- [for](verida_verifiable_credentials._internal_.CodeGen.md#for) -- [forIn](verida_verifiable_credentials._internal_.CodeGen.md#forin) -- [forOf](verida_verifiable_credentials._internal_.CodeGen.md#forof) -- [forRange](verida_verifiable_credentials._internal_.CodeGen.md#forrange) -- [func](verida_verifiable_credentials._internal_.CodeGen.md#func) -- [getScopeValue](verida_verifiable_credentials._internal_.CodeGen.md#getscopevalue) -- [if](verida_verifiable_credentials._internal_.CodeGen.md#if) -- [label](verida_verifiable_credentials._internal_.CodeGen.md#label) -- [let](verida_verifiable_credentials._internal_.CodeGen.md#let) -- [name](verida_verifiable_credentials._internal_.CodeGen.md#name) -- [object](verida_verifiable_credentials._internal_.CodeGen.md#object) -- [optimize](verida_verifiable_credentials._internal_.CodeGen.md#optimize) -- [return](verida_verifiable_credentials._internal_.CodeGen.md#return) -- [scopeCode](verida_verifiable_credentials._internal_.CodeGen.md#scopecode) -- [scopeName](verida_verifiable_credentials._internal_.CodeGen.md#scopename) -- [scopeRefs](verida_verifiable_credentials._internal_.CodeGen.md#scoperefs) -- [scopeValue](verida_verifiable_credentials._internal_.CodeGen.md#scopevalue) -- [throw](verida_verifiable_credentials._internal_.CodeGen.md#throw) -- [toString](verida_verifiable_credentials._internal_.CodeGen.md#tostring) -- [try](verida_verifiable_credentials._internal_.CodeGen.md#try) -- [var](verida_verifiable_credentials._internal_.CodeGen.md#var) - -## Constructors - -### constructor - -• **new CodeGen**(`extScope`, `opts?`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `extScope` | [`ValueScope`](verida_verifiable_credentials._internal_.ValueScope.md) | -| `opts?` | [`CodeGenOptions`](../interfaces/verida_verifiable_credentials._internal_.CodeGenOptions.md) | - -#### Defined in - -node_modules/ajv/dist/compile/codegen/index.d.ts:33 - -## Properties - -### \_blockNode - -• `Private` **\_blockNode**: `any` - -#### Defined in - -node_modules/ajv/dist/compile/codegen/index.d.ts:70 - -___ - -### \_blockStarts - -• `Private` `Readonly` **\_blockStarts**: `any` - -#### Defined in - -node_modules/ajv/dist/compile/codegen/index.d.ts:30 - -___ - -### \_constants - -• `Private` `Readonly` **\_constants**: `any` - -#### Defined in - -node_modules/ajv/dist/compile/codegen/index.d.ts:31 - -___ - -### \_def - -• `Private` **\_def**: `any` - -#### Defined in - -node_modules/ajv/dist/compile/codegen/index.d.ts:41 - -___ - -### \_elseNode - -• `Private` **\_elseNode**: `any` - -#### Defined in - -node_modules/ajv/dist/compile/codegen/index.d.ts:72 - -___ - -### \_endBlockNode - -• `Private` **\_endBlockNode**: `any` - -#### Defined in - -node_modules/ajv/dist/compile/codegen/index.d.ts:71 - -___ - -### \_extScope - -• `Readonly` **\_extScope**: [`ValueScope`](verida_verifiable_credentials._internal_.ValueScope.md) - -#### Defined in - -node_modules/ajv/dist/compile/codegen/index.d.ts:27 - -___ - -### \_for - -• `Private` **\_for**: `any` - -#### Defined in - -node_modules/ajv/dist/compile/codegen/index.d.ts:53 - -___ - -### \_leafNode - -• `Private` **\_leafNode**: `any` - -#### Defined in - -node_modules/ajv/dist/compile/codegen/index.d.ts:69 - -___ - -### \_nodes - -• `Private` `Readonly` **\_nodes**: `any` - -#### Defined in - -node_modules/ajv/dist/compile/codegen/index.d.ts:29 - -___ - -### \_scope - -• `Readonly` **\_scope**: [`Scope`](verida_verifiable_credentials._internal_.Scope.md) - -#### Defined in - -node_modules/ajv/dist/compile/codegen/index.d.ts:26 - -___ - -### \_values - -• `Readonly` **\_values**: [`ScopeValueSets`](../modules/verida_verifiable_credentials._internal_.md#scopevaluesets) - -#### Defined in - -node_modules/ajv/dist/compile/codegen/index.d.ts:28 - -___ - -### opts - -• `Private` `Readonly` **opts**: `any` - -#### Defined in - -node_modules/ajv/dist/compile/codegen/index.d.ts:32 - -## Accessors - -### \_currNode - -• `Private` `get` **_currNode**(): `any` - -#### Returns - -`any` - -#### Defined in - -node_modules/ajv/dist/compile/codegen/index.d.ts:74 - -• `Private` `set` **_currNode**(`value`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `any` | - -#### Returns - -`void` - -#### Defined in - -node_modules/ajv/dist/compile/codegen/index.d.ts:75 - -___ - -### \_root - -• `Private` `get` **_root**(): `any` - -#### Returns - -`any` - -#### Defined in - -node_modules/ajv/dist/compile/codegen/index.d.ts:73 - -## Methods - -### add - -▸ **add**(`lhs`, `rhs`): [`CodeGen`](verida_verifiable_credentials._internal_.CodeGen.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `lhs` | [`Code`](../modules/verida_verifiable_credentials._internal_.md#code) | -| `rhs` | [`SafeExpr`](../modules/verida_verifiable_credentials._internal_.md#safeexpr) | - -#### Returns - -[`CodeGen`](verida_verifiable_credentials._internal_.CodeGen.md) - -#### Defined in - -node_modules/ajv/dist/compile/codegen/index.d.ts:46 - -___ - -### assign - -▸ **assign**(`lhs`, `rhs`, `sideEffects?`): [`CodeGen`](verida_verifiable_credentials._internal_.CodeGen.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `lhs` | [`Code`](../modules/verida_verifiable_credentials._internal_.md#code) | -| `rhs` | [`SafeExpr`](../modules/verida_verifiable_credentials._internal_.md#safeexpr) | -| `sideEffects?` | `boolean` | - -#### Returns - -[`CodeGen`](verida_verifiable_credentials._internal_.CodeGen.md) - -#### Defined in - -node_modules/ajv/dist/compile/codegen/index.d.ts:45 - -___ - -### block - -▸ **block**(`body?`, `nodeCount?`): [`CodeGen`](verida_verifiable_credentials._internal_.CodeGen.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `body?` | [`Block`](../modules/verida_verifiable_credentials._internal_.md#block) | -| `nodeCount?` | `number` | - -#### Returns - -[`CodeGen`](verida_verifiable_credentials._internal_.CodeGen.md) - -#### Defined in - -node_modules/ajv/dist/compile/codegen/index.d.ts:64 - -___ - -### break - -▸ **break**(`label?`): [`CodeGen`](verida_verifiable_credentials._internal_.CodeGen.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `label?` | [`Code`](../modules/verida_verifiable_credentials._internal_.md#code) | - -#### Returns - -[`CodeGen`](verida_verifiable_credentials._internal_.CodeGen.md) - -#### Defined in - -node_modules/ajv/dist/compile/codegen/index.d.ts:60 - -___ - -### code - -▸ **code**(`c`): [`CodeGen`](verida_verifiable_credentials._internal_.CodeGen.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `c` | ``null`` \| `number` \| `boolean` \| [`Name`](verida_verifiable_credentials._internal_.Name.md) \| [`_Code`](verida_verifiable_credentials._internal_._Code.md) \| () => `void` | - -#### Returns - -[`CodeGen`](verida_verifiable_credentials._internal_.CodeGen.md) - -#### Defined in - -node_modules/ajv/dist/compile/codegen/index.d.ts:47 - -___ - -### const - -▸ **const**(`nameOrPrefix`, `rhs`, `_constant?`): [`Name`](verida_verifiable_credentials._internal_.Name.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `nameOrPrefix` | `string` \| [`Name`](verida_verifiable_credentials._internal_.Name.md) | -| `rhs` | [`SafeExpr`](../modules/verida_verifiable_credentials._internal_.md#safeexpr) | -| `_constant?` | `boolean` | - -#### Returns - -[`Name`](verida_verifiable_credentials._internal_.Name.md) - -#### Defined in - -node_modules/ajv/dist/compile/codegen/index.d.ts:42 - -___ - -### else - -▸ **else**(): [`CodeGen`](verida_verifiable_credentials._internal_.CodeGen.md) - -#### Returns - -[`CodeGen`](verida_verifiable_credentials._internal_.CodeGen.md) - -#### Defined in - -node_modules/ajv/dist/compile/codegen/index.d.ts:51 - -___ - -### elseIf - -▸ **elseIf**(`condition`): [`CodeGen`](verida_verifiable_credentials._internal_.CodeGen.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `condition` | `boolean` \| [`Code`](../modules/verida_verifiable_credentials._internal_.md#code) | - -#### Returns - -[`CodeGen`](verida_verifiable_credentials._internal_.CodeGen.md) - -#### Defined in - -node_modules/ajv/dist/compile/codegen/index.d.ts:50 - -___ - -### endBlock - -▸ **endBlock**(`nodeCount?`): [`CodeGen`](verida_verifiable_credentials._internal_.CodeGen.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `nodeCount?` | `number` | - -#### Returns - -[`CodeGen`](verida_verifiable_credentials._internal_.CodeGen.md) - -#### Defined in - -node_modules/ajv/dist/compile/codegen/index.d.ts:65 - -___ - -### endFor - -▸ **endFor**(): [`CodeGen`](verida_verifiable_credentials._internal_.CodeGen.md) - -#### Returns - -[`CodeGen`](verida_verifiable_credentials._internal_.CodeGen.md) - -#### Defined in - -node_modules/ajv/dist/compile/codegen/index.d.ts:58 - -___ - -### endFunc - -▸ **endFunc**(): [`CodeGen`](verida_verifiable_credentials._internal_.CodeGen.md) - -#### Returns - -[`CodeGen`](verida_verifiable_credentials._internal_.CodeGen.md) - -#### Defined in - -node_modules/ajv/dist/compile/codegen/index.d.ts:67 - -___ - -### endIf - -▸ **endIf**(): [`CodeGen`](verida_verifiable_credentials._internal_.CodeGen.md) - -#### Returns - -[`CodeGen`](verida_verifiable_credentials._internal_.CodeGen.md) - -#### Defined in - -node_modules/ajv/dist/compile/codegen/index.d.ts:52 - -___ - -### for - -▸ **for**(`iteration`, `forBody?`): [`CodeGen`](verida_verifiable_credentials._internal_.CodeGen.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `iteration` | [`Code`](../modules/verida_verifiable_credentials._internal_.md#code) | -| `forBody?` | [`Block`](../modules/verida_verifiable_credentials._internal_.md#block) | - -#### Returns - -[`CodeGen`](verida_verifiable_credentials._internal_.CodeGen.md) - -#### Defined in - -node_modules/ajv/dist/compile/codegen/index.d.ts:54 - -___ - -### forIn - -▸ **forIn**(`nameOrPrefix`, `obj`, `forBody`, `varKind?`): [`CodeGen`](verida_verifiable_credentials._internal_.CodeGen.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `nameOrPrefix` | `string` \| [`Name`](verida_verifiable_credentials._internal_.Name.md) | -| `obj` | [`Code`](../modules/verida_verifiable_credentials._internal_.md#code) | -| `forBody` | (`item`: [`Name`](verida_verifiable_credentials._internal_.Name.md)) => `void` | -| `varKind?` | [`Code`](../modules/verida_verifiable_credentials._internal_.md#code) | - -#### Returns - -[`CodeGen`](verida_verifiable_credentials._internal_.CodeGen.md) - -#### Defined in - -node_modules/ajv/dist/compile/codegen/index.d.ts:57 - -___ - -### forOf - -▸ **forOf**(`nameOrPrefix`, `iterable`, `forBody`, `varKind?`): [`CodeGen`](verida_verifiable_credentials._internal_.CodeGen.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `nameOrPrefix` | `string` \| [`Name`](verida_verifiable_credentials._internal_.Name.md) | -| `iterable` | [`Code`](../modules/verida_verifiable_credentials._internal_.md#code) | -| `forBody` | (`item`: [`Name`](verida_verifiable_credentials._internal_.Name.md)) => `void` | -| `varKind?` | [`Code`](../modules/verida_verifiable_credentials._internal_.md#code) | - -#### Returns - -[`CodeGen`](verida_verifiable_credentials._internal_.CodeGen.md) - -#### Defined in - -node_modules/ajv/dist/compile/codegen/index.d.ts:56 - -___ - -### forRange - -▸ **forRange**(`nameOrPrefix`, `from`, `to`, `forBody`, `varKind?`): [`CodeGen`](verida_verifiable_credentials._internal_.CodeGen.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `nameOrPrefix` | `string` \| [`Name`](verida_verifiable_credentials._internal_.Name.md) | -| `from` | [`SafeExpr`](../modules/verida_verifiable_credentials._internal_.md#safeexpr) | -| `to` | [`SafeExpr`](../modules/verida_verifiable_credentials._internal_.md#safeexpr) | -| `forBody` | (`index`: [`Name`](verida_verifiable_credentials._internal_.Name.md)) => `void` | -| `varKind?` | [`Code`](../modules/verida_verifiable_credentials._internal_.md#code) | - -#### Returns - -[`CodeGen`](verida_verifiable_credentials._internal_.CodeGen.md) - -#### Defined in - -node_modules/ajv/dist/compile/codegen/index.d.ts:55 - -___ - -### func - -▸ **func**(`name`, `args?`, `async?`, `funcBody?`): [`CodeGen`](verida_verifiable_credentials._internal_.CodeGen.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | [`Name`](verida_verifiable_credentials._internal_.Name.md) | -| `args?` | [`Code`](../modules/verida_verifiable_credentials._internal_.md#code) | -| `async?` | `boolean` | -| `funcBody?` | [`Block`](../modules/verida_verifiable_credentials._internal_.md#block) | - -#### Returns - -[`CodeGen`](verida_verifiable_credentials._internal_.CodeGen.md) - -#### Defined in - -node_modules/ajv/dist/compile/codegen/index.d.ts:66 - -___ - -### getScopeValue - -▸ **getScopeValue**(`prefix`, `keyOrRef`): `undefined` \| [`ValueScopeName`](verida_verifiable_credentials._internal_.ValueScopeName.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `prefix` | `string` | -| `keyOrRef` | `unknown` | - -#### Returns - -`undefined` \| [`ValueScopeName`](verida_verifiable_credentials._internal_.ValueScopeName.md) - -#### Defined in - -node_modules/ajv/dist/compile/codegen/index.d.ts:38 - -___ - -### if - -▸ **if**(`condition`, `thenBody?`, `elseBody?`): [`CodeGen`](verida_verifiable_credentials._internal_.CodeGen.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `condition` | `boolean` \| [`Code`](../modules/verida_verifiable_credentials._internal_.md#code) | -| `thenBody?` | [`Block`](../modules/verida_verifiable_credentials._internal_.md#block) | -| `elseBody?` | [`Block`](../modules/verida_verifiable_credentials._internal_.md#block) | - -#### Returns - -[`CodeGen`](verida_verifiable_credentials._internal_.CodeGen.md) - -#### Defined in - -node_modules/ajv/dist/compile/codegen/index.d.ts:49 - -___ - -### label - -▸ **label**(`label`): [`CodeGen`](verida_verifiable_credentials._internal_.CodeGen.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `label` | [`Name`](verida_verifiable_credentials._internal_.Name.md) | - -#### Returns - -[`CodeGen`](verida_verifiable_credentials._internal_.CodeGen.md) - -#### Defined in - -node_modules/ajv/dist/compile/codegen/index.d.ts:59 - -___ - -### let - -▸ **let**(`nameOrPrefix`, `rhs?`, `_constant?`): [`Name`](verida_verifiable_credentials._internal_.Name.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `nameOrPrefix` | `string` \| [`Name`](verida_verifiable_credentials._internal_.Name.md) | -| `rhs?` | [`SafeExpr`](../modules/verida_verifiable_credentials._internal_.md#safeexpr) | -| `_constant?` | `boolean` | - -#### Returns - -[`Name`](verida_verifiable_credentials._internal_.Name.md) - -#### Defined in - -node_modules/ajv/dist/compile/codegen/index.d.ts:43 - -___ - -### name - -▸ **name**(`prefix`): [`Name`](verida_verifiable_credentials._internal_.Name.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `prefix` | `string` | - -#### Returns - -[`Name`](verida_verifiable_credentials._internal_.Name.md) - -#### Defined in - -node_modules/ajv/dist/compile/codegen/index.d.ts:35 - -___ - -### object - -▸ **object**(...`keyValues`): [`_Code`](verida_verifiable_credentials._internal_._Code.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `...keyValues` | [`string` \| [`Name`](verida_verifiable_credentials._internal_.Name.md), `string` \| [`SafeExpr`](../modules/verida_verifiable_credentials._internal_.md#safeexpr)][] | - -#### Returns - -[`_Code`](verida_verifiable_credentials._internal_._Code.md) - -#### Defined in - -node_modules/ajv/dist/compile/codegen/index.d.ts:48 - -___ - -### optimize - -▸ **optimize**(`n?`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `n?` | `number` | - -#### Returns - -`void` - -#### Defined in - -node_modules/ajv/dist/compile/codegen/index.d.ts:68 - -___ - -### return - -▸ **return**(`value`): [`CodeGen`](verida_verifiable_credentials._internal_.CodeGen.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | ``null`` \| `number` \| `boolean` \| [`Name`](verida_verifiable_credentials._internal_.Name.md) \| [`_Code`](verida_verifiable_credentials._internal_._Code.md) \| () => `void` | - -#### Returns - -[`CodeGen`](verida_verifiable_credentials._internal_.CodeGen.md) - -#### Defined in - -node_modules/ajv/dist/compile/codegen/index.d.ts:61 - -___ - -### scopeCode - -▸ **scopeCode**(): [`Code`](../modules/verida_verifiable_credentials._internal_.md#code) - -#### Returns - -[`Code`](../modules/verida_verifiable_credentials._internal_.md#code) - -#### Defined in - -node_modules/ajv/dist/compile/codegen/index.d.ts:40 - -___ - -### scopeName - -▸ **scopeName**(`prefix`): [`ValueScopeName`](verida_verifiable_credentials._internal_.ValueScopeName.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `prefix` | `string` | - -#### Returns - -[`ValueScopeName`](verida_verifiable_credentials._internal_.ValueScopeName.md) - -#### Defined in - -node_modules/ajv/dist/compile/codegen/index.d.ts:36 - -___ - -### scopeRefs - -▸ **scopeRefs**(`scopeName`): [`Code`](../modules/verida_verifiable_credentials._internal_.md#code) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `scopeName` | [`Name`](verida_verifiable_credentials._internal_.Name.md) | - -#### Returns - -[`Code`](../modules/verida_verifiable_credentials._internal_.md#code) - -#### Defined in - -node_modules/ajv/dist/compile/codegen/index.d.ts:39 - -___ - -### scopeValue - -▸ **scopeValue**(`prefixOrName`, `value`): [`Name`](verida_verifiable_credentials._internal_.Name.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `prefixOrName` | `string` \| [`ValueScopeName`](verida_verifiable_credentials._internal_.ValueScopeName.md) | -| `value` | [`NameValue`](../interfaces/verida_verifiable_credentials._internal_.NameValue.md) | - -#### Returns - -[`Name`](verida_verifiable_credentials._internal_.Name.md) - -#### Defined in - -node_modules/ajv/dist/compile/codegen/index.d.ts:37 - -___ - -### throw - -▸ **throw**(`error`): [`CodeGen`](verida_verifiable_credentials._internal_.CodeGen.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `error` | [`Code`](../modules/verida_verifiable_credentials._internal_.md#code) | - -#### Returns - -[`CodeGen`](verida_verifiable_credentials._internal_.CodeGen.md) - -#### Defined in - -node_modules/ajv/dist/compile/codegen/index.d.ts:63 - -___ - -### toString - -▸ **toString**(): `string` - -#### Returns - -`string` - -#### Defined in - -node_modules/ajv/dist/compile/codegen/index.d.ts:34 - -___ - -### try - -▸ **try**(`tryBody`, `catchCode?`, `finallyCode?`): [`CodeGen`](verida_verifiable_credentials._internal_.CodeGen.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `tryBody` | [`Block`](../modules/verida_verifiable_credentials._internal_.md#block) | -| `catchCode?` | (`e`: [`Name`](verida_verifiable_credentials._internal_.Name.md)) => `void` | -| `finallyCode?` | [`Block`](../modules/verida_verifiable_credentials._internal_.md#block) | - -#### Returns - -[`CodeGen`](verida_verifiable_credentials._internal_.CodeGen.md) - -#### Defined in - -node_modules/ajv/dist/compile/codegen/index.d.ts:62 - -___ - -### var - -▸ **var**(`nameOrPrefix`, `rhs?`, `_constant?`): [`Name`](verida_verifiable_credentials._internal_.Name.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `nameOrPrefix` | `string` \| [`Name`](verida_verifiable_credentials._internal_.Name.md) | -| `rhs?` | [`SafeExpr`](../modules/verida_verifiable_credentials._internal_.md#safeexpr) | -| `_constant?` | `boolean` | - -#### Returns - -[`Name`](verida_verifiable_credentials._internal_.Name.md) - -#### Defined in - -node_modules/ajv/dist/compile/codegen/index.d.ts:44 diff --git a/docs/api/verida-js/classes/verida_verifiable_credentials._internal_.Context.md b/docs/api/verida-js/classes/verida_verifiable_credentials._internal_.Context.md deleted file mode 100644 index 3cff6a8..0000000 --- a/docs/api/verida-js/classes/verida_verifiable_credentials._internal_.Context.md +++ /dev/null @@ -1,423 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / Context - -# Class: Context - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md).Context - -## Table of contents - -### Constructors - -- [constructor](verida_verifiable_credentials._internal_.Context.md#constructor) - -### Properties - -- [account](verida_verifiable_credentials._internal_.Context.md#account) -- [client](verida_verifiable_credentials._internal_.Context.md#client) -- [contextName](verida_verifiable_credentials._internal_.Context.md#contextname) -- [databaseEngines](verida_verifiable_credentials._internal_.Context.md#databaseengines) -- [dbRegistry](verida_verifiable_credentials._internal_.Context.md#dbregistry) -- [didContextManager](verida_verifiable_credentials._internal_.Context.md#didcontextmanager) -- [getDatabaseEngine](verida_verifiable_credentials._internal_.Context.md#getdatabaseengine) -- [messagingEngine](verida_verifiable_credentials._internal_.Context.md#messagingengine) -- [notificationEngine](verida_verifiable_credentials._internal_.Context.md#notificationengine) - -### Methods - -- [disconnect](verida_verifiable_credentials._internal_.Context.md#disconnect) -- [getAccount](verida_verifiable_credentials._internal_.Context.md#getaccount) -- [getClient](verida_verifiable_credentials._internal_.Context.md#getclient) -- [getContextConfig](verida_verifiable_credentials._internal_.Context.md#getcontextconfig) -- [getContextName](verida_verifiable_credentials._internal_.Context.md#getcontextname) -- [getDbRegistry](verida_verifiable_credentials._internal_.Context.md#getdbregistry) -- [getDidContextManager](verida_verifiable_credentials._internal_.Context.md#getdidcontextmanager) -- [getMessaging](verida_verifiable_credentials._internal_.Context.md#getmessaging) -- [getNotification](verida_verifiable_credentials._internal_.Context.md#getnotification) -- [openDatabase](verida_verifiable_credentials._internal_.Context.md#opendatabase) -- [openDatastore](verida_verifiable_credentials._internal_.Context.md#opendatastore) -- [openExternalDatabase](verida_verifiable_credentials._internal_.Context.md#openexternaldatabase) -- [openExternalDatastore](verida_verifiable_credentials._internal_.Context.md#openexternaldatastore) -- [openProfile](verida_verifiable_credentials._internal_.Context.md#openprofile) - -## Constructors - -### constructor - -• **new Context**(`client`, `contextName`, `didContextManager`, `account?`) - -Instantiate a new context. - -**Do not use directly**. Use `client.openContext()` or `Network.connect()`. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `client` | [`Client`](verida_verifiable_credentials._internal_.Client.md) | -| `contextName` | `string` | -| `didContextManager` | [`DIDContextManager`](verida_verifiable_credentials._internal_.DIDContextManager.md) | -| `account?` | [`default`](verida_verifiable_credentials._internal_.default.md) | - -#### Defined in - -packages/client-ts/dist/context/context.d.ts:44 - -## Properties - -### account - -• `Private` `Optional` **account**: `any` - -#### Defined in - -packages/client-ts/dist/context/context.d.ts:27 - -___ - -### client - -• `Private` **client**: `any` - -#### Defined in - -packages/client-ts/dist/context/context.d.ts:26 - -___ - -### contextName - -• `Private` **contextName**: `any` - -#### Defined in - -packages/client-ts/dist/context/context.d.ts:30 - -___ - -### databaseEngines - -• `Private` **databaseEngines**: `any` - -#### Defined in - -packages/client-ts/dist/context/context.d.ts:32 - -___ - -### dbRegistry - -• `Private` **dbRegistry**: `any` - -#### Defined in - -packages/client-ts/dist/context/context.d.ts:33 - -___ - -### didContextManager - -• `Private` **didContextManager**: `any` - -#### Defined in - -packages/client-ts/dist/context/context.d.ts:31 - -___ - -### getDatabaseEngine - -• `Private` **getDatabaseEngine**: `any` - -Get a storage engine for a given DID and this contextName - -**`param`** - -**`returns`** - -#### Defined in - -packages/client-ts/dist/context/context.d.ts:57 - -___ - -### messagingEngine - -• `Private` `Optional` **messagingEngine**: `any` - -#### Defined in - -packages/client-ts/dist/context/context.d.ts:28 - -___ - -### notificationEngine - -• `Private` `Optional` **notificationEngine**: `any` - -#### Defined in - -packages/client-ts/dist/context/context.d.ts:29 - -## Methods - -### disconnect - -▸ **disconnect**(): `Promise`<`boolean`\> - -#### Returns - -`Promise`<`boolean`\> - -#### Defined in - -packages/client-ts/dist/context/context.d.ts:50 - -___ - -### getAccount - -▸ **getAccount**(): [`default`](verida_verifiable_credentials._internal_.default.md) - -#### Returns - -[`default`](verida_verifiable_credentials._internal_.default.md) - -#### Defined in - -packages/client-ts/dist/context/context.d.ts:47 - -___ - -### getClient - -▸ **getClient**(): [`Client`](verida_verifiable_credentials._internal_.Client.md) - -#### Returns - -[`Client`](verida_verifiable_credentials._internal_.Client.md) - -#### Defined in - -packages/client-ts/dist/context/context.d.ts:49 - -___ - -### getContextConfig - -▸ **getContextConfig**(`did?`, `forceCreate?`, `customContextName?`): `Promise`<[`SecureContextConfig`](../interfaces/verida_verifiable_credentials._internal_.SecureContextConfig.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did?` | `string` | -| `forceCreate?` | `boolean` | -| `customContextName?` | `string` | - -#### Returns - -`Promise`<[`SecureContextConfig`](../interfaces/verida_verifiable_credentials._internal_.SecureContextConfig.md)\> - -#### Defined in - -packages/client-ts/dist/context/context.d.ts:45 - -___ - -### getContextName - -▸ **getContextName**(): `string` - -#### Returns - -`string` - -#### Defined in - -packages/client-ts/dist/context/context.d.ts:46 - -___ - -### getDbRegistry - -▸ **getDbRegistry**(): [`DbRegistry`](verida_verifiable_credentials._internal_.DbRegistry.md) - -#### Returns - -[`DbRegistry`](verida_verifiable_credentials._internal_.DbRegistry.md) - -#### Defined in - -packages/client-ts/dist/context/context.d.ts:110 - -___ - -### getDidContextManager - -▸ **getDidContextManager**(): [`DIDContextManager`](verida_verifiable_credentials._internal_.DIDContextManager.md) - -#### Returns - -[`DIDContextManager`](verida_verifiable_credentials._internal_.DIDContextManager.md) - -#### Defined in - -packages/client-ts/dist/context/context.d.ts:48 - -___ - -### getMessaging - -▸ **getMessaging**(`messageConfig?`): `Promise`<[`default`](../interfaces/verida_verifiable_credentials._internal_.default-7.md)\> - -Get a messaging instance for this application context. - -Allows you to send and receive messages as the currently connected account. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `messageConfig?` | [`MessagesConfig`](../interfaces/verida_verifiable_credentials._internal_.MessagesConfig.md) | - -#### Returns - -`Promise`<[`default`](../interfaces/verida_verifiable_credentials._internal_.default-7.md)\> - -Messaging instance - -#### Defined in - -packages/client-ts/dist/context/context.d.ts:65 - -___ - -### getNotification - -▸ **getNotification**(): `Promise`<`undefined` \| [`default`](../interfaces/verida_verifiable_credentials._internal_.default-8.md)\> - -#### Returns - -`Promise`<`undefined` \| [`default`](../interfaces/verida_verifiable_credentials._internal_.default-8.md)\> - -#### Defined in - -packages/client-ts/dist/context/context.d.ts:66 - -___ - -### openDatabase - -▸ **openDatabase**(`databaseName`, `config?`): `Promise`<[`default`](../interfaces/verida_verifiable_credentials._internal_.default-9.md)\> - -Open a database owned by this account. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `databaseName` | `string` | Name of the database to open | -| `config?` | [`DatabaseOpenConfig`](../interfaces/verida_verifiable_credentials._internal_.DatabaseOpenConfig.md) | - | - -#### Returns - -`Promise`<[`default`](../interfaces/verida_verifiable_credentials._internal_.default-9.md)\> - -#### Defined in - -packages/client-ts/dist/context/context.d.ts:83 - -___ - -### openDatastore - -▸ **openDatastore**(`schemaUri`, `config?`): `Promise`<[`Datastore`](verida_verifiable_credentials._internal_.Datastore.md)\> - -Open a dataastore owned by this account. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `schemaUri` | `string` | URI of the schema to open (ie: https://common.schemas.verida.io/health/activity/latest/schema.json) | -| `config?` | [`DatastoreOpenConfig`](../interfaces/verida_verifiable_credentials._internal_.DatastoreOpenConfig.md) | Optional datastore configuration | - -#### Returns - -`Promise`<[`Datastore`](verida_verifiable_credentials._internal_.Datastore.md)\> - -#### Defined in - -packages/client-ts/dist/context/context.d.ts:100 - -___ - -### openExternalDatabase - -▸ **openExternalDatabase**(`databaseName`, `did`, `config?`): `Promise`<[`default`](../interfaces/verida_verifiable_credentials._internal_.default-9.md)\> - -Open an external database owned by an account that isn't the currently connected account. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `databaseName` | `string` | Name of the database to open | -| `did` | `string` | DID of the external account that owns the database | -| `config?` | [`DatabaseOpenConfig`](../interfaces/verida_verifiable_credentials._internal_.DatabaseOpenConfig.md) | - | - -#### Returns - -`Promise`<[`default`](../interfaces/verida_verifiable_credentials._internal_.default-9.md)\> - -#### Defined in - -packages/client-ts/dist/context/context.d.ts:92 - -___ - -### openExternalDatastore - -▸ **openExternalDatastore**(`schemaUri`, `did`, `options?`): `Promise`<[`Datastore`](verida_verifiable_credentials._internal_.Datastore.md)\> - -Open an external datastore owned by an account that isn't the currently connected account. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `schemaUri` | `string` | URI of the schema to open (ie: https://common.schemas.verida.io/health/activity/latest/schema.json) | -| `did` | `string` | DID of the external account that owns the database | -| `options?` | [`DatastoreOpenConfig`](../interfaces/verida_verifiable_credentials._internal_.DatastoreOpenConfig.md) | Optional database configuration | - -#### Returns - -`Promise`<[`Datastore`](verida_verifiable_credentials._internal_.Datastore.md)\> - -#### Defined in - -packages/client-ts/dist/context/context.d.ts:109 - -___ - -### openProfile - -▸ **openProfile**(`profileName?`, `did?`, `writeAccess?`): `Promise`<`undefined` \| [`Profile`](verida_verifiable_credentials._internal_.Profile.md)\> - -Get a user's profile. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `profileName?` | `string` | string Name of the Verida profile schema to load | -| `did?` | `string` | string DID of the profile to get. Leave blank to fetch a read/write profile for the currently authenticated user | -| `writeAccess?` | `boolean` | - | - -#### Returns - -`Promise`<`undefined` \| [`Profile`](verida_verifiable_credentials._internal_.Profile.md)\> - -#### Defined in - -packages/client-ts/dist/context/context.d.ts:74 diff --git a/docs/api/verida-js/classes/verida_verifiable_credentials._internal_.DIDContextManager.md b/docs/api/verida-js/classes/verida_verifiable_credentials._internal_.DIDContextManager.md deleted file mode 100644 index b061186..0000000 --- a/docs/api/verida-js/classes/verida_verifiable_credentials._internal_.DIDContextManager.md +++ /dev/null @@ -1,201 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / DIDContextManager - -# Class: DIDContextManager - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md).DIDContextManager - -## Table of contents - -### Constructors - -- [constructor](verida_verifiable_credentials._internal_.DIDContextManager.md#constructor) - -### Properties - -- [account](verida_verifiable_credentials._internal_.DIDContextManager.md#account) -- [didClient](verida_verifiable_credentials._internal_.DIDContextManager.md#didclient) -- [didContexts](verida_verifiable_credentials._internal_.DIDContextManager.md#didcontexts) - -### Methods - -- [getContextDatabaseServer](verida_verifiable_credentials._internal_.DIDContextManager.md#getcontextdatabaseserver) -- [getContextMessageServer](verida_verifiable_credentials._internal_.DIDContextManager.md#getcontextmessageserver) -- [getContextStorageServer](verida_verifiable_credentials._internal_.DIDContextManager.md#getcontextstorageserver) -- [getDIDContextConfig](verida_verifiable_credentials._internal_.DIDContextManager.md#getdidcontextconfig) -- [getDIDContextHashConfig](verida_verifiable_credentials._internal_.DIDContextManager.md#getdidcontexthashconfig) -- [setAccount](verida_verifiable_credentials._internal_.DIDContextManager.md#setaccount) - -## Constructors - -### constructor - -• **new DIDContextManager**(`didClient`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `didClient` | [`default`](verida_verifiable_credentials._internal_.default-1.md) | - -#### Defined in - -packages/client-ts/dist/did-context-manager.d.ts:17 - -## Properties - -### account - -• `Private` `Optional` **account**: `any` - -#### Defined in - -packages/client-ts/dist/did-context-manager.d.ts:16 - -___ - -### didClient - -• `Private` **didClient**: `any` - -#### Defined in - -packages/client-ts/dist/did-context-manager.d.ts:15 - -___ - -### didContexts - -• `Private` **didContexts**: `any` - -#### Defined in - -packages/client-ts/dist/did-context-manager.d.ts:14 - -## Methods - -### getContextDatabaseServer - -▸ **getContextDatabaseServer**(`did`, `contextName`, `forceCreate?`): `Promise`<[`SecureContextEndpoint`](../interfaces/verida_verifiable_credentials._internal_.SecureContextEndpoint.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did` | `string` | -| `contextName` | `string` | -| `forceCreate?` | `boolean` | - -#### Returns - -`Promise`<[`SecureContextEndpoint`](../interfaces/verida_verifiable_credentials._internal_.SecureContextEndpoint.md)\> - -#### Defined in - -packages/client-ts/dist/did-context-manager.d.ts:19 - -___ - -### getContextMessageServer - -▸ **getContextMessageServer**(`did`, `contextName`, `forceCreate?`): `Promise`<[`SecureContextEndpoint`](../interfaces/verida_verifiable_credentials._internal_.SecureContextEndpoint.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did` | `string` | -| `contextName` | `string` | -| `forceCreate?` | `boolean` | - -#### Returns - -`Promise`<[`SecureContextEndpoint`](../interfaces/verida_verifiable_credentials._internal_.SecureContextEndpoint.md)\> - -#### Defined in - -packages/client-ts/dist/did-context-manager.d.ts:21 - -___ - -### getContextStorageServer - -▸ **getContextStorageServer**(`did`, `contextName`, `forceCreate?`): `Promise`<[`SecureContextEndpoint`](../interfaces/verida_verifiable_credentials._internal_.SecureContextEndpoint.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did` | `string` | -| `contextName` | `string` | -| `forceCreate?` | `boolean` | - -#### Returns - -`Promise`<[`SecureContextEndpoint`](../interfaces/verida_verifiable_credentials._internal_.SecureContextEndpoint.md)\> - -#### Defined in - -packages/client-ts/dist/did-context-manager.d.ts:20 - -___ - -### getDIDContextConfig - -▸ **getDIDContextConfig**(`did`, `contextName`, `forceCreate?`): `Promise`<[`SecureContextConfig`](../interfaces/verida_verifiable_credentials._internal_.SecureContextConfig.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did` | `string` | -| `contextName` | `string` | -| `forceCreate?` | `boolean` | - -#### Returns - -`Promise`<[`SecureContextConfig`](../interfaces/verida_verifiable_credentials._internal_.SecureContextConfig.md)\> - -#### Defined in - -packages/client-ts/dist/did-context-manager.d.ts:23 - -___ - -### getDIDContextHashConfig - -▸ **getDIDContextHashConfig**(`did`, `contextHash`): `Promise`<[`SecureContextConfig`](../interfaces/verida_verifiable_credentials._internal_.SecureContextConfig.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did` | `string` | -| `contextHash` | `string` | - -#### Returns - -`Promise`<[`SecureContextConfig`](../interfaces/verida_verifiable_credentials._internal_.SecureContextConfig.md)\> - -#### Defined in - -packages/client-ts/dist/did-context-manager.d.ts:22 - -___ - -### setAccount - -▸ **setAccount**(`account`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `account` | [`default`](verida_verifiable_credentials._internal_.default.md) | - -#### Returns - -`void` - -#### Defined in - -packages/client-ts/dist/did-context-manager.d.ts:18 diff --git a/docs/api/verida-js/classes/verida_verifiable_credentials._internal_.Datastore.md b/docs/api/verida-js/classes/verida_verifiable_credentials._internal_.Datastore.md deleted file mode 100644 index 802aae0..0000000 --- a/docs/api/verida-js/classes/verida_verifiable_credentials._internal_.Datastore.md +++ /dev/null @@ -1,414 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / Datastore - -# Class: Datastore - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md).Datastore - -## Table of contents - -### Constructors - -- [constructor](verida_verifiable_credentials._internal_.Datastore.md#constructor) - -### Properties - -- [config](verida_verifiable_credentials._internal_.Datastore.md#config) -- [context](verida_verifiable_credentials._internal_.Datastore.md#context) -- [db](verida_verifiable_credentials._internal_.Datastore.md#db) -- [errors](verida_verifiable_credentials._internal_.Datastore.md#errors) -- [init](verida_verifiable_credentials._internal_.Datastore.md#init) -- [schema](verida_verifiable_credentials._internal_.Datastore.md#schema) -- [schemaName](verida_verifiable_credentials._internal_.Datastore.md#schemaname) -- [schemaPath](verida_verifiable_credentials._internal_.Datastore.md#schemapath) - -### Methods - -- [changes](verida_verifiable_credentials._internal_.Datastore.md#changes) -- [delete](verida_verifiable_credentials._internal_.Datastore.md#delete) -- [deleteAll](verida_verifiable_credentials._internal_.Datastore.md#deleteall) -- [ensureIndexes](verida_verifiable_credentials._internal_.Datastore.md#ensureindexes) -- [get](verida_verifiable_credentials._internal_.Datastore.md#get) -- [getDb](verida_verifiable_credentials._internal_.Datastore.md#getdb) -- [getMany](verida_verifiable_credentials._internal_.Datastore.md#getmany) -- [getOne](verida_verifiable_credentials._internal_.Datastore.md#getone) -- [save](verida_verifiable_credentials._internal_.Datastore.md#save) -- [updateUsers](verida_verifiable_credentials._internal_.Datastore.md#updateusers) - -## Constructors - -### constructor - -• **new Datastore**(`schemaName`, `context`, `config?`) - -Create a new Datastore. - -**Do not instantiate directly.** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schemaName` | `string` | -| `context` | [`Context`](verida_verifiable_credentials._internal_.Context.md) | -| `config?` | [`DatastoreOpenConfig`](../interfaces/verida_verifiable_credentials._internal_.DatastoreOpenConfig.md) | - -#### Defined in - -packages/client-ts/dist/context/datastore.d.ts:33 - -## Properties - -### config - -• `Protected` **config**: [`DatastoreOpenConfig`](../interfaces/verida_verifiable_credentials._internal_.DatastoreOpenConfig.md) - -#### Defined in - -packages/client-ts/dist/context/datastore.d.ts:18 - -___ - -### context - -• `Protected` **context**: [`Context`](verida_verifiable_credentials._internal_.Context.md) - -#### Defined in - -packages/client-ts/dist/context/datastore.d.ts:17 - -___ - -### db - -• `Private` **db**: `any` - -#### Defined in - -packages/client-ts/dist/context/datastore.d.ts:19 - -___ - -### errors - -• **errors**: `object` - -A list of the latest database errors. - -Any errors from saving a record will be available on this public object. - -The errors remain until they are replaced by any new errors. - -#### Defined in - -packages/client-ts/dist/context/datastore.d.ts:27 - -___ - -### init - -• `Private` **init**: `any` - -Initialize this datastore instance before use. - -**`todo:`** move this into context.openDatastore??? - -#### Defined in - -packages/client-ts/dist/context/datastore.d.ts:128 - -___ - -### schema - -• `Protected` `Optional` **schema**: `any` - -#### Defined in - -packages/client-ts/dist/context/datastore.d.ts:16 - -___ - -### schemaName - -• `Protected` **schemaName**: `string` - -#### Defined in - -packages/client-ts/dist/context/datastore.d.ts:14 - -___ - -### schemaPath - -• `Protected` `Optional` **schemaPath**: `string` - -#### Defined in - -packages/client-ts/dist/context/datastore.d.ts:15 - -## Methods - -### changes - -▸ **changes**(`cb`, `options?`): `Promise`<`any`\> - -Bind to changes to this datastore - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `cb` | `any` | Callback function that fires when new data is received | -| `options?` | `any` | Options to be passed to the listener. See https://pouchdb.com/api.html#changes | - -#### Returns - -`Promise`<`any`\> - -Returns an object with a `.cancel()` method to cancel the listener - -#### Defined in - -packages/client-ts/dist/context/datastore.d.ts:122 - -___ - -### delete - -▸ **delete**(`docId`): `Promise`<`any`\> - -Delete a record by ID. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `docId` | `string` | Unique ID of the record to delete | - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -packages/client-ts/dist/context/datastore.d.ts:107 - -___ - -### deleteAll - -▸ **deleteAll**(): `Promise`<`void`\> - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -packages/client-ts/dist/context/datastore.d.ts:108 - -___ - -### ensureIndexes - -▸ **ensureIndexes**(`indexes`): `Promise`<`void`\> - -**`todo:`** Support removing indexes that were deleted from the spec - -**`todo:`** Validate indexes - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `indexes` | `any` | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -packages/client-ts/dist/context/datastore.d.ts:135 - -___ - -### get - -▸ **get**(`key`, `options?`): `Promise`<`any`\> - -Get a record by ID. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `key` | `string` | Unique ID of the record to fetch | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -packages/client-ts/dist/context/datastore.d.ts:101 - -___ - -### getDb - -▸ **getDb**(): `Promise`<`any`\> - -Get the underlying database instance associated with this datastore. - -**Note: Do not use unless you know what you're doing as you can easily corrupt a database by breaking schema data.** - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -packages/client-ts/dist/context/datastore.d.ts:114 - -___ - -### getMany - -▸ **getMany**(`customFilter?`, `options?`): `Promise`<`object`[]\> - -Fetch a list of records from this Datastore. - -Only returns records that belong to this Datastore's schema. - -Example filters and options: - -``` -let filter = { - organization: 'Google' -}; - -let options = { - limit: 20, - skip: 0, - sort: ['firstName' -}; -``` - -**`example`** -let results = datastore.getMany({ - name: 'John' -}); - -console.log(results); - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `customFilter?` | `any` | -| `options?` | `any` | - -#### Returns - -`Promise`<`object`[]\> - -An array of database records. - -#### Defined in - -packages/client-ts/dist/context/datastore.d.ts:86 - -___ - -### getOne - -▸ **getOne**(`customFilter?`, `options?`): `Promise`<`undefined` \| `object`\> - -Get a single database record that matches. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `customFilter?` | `any` | -| `options?` | `any` | - -#### Returns - -`Promise`<`undefined` \| `object`\> - -A database record - -#### Defined in - -packages/client-ts/dist/context/datastore.d.ts:94 - -___ - -### save - -▸ **save**(`data`, `options?`): `Promise`<`boolean` \| `object`\> - -Save data to an application schema. - -**`fires`** Database#beforeInsert Event fired before inserting a new record - -**`fires`** Database#beforeUpdate Event fired before updating a new record - -**`fires`** Database#afterInsert Event fired after inserting a new record - -**`fires`** Database#afterUpdate Event fired after updating a new record - -**`example`** -let result = await datastore.save({ - "firstName": "John", - "lastName": "Doe" -}); - -if (!result) { - console.errors(datastore.errors); -} else { - console.log("Successfully saved"); -} - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `data` | `any` | Data to be saved. Will be validated against the schema associated with this Datastore. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`boolean` \| `object`\> - -Boolean indicating if the save was successful. If not successful `this.errors` will be populated. - -#### Defined in - -packages/client-ts/dist/context/datastore.d.ts:56 - -___ - -### updateUsers - -▸ **updateUsers**(`readList?`, `writeList?`): `Promise`<`void`\> - -Update the list of valid users for this datastore. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `readList?` | `string`[] | List of DID's that can read from this datastore. | -| `writeList?` | `string`[] | List of DID's that can wrtie to this datastore. | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -packages/client-ts/dist/context/datastore.d.ts:142 diff --git a/docs/api/verida-js/classes/verida_verifiable_credentials._internal_.DbRegistry.md b/docs/api/verida-js/classes/verida_verifiable_credentials._internal_.DbRegistry.md deleted file mode 100644 index 3732567..0000000 --- a/docs/api/verida-js/classes/verida_verifiable_credentials._internal_.DbRegistry.md +++ /dev/null @@ -1,148 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / DbRegistry - -# Class: DbRegistry - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md).DbRegistry - -## Table of contents - -### Constructors - -- [constructor](verida_verifiable_credentials._internal_.DbRegistry.md#constructor) - -### Properties - -- [buildDatabaseId](verida_verifiable_credentials._internal_.DbRegistry.md#builddatabaseid) -- [context](verida_verifiable_credentials._internal_.DbRegistry.md#context) -- [dbStore](verida_verifiable_credentials._internal_.DbRegistry.md#dbstore) - -### Methods - -- [get](verida_verifiable_credentials._internal_.DbRegistry.md#get) -- [getMany](verida_verifiable_credentials._internal_.DbRegistry.md#getmany) -- [init](verida_verifiable_credentials._internal_.DbRegistry.md#init) -- [saveDb](verida_verifiable_credentials._internal_.DbRegistry.md#savedb) - -## Constructors - -### constructor - -• **new DbRegistry**(`context`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `context` | [`Context`](verida_verifiable_credentials._internal_.Context.md) | - -#### Defined in - -packages/client-ts/dist/context/db-registry.d.ts:34 - -## Properties - -### buildDatabaseId - -• `Private` **buildDatabaseId**: `any` - -#### Defined in - -packages/client-ts/dist/context/db-registry.d.ts:47 - -___ - -### context - -• `Private` **context**: `any` - -#### Defined in - -packages/client-ts/dist/context/db-registry.d.ts:32 - -___ - -### dbStore - -• `Private` `Optional` **dbStore**: `any` - -#### Defined in - -packages/client-ts/dist/context/db-registry.d.ts:33 - -## Methods - -### get - -▸ **get**(`dbName`, `did`, `contextName`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `dbName` | `string` | -| `did` | `string` | -| `contextName` | `string` | - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -packages/client-ts/dist/context/db-registry.d.ts:46 - -___ - -### getMany - -▸ **getMany**(`filter`, `options`): `Promise`<`object`[]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `filter` | `any` | -| `options` | `any` | - -#### Returns - -`Promise`<`object`[]\> - -#### Defined in - -packages/client-ts/dist/context/db-registry.d.ts:45 - -___ - -### init - -▸ **init**(): `Promise`<`void`\> - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -packages/client-ts/dist/context/db-registry.d.ts:48 - -___ - -### saveDb - -▸ **saveDb**(`database`, `checkPermissions?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `database` | [`default`](../interfaces/verida_verifiable_credentials._internal_.default-9.md) | -| `checkPermissions?` | `boolean` | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -packages/client-ts/dist/context/db-registry.d.ts:44 diff --git a/docs/api/verida-js/classes/verida_verifiable_credentials._internal_.EventEmitter-1.md b/docs/api/verida-js/classes/verida_verifiable_credentials._internal_.EventEmitter-1.md deleted file mode 100644 index 2275164..0000000 --- a/docs/api/verida-js/classes/verida_verifiable_credentials._internal_.EventEmitter-1.md +++ /dev/null @@ -1,1083 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / EventEmitter - -# Class: EventEmitter - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md).EventEmitter - -The `EventEmitter` class is defined and exposed by the `events` module: - -```js -const EventEmitter = require('events'); -``` - -All `EventEmitter`s emit the event `'newListener'` when new listeners are -added and `'removeListener'` when existing listeners are removed. - -It supports the following option: - -**`since`** v0.1.26 - -## Hierarchy - -- `EventEmitter` - - ↳ **`EventEmitter`** - -## Table of contents - -### Constructors - -- [constructor](verida_verifiable_credentials._internal_.EventEmitter-1.md#constructor) - -### Properties - -- [captureRejectionSymbol](verida_verifiable_credentials._internal_.EventEmitter-1.md#capturerejectionsymbol) -- [captureRejections](verida_verifiable_credentials._internal_.EventEmitter-1.md#capturerejections) -- [defaultMaxListeners](verida_verifiable_credentials._internal_.EventEmitter-1.md#defaultmaxlisteners) -- [errorMonitor](verida_verifiable_credentials._internal_.EventEmitter-1.md#errormonitor) - -### Methods - -- [addListener](verida_verifiable_credentials._internal_.EventEmitter-1.md#addlistener) -- [emit](verida_verifiable_credentials._internal_.EventEmitter-1.md#emit) -- [eventNames](verida_verifiable_credentials._internal_.EventEmitter-1.md#eventnames) -- [getMaxListeners](verida_verifiable_credentials._internal_.EventEmitter-1.md#getmaxlisteners) -- [listenerCount](verida_verifiable_credentials._internal_.EventEmitter-1.md#listenercount) -- [listeners](verida_verifiable_credentials._internal_.EventEmitter-1.md#listeners) -- [off](verida_verifiable_credentials._internal_.EventEmitter-1.md#off) -- [on](verida_verifiable_credentials._internal_.EventEmitter-1.md#on) -- [once](verida_verifiable_credentials._internal_.EventEmitter-1.md#once) -- [prependListener](verida_verifiable_credentials._internal_.EventEmitter-1.md#prependlistener) -- [prependOnceListener](verida_verifiable_credentials._internal_.EventEmitter-1.md#prependoncelistener) -- [rawListeners](verida_verifiable_credentials._internal_.EventEmitter-1.md#rawlisteners) -- [removeAllListeners](verida_verifiable_credentials._internal_.EventEmitter-1.md#removealllisteners) -- [removeListener](verida_verifiable_credentials._internal_.EventEmitter-1.md#removelistener) -- [setMaxListeners](verida_verifiable_credentials._internal_.EventEmitter-1.md#setmaxlisteners) -- [getEventListeners](verida_verifiable_credentials._internal_.EventEmitter-1.md#geteventlisteners) -- [listenerCount](verida_verifiable_credentials._internal_.EventEmitter-1.md#listenercount) -- [on](verida_verifiable_credentials._internal_.EventEmitter-1.md#on) -- [once](verida_verifiable_credentials._internal_.EventEmitter-1.md#once) - -## Constructors - -### constructor - -• **new EventEmitter**(`options?`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options?` | [`EventEmitterOptions`](../interfaces/verida_verifiable_credentials._internal_.EventEmitterOptions.md) | - -#### Inherited from - -NodeJS.EventEmitter.constructor - -#### Defined in - -node_modules/@types/node/events.d.ts:74 - -## Properties - -### captureRejectionSymbol - -▪ `Static` `Readonly` **captureRejectionSymbol**: typeof [`captureRejectionSymbol`](verida_verifiable_credentials._internal_.EventEmitter-1.md#capturerejectionsymbol) - -#### Defined in - -node_modules/@types/node/events.d.ts:273 - -___ - -### captureRejections - -▪ `Static` **captureRejections**: `boolean` - -Sets or gets the default captureRejection value for all emitters. - -#### Defined in - -node_modules/@types/node/events.d.ts:278 - -___ - -### defaultMaxListeners - -▪ `Static` **defaultMaxListeners**: `number` - -#### Defined in - -node_modules/@types/node/events.d.ts:279 - -___ - -### errorMonitor - -▪ `Static` `Readonly` **errorMonitor**: typeof [`errorMonitor`](verida_verifiable_credentials._internal_.EventEmitter-1.md#errormonitor) - -This symbol shall be used to install a listener for only monitoring `'error'` -events. Listeners installed using this symbol are called before the regular -`'error'` listeners are called. - -Installing a listener using this symbol does not change the behavior once an -`'error'` event is emitted, therefore the process will still crash if no -regular `'error'` listener is installed. - -#### Defined in - -node_modules/@types/node/events.d.ts:272 - -## Methods - -### addListener - -▸ **addListener**(`eventName`, `listener`): [`EventEmitter`](verida_verifiable_credentials._internal_.EventEmitter-1.md) - -Alias for `emitter.on(eventName, listener)`. - -**`since`** v0.1.26 - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | `string` \| `symbol` | -| `listener` | (...`args`: `any`[]) => `void` | - -#### Returns - -[`EventEmitter`](verida_verifiable_credentials._internal_.EventEmitter-1.md) - -#### Inherited from - -NodeJS.EventEmitter.addListener - -#### Defined in - -node_modules/@types/node/events.d.ts:299 - -___ - -### emit - -▸ **emit**(`eventName`, ...`args`): `boolean` - -Synchronously calls each of the listeners registered for the event named`eventName`, in the order they were registered, passing the supplied arguments -to each. - -Returns `true` if the event had listeners, `false` otherwise. - -```js -const EventEmitter = require('events'); -const myEmitter = new EventEmitter(); - -// First listener -myEmitter.on('event', function firstListener() { - console.log('Helloooo! first listener'); -}); -// Second listener -myEmitter.on('event', function secondListener(arg1, arg2) { - console.log(`event with parameters ${arg1}, ${arg2} in second listener`); -}); -// Third listener -myEmitter.on('event', function thirdListener(...args) { - const parameters = args.join(', '); - console.log(`event with parameters ${parameters} in third listener`); -}); - -console.log(myEmitter.listeners('event')); - -myEmitter.emit('event', 1, 2, 3, 4, 5); - -// Prints: -// [ -// [Function: firstListener], -// [Function: secondListener], -// [Function: thirdListener] -// ] -// Helloooo! first listener -// event with parameters 1, 2 in second listener -// event with parameters 1, 2, 3, 4, 5 in third listener -``` - -**`since`** v0.1.26 - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | `string` \| `symbol` | -| `...args` | `any`[] | - -#### Returns - -`boolean` - -#### Inherited from - -NodeJS.EventEmitter.emit - -#### Defined in - -node_modules/@types/node/events.d.ts:555 - -___ - -### eventNames - -▸ **eventNames**(): (`string` \| `symbol`)[] - -Returns an array listing the events for which the emitter has registered -listeners. The values in the array are strings or `Symbol`s. - -```js -const EventEmitter = require('events'); -const myEE = new EventEmitter(); -myEE.on('foo', () => {}); -myEE.on('bar', () => {}); - -const sym = Symbol('symbol'); -myEE.on(sym, () => {}); - -console.log(myEE.eventNames()); -// Prints: [ 'foo', 'bar', Symbol(symbol) ] -``` - -**`since`** v6.0.0 - -#### Returns - -(`string` \| `symbol`)[] - -#### Inherited from - -NodeJS.EventEmitter.eventNames - -#### Defined in - -node_modules/@types/node/events.d.ts:614 - -___ - -### getMaxListeners - -▸ **getMaxListeners**(): `number` - -Returns the current max listener value for the `EventEmitter` which is either -set by `emitter.setMaxListeners(n)` or defaults to [defaultMaxListeners](verida_verifiable_credentials._internal_.EventEmitter-1.md#defaultmaxlisteners). - -**`since`** v1.0.0 - -#### Returns - -`number` - -#### Inherited from - -NodeJS.EventEmitter.getMaxListeners - -#### Defined in - -node_modules/@types/node/events.d.ts:471 - -___ - -### listenerCount - -▸ **listenerCount**(`eventName`): `number` - -Returns the number of listeners listening to the event named `eventName`. - -**`since`** v3.2.0 - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `eventName` | `string` \| `symbol` | The name of the event being listened for | - -#### Returns - -`number` - -#### Inherited from - -NodeJS.EventEmitter.listenerCount - -#### Defined in - -node_modules/@types/node/events.d.ts:561 - -___ - -### listeners - -▸ **listeners**(`eventName`): `Function`[] - -Returns a copy of the array of listeners for the event named `eventName`. - -```js -server.on('connection', (stream) => { - console.log('someone connected!'); -}); -console.log(util.inspect(server.listeners('connection'))); -// Prints: [ [Function] ] -``` - -**`since`** v0.1.26 - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | `string` \| `symbol` | - -#### Returns - -`Function`[] - -#### Inherited from - -NodeJS.EventEmitter.listeners - -#### Defined in - -node_modules/@types/node/events.d.ts:484 - -___ - -### off - -▸ **off**(`eventName`, `listener`): [`EventEmitter`](verida_verifiable_credentials._internal_.EventEmitter-1.md) - -Alias for `emitter.removeListener()`. - -**`since`** v10.0.0 - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | `string` \| `symbol` | -| `listener` | (...`args`: `any`[]) => `void` | - -#### Returns - -[`EventEmitter`](verida_verifiable_credentials._internal_.EventEmitter-1.md) - -#### Inherited from - -NodeJS.EventEmitter.off - -#### Defined in - -node_modules/@types/node/events.d.ts:444 - -___ - -### on - -▸ **on**(`eventName`, `listener`): [`EventEmitter`](verida_verifiable_credentials._internal_.EventEmitter-1.md) - -Adds the `listener` function to the end of the listeners array for the -event named `eventName`. No checks are made to see if the `listener` has -already been added. Multiple calls passing the same combination of `eventName`and `listener` will result in the `listener` being added, and called, multiple -times. - -```js -server.on('connection', (stream) => { - console.log('someone connected!'); -}); -``` - -Returns a reference to the `EventEmitter`, so that calls can be chained. - -By default, event listeners are invoked in the order they are added. The`emitter.prependListener()` method can be used as an alternative to add the -event listener to the beginning of the listeners array. - -```js -const myEE = new EventEmitter(); -myEE.on('foo', () => console.log('a')); -myEE.prependListener('foo', () => console.log('b')); -myEE.emit('foo'); -// Prints: -// b -// a -``` - -**`since`** v0.1.101 - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `eventName` | `string` \| `symbol` | The name of the event. | -| `listener` | (...`args`: `any`[]) => `void` | The callback function | - -#### Returns - -[`EventEmitter`](verida_verifiable_credentials._internal_.EventEmitter-1.md) - -#### Inherited from - -NodeJS.EventEmitter.on - -#### Defined in - -node_modules/@types/node/events.d.ts:330 - -___ - -### once - -▸ **once**(`eventName`, `listener`): [`EventEmitter`](verida_verifiable_credentials._internal_.EventEmitter-1.md) - -Adds a **one-time**`listener` function for the event named `eventName`. The -next time `eventName` is triggered, this listener is removed and then invoked. - -```js -server.once('connection', (stream) => { - console.log('Ah, we have our first user!'); -}); -``` - -Returns a reference to the `EventEmitter`, so that calls can be chained. - -By default, event listeners are invoked in the order they are added. The`emitter.prependOnceListener()` method can be used as an alternative to add the -event listener to the beginning of the listeners array. - -```js -const myEE = new EventEmitter(); -myEE.once('foo', () => console.log('a')); -myEE.prependOnceListener('foo', () => console.log('b')); -myEE.emit('foo'); -// Prints: -// b -// a -``` - -**`since`** v0.3.0 - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `eventName` | `string` \| `symbol` | The name of the event. | -| `listener` | (...`args`: `any`[]) => `void` | The callback function | - -#### Returns - -[`EventEmitter`](verida_verifiable_credentials._internal_.EventEmitter-1.md) - -#### Inherited from - -NodeJS.EventEmitter.once - -#### Defined in - -node_modules/@types/node/events.d.ts:359 - -___ - -### prependListener - -▸ **prependListener**(`eventName`, `listener`): [`EventEmitter`](verida_verifiable_credentials._internal_.EventEmitter-1.md) - -Adds the `listener` function to the _beginning_ of the listeners array for the -event named `eventName`. No checks are made to see if the `listener` has -already been added. Multiple calls passing the same combination of `eventName`and `listener` will result in the `listener` being added, and called, multiple -times. - -```js -server.prependListener('connection', (stream) => { - console.log('someone connected!'); -}); -``` - -Returns a reference to the `EventEmitter`, so that calls can be chained. - -**`since`** v6.0.0 - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `eventName` | `string` \| `symbol` | The name of the event. | -| `listener` | (...`args`: `any`[]) => `void` | The callback function | - -#### Returns - -[`EventEmitter`](verida_verifiable_credentials._internal_.EventEmitter-1.md) - -#### Inherited from - -NodeJS.EventEmitter.prependListener - -#### Defined in - -node_modules/@types/node/events.d.ts:579 - -___ - -### prependOnceListener - -▸ **prependOnceListener**(`eventName`, `listener`): [`EventEmitter`](verida_verifiable_credentials._internal_.EventEmitter-1.md) - -Adds a **one-time**`listener` function for the event named `eventName` to the_beginning_ of the listeners array. The next time `eventName` is triggered, this -listener is removed, and then invoked. - -```js -server.prependOnceListener('connection', (stream) => { - console.log('Ah, we have our first user!'); -}); -``` - -Returns a reference to the `EventEmitter`, so that calls can be chained. - -**`since`** v6.0.0 - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `eventName` | `string` \| `symbol` | The name of the event. | -| `listener` | (...`args`: `any`[]) => `void` | The callback function | - -#### Returns - -[`EventEmitter`](verida_verifiable_credentials._internal_.EventEmitter-1.md) - -#### Inherited from - -NodeJS.EventEmitter.prependOnceListener - -#### Defined in - -node_modules/@types/node/events.d.ts:595 - -___ - -### rawListeners - -▸ **rawListeners**(`eventName`): `Function`[] - -Returns a copy of the array of listeners for the event named `eventName`, -including any wrappers (such as those created by `.once()`). - -```js -const emitter = new EventEmitter(); -emitter.once('log', () => console.log('log once')); - -// Returns a new Array with a function `onceWrapper` which has a property -// `listener` which contains the original listener bound above -const listeners = emitter.rawListeners('log'); -const logFnWrapper = listeners[0]; - -// Logs "log once" to the console and does not unbind the `once` event -logFnWrapper.listener(); - -// Logs "log once" to the console and removes the listener -logFnWrapper(); - -emitter.on('log', () => console.log('log persistently')); -// Will return a new Array with a single function bound by `.on()` above -const newListeners = emitter.rawListeners('log'); - -// Logs "log persistently" twice -newListeners[0](); -emitter.emit('log'); -``` - -**`since`** v9.4.0 - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | `string` \| `symbol` | - -#### Returns - -`Function`[] - -#### Inherited from - -NodeJS.EventEmitter.rawListeners - -#### Defined in - -node_modules/@types/node/events.d.ts:514 - -___ - -### removeAllListeners - -▸ **removeAllListeners**(`event?`): [`EventEmitter`](verida_verifiable_credentials._internal_.EventEmitter-1.md) - -Removes all listeners, or those of the specified `eventName`. - -It is bad practice to remove listeners added elsewhere in the code, -particularly when the `EventEmitter` instance was created by some other -component or module (e.g. sockets or file streams). - -Returns a reference to the `EventEmitter`, so that calls can be chained. - -**`since`** v0.1.26 - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event?` | `string` \| `symbol` | - -#### Returns - -[`EventEmitter`](verida_verifiable_credentials._internal_.EventEmitter-1.md) - -#### Inherited from - -NodeJS.EventEmitter.removeAllListeners - -#### Defined in - -node_modules/@types/node/events.d.ts:455 - -___ - -### removeListener - -▸ **removeListener**(`eventName`, `listener`): [`EventEmitter`](verida_verifiable_credentials._internal_.EventEmitter-1.md) - -Removes the specified `listener` from the listener array for the event named`eventName`. - -```js -const callback = (stream) => { - console.log('someone connected!'); -}; -server.on('connection', callback); -// ... -server.removeListener('connection', callback); -``` - -`removeListener()` will remove, at most, one instance of a listener from the -listener array. If any single listener has been added multiple times to the -listener array for the specified `eventName`, then `removeListener()` must be -called multiple times to remove each instance. - -Once an event is emitted, all listeners attached to it at the -time of emitting are called in order. This implies that any`removeListener()` or `removeAllListeners()` calls _after_ emitting and_before_ the last listener finishes execution will -not remove them from`emit()` in progress. Subsequent events behave as expected. - -```js -const myEmitter = new MyEmitter(); - -const callbackA = () => { - console.log('A'); - myEmitter.removeListener('event', callbackB); -}; - -const callbackB = () => { - console.log('B'); -}; - -myEmitter.on('event', callbackA); - -myEmitter.on('event', callbackB); - -// callbackA removes listener callbackB but it will still be called. -// Internal listener array at time of emit [callbackA, callbackB] -myEmitter.emit('event'); -// Prints: -// A -// B - -// callbackB is now removed. -// Internal listener array [callbackA] -myEmitter.emit('event'); -// Prints: -// A -``` - -Because listeners are managed using an internal array, calling this will -change the position indices of any listener registered _after_ the listener -being removed. This will not impact the order in which listeners are called, -but it means that any copies of the listener array as returned by -the `emitter.listeners()` method will need to be recreated. - -When a single function has been added as a handler multiple times for a single -event (as in the example below), `removeListener()` will remove the most -recently added instance. In the example the `once('ping')`listener is removed: - -```js -const ee = new EventEmitter(); - -function pong() { - console.log('pong'); -} - -ee.on('ping', pong); -ee.once('ping', pong); -ee.removeListener('ping', pong); - -ee.emit('ping'); -ee.emit('ping'); -``` - -Returns a reference to the `EventEmitter`, so that calls can be chained. - -**`since`** v0.1.26 - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | `string` \| `symbol` | -| `listener` | (...`args`: `any`[]) => `void` | - -#### Returns - -[`EventEmitter`](verida_verifiable_credentials._internal_.EventEmitter-1.md) - -#### Inherited from - -NodeJS.EventEmitter.removeListener - -#### Defined in - -node_modules/@types/node/events.d.ts:439 - -___ - -### setMaxListeners - -▸ **setMaxListeners**(`n`): [`EventEmitter`](verida_verifiable_credentials._internal_.EventEmitter-1.md) - -By default `EventEmitter`s will print a warning if more than `10` listeners are -added for a particular event. This is a useful default that helps finding -memory leaks. The `emitter.setMaxListeners()` method allows the limit to be -modified for this specific `EventEmitter` instance. The value can be set to`Infinity` (or `0`) to indicate an unlimited number of listeners. - -Returns a reference to the `EventEmitter`, so that calls can be chained. - -**`since`** v0.3.5 - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `n` | `number` | - -#### Returns - -[`EventEmitter`](verida_verifiable_credentials._internal_.EventEmitter-1.md) - -#### Inherited from - -NodeJS.EventEmitter.setMaxListeners - -#### Defined in - -node_modules/@types/node/events.d.ts:465 - -___ - -### getEventListeners - -▸ `Static` **getEventListeners**(`emitter`, `name`): `Function`[] - -Returns a copy of the array of listeners for the event named `eventName`. - -For `EventEmitter`s this behaves exactly the same as calling `.listeners` on -the emitter. - -For `EventTarget`s this is the only way to get the event listeners for the -event target. This is useful for debugging and diagnostic purposes. - -```js -const { getEventListeners, EventEmitter } = require('events'); - -{ - const ee = new EventEmitter(); - const listener = () => console.log('Events are fun'); - ee.on('foo', listener); - getEventListeners(ee, 'foo'); // [listener] -} -{ - const et = new EventTarget(); - const listener = () => console.log('Events are fun'); - et.addEventListener('foo', listener); - getEventListeners(et, 'foo'); // [listener] -} -``` - -**`since`** v15.2.0 - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `emitter` | `EventEmitter` \| [`DOMEventTarget`](../interfaces/verida_verifiable_credentials._internal_.DOMEventTarget.md) | -| `name` | `string` \| `symbol` | - -#### Returns - -`Function`[] - -#### Defined in - -node_modules/@types/node/events.d.ts:262 - -___ - -### listenerCount - -▸ `Static` **listenerCount**(`emitter`, `eventName`): `number` - -A class method that returns the number of listeners for the given `eventName`registered on the given `emitter`. - -```js -const { EventEmitter, listenerCount } = require('events'); -const myEmitter = new EventEmitter(); -myEmitter.on('event', () => {}); -myEmitter.on('event', () => {}); -console.log(listenerCount(myEmitter, 'event')); -// Prints: 2 -``` - -**`since`** v0.9.12 - -**`deprecated`** Since v3.2.0 - Use `listenerCount` instead. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `emitter` | `EventEmitter` | The emitter to query | -| `eventName` | `string` \| `symbol` | The event name | - -#### Returns - -`number` - -#### Inherited from - -NodeJS.EventEmitter.listenerCount - -#### Defined in - -node_modules/@types/node/events.d.ts:234 - -___ - -### on - -▸ `Static` **on**(`emitter`, `eventName`, `options?`): [`AsyncIterableIterator`](../interfaces/verida_verifiable_credentials._internal_.AsyncIterableIterator.md)<`any`\> - -```js -const { on, EventEmitter } = require('events'); - -(async () => { - const ee = new EventEmitter(); - - // Emit later on - process.nextTick(() => { - ee.emit('foo', 'bar'); - ee.emit('foo', 42); - }); - - for await (const event of on(ee, 'foo')) { - // The execution of this inner block is synchronous and it - // processes one event at a time (even with await). Do not use - // if concurrent execution is required. - console.log(event); // prints ['bar'] [42] - } - // Unreachable here -})(); -``` - -Returns an `AsyncIterator` that iterates `eventName` events. It will throw -if the `EventEmitter` emits `'error'`. It removes all listeners when -exiting the loop. The `value` returned by each iteration is an array -composed of the emitted event arguments. - -An `AbortSignal` can be used to cancel waiting on events: - -```js -const { on, EventEmitter } = require('events'); -const ac = new AbortController(); - -(async () => { - const ee = new EventEmitter(); - - // Emit later on - process.nextTick(() => { - ee.emit('foo', 'bar'); - ee.emit('foo', 42); - }); - - for await (const event of on(ee, 'foo', { signal: ac.signal })) { - // The execution of this inner block is synchronous and it - // processes one event at a time (even with await). Do not use - // if concurrent execution is required. - console.log(event); // prints ['bar'] [42] - } - // Unreachable here -})(); - -process.nextTick(() => ac.abort()); -``` - -**`since`** v13.6.0, v12.16.0 - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `emitter` | `EventEmitter` | - | -| `eventName` | `string` | The name of the event being listened for | -| `options?` | [`StaticEventEmitterOptions`](../interfaces/verida_verifiable_credentials._internal_.StaticEventEmitterOptions.md) | - | - -#### Returns - -[`AsyncIterableIterator`](../interfaces/verida_verifiable_credentials._internal_.AsyncIterableIterator.md)<`any`\> - -that iterates `eventName` events emitted by the `emitter` - -#### Inherited from - -NodeJS.EventEmitter.on - -#### Defined in - -node_modules/@types/node/events.d.ts:217 - -___ - -### once - -▸ `Static` **once**(`emitter`, `eventName`, `options?`): `Promise`<`any`[]\> - -Creates a `Promise` that is fulfilled when the `EventEmitter` emits the given -event or that is rejected if the `EventEmitter` emits `'error'` while waiting. -The `Promise` will resolve with an array of all the arguments emitted to the -given event. - -This method is intentionally generic and works with the web platform[EventTarget](https://dom.spec.whatwg.org/#interface-eventtarget) interface, which has no special`'error'` event -semantics and does not listen to the `'error'` event. - -```js -const { once, EventEmitter } = require('events'); - -async function run() { - const ee = new EventEmitter(); - - process.nextTick(() => { - ee.emit('myevent', 42); - }); - - const [value] = await once(ee, 'myevent'); - console.log(value); - - const err = new Error('kaboom'); - process.nextTick(() => { - ee.emit('error', err); - }); - - try { - await once(ee, 'myevent'); - } catch (err) { - console.log('error happened', err); - } -} - -run(); -``` - -The special handling of the `'error'` event is only used when `events.once()`is used to wait for another event. If `events.once()` is used to wait for the -'`error'` event itself, then it is treated as any other kind of event without -special handling: - -```js -const { EventEmitter, once } = require('events'); - -const ee = new EventEmitter(); - -once(ee, 'error') - .then(([err]) => console.log('ok', err.message)) - .catch((err) => console.log('error', err.message)); - -ee.emit('error', new Error('boom')); - -// Prints: ok boom -``` - -An `AbortSignal` can be used to cancel waiting for the event: - -```js -const { EventEmitter, once } = require('events'); - -const ee = new EventEmitter(); -const ac = new AbortController(); - -async function foo(emitter, event, signal) { - try { - await once(emitter, event, { signal }); - console.log('event emitted!'); - } catch (error) { - if (error.name === 'AbortError') { - console.error('Waiting for the event was canceled!'); - } else { - console.error('There was an error', error.message); - } - } -} - -foo(ee, 'foo', ac.signal); -ac.abort(); // Abort waiting for the event -ee.emit('foo'); // Prints: Waiting for the event was canceled! -``` - -**`since`** v11.13.0, v10.16.0 - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `emitter` | [`NodeEventTarget`](../interfaces/verida_verifiable_credentials._internal_.NodeEventTarget.md) | -| `eventName` | `string` \| `symbol` | -| `options?` | [`StaticEventEmitterOptions`](../interfaces/verida_verifiable_credentials._internal_.StaticEventEmitterOptions.md) | - -#### Returns - -`Promise`<`any`[]\> - -#### Inherited from - -NodeJS.EventEmitter.once - -#### Defined in - -node_modules/@types/node/events.d.ts:157 - -▸ `Static` **once**(`emitter`, `eventName`, `options?`): `Promise`<`any`[]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `emitter` | [`DOMEventTarget`](../interfaces/verida_verifiable_credentials._internal_.DOMEventTarget.md) | -| `eventName` | `string` | -| `options?` | [`StaticEventEmitterOptions`](../interfaces/verida_verifiable_credentials._internal_.StaticEventEmitterOptions.md) | - -#### Returns - -`Promise`<`any`[]\> - -#### Inherited from - -NodeJS.EventEmitter.once - -#### Defined in - -node_modules/@types/node/events.d.ts:158 diff --git a/docs/api/verida-js/classes/verida_verifiable_credentials._internal_.KeywordCxt.md b/docs/api/verida-js/classes/verida_verifiable_credentials._internal_.KeywordCxt.md deleted file mode 100644 index 15497d9..0000000 --- a/docs/api/verida-js/classes/verida_verifiable_credentials._internal_.KeywordCxt.md +++ /dev/null @@ -1,584 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / KeywordCxt - -# Class: KeywordCxt - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md).KeywordCxt - -## Implements - -- [`KeywordErrorCxt`](../interfaces/verida_verifiable_credentials._internal_.KeywordErrorCxt.md) - -## Table of contents - -### Constructors - -- [constructor](verida_verifiable_credentials._internal_.KeywordCxt.md#constructor) - -### Properties - -- [$data](verida_verifiable_credentials._internal_.KeywordCxt.md#$data) -- [\_error](verida_verifiable_credentials._internal_.KeywordCxt.md#_error) -- [allErrors](verida_verifiable_credentials._internal_.KeywordCxt.md#allerrors) -- [data](verida_verifiable_credentials._internal_.KeywordCxt.md#data) -- [def](verida_verifiable_credentials._internal_.KeywordCxt.md#def) -- [errsCount](verida_verifiable_credentials._internal_.KeywordCxt.md#errscount) -- [gen](verida_verifiable_credentials._internal_.KeywordCxt.md#gen) -- [it](verida_verifiable_credentials._internal_.KeywordCxt.md#it) -- [keyword](verida_verifiable_credentials._internal_.KeywordCxt.md#keyword) -- [params](verida_verifiable_credentials._internal_.KeywordCxt.md#params) -- [parentSchema](verida_verifiable_credentials._internal_.KeywordCxt.md#parentschema) -- [schema](verida_verifiable_credentials._internal_.KeywordCxt.md#schema) -- [schemaCode](verida_verifiable_credentials._internal_.KeywordCxt.md#schemacode) -- [schemaType](verida_verifiable_credentials._internal_.KeywordCxt.md#schematype) -- [schemaValue](verida_verifiable_credentials._internal_.KeywordCxt.md#schemavalue) - -### Methods - -- [$dataError](verida_verifiable_credentials._internal_.KeywordCxt.md#$dataerror) -- [block$data](verida_verifiable_credentials._internal_.KeywordCxt.md#block$data) -- [check$data](verida_verifiable_credentials._internal_.KeywordCxt.md#check$data) -- [error](verida_verifiable_credentials._internal_.KeywordCxt.md#error) -- [fail](verida_verifiable_credentials._internal_.KeywordCxt.md#fail) -- [fail$data](verida_verifiable_credentials._internal_.KeywordCxt.md#fail$data) -- [failResult](verida_verifiable_credentials._internal_.KeywordCxt.md#failresult) -- [invalid$data](verida_verifiable_credentials._internal_.KeywordCxt.md#invalid$data) -- [mergeEvaluated](verida_verifiable_credentials._internal_.KeywordCxt.md#mergeevaluated) -- [mergeValidEvaluated](verida_verifiable_credentials._internal_.KeywordCxt.md#mergevalidevaluated) -- [ok](verida_verifiable_credentials._internal_.KeywordCxt.md#ok) -- [pass](verida_verifiable_credentials._internal_.KeywordCxt.md#pass) -- [reset](verida_verifiable_credentials._internal_.KeywordCxt.md#reset) -- [result](verida_verifiable_credentials._internal_.KeywordCxt.md#result) -- [setParams](verida_verifiable_credentials._internal_.KeywordCxt.md#setparams) -- [subschema](verida_verifiable_credentials._internal_.KeywordCxt.md#subschema) - -## Constructors - -### constructor - -• **new KeywordCxt**(`it`, `def`, `keyword`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `it` | [`SchemaObjCxt`](../interfaces/verida_verifiable_credentials._internal_.SchemaObjCxt.md) | -| `def` | [`AddedKeywordDefinition`](../modules/verida_verifiable_credentials._internal_.md#addedkeyworddefinition) | -| `keyword` | `string` | - -#### Defined in - -node_modules/ajv/dist/compile/validate/index.d.ts:23 - -## Properties - -### $data - -• `Optional` `Readonly` **$data**: `string` \| ``false`` - -#### Implementation of - -[KeywordErrorCxt](../interfaces/verida_verifiable_credentials._internal_.KeywordErrorCxt.md).[$data](../interfaces/verida_verifiable_credentials._internal_.KeywordErrorCxt.md#$data) - -#### Defined in - -node_modules/ajv/dist/compile/validate/index.d.ts:13 - -___ - -### \_error - -• `Private` **\_error**: `any` - -#### Defined in - -node_modules/ajv/dist/compile/validate/index.d.ts:30 - -___ - -### allErrors - -• `Optional` `Readonly` **allErrors**: `boolean` - -#### Defined in - -node_modules/ajv/dist/compile/validate/index.d.ts:10 - -___ - -### data - -• `Readonly` **data**: [`Name`](verida_verifiable_credentials._internal_.Name.md) - -#### Implementation of - -[KeywordErrorCxt](../interfaces/verida_verifiable_credentials._internal_.KeywordErrorCxt.md).[data](../interfaces/verida_verifiable_credentials._internal_.KeywordErrorCxt.md#data) - -#### Defined in - -node_modules/ajv/dist/compile/validate/index.d.ts:12 - -___ - -### def - -• `Readonly` **def**: [`AddedKeywordDefinition`](../modules/verida_verifiable_credentials._internal_.md#addedkeyworddefinition) - -#### Defined in - -node_modules/ajv/dist/compile/validate/index.d.ts:22 - -___ - -### errsCount - -• `Optional` `Readonly` **errsCount**: [`Name`](verida_verifiable_credentials._internal_.Name.md) - -#### Implementation of - -[KeywordErrorCxt](../interfaces/verida_verifiable_credentials._internal_.KeywordErrorCxt.md).[errsCount](../interfaces/verida_verifiable_credentials._internal_.KeywordErrorCxt.md#errscount) - -#### Defined in - -node_modules/ajv/dist/compile/validate/index.d.ts:19 - -___ - -### gen - -• `Readonly` **gen**: [`CodeGen`](verida_verifiable_credentials._internal_.CodeGen.md) - -#### Implementation of - -[KeywordErrorCxt](../interfaces/verida_verifiable_credentials._internal_.KeywordErrorCxt.md).[gen](../interfaces/verida_verifiable_credentials._internal_.KeywordErrorCxt.md#gen) - -#### Defined in - -node_modules/ajv/dist/compile/validate/index.d.ts:9 - -___ - -### it - -• `Readonly` **it**: [`SchemaObjCxt`](../interfaces/verida_verifiable_credentials._internal_.SchemaObjCxt.md) - -#### Implementation of - -[KeywordErrorCxt](../interfaces/verida_verifiable_credentials._internal_.KeywordErrorCxt.md).[it](../interfaces/verida_verifiable_credentials._internal_.KeywordErrorCxt.md#it) - -#### Defined in - -node_modules/ajv/dist/compile/validate/index.d.ts:21 - -___ - -### keyword - -• `Readonly` **keyword**: `string` - -#### Implementation of - -[KeywordErrorCxt](../interfaces/verida_verifiable_credentials._internal_.KeywordErrorCxt.md).[keyword](../interfaces/verida_verifiable_credentials._internal_.KeywordErrorCxt.md#keyword) - -#### Defined in - -node_modules/ajv/dist/compile/validate/index.d.ts:11 - -___ - -### params - -• **params**: [`KeywordCxtParams`](../modules/verida_verifiable_credentials._internal_.md#keywordcxtparams) - -#### Implementation of - -[KeywordErrorCxt](../interfaces/verida_verifiable_credentials._internal_.KeywordErrorCxt.md).[params](../interfaces/verida_verifiable_credentials._internal_.KeywordErrorCxt.md#params) - -#### Defined in - -node_modules/ajv/dist/compile/validate/index.d.ts:20 - -___ - -### parentSchema - -• `Readonly` **parentSchema**: [`AnySchemaObject`](../modules/verida_verifiable_credentials._internal_.md#anyschemaobject) - -#### Implementation of - -[KeywordErrorCxt](../interfaces/verida_verifiable_credentials._internal_.KeywordErrorCxt.md).[parentSchema](../interfaces/verida_verifiable_credentials._internal_.KeywordErrorCxt.md#parentschema) - -#### Defined in - -node_modules/ajv/dist/compile/validate/index.d.ts:18 - -___ - -### schema - -• **schema**: `any` - -#### Implementation of - -[KeywordErrorCxt](../interfaces/verida_verifiable_credentials._internal_.KeywordErrorCxt.md).[schema](../interfaces/verida_verifiable_credentials._internal_.KeywordErrorCxt.md#schema) - -#### Defined in - -node_modules/ajv/dist/compile/validate/index.d.ts:14 - -___ - -### schemaCode - -• `Readonly` **schemaCode**: `number` \| `boolean` \| [`Code`](../modules/verida_verifiable_credentials._internal_.md#code) - -#### Implementation of - -[KeywordErrorCxt](../interfaces/verida_verifiable_credentials._internal_.KeywordErrorCxt.md).[schemaCode](../interfaces/verida_verifiable_credentials._internal_.KeywordErrorCxt.md#schemacode) - -#### Defined in - -node_modules/ajv/dist/compile/validate/index.d.ts:16 - -___ - -### schemaType - -• `Readonly` **schemaType**: (``"string"`` \| ``"number"`` \| ``"boolean"`` \| ``"object"`` \| ``"integer"`` \| ``"array"`` \| ``"null"``)[] - -#### Implementation of - -[KeywordErrorCxt](../interfaces/verida_verifiable_credentials._internal_.KeywordErrorCxt.md).[schemaType](../interfaces/verida_verifiable_credentials._internal_.KeywordErrorCxt.md#schematype) - -#### Defined in - -node_modules/ajv/dist/compile/validate/index.d.ts:17 - -___ - -### schemaValue - -• `Readonly` **schemaValue**: `number` \| `boolean` \| [`Code`](../modules/verida_verifiable_credentials._internal_.md#code) - -#### Implementation of - -[KeywordErrorCxt](../interfaces/verida_verifiable_credentials._internal_.KeywordErrorCxt.md).[schemaValue](../interfaces/verida_verifiable_credentials._internal_.KeywordErrorCxt.md#schemavalue) - -#### Defined in - -node_modules/ajv/dist/compile/validate/index.d.ts:15 - -## Methods - -### $dataError - -▸ **$dataError**(): `void` - -#### Returns - -`void` - -#### Defined in - -node_modules/ajv/dist/compile/validate/index.d.ts:31 - -___ - -### block$data - -▸ **block$data**(`valid`, `codeBlock`, `$dataValid?`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `valid` | [`Name`](verida_verifiable_credentials._internal_.Name.md) | -| `codeBlock` | () => `void` | -| `$dataValid?` | [`Code`](../modules/verida_verifiable_credentials._internal_.md#code) | - -#### Returns - -`void` - -#### Defined in - -node_modules/ajv/dist/compile/validate/index.d.ts:35 - -___ - -### check$data - -▸ **check$data**(`valid?`, `$dataValid?`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `valid?` | [`Name`](verida_verifiable_credentials._internal_.Name.md) | -| `$dataValid?` | [`Code`](../modules/verida_verifiable_credentials._internal_.md#code) | - -#### Returns - -`void` - -#### Defined in - -node_modules/ajv/dist/compile/validate/index.d.ts:36 - -___ - -### error - -▸ **error**(`append?`, `errorParams?`, `errorPaths?`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `append?` | `boolean` | -| `errorParams?` | [`KeywordCxtParams`](../modules/verida_verifiable_credentials._internal_.md#keywordcxtparams) | -| `errorPaths?` | [`ErrorPaths`](../interfaces/verida_verifiable_credentials._internal_.ErrorPaths.md) | - -#### Returns - -`void` - -#### Defined in - -node_modules/ajv/dist/compile/validate/index.d.ts:29 - -___ - -### fail - -▸ **fail**(`condition?`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `condition?` | [`Code`](../modules/verida_verifiable_credentials._internal_.md#code) | - -#### Returns - -`void` - -#### Defined in - -node_modules/ajv/dist/compile/validate/index.d.ts:27 - -___ - -### fail$data - -▸ **fail$data**(`condition`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `condition` | [`Code`](../modules/verida_verifiable_credentials._internal_.md#code) | - -#### Returns - -`void` - -#### Defined in - -node_modules/ajv/dist/compile/validate/index.d.ts:28 - -___ - -### failResult - -▸ **failResult**(`condition`, `successAction?`, `failAction?`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `condition` | [`Code`](../modules/verida_verifiable_credentials._internal_.md#code) | -| `successAction?` | () => `void` | -| `failAction?` | () => `void` | - -#### Returns - -`void` - -#### Defined in - -node_modules/ajv/dist/compile/validate/index.d.ts:25 - -___ - -### invalid$data - -▸ **invalid$data**(): [`Code`](../modules/verida_verifiable_credentials._internal_.md#code) - -#### Returns - -[`Code`](../modules/verida_verifiable_credentials._internal_.md#code) - -#### Defined in - -node_modules/ajv/dist/compile/validate/index.d.ts:37 - -___ - -### mergeEvaluated - -▸ **mergeEvaluated**(`schemaCxt`, `toName?`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schemaCxt` | [`SchemaCxt`](../interfaces/verida_verifiable_credentials._internal_.SchemaCxt.md) | -| `toName?` | typeof [`Name`](verida_verifiable_credentials._internal_.Name.md) | - -#### Returns - -`void` - -#### Defined in - -node_modules/ajv/dist/compile/validate/index.d.ts:39 - -___ - -### mergeValidEvaluated - -▸ **mergeValidEvaluated**(`schemaCxt`, `valid`): `boolean` \| `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schemaCxt` | [`SchemaCxt`](../interfaces/verida_verifiable_credentials._internal_.SchemaCxt.md) | -| `valid` | [`Name`](verida_verifiable_credentials._internal_.Name.md) | - -#### Returns - -`boolean` \| `void` - -#### Defined in - -node_modules/ajv/dist/compile/validate/index.d.ts:40 - -___ - -### ok - -▸ **ok**(`cond`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `cond` | `boolean` \| [`Code`](../modules/verida_verifiable_credentials._internal_.md#code) | - -#### Returns - -`void` - -#### Defined in - -node_modules/ajv/dist/compile/validate/index.d.ts:33 - -___ - -### pass - -▸ **pass**(`condition`, `failAction?`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `condition` | [`Code`](../modules/verida_verifiable_credentials._internal_.md#code) | -| `failAction?` | () => `void` | - -#### Returns - -`void` - -#### Defined in - -node_modules/ajv/dist/compile/validate/index.d.ts:26 - -___ - -### reset - -▸ **reset**(): `void` - -#### Returns - -`void` - -#### Defined in - -node_modules/ajv/dist/compile/validate/index.d.ts:32 - -___ - -### result - -▸ **result**(`condition`, `successAction?`, `failAction?`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `condition` | [`Code`](../modules/verida_verifiable_credentials._internal_.md#code) | -| `successAction?` | () => `void` | -| `failAction?` | () => `void` | - -#### Returns - -`void` - -#### Defined in - -node_modules/ajv/dist/compile/validate/index.d.ts:24 - -___ - -### setParams - -▸ **setParams**(`obj`, `assign?`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `obj` | [`KeywordCxtParams`](../modules/verida_verifiable_credentials._internal_.md#keywordcxtparams) | -| `assign?` | ``true`` | - -#### Returns - -`void` - -#### Defined in - -node_modules/ajv/dist/compile/validate/index.d.ts:34 - -___ - -### subschema - -▸ **subschema**(`appl`, `valid`): [`SchemaCxt`](../interfaces/verida_verifiable_credentials._internal_.SchemaCxt.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `appl` | [`Partial`](../modules/verida_verifiable_credentials._internal_.md#partial)<{ `allErrors`: `boolean` ; `compositeRule`: ``true`` ; `createErrors`: `boolean` ; `data`: [`Code`](../modules/verida_verifiable_credentials._internal_.md#code) ; `dataProp`: `string` \| `number` \| [`Code`](../modules/verida_verifiable_credentials._internal_.md#code) ; `dataPropType`: [`Type`](../enums/verida_verifiable_credentials._internal_.Type.md) ; `dataTypes`: (``"string"`` \| ``"number"`` \| ``"boolean"`` \| ``"object"`` \| ``"integer"`` \| ``"array"`` \| ``"null"``)[] ; `definedProperties`: `Set`<`string`\> ; `errSchemaPath`: `string` ; `jtdDiscriminator`: `string` ; `jtdMetadata`: `boolean` ; `keyword`: `string` ; `propertyName`: [`Name`](verida_verifiable_credentials._internal_.Name.md) ; `schema`: [`AnySchema`](../modules/verida_verifiable_credentials._internal_.md#anyschema) ; `schemaPath`: [`Code`](../modules/verida_verifiable_credentials._internal_.md#code) ; `schemaProp`: `string` \| `number` ; `topSchemaRef`: [`Code`](../modules/verida_verifiable_credentials._internal_.md#code) }\> | -| `valid` | [`Name`](verida_verifiable_credentials._internal_.Name.md) | - -#### Returns - -[`SchemaCxt`](../interfaces/verida_verifiable_credentials._internal_.SchemaCxt.md) - -#### Defined in - -node_modules/ajv/dist/compile/validate/index.d.ts:38 diff --git a/docs/api/verida-js/classes/verida_verifiable_credentials._internal_.Name.md b/docs/api/verida-js/classes/verida_verifiable_credentials._internal_.Name.md deleted file mode 100644 index a16b42c..0000000 --- a/docs/api/verida-js/classes/verida_verifiable_credentials._internal_.Name.md +++ /dev/null @@ -1,120 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / Name - -# Class: Name - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md).Name - -## Hierarchy - -- [`_CodeOrName`](verida_verifiable_credentials._internal_._CodeOrName.md) - - ↳ **`Name`** - - ↳↳ [`ValueScopeName`](verida_verifiable_credentials._internal_.ValueScopeName.md) - -## Table of contents - -### Constructors - -- [constructor](verida_verifiable_credentials._internal_.Name.md#constructor) - -### Properties - -- [str](verida_verifiable_credentials._internal_.Name.md#str) - -### Accessors - -- [names](verida_verifiable_credentials._internal_.Name.md#names) - -### Methods - -- [emptyStr](verida_verifiable_credentials._internal_.Name.md#emptystr) -- [toString](verida_verifiable_credentials._internal_.Name.md#tostring) - -## Constructors - -### constructor - -• **new Name**(`s`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `s` | `string` | - -#### Overrides - -[_CodeOrName](verida_verifiable_credentials._internal_._CodeOrName.md).[constructor](verida_verifiable_credentials._internal_._CodeOrName.md#constructor) - -#### Defined in - -node_modules/ajv/dist/compile/codegen/code.d.ts:10 - -## Properties - -### str - -• `Readonly` **str**: `string` - -#### Overrides - -[_CodeOrName](verida_verifiable_credentials._internal_._CodeOrName.md).[str](verida_verifiable_credentials._internal_._CodeOrName.md#str) - -#### Defined in - -node_modules/ajv/dist/compile/codegen/code.d.ts:9 - -## Accessors - -### names - -• `get` **names**(): [`UsedNames`](../modules/verida_verifiable_credentials._internal_.md#usednames) - -#### Returns - -[`UsedNames`](../modules/verida_verifiable_credentials._internal_.md#usednames) - -#### Overrides - -\_CodeOrName.names - -#### Defined in - -node_modules/ajv/dist/compile/codegen/code.d.ts:13 - -## Methods - -### emptyStr - -▸ **emptyStr**(): `boolean` - -#### Returns - -`boolean` - -#### Overrides - -[_CodeOrName](verida_verifiable_credentials._internal_._CodeOrName.md).[emptyStr](verida_verifiable_credentials._internal_._CodeOrName.md#emptystr) - -#### Defined in - -node_modules/ajv/dist/compile/codegen/code.d.ts:12 - -___ - -### toString - -▸ **toString**(): `string` - -#### Returns - -`string` - -#### Overrides - -[_CodeOrName](verida_verifiable_credentials._internal_._CodeOrName.md).[toString](verida_verifiable_credentials._internal_._CodeOrName.md#tostring) - -#### Defined in - -node_modules/ajv/dist/compile/codegen/code.d.ts:11 diff --git a/docs/api/verida-js/classes/verida_verifiable_credentials._internal_.Profile.md b/docs/api/verida-js/classes/verida_verifiable_credentials._internal_.Profile.md deleted file mode 100644 index c9c19c7..0000000 --- a/docs/api/verida-js/classes/verida_verifiable_credentials._internal_.Profile.md +++ /dev/null @@ -1,327 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / Profile - -# Class: Profile - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md).Profile - -## Hierarchy - -- [`EventEmitter`](../modules/verida_verifiable_credentials._internal_.md#eventemitter) - - ↳ **`Profile`** - -## Table of contents - -### Constructors - -- [constructor](verida_verifiable_credentials._internal_.Profile.md#constructor) - -### Properties - -- [context](verida_verifiable_credentials._internal_.Profile.md#context) -- [did](verida_verifiable_credentials._internal_.Profile.md#did) -- [errors](verida_verifiable_credentials._internal_.Profile.md#errors) -- [getRecord](verida_verifiable_credentials._internal_.Profile.md#getrecord) -- [init](verida_verifiable_credentials._internal_.Profile.md#init) -- [isPrivate](verida_verifiable_credentials._internal_.Profile.md#isprivate) -- [profileName](verida_verifiable_credentials._internal_.Profile.md#profilename) -- [saveRecord](verida_verifiable_credentials._internal_.Profile.md#saverecord) -- [store](verida_verifiable_credentials._internal_.Profile.md#store) -- [writeAccess](verida_verifiable_credentials._internal_.Profile.md#writeaccess) - -### Methods - -- [delete](verida_verifiable_credentials._internal_.Profile.md#delete) -- [get](verida_verifiable_credentials._internal_.Profile.md#get) -- [getMany](verida_verifiable_credentials._internal_.Profile.md#getmany) -- [listen](verida_verifiable_credentials._internal_.Profile.md#listen) -- [set](verida_verifiable_credentials._internal_.Profile.md#set) -- [setMany](verida_verifiable_credentials._internal_.Profile.md#setmany) - -## Constructors - -### constructor - -• **new Profile**(`context`, `did`, `profileName`, `writeAccess`, `isPrivate?`) - -Create a new user profile. - -**Do not instantiate directly.** - -Access the current user's profile via {@link App.profile} - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `context` | [`Context`](verida_verifiable_credentials._internal_.Context.md) | -| `did` | `string` | -| `profileName` | `string` | -| `writeAccess` | `boolean` | -| `isPrivate?` | `boolean` | - -#### Overrides - -EventEmitter.constructor - -#### Defined in - -packages/client-ts/dist/context/profiles/profile.d.ts:28 - -## Properties - -### context - -• `Private` **context**: `any` - -#### Defined in - -packages/client-ts/dist/context/profiles/profile.d.ts:12 - -___ - -### did - -• `Private` **did**: `any` - -#### Defined in - -packages/client-ts/dist/context/profiles/profile.d.ts:13 - -___ - -### errors - -• **errors**: `object` - -#### Defined in - -packages/client-ts/dist/context/profiles/profile.d.ts:18 - -___ - -### getRecord - -• `Private` **getRecord**: `any` - -#### Defined in - -packages/client-ts/dist/context/profiles/profile.d.ts:85 - -___ - -### init - -• `Private` **init**: `any` - -#### Defined in - -packages/client-ts/dist/context/profiles/profile.d.ts:87 - -___ - -### isPrivate - -• `Private` **isPrivate**: `any` - -#### Defined in - -packages/client-ts/dist/context/profiles/profile.d.ts:17 - -___ - -### profileName - -• `Private` **profileName**: `any` - -#### Defined in - -packages/client-ts/dist/context/profiles/profile.d.ts:14 - -___ - -### saveRecord - -• `Private` **saveRecord**: `any` - -#### Defined in - -packages/client-ts/dist/context/profiles/profile.d.ts:86 - -___ - -### store - -• `Private` `Optional` **store**: `any` - -#### Defined in - -packages/client-ts/dist/context/profiles/profile.d.ts:15 - -___ - -### writeAccess - -• `Private` **writeAccess**: `any` - -#### Defined in - -packages/client-ts/dist/context/profiles/profile.d.ts:16 - -## Methods - -### delete - -▸ **delete**(`key`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `key` | `string` | Profile key to delete (ie: `email`) | - -#### Returns - -`Promise`<`boolean`\> - -Boolean indicating if the delete was successful - -#### Defined in - -packages/client-ts/dist/context/profiles/profile.d.ts:49 - -___ - -### get - -▸ **get**(`key`, `options?`, `extended?`): `Promise`<`any`\> - -Get a profile value by key - -**`example`** -let emailDoc = app.wallet.profile.get('email'); - -// key = email -// value = john@doe.com -console.log(emailDoc.key, emailDoc.value); - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `key` | `string` | Profile key to get (ie: `email`) | -| `options?` | `any` | | -| `extended?` | `boolean` | | - -#### Returns - -`Promise`<`any`\> - -Database record for this profile key. Object has keys [`key`, `value`, `_id`, `_rev`]. - -#### Defined in - -packages/client-ts/dist/context/profiles/profile.d.ts:43 - -___ - -### getMany - -▸ **getMany**(`filter`, `options`): `Promise`<`any`\> - -Get many profile values. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `filter` | `any` | -| `options` | `any` | - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -packages/client-ts/dist/context/profiles/profile.d.ts:56 - -___ - -### listen - -▸ **listen**(`callback`): `Promise`<`any`\> - -Listen for changes to the public profile - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `callback` | `any` | - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -packages/client-ts/dist/context/profiles/profile.d.ts:84 - -___ - -### set - -▸ **set**(`key`, `value`): `Promise`<`any`\> - -Set a profile value by key - -**`example`** -// Set a profile value by key -app.wallet.profile.set('name', 'John'); - -// Update a profile value from an existing document -let emailDoc = app.wallet.profile.get('email'); -app.wallet.profile.set(emailDoc, 'john@doe.com'); - -// Update a profile profile by key -app.wallet.profile.set('email', 'john@doe.com'); - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `key` | `string` | Profile key to set (ie: `email`) | -| `value` | `any` | Value to save | - -#### Returns - -`Promise`<`any`\> - -Boolean indicating if the save was successful - -#### Defined in - -packages/client-ts/dist/context/profiles/profile.d.ts:74 - -___ - -### setMany - -▸ **setMany**(`data`): `Promise`<`any`\> - -Set many profile key / values at once - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `any` | - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -packages/client-ts/dist/context/profiles/profile.d.ts:80 diff --git a/docs/api/verida-js/classes/verida_verifiable_credentials._internal_.Schema.md b/docs/api/verida-js/classes/verida_verifiable_credentials._internal_.Schema.md deleted file mode 100644 index f8c93d3..0000000 --- a/docs/api/verida-js/classes/verida_verifiable_credentials._internal_.Schema.md +++ /dev/null @@ -1,377 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / Schema - -# Class: Schema - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md).Schema - -## Table of contents - -### Constructors - -- [constructor](verida_verifiable_credentials._internal_.Schema.md#constructor) - -### Properties - -- [ajv](verida_verifiable_credentials._internal_.Schema.md#ajv) -- [errors](verida_verifiable_credentials._internal_.Schema.md#errors) -- [finalPath](verida_verifiable_credentials._internal_.Schema.md#finalpath) -- [path](verida_verifiable_credentials._internal_.Schema.md#path) -- [schemaJson](verida_verifiable_credentials._internal_.Schema.md#schemajson) -- [specification](verida_verifiable_credentials._internal_.Schema.md#specification) -- [validateFunction](verida_verifiable_credentials._internal_.Schema.md#validatefunction) -- [schemaPaths](verida_verifiable_credentials._internal_.Schema.md#schemapaths) -- [schemas](verida_verifiable_credentials._internal_.Schema.md#schemas) - -### Methods - -- [getAppearance](verida_verifiable_credentials._internal_.Schema.md#getappearance) -- [getPath](verida_verifiable_credentials._internal_.Schema.md#getpath) -- [getSchemaJson](verida_verifiable_credentials._internal_.Schema.md#getschemajson) -- [getSpecification](verida_verifiable_credentials._internal_.Schema.md#getspecification) -- [validate](verida_verifiable_credentials._internal_.Schema.md#validate) -- [getSchema](verida_verifiable_credentials._internal_.Schema.md#getschema) -- [getSchemaPaths](verida_verifiable_credentials._internal_.Schema.md#getschemapaths) -- [getVersionlessSchemaName](verida_verifiable_credentials._internal_.Schema.md#getversionlessschemaname) -- [loadJson](verida_verifiable_credentials._internal_.Schema.md#loadjson) -- [resolvePath](verida_verifiable_credentials._internal_.Schema.md#resolvepath) -- [setSchemaPaths](verida_verifiable_credentials._internal_.Schema.md#setschemapaths) - -## Constructors - -### constructor - -• **new Schema**(`path`, `options?`) - -An object representation of a JSON Schema. - -**Do not instantiate directly.** - -Access via {@link App#getSchema} - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `path` | `string` | Path to a schema in the form (http://..../schema.json, /schemas/name/schema.json, name/of/schema) | -| `options?` | `any` | - | - -#### Defined in - -packages/client-ts/dist/context/schema.d.ts:25 - -## Properties - -### ajv - -• `Protected` **ajv**: [`Ajv2020`](verida_verifiable_credentials._internal_.Ajv2020.md) - -#### Defined in - -packages/client-ts/dist/context/schema.d.ts:9 - -___ - -### errors - -• **errors**: `any`[] - -#### Defined in - -packages/client-ts/dist/context/schema.d.ts:7 - -___ - -### finalPath - -• `Protected` `Optional` **finalPath**: `string` - -#### Defined in - -packages/client-ts/dist/context/schema.d.ts:11 - -___ - -### path - -• `Protected` **path**: `string` - -#### Defined in - -packages/client-ts/dist/context/schema.d.ts:8 - -___ - -### schemaJson - -• `Protected` `Optional` **schemaJson**: `object` - -#### Defined in - -packages/client-ts/dist/context/schema.d.ts:10 - -___ - -### specification - -• `Protected` `Optional` **specification**: `any` - -#### Defined in - -packages/client-ts/dist/context/schema.d.ts:12 - -___ - -### validateFunction - -• `Protected` `Optional` **validateFunction**: `any` - -#### Defined in - -packages/client-ts/dist/context/schema.d.ts:13 - -___ - -### schemaPaths - -▪ `Static` `Protected` `Optional` **schemaPaths**: [`Record`](../modules/verida_verifiable_credentials._internal_.md#record)<`string`, `string`\> - -#### Defined in - -packages/client-ts/dist/context/schema.d.ts:14 - -___ - -### schemas - -▪ `Static` `Protected` **schemas**: `any` - -#### Defined in - -packages/client-ts/dist/context/schema.d.ts:15 - -## Methods - -### getAppearance - -▸ **getAppearance**(): `Promise`<`any`\> - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -packages/client-ts/dist/context/schema.d.ts:52 - -___ - -### getPath - -▸ `Protected` **getPath**(): `Promise`<`string`\> - -Get a rully resolveable path for a URL - -Handle shortened paths: - - `health/activity` -> `https://common.schemas.verida.io/health/activity/latest/schema.json` - - `https://common/schemas.verida.io/health/activity/latest` -> `https://common.schemas.verida.io/health/activity/latest/schema.json` - - `/health/activity/test.json` -> `https://common/schemas.verida.io/health/activity/test.json` - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -packages/client-ts/dist/context/schema.d.ts:61 - -___ - -### getSchemaJson - -▸ **getSchemaJson**(): `Promise`<`object`\> - -Fetch unresolved JSON schema - -#### Returns - -`Promise`<`object`\> - -#### Defined in - -packages/client-ts/dist/context/schema.d.ts:51 - -___ - -### getSpecification - -▸ **getSpecification**(): `Promise`<`any`\> - -**`todo:`** Deprecate in favour of `getProperties()` -Get an object that represents the JSON Schema. Fully resolved. -Warning: This can cause issues with very large schemas. - -**`example`** -let schemaDoc = await app.getSchema("social/contact"); -let spec = schemaDoc.getSpecification(); -console.log(spec); - -#### Returns - -`Promise`<`any`\> - -JSON object representing the defereferenced schema - -#### Defined in - -packages/client-ts/dist/context/schema.d.ts:40 - -___ - -### validate - -▸ **validate**(`data`): `Promise`<`boolean`\> - -Validate a data object with this schema, using AJV - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `any` | - -#### Returns - -`Promise`<`boolean`\> - -True if the data validates against the schema. - -#### Defined in - -packages/client-ts/dist/context/schema.d.ts:47 - -___ - -### getSchema - -▸ `Static` **getSchema**(`schemaName`): `Promise`<[`Schema`](verida_verifiable_credentials._internal_.Schema.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schemaName` | `string` | - -#### Returns - -`Promise`<[`Schema`](verida_verifiable_credentials._internal_.Schema.md)\> - -#### Defined in - -packages/client-ts/dist/context/schema.d.ts:26 - -___ - -### getSchemaPaths - -▸ `Static` **getSchemaPaths**(): [`Record`](../modules/verida_verifiable_credentials._internal_.md#record)<`string`, `string`\> - -#### Returns - -[`Record`](../modules/verida_verifiable_credentials._internal_.md#record)<`string`, `string`\> - -#### Defined in - -packages/client-ts/dist/context/schema.d.ts:28 - -___ - -### getVersionlessSchemaName - -▸ `Static` **getVersionlessSchemaName**(`schemaName`): `string` - -Checks a version specified in schemaName - -SchemaName example :- https://core.schemas.verida.io/base/v0.1.0/schema.json -SchemaName format :- https://{protocol-name}/{name}/{v}{version}/name.json - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schemaName` | `string` | - -#### Returns - -`string` - -schemaName without the version - -#### Defined in - -packages/client-ts/dist/context/schema.d.ts:83 - -___ - -### loadJson - -▸ `Static` **loadJson**(`uri`): `Promise`<`object`\> - -Load JSON from a url that is fully resolved. - -Used by AJV. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `uri` | `string` | - -#### Returns - -`Promise`<`object`\> - -#### Defined in - -packages/client-ts/dist/context/schema.d.ts:74 - -___ - -### resolvePath - -▸ `Static` **resolvePath**(`uri`): `Promise`<`string`\> - -Force schema paths to be applied to URLs - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `uri` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -packages/client-ts/dist/context/schema.d.ts:66 - -___ - -### setSchemaPaths - -▸ `Static` **setSchemaPaths**(`schemaPaths`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schemaPaths` | [`Record`](../modules/verida_verifiable_credentials._internal_.md#record)<`string`, `string`\> | - -#### Returns - -`void` - -#### Defined in - -packages/client-ts/dist/context/schema.d.ts:27 diff --git a/docs/api/verida-js/classes/verida_verifiable_credentials._internal_.SchemaEnv.md b/docs/api/verida-js/classes/verida_verifiable_credentials._internal_.SchemaEnv.md deleted file mode 100644 index b11df08..0000000 --- a/docs/api/verida-js/classes/verida_verifiable_credentials._internal_.SchemaEnv.md +++ /dev/null @@ -1,266 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / SchemaEnv - -# Class: SchemaEnv - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md).SchemaEnv - -## Implements - -- [`SchemaEnvArgs`](../interfaces/verida_verifiable_credentials._internal_.SchemaEnvArgs.md) - -## Table of contents - -### Constructors - -- [constructor](verida_verifiable_credentials._internal_.SchemaEnv.md#constructor) - -### Properties - -- [$async](verida_verifiable_credentials._internal_.SchemaEnv.md#$async) -- [baseId](verida_verifiable_credentials._internal_.SchemaEnv.md#baseid) -- [dynamicAnchors](verida_verifiable_credentials._internal_.SchemaEnv.md#dynamicanchors) -- [localRefs](verida_verifiable_credentials._internal_.SchemaEnv.md#localrefs) -- [meta](verida_verifiable_credentials._internal_.SchemaEnv.md#meta) -- [parse](verida_verifiable_credentials._internal_.SchemaEnv.md#parse) -- [parseName](verida_verifiable_credentials._internal_.SchemaEnv.md#parsename) -- [refs](verida_verifiable_credentials._internal_.SchemaEnv.md#refs) -- [root](verida_verifiable_credentials._internal_.SchemaEnv.md#root) -- [schema](verida_verifiable_credentials._internal_.SchemaEnv.md#schema) -- [schemaId](verida_verifiable_credentials._internal_.SchemaEnv.md#schemaid) -- [schemaPath](verida_verifiable_credentials._internal_.SchemaEnv.md#schemapath) -- [serialize](verida_verifiable_credentials._internal_.SchemaEnv.md#serialize) -- [serializeName](verida_verifiable_credentials._internal_.SchemaEnv.md#serializename) -- [validate](verida_verifiable_credentials._internal_.SchemaEnv.md#validate) -- [validateName](verida_verifiable_credentials._internal_.SchemaEnv.md#validatename) - -## Constructors - -### constructor - -• **new SchemaEnv**(`env`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `env` | [`SchemaEnvArgs`](../interfaces/verida_verifiable_credentials._internal_.SchemaEnvArgs.md) | - -#### Defined in - -node_modules/ajv/dist/compile/index.d.ts:73 - -## Properties - -### $async - -• `Optional` `Readonly` **$async**: `boolean` - -#### Defined in - -node_modules/ajv/dist/compile/index.d.ts:62 - -___ - -### baseId - -• **baseId**: `string` - -#### Implementation of - -[SchemaEnvArgs](../interfaces/verida_verifiable_credentials._internal_.SchemaEnvArgs.md).[baseId](../interfaces/verida_verifiable_credentials._internal_.SchemaEnvArgs.md#baseid) - -#### Defined in - -node_modules/ajv/dist/compile/index.d.ts:58 - -___ - -### dynamicAnchors - -• `Readonly` **dynamicAnchors**: `Object` - -#### Defined in - -node_modules/ajv/dist/compile/index.d.ts:64 - -___ - -### localRefs - -• `Optional` **localRefs**: [`LocalRefs`](../modules/verida_verifiable_credentials._internal_.md#localrefs) - -#### Implementation of - -[SchemaEnvArgs](../interfaces/verida_verifiable_credentials._internal_.SchemaEnvArgs.md).[localRefs](../interfaces/verida_verifiable_credentials._internal_.SchemaEnvArgs.md#localrefs) - -#### Defined in - -node_modules/ajv/dist/compile/index.d.ts:60 - -___ - -### meta - -• `Optional` `Readonly` **meta**: `boolean` - -#### Implementation of - -[SchemaEnvArgs](../interfaces/verida_verifiable_credentials._internal_.SchemaEnvArgs.md).[meta](../interfaces/verida_verifiable_credentials._internal_.SchemaEnvArgs.md#meta) - -#### Defined in - -node_modules/ajv/dist/compile/index.d.ts:61 - -___ - -### parse - -• `Optional` **parse**: (`data`: `string`) => `unknown` - -#### Type declaration - -▸ (`data`): `unknown` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `string` | - -##### Returns - -`unknown` - -#### Defined in - -node_modules/ajv/dist/compile/index.d.ts:71 - -___ - -### parseName - -• `Optional` **parseName**: [`ValueScopeName`](verida_verifiable_credentials._internal_.ValueScopeName.md) - -#### Defined in - -node_modules/ajv/dist/compile/index.d.ts:72 - -___ - -### refs - -• `Readonly` **refs**: [`SchemaRefs`](../modules/verida_verifiable_credentials._internal_.md#schemarefs) - -#### Defined in - -node_modules/ajv/dist/compile/index.d.ts:63 - -___ - -### root - -• `Readonly` **root**: [`SchemaEnv`](verida_verifiable_credentials._internal_.SchemaEnv.md) - -#### Implementation of - -[SchemaEnvArgs](../interfaces/verida_verifiable_credentials._internal_.SchemaEnvArgs.md).[root](../interfaces/verida_verifiable_credentials._internal_.SchemaEnvArgs.md#root) - -#### Defined in - -node_modules/ajv/dist/compile/index.d.ts:57 - -___ - -### schema - -• `Readonly` **schema**: [`AnySchema`](../modules/verida_verifiable_credentials._internal_.md#anyschema) - -#### Implementation of - -[SchemaEnvArgs](../interfaces/verida_verifiable_credentials._internal_.SchemaEnvArgs.md).[schema](../interfaces/verida_verifiable_credentials._internal_.SchemaEnvArgs.md#schema) - -#### Defined in - -node_modules/ajv/dist/compile/index.d.ts:55 - -___ - -### schemaId - -• `Optional` `Readonly` **schemaId**: ``"id"`` \| ``"$id"`` - -#### Implementation of - -[SchemaEnvArgs](../interfaces/verida_verifiable_credentials._internal_.SchemaEnvArgs.md).[schemaId](../interfaces/verida_verifiable_credentials._internal_.SchemaEnvArgs.md#schemaid) - -#### Defined in - -node_modules/ajv/dist/compile/index.d.ts:56 - -___ - -### schemaPath - -• `Optional` **schemaPath**: `string` - -#### Implementation of - -[SchemaEnvArgs](../interfaces/verida_verifiable_credentials._internal_.SchemaEnvArgs.md).[schemaPath](../interfaces/verida_verifiable_credentials._internal_.SchemaEnvArgs.md#schemapath) - -#### Defined in - -node_modules/ajv/dist/compile/index.d.ts:59 - -___ - -### serialize - -• `Optional` **serialize**: (`data`: `unknown`) => `string` - -#### Type declaration - -▸ (`data`): `string` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `unknown` | - -##### Returns - -`string` - -#### Defined in - -node_modules/ajv/dist/compile/index.d.ts:69 - -___ - -### serializeName - -• `Optional` **serializeName**: [`ValueScopeName`](verida_verifiable_credentials._internal_.ValueScopeName.md) - -#### Defined in - -node_modules/ajv/dist/compile/index.d.ts:70 - -___ - -### validate - -• `Optional` **validate**: [`AnyValidateFunction`](../modules/verida_verifiable_credentials._internal_.md#anyvalidatefunction)<`any`\> - -#### Defined in - -node_modules/ajv/dist/compile/index.d.ts:67 - -___ - -### validateName - -• `Optional` **validateName**: [`ValueScopeName`](verida_verifiable_credentials._internal_.ValueScopeName.md) - -#### Defined in - -node_modules/ajv/dist/compile/index.d.ts:68 diff --git a/docs/api/verida-js/classes/verida_verifiable_credentials._internal_.Scope.md b/docs/api/verida-js/classes/verida_verifiable_credentials._internal_.Scope.md deleted file mode 100644 index b8eb56a..0000000 --- a/docs/api/verida-js/classes/verida_verifiable_credentials._internal_.Scope.md +++ /dev/null @@ -1,146 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / Scope - -# Class: Scope - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md).Scope - -## Hierarchy - -- **`Scope`** - - ↳ [`ValueScope`](verida_verifiable_credentials._internal_.ValueScope.md) - -## Table of contents - -### Constructors - -- [constructor](verida_verifiable_credentials._internal_.Scope.md#constructor) - -### Properties - -- [\_nameGroup](verida_verifiable_credentials._internal_.Scope.md#_namegroup) -- [\_names](verida_verifiable_credentials._internal_.Scope.md#_names) -- [\_parent](verida_verifiable_credentials._internal_.Scope.md#_parent) -- [\_prefixes](verida_verifiable_credentials._internal_.Scope.md#_prefixes) - -### Methods - -- [\_newName](verida_verifiable_credentials._internal_.Scope.md#_newname) -- [name](verida_verifiable_credentials._internal_.Scope.md#name) -- [toName](verida_verifiable_credentials._internal_.Scope.md#toname) - -## Constructors - -### constructor - -• **new Scope**(`__namedParameters?`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `__namedParameters?` | [`ScopeOptions`](../interfaces/verida_verifiable_credentials._internal_.ScopeOptions.md) | - -#### Defined in - -node_modules/ajv/dist/compile/codegen/scope.d.ts:46 - -## Properties - -### \_nameGroup - -• `Private` **\_nameGroup**: `any` - -#### Defined in - -node_modules/ajv/dist/compile/codegen/scope.d.ts:50 - -___ - -### \_names - -• `Protected` `Readonly` **\_names**: `Object` - -#### Defined in - -node_modules/ajv/dist/compile/codegen/scope.d.ts:41 - -___ - -### \_parent - -• `Protected` `Optional` `Readonly` **\_parent**: [`Scope`](verida_verifiable_credentials._internal_.Scope.md) - -#### Defined in - -node_modules/ajv/dist/compile/codegen/scope.d.ts:45 - -___ - -### \_prefixes - -• `Protected` `Optional` `Readonly` **\_prefixes**: `Set`<`string`\> - -#### Defined in - -node_modules/ajv/dist/compile/codegen/scope.d.ts:44 - -## Methods - -### \_newName - -▸ `Protected` **_newName**(`prefix`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `prefix` | `string` | - -#### Returns - -`string` - -#### Defined in - -node_modules/ajv/dist/compile/codegen/scope.d.ts:49 - -___ - -### name - -▸ **name**(`prefix`): [`Name`](verida_verifiable_credentials._internal_.Name.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `prefix` | `string` | - -#### Returns - -[`Name`](verida_verifiable_credentials._internal_.Name.md) - -#### Defined in - -node_modules/ajv/dist/compile/codegen/scope.d.ts:48 - -___ - -### toName - -▸ **toName**(`nameOrPrefix`): [`Name`](verida_verifiable_credentials._internal_.Name.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `nameOrPrefix` | `string` \| [`Name`](verida_verifiable_credentials._internal_.Name.md) | - -#### Returns - -[`Name`](verida_verifiable_credentials._internal_.Name.md) - -#### Defined in - -node_modules/ajv/dist/compile/codegen/scope.d.ts:47 diff --git a/docs/api/verida-js/classes/verida_verifiable_credentials._internal_.ValueScope.md b/docs/api/verida-js/classes/verida_verifiable_credentials._internal_.ValueScope.md deleted file mode 100644 index d2fd4ba..0000000 --- a/docs/api/verida-js/classes/verida_verifiable_credentials._internal_.ValueScope.md +++ /dev/null @@ -1,311 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / ValueScope - -# Class: ValueScope - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md).ValueScope - -## Hierarchy - -- [`Scope`](verida_verifiable_credentials._internal_.Scope.md) - - ↳ **`ValueScope`** - -## Table of contents - -### Constructors - -- [constructor](verida_verifiable_credentials._internal_.ValueScope.md#constructor) - -### Properties - -- [\_names](verida_verifiable_credentials._internal_.ValueScope.md#_names) -- [\_parent](verida_verifiable_credentials._internal_.ValueScope.md#_parent) -- [\_prefixes](verida_verifiable_credentials._internal_.ValueScope.md#_prefixes) -- [\_reduceValues](verida_verifiable_credentials._internal_.ValueScope.md#_reducevalues) -- [\_scope](verida_verifiable_credentials._internal_.ValueScope.md#_scope) -- [\_values](verida_verifiable_credentials._internal_.ValueScope.md#_values) -- [opts](verida_verifiable_credentials._internal_.ValueScope.md#opts) - -### Methods - -- [\_newName](verida_verifiable_credentials._internal_.ValueScope.md#_newname) -- [get](verida_verifiable_credentials._internal_.ValueScope.md#get) -- [getValue](verida_verifiable_credentials._internal_.ValueScope.md#getvalue) -- [name](verida_verifiable_credentials._internal_.ValueScope.md#name) -- [scopeCode](verida_verifiable_credentials._internal_.ValueScope.md#scopecode) -- [scopeRefs](verida_verifiable_credentials._internal_.ValueScope.md#scoperefs) -- [toName](verida_verifiable_credentials._internal_.ValueScope.md#toname) -- [value](verida_verifiable_credentials._internal_.ValueScope.md#value) - -## Constructors - -### constructor - -• **new ValueScope**(`opts`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `opts` | [`ValueScopeOptions`](../interfaces/verida_verifiable_credentials._internal_.ValueScopeOptions.md) | - -#### Overrides - -[Scope](verida_verifiable_credentials._internal_.Scope.md).[constructor](verida_verifiable_credentials._internal_.Scope.md#constructor) - -#### Defined in - -node_modules/ajv/dist/compile/codegen/scope.d.ts:70 - -## Properties - -### \_names - -• `Protected` `Readonly` **\_names**: `Object` - -#### Inherited from - -[Scope](verida_verifiable_credentials._internal_.Scope.md).[_names](verida_verifiable_credentials._internal_.Scope.md#_names) - -#### Defined in - -node_modules/ajv/dist/compile/codegen/scope.d.ts:41 - -___ - -### \_parent - -• `Protected` `Optional` `Readonly` **\_parent**: [`Scope`](verida_verifiable_credentials._internal_.Scope.md) - -#### Inherited from - -[Scope](verida_verifiable_credentials._internal_.Scope.md).[_parent](verida_verifiable_credentials._internal_.Scope.md#_parent) - -#### Defined in - -node_modules/ajv/dist/compile/codegen/scope.d.ts:45 - -___ - -### \_prefixes - -• `Protected` `Optional` `Readonly` **\_prefixes**: `Set`<`string`\> - -#### Inherited from - -[Scope](verida_verifiable_credentials._internal_.Scope.md).[_prefixes](verida_verifiable_credentials._internal_.Scope.md#_prefixes) - -#### Defined in - -node_modules/ajv/dist/compile/codegen/scope.d.ts:44 - -___ - -### \_reduceValues - -• `Private` **\_reduceValues**: `any` - -#### Defined in - -node_modules/ajv/dist/compile/codegen/scope.d.ts:77 - -___ - -### \_scope - -• `Protected` `Readonly` **\_scope**: [`ScopeStore`](../modules/verida_verifiable_credentials._internal_.md#scopestore) - -#### Defined in - -node_modules/ajv/dist/compile/codegen/scope.d.ts:68 - -___ - -### \_values - -• `Protected` `Readonly` **\_values**: [`ScopeValues`](../modules/verida_verifiable_credentials._internal_.md#scopevalues) - -#### Defined in - -node_modules/ajv/dist/compile/codegen/scope.d.ts:67 - -___ - -### opts - -• `Readonly` **opts**: [`VSOptions`](../interfaces/verida_verifiable_credentials._internal_.VSOptions.md) - -#### Defined in - -node_modules/ajv/dist/compile/codegen/scope.d.ts:69 - -## Methods - -### \_newName - -▸ `Protected` **_newName**(`prefix`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `prefix` | `string` | - -#### Returns - -`string` - -#### Inherited from - -[Scope](verida_verifiable_credentials._internal_.Scope.md).[_newName](verida_verifiable_credentials._internal_.Scope.md#_newname) - -#### Defined in - -node_modules/ajv/dist/compile/codegen/scope.d.ts:49 - -___ - -### get - -▸ **get**(): [`ScopeStore`](../modules/verida_verifiable_credentials._internal_.md#scopestore) - -#### Returns - -[`ScopeStore`](../modules/verida_verifiable_credentials._internal_.md#scopestore) - -#### Defined in - -node_modules/ajv/dist/compile/codegen/scope.d.ts:71 - -___ - -### getValue - -▸ **getValue**(`prefix`, `keyOrRef`): `undefined` \| [`ValueScopeName`](verida_verifiable_credentials._internal_.ValueScopeName.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `prefix` | `string` | -| `keyOrRef` | `unknown` | - -#### Returns - -`undefined` \| [`ValueScopeName`](verida_verifiable_credentials._internal_.ValueScopeName.md) - -#### Defined in - -node_modules/ajv/dist/compile/codegen/scope.d.ts:74 - -___ - -### name - -▸ **name**(`prefix`): [`ValueScopeName`](verida_verifiable_credentials._internal_.ValueScopeName.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `prefix` | `string` | - -#### Returns - -[`ValueScopeName`](verida_verifiable_credentials._internal_.ValueScopeName.md) - -#### Overrides - -[Scope](verida_verifiable_credentials._internal_.Scope.md).[name](verida_verifiable_credentials._internal_.Scope.md#name) - -#### Defined in - -node_modules/ajv/dist/compile/codegen/scope.d.ts:72 - -___ - -### scopeCode - -▸ **scopeCode**(`values?`, `usedValues?`, `getCode?`): [`Code`](../modules/verida_verifiable_credentials._internal_.md#code) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `values?` | [`ScopeValues`](../modules/verida_verifiable_credentials._internal_.md#scopevalues) \| [`ScopeValueSets`](../modules/verida_verifiable_credentials._internal_.md#scopevaluesets) | -| `usedValues?` | [`UsedScopeValues`](../modules/verida_verifiable_credentials._internal_.md#usedscopevalues) | -| `getCode?` | (`n`: [`ValueScopeName`](verida_verifiable_credentials._internal_.ValueScopeName.md)) => `undefined` \| [`Code`](../modules/verida_verifiable_credentials._internal_.md#code) | - -#### Returns - -[`Code`](../modules/verida_verifiable_credentials._internal_.md#code) - -#### Defined in - -node_modules/ajv/dist/compile/codegen/scope.d.ts:76 - -___ - -### scopeRefs - -▸ **scopeRefs**(`scopeName`, `values?`): [`Code`](../modules/verida_verifiable_credentials._internal_.md#code) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `scopeName` | [`Name`](verida_verifiable_credentials._internal_.Name.md) | -| `values?` | [`ScopeValues`](../modules/verida_verifiable_credentials._internal_.md#scopevalues) \| [`ScopeValueSets`](../modules/verida_verifiable_credentials._internal_.md#scopevaluesets) | - -#### Returns - -[`Code`](../modules/verida_verifiable_credentials._internal_.md#code) - -#### Defined in - -node_modules/ajv/dist/compile/codegen/scope.d.ts:75 - -___ - -### toName - -▸ **toName**(`nameOrPrefix`): [`Name`](verida_verifiable_credentials._internal_.Name.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `nameOrPrefix` | `string` \| [`Name`](verida_verifiable_credentials._internal_.Name.md) | - -#### Returns - -[`Name`](verida_verifiable_credentials._internal_.Name.md) - -#### Inherited from - -[Scope](verida_verifiable_credentials._internal_.Scope.md).[toName](verida_verifiable_credentials._internal_.Scope.md#toname) - -#### Defined in - -node_modules/ajv/dist/compile/codegen/scope.d.ts:47 - -___ - -### value - -▸ **value**(`nameOrPrefix`, `value`): [`ValueScopeName`](verida_verifiable_credentials._internal_.ValueScopeName.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `nameOrPrefix` | `string` \| [`ValueScopeName`](verida_verifiable_credentials._internal_.ValueScopeName.md) | -| `value` | [`NameValue`](../interfaces/verida_verifiable_credentials._internal_.NameValue.md) | - -#### Returns - -[`ValueScopeName`](verida_verifiable_credentials._internal_.ValueScopeName.md) - -#### Defined in - -node_modules/ajv/dist/compile/codegen/scope.d.ts:73 diff --git a/docs/api/verida-js/classes/verida_verifiable_credentials._internal_.ValueScopeName.md b/docs/api/verida-js/classes/verida_verifiable_credentials._internal_.ValueScopeName.md deleted file mode 100644 index ca34966..0000000 --- a/docs/api/verida-js/classes/verida_verifiable_credentials._internal_.ValueScopeName.md +++ /dev/null @@ -1,174 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / ValueScopeName - -# Class: ValueScopeName - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md).ValueScopeName - -## Hierarchy - -- [`Name`](verida_verifiable_credentials._internal_.Name.md) - - ↳ **`ValueScopeName`** - -## Table of contents - -### Constructors - -- [constructor](verida_verifiable_credentials._internal_.ValueScopeName.md#constructor) - -### Properties - -- [prefix](verida_verifiable_credentials._internal_.ValueScopeName.md#prefix) -- [scopePath](verida_verifiable_credentials._internal_.ValueScopeName.md#scopepath) -- [str](verida_verifiable_credentials._internal_.ValueScopeName.md#str) -- [value](verida_verifiable_credentials._internal_.ValueScopeName.md#value) - -### Accessors - -- [names](verida_verifiable_credentials._internal_.ValueScopeName.md#names) - -### Methods - -- [emptyStr](verida_verifiable_credentials._internal_.ValueScopeName.md#emptystr) -- [setValue](verida_verifiable_credentials._internal_.ValueScopeName.md#setvalue) -- [toString](verida_verifiable_credentials._internal_.ValueScopeName.md#tostring) - -## Constructors - -### constructor - -• **new ValueScopeName**(`prefix`, `nameStr`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `prefix` | `string` | -| `nameStr` | `string` | - -#### Overrides - -[Name](verida_verifiable_credentials._internal_.Name.md).[constructor](verida_verifiable_credentials._internal_.Name.md#constructor) - -#### Defined in - -node_modules/ajv/dist/compile/codegen/scope.d.ts:60 - -## Properties - -### prefix - -• `Readonly` **prefix**: `string` - -#### Defined in - -node_modules/ajv/dist/compile/codegen/scope.d.ts:57 - -___ - -### scopePath - -• `Optional` **scopePath**: [`Code`](../modules/verida_verifiable_credentials._internal_.md#code) - -#### Defined in - -node_modules/ajv/dist/compile/codegen/scope.d.ts:59 - -___ - -### str - -• `Readonly` **str**: `string` - -#### Inherited from - -[Name](verida_verifiable_credentials._internal_.Name.md).[str](verida_verifiable_credentials._internal_.Name.md#str) - -#### Defined in - -node_modules/ajv/dist/compile/codegen/code.d.ts:9 - -___ - -### value - -• `Optional` **value**: [`NameValue`](../interfaces/verida_verifiable_credentials._internal_.NameValue.md) - -#### Defined in - -node_modules/ajv/dist/compile/codegen/scope.d.ts:58 - -## Accessors - -### names - -• `get` **names**(): [`UsedNames`](../modules/verida_verifiable_credentials._internal_.md#usednames) - -#### Returns - -[`UsedNames`](../modules/verida_verifiable_credentials._internal_.md#usednames) - -#### Inherited from - -Name.names - -#### Defined in - -node_modules/ajv/dist/compile/codegen/code.d.ts:13 - -## Methods - -### emptyStr - -▸ **emptyStr**(): `boolean` - -#### Returns - -`boolean` - -#### Inherited from - -[Name](verida_verifiable_credentials._internal_.Name.md).[emptyStr](verida_verifiable_credentials._internal_.Name.md#emptystr) - -#### Defined in - -node_modules/ajv/dist/compile/codegen/code.d.ts:12 - -___ - -### setValue - -▸ **setValue**(`value`, `__namedParameters`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | [`NameValue`](../interfaces/verida_verifiable_credentials._internal_.NameValue.md) | -| `__namedParameters` | [`ScopePath`](../interfaces/verida_verifiable_credentials._internal_.ScopePath.md) | - -#### Returns - -`void` - -#### Defined in - -node_modules/ajv/dist/compile/codegen/scope.d.ts:61 - -___ - -### toString - -▸ **toString**(): `string` - -#### Returns - -`string` - -#### Inherited from - -[Name](verida_verifiable_credentials._internal_.Name.md).[toString](verida_verifiable_credentials._internal_.Name.md#tostring) - -#### Defined in - -node_modules/ajv/dist/compile/codegen/code.d.ts:11 diff --git a/docs/api/verida-js/classes/verida_verifiable_credentials._internal_._Code.md b/docs/api/verida-js/classes/verida_verifiable_credentials._internal_._Code.md deleted file mode 100644 index 656153d..0000000 --- a/docs/api/verida-js/classes/verida_verifiable_credentials._internal_._Code.md +++ /dev/null @@ -1,155 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / \_Code - -# Class: \_Code - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md)._Code - -## Hierarchy - -- [`_CodeOrName`](verida_verifiable_credentials._internal_._CodeOrName.md) - - ↳ **`_Code`** - -## Table of contents - -### Constructors - -- [constructor](verida_verifiable_credentials._internal_._Code.md#constructor) - -### Properties - -- [\_items](verida_verifiable_credentials._internal_._Code.md#_items) -- [\_names](verida_verifiable_credentials._internal_._Code.md#_names) -- [\_str](verida_verifiable_credentials._internal_._Code.md#_str) - -### Accessors - -- [names](verida_verifiable_credentials._internal_._Code.md#names) -- [str](verida_verifiable_credentials._internal_._Code.md#str) - -### Methods - -- [emptyStr](verida_verifiable_credentials._internal_._Code.md#emptystr) -- [toString](verida_verifiable_credentials._internal_._Code.md#tostring) - -## Constructors - -### constructor - -• **new _Code**(`code`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `code` | `string` \| readonly [`CodeItem`](../modules/verida_verifiable_credentials._internal_.md#codeitem)[] | - -#### Overrides - -[_CodeOrName](verida_verifiable_credentials._internal_._CodeOrName.md).[constructor](verida_verifiable_credentials._internal_._CodeOrName.md#constructor) - -#### Defined in - -node_modules/ajv/dist/compile/codegen/code.d.ts:19 - -## Properties - -### \_items - -• `Readonly` **\_items**: readonly [`CodeItem`](../modules/verida_verifiable_credentials._internal_.md#codeitem)[] - -#### Defined in - -node_modules/ajv/dist/compile/codegen/code.d.ts:16 - -___ - -### \_names - -• `Private` `Optional` **\_names**: `any` - -#### Defined in - -node_modules/ajv/dist/compile/codegen/code.d.ts:18 - -___ - -### \_str - -• `Private` `Optional` **\_str**: `any` - -#### Defined in - -node_modules/ajv/dist/compile/codegen/code.d.ts:17 - -## Accessors - -### names - -• `get` **names**(): [`UsedNames`](../modules/verida_verifiable_credentials._internal_.md#usednames) - -#### Returns - -[`UsedNames`](../modules/verida_verifiable_credentials._internal_.md#usednames) - -#### Overrides - -\_CodeOrName.names - -#### Defined in - -node_modules/ajv/dist/compile/codegen/code.d.ts:23 - -___ - -### str - -• `get` **str**(): `string` - -#### Returns - -`string` - -#### Overrides - -\_CodeOrName.str - -#### Defined in - -node_modules/ajv/dist/compile/codegen/code.d.ts:22 - -## Methods - -### emptyStr - -▸ **emptyStr**(): `boolean` - -#### Returns - -`boolean` - -#### Overrides - -[_CodeOrName](verida_verifiable_credentials._internal_._CodeOrName.md).[emptyStr](verida_verifiable_credentials._internal_._CodeOrName.md#emptystr) - -#### Defined in - -node_modules/ajv/dist/compile/codegen/code.d.ts:21 - -___ - -### toString - -▸ **toString**(): `string` - -#### Returns - -`string` - -#### Overrides - -[_CodeOrName](verida_verifiable_credentials._internal_._CodeOrName.md).[toString](verida_verifiable_credentials._internal_._CodeOrName.md#tostring) - -#### Defined in - -node_modules/ajv/dist/compile/codegen/code.d.ts:20 diff --git a/docs/api/verida-js/classes/verida_verifiable_credentials._internal_._CodeOrName.md b/docs/api/verida-js/classes/verida_verifiable_credentials._internal_._CodeOrName.md deleted file mode 100644 index ccbd84a..0000000 --- a/docs/api/verida-js/classes/verida_verifiable_credentials._internal_._CodeOrName.md +++ /dev/null @@ -1,83 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / \_CodeOrName - -# Class: \_CodeOrName - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md)._CodeOrName - -## Hierarchy - -- **`_CodeOrName`** - - ↳ [`Name`](verida_verifiable_credentials._internal_.Name.md) - - ↳ [`_Code`](verida_verifiable_credentials._internal_._Code.md) - -## Table of contents - -### Constructors - -- [constructor](verida_verifiable_credentials._internal_._CodeOrName.md#constructor) - -### Properties - -- [names](verida_verifiable_credentials._internal_._CodeOrName.md#names) -- [str](verida_verifiable_credentials._internal_._CodeOrName.md#str) - -### Methods - -- [emptyStr](verida_verifiable_credentials._internal_._CodeOrName.md#emptystr) -- [toString](verida_verifiable_credentials._internal_._CodeOrName.md#tostring) - -## Constructors - -### constructor - -• **new _CodeOrName**() - -## Properties - -### names - -• `Readonly` `Abstract` **names**: [`UsedNames`](../modules/verida_verifiable_credentials._internal_.md#usednames) - -#### Defined in - -node_modules/ajv/dist/compile/codegen/code.d.ts:3 - -___ - -### str - -• `Readonly` `Abstract` **str**: `string` - -#### Defined in - -node_modules/ajv/dist/compile/codegen/code.d.ts:2 - -## Methods - -### emptyStr - -▸ `Abstract` **emptyStr**(): `boolean` - -#### Returns - -`boolean` - -#### Defined in - -node_modules/ajv/dist/compile/codegen/code.d.ts:5 - -___ - -### toString - -▸ `Abstract` **toString**(): `string` - -#### Returns - -`string` - -#### Defined in - -node_modules/ajv/dist/compile/codegen/code.d.ts:4 diff --git a/docs/api/verida-js/classes/verida_verifiable_credentials._internal_.default-1.md b/docs/api/verida-js/classes/verida_verifiable_credentials._internal_.default-1.md deleted file mode 100644 index e3eda9f..0000000 --- a/docs/api/verida-js/classes/verida_verifiable_credentials._internal_.default-1.md +++ /dev/null @@ -1,176 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / default - -# Class: default - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md).default - -## Table of contents - -### Constructors - -- [constructor](verida_verifiable_credentials._internal_.default-1.md#constructor) - -### Properties - -- [did](verida_verifiable_credentials._internal_.default-1.md#did) -- [endpointUrl](verida_verifiable_credentials._internal_.default-1.md#endpointurl) -- [privateKey](verida_verifiable_credentials._internal_.default-1.md#privatekey) -- [wallet](verida_verifiable_credentials._internal_.default-1.md#wallet) - -### Methods - -- [authenticate](verida_verifiable_credentials._internal_.default-1.md#authenticate) -- [get](verida_verifiable_credentials._internal_.default-1.md#get) -- [getDid](verida_verifiable_credentials._internal_.default-1.md#getdid) -- [getPublicKey](verida_verifiable_credentials._internal_.default-1.md#getpublickey) -- [save](verida_verifiable_credentials._internal_.default-1.md#save) - -## Constructors - -### constructor - -• **new default**(`endpointUrl`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `endpointUrl` | `string` | - -#### Defined in - -packages/did-client/dist/did-client.d.ts:7 - -## Properties - -### did - -• `Private` `Optional` **did**: `any` - -#### Defined in - -packages/did-client/dist/did-client.d.ts:5 - -___ - -### endpointUrl - -• `Private` **endpointUrl**: `any` - -#### Defined in - -packages/did-client/dist/did-client.d.ts:3 - -___ - -### privateKey - -• `Private` `Optional` **privateKey**: `any` - -#### Defined in - -packages/did-client/dist/did-client.d.ts:4 - -___ - -### wallet - -• `Private` `Optional` **wallet**: `any` - -#### Defined in - -packages/did-client/dist/did-client.d.ts:6 - -## Methods - -### authenticate - -▸ **authenticate**(`privateKey`): `void` - -Authenticate using a privateKey or seed phrase. - -This allows the DIDClient to sign DIDDocuments before saving - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `privateKey` | `string` | Hex representation of the private key or a mnemonic | - -#### Returns - -`void` - -#### Defined in - -packages/did-client/dist/did-client.d.ts:15 - -___ - -### get - -▸ **get**(`did`): `Promise`<`undefined` \| [`default`](verida_verifiable_credentials._internal_.default-3.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did` | `string` | - -#### Returns - -`Promise`<`undefined` \| [`default`](verida_verifiable_credentials._internal_.default-3.md)\> - -#### Defined in - -packages/did-client/dist/did-client.d.ts:25 - -___ - -### getDid - -▸ **getDid**(): `undefined` \| `string` - -#### Returns - -`undefined` \| `string` - -#### Defined in - -packages/did-client/dist/did-client.d.ts:16 - -___ - -### getPublicKey - -▸ **getPublicKey**(): `string` - -#### Returns - -`string` - -#### Defined in - -packages/did-client/dist/did-client.d.ts:17 - -___ - -### save - -▸ **save**(`document`): `Promise`<`boolean`\> - -Save a DID document - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `document` | [`default`](verida_verifiable_credentials._internal_.default-3.md) | - -#### Returns - -`Promise`<`boolean`\> - -#### Defined in - -packages/did-client/dist/did-client.d.ts:24 diff --git a/docs/api/verida-js/classes/verida_verifiable_credentials._internal_.default-2.md b/docs/api/verida-js/classes/verida_verifiable_credentials._internal_.default-2.md deleted file mode 100644 index 8cb6da3..0000000 --- a/docs/api/verida-js/classes/verida_verifiable_credentials._internal_.default-2.md +++ /dev/null @@ -1,368 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / default - -# Class: default - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md).default - -Class that takes a signature (generated from a signed consent message) and generates a -collection of asymmetric keys, symmetric key and signing key for a given secure storage -context. - -## Table of contents - -### Constructors - -- [constructor](verida_verifiable_credentials._internal_.default-2.md#constructor) - -### Properties - -- [asymKeyPair](verida_verifiable_credentials._internal_.default-2.md#asymkeypair) -- [buildKey](verida_verifiable_credentials._internal_.default-2.md#buildkey) -- [seed](verida_verifiable_credentials._internal_.default-2.md#seed) -- [signKeyPair](verida_verifiable_credentials._internal_.default-2.md#signkeypair) -- [storageContextKeys](verida_verifiable_credentials._internal_.default-2.md#storagecontextkeys) -- [symKey](verida_verifiable_credentials._internal_.default-2.md#symkey) - -### Methods - -- [\_init](verida_verifiable_credentials._internal_.default-2.md#_init) -- [asymDecrypt](verida_verifiable_credentials._internal_.default-2.md#asymdecrypt) -- [asymEncrypt](verida_verifiable_credentials._internal_.default-2.md#asymencrypt) -- [buildSharedKeyEnd](verida_verifiable_credentials._internal_.default-2.md#buildsharedkeyend) -- [buildSharedKeyStart](verida_verifiable_credentials._internal_.default-2.md#buildsharedkeystart) -- [getKeys](verida_verifiable_credentials._internal_.default-2.md#getkeys) -- [getSeed](verida_verifiable_credentials._internal_.default-2.md#getseed) -- [getStorageContextKey](verida_verifiable_credentials._internal_.default-2.md#getstoragecontextkey) -- [publicKeys](verida_verifiable_credentials._internal_.default-2.md#publickeys) -- [sign](verida_verifiable_credentials._internal_.default-2.md#sign) -- [symDecrypt](verida_verifiable_credentials._internal_.default-2.md#symdecrypt) -- [symEncrypt](verida_verifiable_credentials._internal_.default-2.md#symencrypt) -- [verifySig](verida_verifiable_credentials._internal_.default-2.md#verifysig) - -## Constructors - -### constructor - -• **new default**(`seed`) - -A string used as a seed for this keyring. -The seed should be a hex signature obtained by 3ID signed consent message. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `seed` | `string` | - -#### Defined in - -packages/keyring/dist/keyring.d.ts:19 - -## Properties - -### asymKeyPair - -• `Optional` **asymKeyPair**: [`BoxKeyPair`](../interfaces/verida_verifiable_credentials._internal_.BoxKeyPair.md) - -#### Defined in - -packages/keyring/dist/keyring.d.ts:8 - -___ - -### buildKey - -• `Private` **buildKey**: `any` - -Helper function that generates a key of the appropriate type - -**`param`** - -**`param`** - -**`returns`** - -#### Defined in - -packages/keyring/dist/keyring.d.ts:29 - -___ - -### seed - -• `Private` **seed**: `any` - -#### Defined in - -packages/keyring/dist/keyring.d.ts:11 - -___ - -### signKeyPair - -• `Optional` **signKeyPair**: [`SignKeyPair`](../interfaces/verida_verifiable_credentials._internal_.SignKeyPair.md) - -#### Defined in - -packages/keyring/dist/keyring.d.ts:9 - -___ - -### storageContextKeys - -• `Private` **storageContextKeys**: `any` - -#### Defined in - -packages/keyring/dist/keyring.d.ts:12 - -___ - -### symKey - -• `Optional` **symKey**: `Uint8Array` - -#### Defined in - -packages/keyring/dist/keyring.d.ts:10 - -## Methods - -### \_init - -▸ **_init**(): `Promise`<`void`\> - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -packages/keyring/dist/keyring.d.ts:21 - -___ - -### asymDecrypt - -▸ **asymDecrypt**(`messageWithNonce`, `secretOrSharedKey`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `messageWithNonce` | `string` | -| `secretOrSharedKey` | `Uint8Array` | - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -packages/keyring/dist/keyring.d.ts:48 - -___ - -### asymEncrypt - -▸ **asymEncrypt**(`data`, `secretOrSharedKey`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `string` | -| `secretOrSharedKey` | `Uint8Array` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -packages/keyring/dist/keyring.d.ts:47 - -___ - -### buildSharedKeyEnd - -▸ **buildSharedKeyEnd**(`publicKey`): `Promise`<`Uint8Array`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `publicKey` | `Uint8Array` | - -#### Returns - -`Promise`<`Uint8Array`\> - -#### Defined in - -packages/keyring/dist/keyring.d.ts:50 - -___ - -### buildSharedKeyStart - -▸ **buildSharedKeyStart**(`privateKey`): `Promise`<`Uint8Array`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `privateKey` | `Uint8Array` | - -#### Returns - -`Promise`<`Uint8Array`\> - -#### Defined in - -packages/keyring/dist/keyring.d.ts:49 - -___ - -### getKeys - -▸ **getKeys**(): `Promise`<`any`\> - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -packages/keyring/dist/keyring.d.ts:20 - -___ - -### getSeed - -▸ **getSeed**(): `string` - -#### Returns - -`string` - -#### Defined in - -packages/keyring/dist/keyring.d.ts:51 - -___ - -### getStorageContextKey - -▸ **getStorageContextKey**(`databaseName`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `databaseName` | `string` | - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -packages/keyring/dist/keyring.d.ts:52 - -___ - -### publicKeys - -▸ **publicKeys**(): `Promise`<{ `asymPublicKey`: `Uint8Array` ; `asymPublicKeyBase58`: `string` ; `asymPublicKeyHex`: `string` ; `signPublicKey`: `Uint8Array` ; `signPublicKeyBase58`: `string` ; `signPublicKeyHex`: `string` }\> - -Generate an object containing all the public keys for this Keyring - -#### Returns - -`Promise`<{ `asymPublicKey`: `Uint8Array` ; `asymPublicKeyBase58`: `string` ; `asymPublicKeyHex`: `string` ; `signPublicKey`: `Uint8Array` ; `signPublicKeyBase58`: `string` ; `signPublicKeyHex`: `string` }\> - -#### Defined in - -packages/keyring/dist/keyring.d.ts:35 - -___ - -### sign - -▸ **sign**(`data`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `any` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -packages/keyring/dist/keyring.d.ts:43 - -___ - -### symDecrypt - -▸ **symDecrypt**(`data`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `string` | - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -packages/keyring/dist/keyring.d.ts:46 - -___ - -### symEncrypt - -▸ **symEncrypt**(`data`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -packages/keyring/dist/keyring.d.ts:45 - -___ - -### verifySig - -▸ **verifySig**(`data`, `sig`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `string` | -| `sig` | `string` | - -#### Returns - -`Promise`<`boolean`\> - -#### Defined in - -packages/keyring/dist/keyring.d.ts:44 diff --git a/docs/api/verida-js/classes/verida_verifiable_credentials._internal_.default-3.md b/docs/api/verida-js/classes/verida_verifiable_credentials._internal_.default-3.md deleted file mode 100644 index 97a5f6f..0000000 --- a/docs/api/verida-js/classes/verida_verifiable_credentials._internal_.default-3.md +++ /dev/null @@ -1,378 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / default - -# Class: default - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md).default - -## Table of contents - -### Constructors - -- [constructor](verida_verifiable_credentials._internal_.default-3.md#constructor) - -### Properties - -- [doc](verida_verifiable_credentials._internal_.default-3.md#doc) -- [errors](verida_verifiable_credentials._internal_.default-3.md#errors) -- [getProofData](verida_verifiable_credentials._internal_.default-3.md#getproofdata) - -### Accessors - -- [id](verida_verifiable_credentials._internal_.default-3.md#id) - -### Methods - -- [addContext](verida_verifiable_credentials._internal_.default-3.md#addcontext) -- [addContextAsymKey](verida_verifiable_credentials._internal_.default-3.md#addcontextasymkey) -- [addContextService](verida_verifiable_credentials._internal_.default-3.md#addcontextservice) -- [addContextSignKey](verida_verifiable_credentials._internal_.default-3.md#addcontextsignkey) -- [export](verida_verifiable_credentials._internal_.default-3.md#export) -- [getErrors](verida_verifiable_credentials._internal_.default-3.md#geterrors) -- [import](verida_verifiable_credentials._internal_.default-3.md#import) -- [locateServiceEndpoint](verida_verifiable_credentials._internal_.default-3.md#locateserviceendpoint) -- [removeContext](verida_verifiable_credentials._internal_.default-3.md#removecontext) -- [signProof](verida_verifiable_credentials._internal_.default-3.md#signproof) -- [verifyContextSignature](verida_verifiable_credentials._internal_.default-3.md#verifycontextsignature) -- [verifyProof](verida_verifiable_credentials._internal_.default-3.md#verifyproof) -- [verifySig](verida_verifiable_credentials._internal_.default-3.md#verifysig) -- [generateContextHash](verida_verifiable_credentials._internal_.default-3.md#generatecontexthash) - -## Constructors - -### constructor - -• **new default**(`doc`, `publicKeyHex?`) - -Force lower case DID as we can't guarantee the DID will always be provided with checksum - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `doc` | `string` \| [`DIDDocumentStruct`](../interfaces/verida_verifiable_credentials._internal_.DIDDocumentStruct.md) | -| `publicKeyHex?` | `string` | - -#### Defined in - -packages/did-document/dist/did-document.d.ts:12 - -## Properties - -### doc - -• `Private` **doc**: `any` - -#### Defined in - -packages/did-document/dist/did-document.d.ts:5 - -___ - -### errors - -• `Protected` **errors**: `string`[] - -#### Defined in - -packages/did-document/dist/did-document.d.ts:6 - -___ - -### getProofData - -• `Private` **getProofData**: `any` - -#### Defined in - -packages/did-document/dist/did-document.d.ts:33 - -## Accessors - -### id - -• `get` **id**(): `string` - -#### Returns - -`string` - -#### Defined in - -packages/did-document/dist/did-document.d.ts:13 - -## Methods - -### addContext - -▸ **addContext**(`contextName`, `keyring`, `endpoints`): `Promise`<`void`\> - -Not used directly, used for testing - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | -| `keyring` | [`default`](verida_verifiable_credentials._internal_.default-2.md) | -| `endpoints` | [`Endpoints`](../interfaces/verida_verifiable_credentials._internal_.Endpoints.md) | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -packages/did-document/dist/did-document.d.ts:22 - -___ - -### addContextAsymKey - -▸ **addContextAsymKey**(`contextHash`, `publicKeyHex`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextHash` | `string` | -| `publicKeyHex` | `string` | - -#### Returns - -`void` - -#### Defined in - -packages/did-document/dist/did-document.d.ts:28 - -___ - -### addContextService - -▸ **addContextService**(`contextHash`, `endpointType`, `serviceType`, `endpointUri`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextHash` | `string` | -| `endpointType` | [`EndpointType`](../enums/verida_verifiable_credentials._internal_.EndpointType.md) | -| `serviceType` | `string` | -| `endpointUri` | `string` | - -#### Returns - -`void` - -#### Defined in - -packages/did-document/dist/did-document.d.ts:26 - -___ - -### addContextSignKey - -▸ **addContextSignKey**(`contextHash`, `publicKeyHex`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextHash` | `string` | -| `publicKeyHex` | `string` | - -#### Returns - -`void` - -#### Defined in - -packages/did-document/dist/did-document.d.ts:27 - -___ - -### export - -▸ **export**(): [`DIDDocumentStruct`](../interfaces/verida_verifiable_credentials._internal_.DIDDocumentStruct.md) - -#### Returns - -[`DIDDocumentStruct`](../interfaces/verida_verifiable_credentials._internal_.DIDDocumentStruct.md) - -#### Defined in - -packages/did-document/dist/did-document.d.ts:25 - -___ - -### getErrors - -▸ **getErrors**(): `string`[] - -#### Returns - -`string`[] - -#### Defined in - -packages/did-document/dist/did-document.d.ts:14 - -___ - -### import - -▸ **import**(`doc`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `doc` | [`DIDDocumentStruct`](../interfaces/verida_verifiable_credentials._internal_.DIDDocumentStruct.md) | - -#### Returns - -`void` - -#### Defined in - -packages/did-document/dist/did-document.d.ts:24 - -___ - -### locateServiceEndpoint - -▸ **locateServiceEndpoint**(`contextName`, `endpointType`): `undefined` \| [`ServiceEndpoint`](../interfaces/verida_verifiable_credentials._internal_.ServiceEndpoint.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | -| `endpointType` | [`EndpointType`](../enums/verida_verifiable_credentials._internal_.EndpointType.md) | - -#### Returns - -`undefined` \| [`ServiceEndpoint`](../interfaces/verida_verifiable_credentials._internal_.ServiceEndpoint.md) - -#### Defined in - -packages/did-document/dist/did-document.d.ts:35 - -___ - -### removeContext - -▸ **removeContext**(`contextName`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | - -#### Returns - -`boolean` - -#### Defined in - -packages/did-document/dist/did-document.d.ts:23 - -___ - -### signProof - -▸ **signProof**(`privateKey`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `privateKey` | `string` \| `Uint8Array` | - -#### Returns - -`void` - -#### Defined in - -packages/did-document/dist/did-document.d.ts:29 - -___ - -### verifyContextSignature - -▸ **verifyContextSignature**(`data`, `contextName`, `signature`, `contextIsHash?`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `any` | -| `contextName` | `string` | -| `signature` | `string` | -| `contextIsHash?` | `boolean` | - -#### Returns - -`boolean` - -#### Defined in - -packages/did-document/dist/did-document.d.ts:32 - -___ - -### verifyProof - -▸ **verifyProof**(): `boolean` - -#### Returns - -`boolean` - -#### Defined in - -packages/did-document/dist/did-document.d.ts:30 - -___ - -### verifySig - -▸ **verifySig**(`data`, `signature`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `any` | -| `signature` | `string` | - -#### Returns - -`boolean` - -#### Defined in - -packages/did-document/dist/did-document.d.ts:31 - -___ - -### generateContextHash - -▸ `Static` **generateContextHash**(`did`, `contextName`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did` | `string` | -| `contextName` | `string` | - -#### Returns - -`string` - -#### Defined in - -packages/did-document/dist/did-document.d.ts:34 diff --git a/docs/api/verida-js/classes/verida_verifiable_credentials._internal_.default-4.md b/docs/api/verida-js/classes/verida_verifiable_credentials._internal_.default-4.md deleted file mode 100644 index 02241cb..0000000 --- a/docs/api/verida-js/classes/verida_verifiable_credentials._internal_.default-4.md +++ /dev/null @@ -1,948 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / default - -# Class: default - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md).default - -## Hierarchy - -- **`default`** - - ↳ [`Ajv2020`](verida_verifiable_credentials._internal_.Ajv2020.md) - -## Table of contents - -### Constructors - -- [constructor](verida_verifiable_credentials._internal_.default-4.md#constructor) - -### Properties - -- [RULES](verida_verifiable_credentials._internal_.default-4.md#rules) -- [\_cache](verida_verifiable_credentials._internal_.default-4.md#_cache) -- [\_checkUnique](verida_verifiable_credentials._internal_.default-4.md#_checkunique) -- [\_compilations](verida_verifiable_credentials._internal_.default-4.md#_compilations) -- [\_compileMetaSchema](verida_verifiable_credentials._internal_.default-4.md#_compilemetaschema) -- [\_compileSchemaEnv](verida_verifiable_credentials._internal_.default-4.md#_compileschemaenv) -- [\_loading](verida_verifiable_credentials._internal_.default-4.md#_loading) -- [\_metaOpts](verida_verifiable_credentials._internal_.default-4.md#_metaopts) -- [\_removeAllSchemas](verida_verifiable_credentials._internal_.default-4.md#_removeallschemas) -- [errors](verida_verifiable_credentials._internal_.default-4.md#errors) -- [formats](verida_verifiable_credentials._internal_.default-4.md#formats) -- [logger](verida_verifiable_credentials._internal_.default-4.md#logger) -- [opts](verida_verifiable_credentials._internal_.default-4.md#opts) -- [refs](verida_verifiable_credentials._internal_.default-4.md#refs) -- [schemas](verida_verifiable_credentials._internal_.default-4.md#schemas) -- [scope](verida_verifiable_credentials._internal_.default-4.md#scope) -- [MissingRefError](verida_verifiable_credentials._internal_.default-4.md#missingreferror) -- [ValidationError](verida_verifiable_credentials._internal_.default-4.md#validationerror) - -### Methods - -- [$dataMetaSchema](verida_verifiable_credentials._internal_.default-4.md#$datametaschema) -- [\_addDefaultMetaSchema](verida_verifiable_credentials._internal_.default-4.md#_adddefaultmetaschema) -- [\_addSchema](verida_verifiable_credentials._internal_.default-4.md#_addschema) -- [\_addVocabularies](verida_verifiable_credentials._internal_.default-4.md#_addvocabularies) -- [addFormat](verida_verifiable_credentials._internal_.default-4.md#addformat) -- [addKeyword](verida_verifiable_credentials._internal_.default-4.md#addkeyword) -- [addMetaSchema](verida_verifiable_credentials._internal_.default-4.md#addmetaschema) -- [addSchema](verida_verifiable_credentials._internal_.default-4.md#addschema) -- [addVocabulary](verida_verifiable_credentials._internal_.default-4.md#addvocabulary) -- [compile](verida_verifiable_credentials._internal_.default-4.md#compile) -- [compileAsync](verida_verifiable_credentials._internal_.default-4.md#compileasync) -- [defaultMeta](verida_verifiable_credentials._internal_.default-4.md#defaultmeta) -- [errorsText](verida_verifiable_credentials._internal_.default-4.md#errorstext) -- [getKeyword](verida_verifiable_credentials._internal_.default-4.md#getkeyword) -- [getSchema](verida_verifiable_credentials._internal_.default-4.md#getschema) -- [removeKeyword](verida_verifiable_credentials._internal_.default-4.md#removekeyword) -- [removeSchema](verida_verifiable_credentials._internal_.default-4.md#removeschema) -- [validate](verida_verifiable_credentials._internal_.default-4.md#validate) -- [validateSchema](verida_verifiable_credentials._internal_.default-4.md#validateschema) - -## Constructors - -### constructor - -• **new default**(`opts?`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `opts?` | [`Options`](../modules/verida_verifiable_credentials._internal_.md#options) | - -#### Defined in - -node_modules/ajv/dist/core.d.ts:123 - -## Properties - -### RULES - -• `Readonly` **RULES**: [`ValidationRules`](../interfaces/verida_verifiable_credentials._internal_.ValidationRules.md) - -#### Defined in - -node_modules/ajv/dist/core.d.ts:116 - -___ - -### \_cache - -• `Private` `Readonly` **\_cache**: `any` - -#### Defined in - -node_modules/ajv/dist/core.d.ts:119 - -___ - -### \_checkUnique - -• `Private` **\_checkUnique**: `any` - -#### Defined in - -node_modules/ajv/dist/core.d.ts:162 - -___ - -### \_compilations - -• `Readonly` **\_compilations**: `Set`<[`SchemaEnv`](verida_verifiable_credentials._internal_.SchemaEnv.md)\> - -#### Defined in - -node_modules/ajv/dist/core.d.ts:117 - -___ - -### \_compileMetaSchema - -• `Private` **\_compileMetaSchema**: `any` - -#### Defined in - -node_modules/ajv/dist/core.d.ts:164 - -___ - -### \_compileSchemaEnv - -• `Private` **\_compileSchemaEnv**: `any` - -#### Defined in - -node_modules/ajv/dist/core.d.ts:163 - -___ - -### \_loading - -• `Private` `Readonly` **\_loading**: `any` - -#### Defined in - -node_modules/ajv/dist/core.d.ts:118 - -___ - -### \_metaOpts - -• `Private` `Readonly` **\_metaOpts**: `any` - -#### Defined in - -node_modules/ajv/dist/core.d.ts:120 - -___ - -### \_removeAllSchemas - -• `Private` **\_removeAllSchemas**: `any` - -#### Defined in - -node_modules/ajv/dist/core.d.ts:160 - -___ - -### errors - -• `Optional` **errors**: ``null`` \| [`ErrorObject`](../interfaces/verida_verifiable_credentials._internal_.ErrorObject.md)<`string`, [`Record`](../modules/verida_verifiable_credentials._internal_.md#record)<`string`, `any`\>, `unknown`\>[] - -#### Defined in - -node_modules/ajv/dist/core.d.ts:104 - -___ - -### formats - -• `Readonly` **formats**: `Object` - -#### Defined in - -node_modules/ajv/dist/core.d.ts:113 - -___ - -### logger - -• **logger**: [`Logger`](../interfaces/verida_verifiable_credentials._internal_.Logger.md) - -#### Defined in - -node_modules/ajv/dist/core.d.ts:105 - -___ - -### opts - -• **opts**: [`InstanceOptions`](../modules/verida_verifiable_credentials._internal_.md#instanceoptions) - -#### Defined in - -node_modules/ajv/dist/core.d.ts:103 - -___ - -### refs - -• `Readonly` **refs**: `Object` - -#### Defined in - -node_modules/ajv/dist/core.d.ts:110 - -___ - -### schemas - -• `Readonly` **schemas**: `Object` - -#### Defined in - -node_modules/ajv/dist/core.d.ts:107 - -___ - -### scope - -• `Readonly` **scope**: [`ValueScope`](verida_verifiable_credentials._internal_.ValueScope.md) - -#### Defined in - -node_modules/ajv/dist/core.d.ts:106 - -___ - -### MissingRefError - -▪ `Static` **MissingRefError**: typeof [`default`](verida_verifiable_credentials._internal_.default-6.md) - -#### Defined in - -node_modules/ajv/dist/core.d.ts:122 - -___ - -### ValidationError - -▪ `Static` **ValidationError**: typeof [`default`](verida_verifiable_credentials._internal_.default-5.md) - -#### Defined in - -node_modules/ajv/dist/core.d.ts:121 - -## Methods - -### $dataMetaSchema - -▸ **$dataMetaSchema**(`metaSchema`, `keywordsJsonPointers`): [`AnySchemaObject`](../modules/verida_verifiable_credentials._internal_.md#anyschemaobject) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `metaSchema` | [`AnySchemaObject`](../modules/verida_verifiable_credentials._internal_.md#anyschemaobject) | -| `keywordsJsonPointers` | `string`[] | - -#### Returns - -[`AnySchemaObject`](../modules/verida_verifiable_credentials._internal_.md#anyschemaobject) - -#### Defined in - -node_modules/ajv/dist/core.d.ts:159 - -___ - -### \_addDefaultMetaSchema - -▸ **_addDefaultMetaSchema**(): `void` - -#### Returns - -`void` - -#### Defined in - -node_modules/ajv/dist/core.d.ts:125 - -___ - -### \_addSchema - -▸ **_addSchema**(`schema`, `meta?`, `baseId?`, `validateSchema?`, `addSchema?`): [`SchemaEnv`](verida_verifiable_credentials._internal_.SchemaEnv.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schema` | [`AnySchema`](../modules/verida_verifiable_credentials._internal_.md#anyschema) | -| `meta?` | `boolean` | -| `baseId?` | `string` | -| `validateSchema?` | `boolean` \| ``"log"`` | -| `addSchema?` | `boolean` | - -#### Returns - -[`SchemaEnv`](verida_verifiable_credentials._internal_.SchemaEnv.md) - -#### Defined in - -node_modules/ajv/dist/core.d.ts:161 - -___ - -### \_addVocabularies - -▸ **_addVocabularies**(): `void` - -#### Returns - -`void` - -#### Defined in - -node_modules/ajv/dist/core.d.ts:124 - -___ - -### addFormat - -▸ **addFormat**(`name`, `format`): [`default`](verida_verifiable_credentials._internal_.default-4.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` | -| `format` | [`Format`](../modules/verida_verifiable_credentials._internal_.md#format) | - -#### Returns - -[`default`](verida_verifiable_credentials._internal_.default-4.md) - -#### Defined in - -node_modules/ajv/dist/core.d.ts:156 - -___ - -### addKeyword - -▸ **addKeyword**(`kwdOrDef`, `def?`): [`default`](verida_verifiable_credentials._internal_.default-4.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `kwdOrDef` | `string` \| [`KeywordDefinition`](../modules/verida_verifiable_credentials._internal_.md#keyworddefinition) | -| `def?` | [`KeywordDefinition`](../modules/verida_verifiable_credentials._internal_.md#keyworddefinition) | - -#### Returns - -[`default`](verida_verifiable_credentials._internal_.default-4.md) - -#### Defined in - -node_modules/ajv/dist/core.d.ts:153 - -___ - -### addMetaSchema - -▸ **addMetaSchema**(`schema`, `key?`, `_validateSchema?`): [`default`](verida_verifiable_credentials._internal_.default-4.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schema` | [`AnySchemaObject`](../modules/verida_verifiable_credentials._internal_.md#anyschemaobject) | -| `key?` | `string` | -| `_validateSchema?` | `boolean` \| ``"log"`` | - -#### Returns - -[`default`](verida_verifiable_credentials._internal_.default-4.md) - -#### Defined in - -node_modules/ajv/dist/core.d.ts:147 - -___ - -### addSchema - -▸ **addSchema**(`schema`, `key?`, `_meta?`, `_validateSchema?`): [`default`](verida_verifiable_credentials._internal_.default-4.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schema` | [`AnySchema`](../modules/verida_verifiable_credentials._internal_.md#anyschema) \| [`AnySchema`](../modules/verida_verifiable_credentials._internal_.md#anyschema)[] | -| `key?` | `string` | -| `_meta?` | `boolean` | -| `_validateSchema?` | `boolean` \| ``"log"`` | - -#### Returns - -[`default`](verida_verifiable_credentials._internal_.default-4.md) - -#### Defined in - -node_modules/ajv/dist/core.d.ts:143 - -___ - -### addVocabulary - -▸ **addVocabulary**(`definitions`): [`default`](verida_verifiable_credentials._internal_.default-4.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `definitions` | [`Vocabulary`](../modules/verida_verifiable_credentials._internal_.md#vocabulary) | - -#### Returns - -[`default`](verida_verifiable_credentials._internal_.default-4.md) - -#### Defined in - -node_modules/ajv/dist/core.d.ts:152 - -___ - -### compile - -▸ **compile**<`T`\>(`schema`, `_meta?`): [`ValidateFunction`](../interfaces/verida_verifiable_credentials._internal_.ValidateFunction.md)<`T`\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `unknown` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schema` | [`Schema`](../modules/verida_verifiable_credentials._internal_.md#schema) \| [`UncheckedJSONSchemaType`](../modules/verida_verifiable_credentials._internal_.md#uncheckedjsonschematype)<`T`, ``false``\> | -| `_meta?` | `boolean` | - -#### Returns - -[`ValidateFunction`](../interfaces/verida_verifiable_credentials._internal_.ValidateFunction.md)<`T`\> - -#### Defined in - -node_modules/ajv/dist/core.d.ts:134 - -▸ **compile**<`T`\>(`schema`, `_meta?`): [`ValidateFunction`](../interfaces/verida_verifiable_credentials._internal_.ValidateFunction.md)<`T`\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `unknown` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schema` | [`JTDSchemaType`](../modules/verida_verifiable_credentials._internal_.md#jtdschematype)<`T`, [`Record`](../modules/verida_verifiable_credentials._internal_.md#record)<`string`, `never`\>\> | -| `_meta?` | `boolean` | - -#### Returns - -[`ValidateFunction`](../interfaces/verida_verifiable_credentials._internal_.ValidateFunction.md)<`T`\> - -#### Defined in - -node_modules/ajv/dist/core.d.ts:135 - -▸ **compile**<`N`, `T`\>(`schema`, `_meta?`): [`ValidateFunction`](../interfaces/verida_verifiable_credentials._internal_.ValidateFunction.md)<[`JTDDataType`](../modules/verida_verifiable_credentials._internal_.md#jtddatatype)<`T`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `N` | extends `never` | -| `T` | extends [`SomeJTDSchemaType`](../modules/verida_verifiable_credentials._internal_.md#somejtdschematype) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schema` | `T` | -| `_meta?` | `boolean` | - -#### Returns - -[`ValidateFunction`](../interfaces/verida_verifiable_credentials._internal_.ValidateFunction.md)<[`JTDDataType`](../modules/verida_verifiable_credentials._internal_.md#jtddatatype)<`T`\>\> - -#### Defined in - -node_modules/ajv/dist/core.d.ts:136 - -▸ **compile**<`T`\>(`schema`, `_meta?`): [`AsyncValidateFunction`](../interfaces/verida_verifiable_credentials._internal_.AsyncValidateFunction.md)<`T`\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `unknown` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schema` | [`AsyncSchema`](../interfaces/verida_verifiable_credentials._internal_.AsyncSchema.md) | -| `_meta?` | `boolean` | - -#### Returns - -[`AsyncValidateFunction`](../interfaces/verida_verifiable_credentials._internal_.AsyncValidateFunction.md)<`T`\> - -#### Defined in - -node_modules/ajv/dist/core.d.ts:137 - -▸ **compile**<`T`\>(`schema`, `_meta?`): [`AnyValidateFunction`](../modules/verida_verifiable_credentials._internal_.md#anyvalidatefunction)<`T`\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `unknown` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schema` | [`AnySchema`](../modules/verida_verifiable_credentials._internal_.md#anyschema) | -| `_meta?` | `boolean` | - -#### Returns - -[`AnyValidateFunction`](../modules/verida_verifiable_credentials._internal_.md#anyvalidatefunction)<`T`\> - -#### Defined in - -node_modules/ajv/dist/core.d.ts:138 - -___ - -### compileAsync - -▸ **compileAsync**<`T`\>(`schema`, `_meta?`): `Promise`<[`ValidateFunction`](../interfaces/verida_verifiable_credentials._internal_.ValidateFunction.md)<`T`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `unknown` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schema` | [`SchemaObject`](../interfaces/verida_verifiable_credentials._internal_.SchemaObject.md) \| [`UncheckedJSONSchemaType`](../modules/verida_verifiable_credentials._internal_.md#uncheckedjsonschematype)<`T`, ``false``\> | -| `_meta?` | `boolean` | - -#### Returns - -`Promise`<[`ValidateFunction`](../interfaces/verida_verifiable_credentials._internal_.ValidateFunction.md)<`T`\>\> - -#### Defined in - -node_modules/ajv/dist/core.d.ts:139 - -▸ **compileAsync**<`T`\>(`schema`, `_meta?`): `Promise`<[`ValidateFunction`](../interfaces/verida_verifiable_credentials._internal_.ValidateFunction.md)<`T`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `unknown` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schema` | [`JTDSchemaType`](../modules/verida_verifiable_credentials._internal_.md#jtdschematype)<`T`, [`Record`](../modules/verida_verifiable_credentials._internal_.md#record)<`string`, `never`\>\> | -| `_meta?` | `boolean` | - -#### Returns - -`Promise`<[`ValidateFunction`](../interfaces/verida_verifiable_credentials._internal_.ValidateFunction.md)<`T`\>\> - -#### Defined in - -node_modules/ajv/dist/core.d.ts:140 - -▸ **compileAsync**<`T`\>(`schema`, `meta?`): `Promise`<[`AsyncValidateFunction`](../interfaces/verida_verifiable_credentials._internal_.AsyncValidateFunction.md)<`T`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `unknown` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schema` | [`AsyncSchema`](../interfaces/verida_verifiable_credentials._internal_.AsyncSchema.md) | -| `meta?` | `boolean` | - -#### Returns - -`Promise`<[`AsyncValidateFunction`](../interfaces/verida_verifiable_credentials._internal_.AsyncValidateFunction.md)<`T`\>\> - -#### Defined in - -node_modules/ajv/dist/core.d.ts:141 - -▸ **compileAsync**<`T`\>(`schema`, `meta?`): `Promise`<[`AnyValidateFunction`](../modules/verida_verifiable_credentials._internal_.md#anyvalidatefunction)<`T`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `unknown` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schema` | [`AnySchemaObject`](../modules/verida_verifiable_credentials._internal_.md#anyschemaobject) | -| `meta?` | `boolean` | - -#### Returns - -`Promise`<[`AnyValidateFunction`](../modules/verida_verifiable_credentials._internal_.md#anyvalidatefunction)<`T`\>\> - -#### Defined in - -node_modules/ajv/dist/core.d.ts:142 - -___ - -### defaultMeta - -▸ **defaultMeta**(): `undefined` \| `string` \| [`AnySchemaObject`](../modules/verida_verifiable_credentials._internal_.md#anyschemaobject) - -#### Returns - -`undefined` \| `string` \| [`AnySchemaObject`](../modules/verida_verifiable_credentials._internal_.md#anyschemaobject) - -#### Defined in - -node_modules/ajv/dist/core.d.ts:126 - -___ - -### errorsText - -▸ **errorsText**(`errors?`, `__namedParameters?`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `errors?` | ``null`` \| [`ErrorObject`](../interfaces/verida_verifiable_credentials._internal_.ErrorObject.md)<`string`, [`Record`](../modules/verida_verifiable_credentials._internal_.md#record)<`string`, `any`\>, `unknown`\>[] | -| `__namedParameters?` | [`ErrorsTextOptions`](../interfaces/verida_verifiable_credentials._internal_.ErrorsTextOptions.md) | - -#### Returns - -`string` - -#### Defined in - -node_modules/ajv/dist/core.d.ts:157 - -___ - -### getKeyword - -▸ **getKeyword**(`keyword`): `boolean` \| [`AddedKeywordDefinition`](../modules/verida_verifiable_credentials._internal_.md#addedkeyworddefinition) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `keyword` | `string` | - -#### Returns - -`boolean` \| [`AddedKeywordDefinition`](../modules/verida_verifiable_credentials._internal_.md#addedkeyworddefinition) - -#### Defined in - -node_modules/ajv/dist/core.d.ts:154 - -___ - -### getSchema - -▸ **getSchema**<`T`\>(`keyRef`): `undefined` \| [`AnyValidateFunction`](../modules/verida_verifiable_credentials._internal_.md#anyvalidatefunction)<`T`\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `unknown` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `keyRef` | `string` | - -#### Returns - -`undefined` \| [`AnyValidateFunction`](../modules/verida_verifiable_credentials._internal_.md#anyvalidatefunction)<`T`\> - -#### Defined in - -node_modules/ajv/dist/core.d.ts:150 - -___ - -### removeKeyword - -▸ **removeKeyword**(`keyword`): [`default`](verida_verifiable_credentials._internal_.default-4.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `keyword` | `string` | - -#### Returns - -[`default`](verida_verifiable_credentials._internal_.default-4.md) - -#### Defined in - -node_modules/ajv/dist/core.d.ts:155 - -___ - -### removeSchema - -▸ **removeSchema**(`schemaKeyRef?`): [`default`](verida_verifiable_credentials._internal_.default-4.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schemaKeyRef?` | `string` \| `RegExp` \| [`AnySchema`](../modules/verida_verifiable_credentials._internal_.md#anyschema) | - -#### Returns - -[`default`](verida_verifiable_credentials._internal_.default-4.md) - -#### Defined in - -node_modules/ajv/dist/core.d.ts:151 - -___ - -### validate - -▸ **validate**(`schema`, `data`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schema` | `string` \| [`Schema`](../modules/verida_verifiable_credentials._internal_.md#schema) | -| `data` | `unknown` | - -#### Returns - -`boolean` - -#### Defined in - -node_modules/ajv/dist/core.d.ts:127 - -▸ **validate**(`schemaKeyRef`, `data`): `boolean` \| `Promise`<`unknown`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schemaKeyRef` | `string` \| [`AnySchema`](../modules/verida_verifiable_credentials._internal_.md#anyschema) | -| `data` | `unknown` | - -#### Returns - -`boolean` \| `Promise`<`unknown`\> - -#### Defined in - -node_modules/ajv/dist/core.d.ts:128 - -▸ **validate**<`T`\>(`schema`, `data`): data is T - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schema` | `string` \| [`Schema`](../modules/verida_verifiable_credentials._internal_.md#schema) \| [`UncheckedJSONSchemaType`](../modules/verida_verifiable_credentials._internal_.md#uncheckedjsonschematype)<`T`, ``false``\> | -| `data` | `unknown` | - -#### Returns - -data is T - -#### Defined in - -node_modules/ajv/dist/core.d.ts:129 - -▸ **validate**<`T`\>(`schema`, `data`): data is T - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schema` | [`JTDSchemaType`](../modules/verida_verifiable_credentials._internal_.md#jtdschematype)<`T`, [`Record`](../modules/verida_verifiable_credentials._internal_.md#record)<`string`, `never`\>\> | -| `data` | `unknown` | - -#### Returns - -data is T - -#### Defined in - -node_modules/ajv/dist/core.d.ts:130 - -▸ **validate**<`N`, `T`\>(`schema`, `data`): data is JTDDataType - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `N` | extends `never` | -| `T` | extends [`SomeJTDSchemaType`](../modules/verida_verifiable_credentials._internal_.md#somejtdschematype) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schema` | `T` | -| `data` | `unknown` | - -#### Returns - -data is JTDDataType - -#### Defined in - -node_modules/ajv/dist/core.d.ts:131 - -▸ **validate**<`T`\>(`schema`, `data`): `Promise`<`T`\> - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schema` | [`AsyncSchema`](../interfaces/verida_verifiable_credentials._internal_.AsyncSchema.md) | -| `data` | `unknown` | - -#### Returns - -`Promise`<`T`\> - -#### Defined in - -node_modules/ajv/dist/core.d.ts:132 - -▸ **validate**<`T`\>(`schemaKeyRef`, `data`): data is T \| Promise - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schemaKeyRef` | `string` \| [`AnySchema`](../modules/verida_verifiable_credentials._internal_.md#anyschema) | -| `data` | `unknown` | - -#### Returns - -data is T \| Promise - -#### Defined in - -node_modules/ajv/dist/core.d.ts:133 - -___ - -### validateSchema - -▸ **validateSchema**(`schema`, `throwOrLogError?`): `boolean` \| `Promise`<`unknown`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schema` | [`AnySchema`](../modules/verida_verifiable_credentials._internal_.md#anyschema) | -| `throwOrLogError?` | `boolean` | - -#### Returns - -`boolean` \| `Promise`<`unknown`\> - -#### Defined in - -node_modules/ajv/dist/core.d.ts:149 diff --git a/docs/api/verida-js/classes/verida_verifiable_credentials._internal_.default-5.md b/docs/api/verida-js/classes/verida_verifiable_credentials._internal_.default-5.md deleted file mode 100644 index 998a332..0000000 --- a/docs/api/verida-js/classes/verida_verifiable_credentials._internal_.default-5.md +++ /dev/null @@ -1,198 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / default - -# Class: default - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md).default - -## Hierarchy - -- [`Error`](../modules/verida_verifiable_credentials._internal_.md#error) - - ↳ **`default`** - -## Table of contents - -### Constructors - -- [constructor](verida_verifiable_credentials._internal_.default-5.md#constructor) - -### Properties - -- [ajv](verida_verifiable_credentials._internal_.default-5.md#ajv) -- [errors](verida_verifiable_credentials._internal_.default-5.md#errors) -- [message](verida_verifiable_credentials._internal_.default-5.md#message) -- [name](verida_verifiable_credentials._internal_.default-5.md#name) -- [stack](verida_verifiable_credentials._internal_.default-5.md#stack) -- [validation](verida_verifiable_credentials._internal_.default-5.md#validation) -- [prepareStackTrace](verida_verifiable_credentials._internal_.default-5.md#preparestacktrace) -- [stackTraceLimit](verida_verifiable_credentials._internal_.default-5.md#stacktracelimit) - -### Methods - -- [captureStackTrace](verida_verifiable_credentials._internal_.default-5.md#capturestacktrace) - -## Constructors - -### constructor - -• **new default**(`errors`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `errors` | [`Partial`](../modules/verida_verifiable_credentials._internal_.md#partial)<[`ErrorObject`](../interfaces/verida_verifiable_credentials._internal_.ErrorObject.md)<`string`, [`Record`](../modules/verida_verifiable_credentials._internal_.md#record)<`string`, `any`\>, `unknown`\>\>[] | - -#### Overrides - -Error.constructor - -#### Defined in - -node_modules/ajv/dist/runtime/validation_error.d.ts:6 - -## Properties - -### ajv - -• `Readonly` **ajv**: ``true`` - -#### Defined in - -node_modules/ajv/dist/runtime/validation_error.d.ts:4 - -___ - -### errors - -• `Readonly` **errors**: [`Partial`](../modules/verida_verifiable_credentials._internal_.md#partial)<[`ErrorObject`](../interfaces/verida_verifiable_credentials._internal_.ErrorObject.md)<`string`, [`Record`](../modules/verida_verifiable_credentials._internal_.md#record)<`string`, `any`\>, `unknown`\>\>[] - -#### Defined in - -node_modules/ajv/dist/runtime/validation_error.d.ts:3 - -___ - -### message - -• **message**: `string` - -#### Inherited from - -Error.message - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:974 - -___ - -### name - -• **name**: `string` - -#### Inherited from - -Error.name - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:973 - -___ - -### stack - -• `Optional` **stack**: `string` - -#### Inherited from - -Error.stack - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:975 - -___ - -### validation - -• `Readonly` **validation**: ``true`` - -#### Defined in - -node_modules/ajv/dist/runtime/validation_error.d.ts:5 - -___ - -### prepareStackTrace - -▪ `Static` `Optional` **prepareStackTrace**: (`err`: [`Error`](../modules/verida_verifiable_credentials._internal_.md#error), `stackTraces`: [`CallSite`](../interfaces/verida_verifiable_credentials._internal_.CallSite.md)[]) => `any` - -#### Type declaration - -▸ (`err`, `stackTraces`): `any` - -Optional override for formatting stack traces - -**`see`** https://v8.dev/docs/stack-trace-api#customizing-stack-traces - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `err` | [`Error`](../modules/verida_verifiable_credentials._internal_.md#error) | -| `stackTraces` | [`CallSite`](../interfaces/verida_verifiable_credentials._internal_.CallSite.md)[] | - -##### Returns - -`any` - -#### Inherited from - -Error.prepareStackTrace - -#### Defined in - -node_modules/@types/node/globals.d.ts:11 - -___ - -### stackTraceLimit - -▪ `Static` **stackTraceLimit**: `number` - -#### Inherited from - -Error.stackTraceLimit - -#### Defined in - -node_modules/@types/node/globals.d.ts:13 - -## Methods - -### captureStackTrace - -▸ `Static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` - -Create .stack property on a target object - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `targetObject` | `object` | -| `constructorOpt?` | `Function` | - -#### Returns - -`void` - -#### Inherited from - -Error.captureStackTrace - -#### Defined in - -node_modules/@types/node/globals.d.ts:4 diff --git a/docs/api/verida-js/classes/verida_verifiable_credentials._internal_.default-6.md b/docs/api/verida-js/classes/verida_verifiable_credentials._internal_.default-6.md deleted file mode 100644 index 9e76135..0000000 --- a/docs/api/verida-js/classes/verida_verifiable_credentials._internal_.default-6.md +++ /dev/null @@ -1,189 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / default - -# Class: default - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md).default - -## Hierarchy - -- [`Error`](../modules/verida_verifiable_credentials._internal_.md#error) - - ↳ **`default`** - -## Table of contents - -### Constructors - -- [constructor](verida_verifiable_credentials._internal_.default-6.md#constructor) - -### Properties - -- [message](verida_verifiable_credentials._internal_.default-6.md#message) -- [missingRef](verida_verifiable_credentials._internal_.default-6.md#missingref) -- [missingSchema](verida_verifiable_credentials._internal_.default-6.md#missingschema) -- [name](verida_verifiable_credentials._internal_.default-6.md#name) -- [stack](verida_verifiable_credentials._internal_.default-6.md#stack) -- [prepareStackTrace](verida_verifiable_credentials._internal_.default-6.md#preparestacktrace) -- [stackTraceLimit](verida_verifiable_credentials._internal_.default-6.md#stacktracelimit) - -### Methods - -- [captureStackTrace](verida_verifiable_credentials._internal_.default-6.md#capturestacktrace) - -## Constructors - -### constructor - -• **new default**(`baseId`, `ref`, `msg?`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `baseId` | `string` | -| `ref` | `string` | -| `msg?` | `string` | - -#### Overrides - -Error.constructor - -#### Defined in - -node_modules/ajv/dist/compile/ref_error.d.ts:4 - -## Properties - -### message - -• **message**: `string` - -#### Inherited from - -Error.message - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:974 - -___ - -### missingRef - -• `Readonly` **missingRef**: `string` - -#### Defined in - -node_modules/ajv/dist/compile/ref_error.d.ts:2 - -___ - -### missingSchema - -• `Readonly` **missingSchema**: `string` - -#### Defined in - -node_modules/ajv/dist/compile/ref_error.d.ts:3 - -___ - -### name - -• **name**: `string` - -#### Inherited from - -Error.name - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:973 - -___ - -### stack - -• `Optional` **stack**: `string` - -#### Inherited from - -Error.stack - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:975 - -___ - -### prepareStackTrace - -▪ `Static` `Optional` **prepareStackTrace**: (`err`: [`Error`](../modules/verida_verifiable_credentials._internal_.md#error), `stackTraces`: [`CallSite`](../interfaces/verida_verifiable_credentials._internal_.CallSite.md)[]) => `any` - -#### Type declaration - -▸ (`err`, `stackTraces`): `any` - -Optional override for formatting stack traces - -**`see`** https://v8.dev/docs/stack-trace-api#customizing-stack-traces - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `err` | [`Error`](../modules/verida_verifiable_credentials._internal_.md#error) | -| `stackTraces` | [`CallSite`](../interfaces/verida_verifiable_credentials._internal_.CallSite.md)[] | - -##### Returns - -`any` - -#### Inherited from - -Error.prepareStackTrace - -#### Defined in - -node_modules/@types/node/globals.d.ts:11 - -___ - -### stackTraceLimit - -▪ `Static` **stackTraceLimit**: `number` - -#### Inherited from - -Error.stackTraceLimit - -#### Defined in - -node_modules/@types/node/globals.d.ts:13 - -## Methods - -### captureStackTrace - -▸ `Static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` - -Create .stack property on a target object - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `targetObject` | `object` | -| `constructorOpt?` | `Function` | - -#### Returns - -`void` - -#### Inherited from - -Error.captureStackTrace - -#### Defined in - -node_modules/@types/node/globals.d.ts:4 diff --git a/docs/api/verida-js/classes/verida_verifiable_credentials._internal_.default.md b/docs/api/verida-js/classes/verida_verifiable_credentials._internal_.default.md deleted file mode 100644 index 245c504..0000000 --- a/docs/api/verida-js/classes/verida_verifiable_credentials._internal_.default.md +++ /dev/null @@ -1,242 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / default - -# Class: default - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md).default - -An Authenticator that automatically signs everything - -## Table of contents - -### Constructors - -- [constructor](verida_verifiable_credentials._internal_.default.md#constructor) - -### Methods - -- [createDidJwt](verida_verifiable_credentials._internal_.default.md#createdidjwt) -- [did](verida_verifiable_credentials._internal_.default.md#did) -- [disconnect](verida_verifiable_credentials._internal_.default.md#disconnect) -- [getDidClient](verida_verifiable_credentials._internal_.default.md#getdidclient) -- [keyring](verida_verifiable_credentials._internal_.default.md#keyring) -- [linkStorage](verida_verifiable_credentials._internal_.default.md#linkstorage) -- [linkStorageContextService](verida_verifiable_credentials._internal_.default.md#linkstoragecontextservice) -- [sign](verida_verifiable_credentials._internal_.default.md#sign) -- [storageConfig](verida_verifiable_credentials._internal_.default.md#storageconfig) -- [unlinkStorage](verida_verifiable_credentials._internal_.default.md#unlinkstorage) - -## Constructors - -### constructor - -• **new default**() - -## Methods - -### createDidJwt - -▸ **createDidJwt**(`contextName`, `data`, `config?`): `Promise`<`string`\> - -Create a DID-JWT from a data object - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | -| `data` | `object` | -| `config?` | `any` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -packages/account/dist/account.d.ts:42 - -___ - -### did - -▸ **did**(): `Promise`<`string`\> - -Get the DID of the current user - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -packages/account/dist/account.d.ts:22 - -___ - -### disconnect - -▸ **disconnect**(`contextName?`): `Promise`<`void`\> - -An optional method that can be used to disconnect the current user. - -For example, in a web browser context, it would remove any stored signatures from local storage. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName?` | `string` | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -packages/account/dist/account.d.ts:48 - -___ - -### getDidClient - -▸ **getDidClient**(): `void` - -#### Returns - -`void` - -#### Defined in - -packages/account/dist/account.d.ts:37 - -___ - -### keyring - -▸ **keyring**(`contextName`): `Promise`<[`default`](verida_verifiable_credentials._internal_.default-2.md)\> - -Generate a keyring for this user for a given storage context. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | - -#### Returns - -`Promise`<[`default`](verida_verifiable_credentials._internal_.default-2.md)\> - -#### Defined in - -packages/account/dist/account.d.ts:12 - -___ - -### linkStorage - -▸ **linkStorage**(`storageConfig`): `Promise`<`void`\> - -Link storage to this user - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `storageConfig` | [`SecureContextConfig`](../interfaces/verida_verifiable_credentials._internal_.SecureContextConfig.md) | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -packages/account/dist/account.d.ts:28 - -___ - -### linkStorageContextService - -▸ **linkStorageContextService**(`contextName`, `endpointType`, `serverType`, `endpointUri`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | -| `endpointType` | `string` | -| `serverType` | `string` | -| `endpointUri` | `string` | - -#### Returns - -`Promise`<`boolean`\> - -#### Defined in - -packages/account/dist/account.d.ts:36 - -___ - -### sign - -▸ **sign**(`input`): `Promise`<`string`\> - -Sign a string as the current user - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `input` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -packages/account/dist/account.d.ts:18 - -___ - -### storageConfig - -▸ **storageConfig**(`contextName`, `forceCreate?`): `Promise`<`undefined` \| [`SecureContextConfig`](../interfaces/verida_verifiable_credentials._internal_.SecureContextConfig.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | -| `forceCreate?` | `boolean` | - -#### Returns - -`Promise`<`undefined` \| [`SecureContextConfig`](../interfaces/verida_verifiable_credentials._internal_.SecureContextConfig.md)\> - -#### Defined in - -packages/account/dist/account.d.ts:35 - -___ - -### unlinkStorage - -▸ **unlinkStorage**(`contextName`): `Promise`<`boolean`\> - -Unlink storage for this user - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | - -#### Returns - -`Promise`<`boolean`\> - -#### Defined in - -packages/account/dist/account.d.ts:34 diff --git a/docs/api/verida-js/classes/verida_web3.VeridaContract.md b/docs/api/verida-js/classes/verida_web3.VeridaContract.md deleted file mode 100644 index dbb69c7..0000000 --- a/docs/api/verida-js/classes/verida_web3.VeridaContract.md +++ /dev/null @@ -1,195 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web3](../modules/verida_web3.md) / VeridaContract - -# Class: VeridaContract - -[@verida/web3](../modules/verida_web3.md).VeridaContract - -Class representing any Verida Smart Contrat - -## Indexable - -▪ [key: `string`]: `any` - -Need such fields to add sub methods in constructor - -## Table of contents - -### Constructors - -- [constructor](verida_web3.VeridaContract.md#constructor) - -### Properties - -- [contract](verida_web3.VeridaContract.md#contract) -- [endPoint](verida_web3.VeridaContract.md#endpoint) -- [gaslessPostConfig](verida_web3.VeridaContract.md#gaslesspostconfig) -- [gaslessServerConfig](verida_web3.VeridaContract.md#gaslessserverconfig) -- [server](verida_web3.VeridaContract.md#server) -- [signer](verida_web3.VeridaContract.md#signer) -- [type](verida_web3.VeridaContract.md#type) -- [web3Config](verida_web3.VeridaContract.md#web3config) - -### Methods - -- [attachContract](verida_web3.VeridaContract.md#attachcontract) -- [callMethod](verida_web3.VeridaContract.md#callmethod) - -## Constructors - -### constructor - -• **new VeridaContract**(`type`, `config`) - -Create Verida smart contract instance. Add member functions of contract as parameters. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `type` | [`Web3CallType`](../modules/verida_web3._internal_.md#web3calltype) | interaction mode | -| `config` | [`VeridaWeb3Config`](../modules/verida_web3._internal_.md#veridaweb3config) | configuration for creating VeridaContract instance | - -#### Defined in - -[packages/vda-web3-client/src/VeridaContractBase.ts:61](https://github.com/verida/verida-js/blob/5040472/packages/vda-web3-client/src/VeridaContractBase.ts#L61) - -## Properties - -### contract - -• `Protected` `Optional` **contract**: [`Contract`](verida_web3._internal_.Contract.md) - -Contract instance used in web3 mode - -#### Defined in - -[packages/vda-web3-client/src/VeridaContractBase.ts:36](https://github.com/verida/verida-js/blob/5040472/packages/vda-web3-client/src/VeridaContractBase.ts#L36) - -___ - -### endPoint - -• `Protected` `Optional` **endPoint**: `string` - -endpoint url : Need to be defined in sub class constructor - -#### Defined in - -[packages/vda-web3-client/src/VeridaContractBase.ts:44](https://github.com/verida/verida-js/blob/5040472/packages/vda-web3-client/src/VeridaContractBase.ts#L44) - -___ - -### gaslessPostConfig - -• `Protected` `Optional` **gaslessPostConfig**: [`Web3GaslessPostConfig`](../interfaces/verida_web3._internal_.Web3GaslessPostConfig.md) - -#### Defined in - -[packages/vda-web3-client/src/VeridaContractBase.ts:54](https://github.com/verida/verida-js/blob/5040472/packages/vda-web3-client/src/VeridaContractBase.ts#L54) - -___ - -### gaslessServerConfig - -• `Protected` `Optional` **gaslessServerConfig**: [`Web3GaslessRequestConfig`](../interfaces/verida_web3._internal_.Web3GaslessRequestConfig.md) - -Configuration for gasless mode - -#### Defined in - -[packages/vda-web3-client/src/VeridaContractBase.ts:53](https://github.com/verida/verida-js/blob/5040472/packages/vda-web3-client/src/VeridaContractBase.ts#L53) - -___ - -### server - -• `Protected` **server**: `any` = `null` - -Axios instance used in gasless mode - -#### Defined in - -[packages/vda-web3-client/src/VeridaContractBase.ts:42](https://github.com/verida/verida-js/blob/5040472/packages/vda-web3-client/src/VeridaContractBase.ts#L42) - -___ - -### signer - -• `Protected` `Optional` **signer**: [`Signer`](verida_web3._internal_.Signer.md) - -#### Defined in - -[packages/vda-web3-client/src/VeridaContractBase.ts:38](https://github.com/verida/verida-js/blob/5040472/packages/vda-web3-client/src/VeridaContractBase.ts#L38) - -___ - -### type - -• `Protected` **type**: [`Web3CallType`](../modules/verida_web3._internal_.md#web3calltype) - -Smart contract interaction mode - -#### Defined in - -[packages/vda-web3-client/src/VeridaContractBase.ts:33](https://github.com/verida/verida-js/blob/5040472/packages/vda-web3-client/src/VeridaContractBase.ts#L33) - -___ - -### web3Config - -• `Protected` `Optional` **web3Config**: [`Web3SelfTransactionConfig`](../interfaces/verida_web3._internal_.Web3SelfTransactionConfig.md) - -Configuration for web3 mode - -#### Defined in - -[packages/vda-web3-client/src/VeridaContractBase.ts:50](https://github.com/verida/verida-js/blob/5040472/packages/vda-web3-client/src/VeridaContractBase.ts#L50) - -## Methods - -### attachContract - -▸ `Protected` **attachContract**(`controller?`): `Promise`<[`Contract`](verida_web3._internal_.Contract.md)\> - -Connect signer to contract to sign transactions. Called in web3 mode only - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `controller?` | `string` \| `Promise`<`string`\> | : Wallet public address | - -#### Returns - -`Promise`<[`Contract`](verida_web3._internal_.Contract.md)\> - -#### Defined in - -[packages/vda-web3-client/src/VeridaContractBase.ts:216](https://github.com/verida/verida-js/blob/5040472/packages/vda-web3-client/src/VeridaContractBase.ts#L216) - -___ - -### callMethod - -▸ `Protected` **callMethod**(`methodName`, `methodType`, `params`, `gasConfig?`): `Promise`<[`VdaTransactionResult`](../interfaces/verida_web3._internal_.VdaTransactionResult.md)\> - -Perform smart contract interaction. Called by member function that were created in constructor. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `methodName` | `string` | Calling method name of smart contract. From ABI. | -| `methodType` | `string` | Method type. Shows whether method in smart contract is Call function or not. | -| `params` | `any` | Parameters used to make interaction with smart contract : Array | -| `gasConfig?` | [`Web3GasConfiguration`](../interfaces/verida_web3._internal_.Web3GasConfiguration.md) | Gas configuration. Only available for non-view functions in Web3 mode | - -#### Returns - -`Promise`<[`VdaTransactionResult`](../interfaces/verida_web3._internal_.VdaTransactionResult.md)\> - -- Response from smart contract interaction - -#### Defined in - -[packages/vda-web3-client/src/VeridaContractBase.ts:240](https://github.com/verida/verida-js/blob/5040472/packages/vda-web3-client/src/VeridaContractBase.ts#L240) diff --git a/docs/api/verida-js/classes/verida_web3._internal_.AbiCoder.md b/docs/api/verida-js/classes/verida_web3._internal_.AbiCoder.md deleted file mode 100644 index 86a8ef6..0000000 --- a/docs/api/verida-js/classes/verida_web3._internal_.AbiCoder.md +++ /dev/null @@ -1,183 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web3](../modules/verida_web3.md) / [](../modules/verida_web3._internal_.md) / AbiCoder - -# Class: AbiCoder - -[@verida/web3](../modules/verida_web3.md).[](../modules/verida_web3._internal_.md).AbiCoder - -## Table of contents - -### Constructors - -- [constructor](verida_web3._internal_.AbiCoder.md#constructor) - -### Properties - -- [coerceFunc](verida_web3._internal_.AbiCoder.md#coercefunc) - -### Methods - -- [\_getCoder](verida_web3._internal_.AbiCoder.md#_getcoder) -- [\_getReader](verida_web3._internal_.AbiCoder.md#_getreader) -- [\_getWordSize](verida_web3._internal_.AbiCoder.md#_getwordsize) -- [\_getWriter](verida_web3._internal_.AbiCoder.md#_getwriter) -- [decode](verida_web3._internal_.AbiCoder.md#decode) -- [encode](verida_web3._internal_.AbiCoder.md#encode) -- [getDefaultValue](verida_web3._internal_.AbiCoder.md#getdefaultvalue) - -## Constructors - -### constructor - -• **new AbiCoder**(`coerceFunc?`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `coerceFunc?` | [`CoerceFunc`](../modules/verida_web3._internal_.md#coercefunc) | - -#### Defined in - -node_modules/@ethersproject/abi/lib/abi-coder.d.ts:7 - -## Properties - -### coerceFunc - -• `Readonly` **coerceFunc**: [`CoerceFunc`](../modules/verida_web3._internal_.md#coercefunc) - -#### Defined in - -node_modules/@ethersproject/abi/lib/abi-coder.d.ts:6 - -## Methods - -### \_getCoder - -▸ **_getCoder**(`param`): [`Coder`](verida_web3._internal_.Coder.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `param` | [`ParamType`](verida_web3._internal_.ParamType.md) | - -#### Returns - -[`Coder`](verida_web3._internal_.Coder.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/abi-coder.d.ts:8 - -___ - -### \_getReader - -▸ **_getReader**(`data`, `allowLoose?`): [`Reader`](verida_web3._internal_.Reader.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `Uint8Array` | -| `allowLoose?` | `boolean` | - -#### Returns - -[`Reader`](verida_web3._internal_.Reader.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/abi-coder.d.ts:10 - -___ - -### \_getWordSize - -▸ **_getWordSize**(): `number` - -#### Returns - -`number` - -#### Defined in - -node_modules/@ethersproject/abi/lib/abi-coder.d.ts:9 - -___ - -### \_getWriter - -▸ **_getWriter**(): [`Writer`](verida_web3._internal_.Writer.md) - -#### Returns - -[`Writer`](verida_web3._internal_.Writer.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/abi-coder.d.ts:11 - -___ - -### decode - -▸ **decode**(`types`, `data`, `loose?`): [`Result`](../interfaces/verida_web3._internal_.Result.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `types` | readonly (`string` \| [`ParamType`](verida_web3._internal_.ParamType.md))[] | -| `data` | [`BytesLike`](../modules/verida_web3._internal_.md#byteslike) | -| `loose?` | `boolean` | - -#### Returns - -[`Result`](../interfaces/verida_web3._internal_.Result.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/abi-coder.d.ts:14 - -___ - -### encode - -▸ **encode**(`types`, `values`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `types` | readonly (`string` \| [`ParamType`](verida_web3._internal_.ParamType.md))[] | -| `values` | readonly `any`[] | - -#### Returns - -`string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/abi-coder.d.ts:13 - -___ - -### getDefaultValue - -▸ **getDefaultValue**(`types`): [`Result`](../interfaces/verida_web3._internal_.Result.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `types` | readonly (`string` \| [`ParamType`](verida_web3._internal_.ParamType.md))[] | - -#### Returns - -[`Result`](../interfaces/verida_web3._internal_.Result.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/abi-coder.d.ts:12 diff --git a/docs/api/verida-js/classes/verida_web3._internal_.BaseContract.md b/docs/api/verida-js/classes/verida_web3._internal_.BaseContract.md deleted file mode 100644 index 7415245..0000000 --- a/docs/api/verida-js/classes/verida_web3._internal_.BaseContract.md +++ /dev/null @@ -1,660 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web3](../modules/verida_web3.md) / [](../modules/verida_web3._internal_.md) / BaseContract - -# Class: BaseContract - -[@verida/web3](../modules/verida_web3.md).[](../modules/verida_web3._internal_.md).BaseContract - -## Hierarchy - -- **`BaseContract`** - - ↳ [`Contract`](verida_web3._internal_.Contract.md) - -## Table of contents - -### Constructors - -- [constructor](verida_web3._internal_.BaseContract.md#constructor) - -### Properties - -- [\_addEventListener](verida_web3._internal_.BaseContract.md#_addeventlistener) -- [\_deployedPromise](verida_web3._internal_.BaseContract.md#_deployedpromise) -- [\_getRunningEvent](verida_web3._internal_.BaseContract.md#_getrunningevent) -- [\_normalizeRunningEvent](verida_web3._internal_.BaseContract.md#_normalizerunningevent) -- [\_runningEvents](verida_web3._internal_.BaseContract.md#_runningevents) -- [\_wrappedEmits](verida_web3._internal_.BaseContract.md#_wrappedemits) -- [address](verida_web3._internal_.BaseContract.md#address) -- [callStatic](verida_web3._internal_.BaseContract.md#callstatic) -- [deployTransaction](verida_web3._internal_.BaseContract.md#deploytransaction) -- [estimateGas](verida_web3._internal_.BaseContract.md#estimategas) -- [filters](verida_web3._internal_.BaseContract.md#filters) -- [functions](verida_web3._internal_.BaseContract.md#functions) -- [interface](verida_web3._internal_.BaseContract.md#interface) -- [populateTransaction](verida_web3._internal_.BaseContract.md#populatetransaction) -- [provider](verida_web3._internal_.BaseContract.md#provider) -- [resolvedAddress](verida_web3._internal_.BaseContract.md#resolvedaddress) -- [signer](verida_web3._internal_.BaseContract.md#signer) - -### Methods - -- [\_checkRunningEvents](verida_web3._internal_.BaseContract.md#_checkrunningevents) -- [\_deployed](verida_web3._internal_.BaseContract.md#_deployed) -- [\_wrapEvent](verida_web3._internal_.BaseContract.md#_wrapevent) -- [attach](verida_web3._internal_.BaseContract.md#attach) -- [connect](verida_web3._internal_.BaseContract.md#connect) -- [deployed](verida_web3._internal_.BaseContract.md#deployed) -- [emit](verida_web3._internal_.BaseContract.md#emit) -- [fallback](verida_web3._internal_.BaseContract.md#fallback) -- [listenerCount](verida_web3._internal_.BaseContract.md#listenercount) -- [listeners](verida_web3._internal_.BaseContract.md#listeners) -- [off](verida_web3._internal_.BaseContract.md#off) -- [on](verida_web3._internal_.BaseContract.md#on) -- [once](verida_web3._internal_.BaseContract.md#once) -- [queryFilter](verida_web3._internal_.BaseContract.md#queryfilter) -- [removeAllListeners](verida_web3._internal_.BaseContract.md#removealllisteners) -- [removeListener](verida_web3._internal_.BaseContract.md#removelistener) -- [getContractAddress](verida_web3._internal_.BaseContract.md#getcontractaddress) -- [getInterface](verida_web3._internal_.BaseContract.md#getinterface) -- [isIndexed](verida_web3._internal_.BaseContract.md#isindexed) - -## Constructors - -### constructor - -• **new BaseContract**(`addressOrName`, `contractInterface`, `signerOrProvider?`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `addressOrName` | `string` | -| `contractInterface` | [`ContractInterface`](../modules/verida_web3._internal_.md#contractinterface) | -| `signerOrProvider?` | [`Signer`](verida_web3._internal_.Signer.md) \| [`Provider`](verida_web3._internal_.Provider.md) | - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:107 - -## Properties - -### \_addEventListener - -• `Private` **\_addEventListener**: `any` - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:123 - -___ - -### \_deployedPromise - -• **\_deployedPromise**: `Promise`<[`Contract`](verida_web3._internal_.Contract.md)\> - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:100 - -___ - -### \_getRunningEvent - -• `Private` **\_getRunningEvent**: `any` - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:120 - -___ - -### \_normalizeRunningEvent - -• `Private` **\_normalizeRunningEvent**: `any` - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:119 - -___ - -### \_runningEvents - -• **\_runningEvents**: `Object` - -#### Index signature - -▪ [eventTag: `string`]: [`RunningEvent`](verida_web3._internal_.RunningEvent.md) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:101 - -___ - -### \_wrappedEmits - -• **\_wrappedEmits**: `Object` - -#### Index signature - -▪ [eventTag: `string`]: (...`args`: `any`[]) => `void` - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:104 - -___ - -### address - -• `Readonly` **address**: `string` - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:79 - -___ - -### callStatic - -• `Readonly` **callStatic**: `Object` - -#### Index signature - -▪ [name: `string`]: [`ContractFunction`](../modules/verida_web3._internal_.md#contractfunction) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:86 - -___ - -### deployTransaction - -• `Readonly` **deployTransaction**: [`TransactionResponse`](../interfaces/verida_web3._internal_.TransactionResponse.md) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:99 - -___ - -### estimateGas - -• `Readonly` **estimateGas**: `Object` - -#### Index signature - -▪ [name: `string`]: [`ContractFunction`](../modules/verida_web3._internal_.md#contractfunction)<[`BigNumber`](verida_web3._internal_.BigNumber.md)\> - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:89 - -___ - -### filters - -• `Readonly` **filters**: `Object` - -#### Index signature - -▪ [name: `string`]: (...`args`: `any`[]) => [`EventFilter`](../modules/verida_web3._internal_.md#eventfilter) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:95 - -___ - -### functions - -• `Readonly` **functions**: `Object` - -#### Index signature - -▪ [name: `string`]: [`ContractFunction`](../modules/verida_web3._internal_.md#contractfunction) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:83 - -___ - -### interface - -• `Readonly` **interface**: [`Interface`](verida_web3._internal_.Interface.md) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:80 - -___ - -### populateTransaction - -• `Readonly` **populateTransaction**: `Object` - -#### Index signature - -▪ [name: `string`]: [`ContractFunction`](../modules/verida_web3._internal_.md#contractfunction)<[`PopulatedTransaction`](../interfaces/verida_web3._internal_.PopulatedTransaction.md)\> - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:92 - -___ - -### provider - -• `Readonly` **provider**: [`Provider`](verida_web3._internal_.Provider.md) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:82 - -___ - -### resolvedAddress - -• `Readonly` **resolvedAddress**: `Promise`<`string`\> - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:98 - -___ - -### signer - -• `Readonly` **signer**: [`Signer`](verida_web3._internal_.Signer.md) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:81 - -## Methods - -### \_checkRunningEvents - -▸ **_checkRunningEvents**(`runningEvent`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `runningEvent` | [`RunningEvent`](verida_web3._internal_.RunningEvent.md) | - -#### Returns - -`void` - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:121 - -___ - -### \_deployed - -▸ **_deployed**(`blockTag?`): `Promise`<[`Contract`](verida_web3._internal_.Contract.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `blockTag?` | [`BlockTag`](../modules/verida_web3._internal_.md#blocktag) | - -#### Returns - -`Promise`<[`Contract`](verida_web3._internal_.Contract.md)\> - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:114 - -___ - -### \_wrapEvent - -▸ **_wrapEvent**(`runningEvent`, `log`, `listener`): [`Event`](../interfaces/verida_web3._internal_.Event.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `runningEvent` | [`RunningEvent`](verida_web3._internal_.RunningEvent.md) | -| `log` | [`Log`](../interfaces/verida_web3._internal_.Log.md) | -| `listener` | [`Listener`](../modules/verida_web3._internal_.md#listener) | - -#### Returns - -[`Event`](../interfaces/verida_web3._internal_.Event.md) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:122 - -___ - -### attach - -▸ **attach**(`addressOrName`): [`Contract`](verida_web3._internal_.Contract.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `addressOrName` | `string` | - -#### Returns - -[`Contract`](verida_web3._internal_.Contract.md) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:117 - -___ - -### connect - -▸ **connect**(`signerOrProvider`): [`Contract`](verida_web3._internal_.Contract.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `signerOrProvider` | `string` \| [`Signer`](verida_web3._internal_.Signer.md) \| [`Provider`](verida_web3._internal_.Provider.md) | - -#### Returns - -[`Contract`](verida_web3._internal_.Contract.md) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:116 - -___ - -### deployed - -▸ **deployed**(): `Promise`<[`Contract`](verida_web3._internal_.Contract.md)\> - -#### Returns - -`Promise`<[`Contract`](verida_web3._internal_.Contract.md)\> - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:113 - -___ - -### emit - -▸ **emit**(`eventName`, ...`args`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | `string` \| [`EventFilter`](../modules/verida_web3._internal_.md#eventfilter) | -| `...args` | `any`[] | - -#### Returns - -`boolean` - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:127 - -___ - -### fallback - -▸ **fallback**(`overrides?`): `Promise`<[`TransactionResponse`](../interfaces/verida_web3._internal_.TransactionResponse.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `overrides?` | [`TransactionRequest`](../modules/verida_web3._internal_.md#transactionrequest) | - -#### Returns - -`Promise`<[`TransactionResponse`](../interfaces/verida_web3._internal_.TransactionResponse.md)\> - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:115 - -___ - -### listenerCount - -▸ **listenerCount**(`eventName?`): `number` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName?` | `string` \| [`EventFilter`](../modules/verida_web3._internal_.md#eventfilter) | - -#### Returns - -`number` - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:128 - -___ - -### listeners - -▸ **listeners**(`eventName?`): [`Listener`](../modules/verida_web3._internal_.md#listener)[] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName?` | `string` \| [`EventFilter`](../modules/verida_web3._internal_.md#eventfilter) | - -#### Returns - -[`Listener`](../modules/verida_web3._internal_.md#listener)[] - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:129 - -___ - -### off - -▸ **off**(`eventName`, `listener`): [`BaseContract`](verida_web3._internal_.BaseContract.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | `string` \| [`EventFilter`](../modules/verida_web3._internal_.md#eventfilter) | -| `listener` | [`Listener`](../modules/verida_web3._internal_.md#listener) | - -#### Returns - -[`BaseContract`](verida_web3._internal_.BaseContract.md) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:131 - -___ - -### on - -▸ **on**(`event`, `listener`): [`BaseContract`](verida_web3._internal_.BaseContract.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | `string` \| [`EventFilter`](../modules/verida_web3._internal_.md#eventfilter) | -| `listener` | [`Listener`](../modules/verida_web3._internal_.md#listener) | - -#### Returns - -[`BaseContract`](verida_web3._internal_.BaseContract.md) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:125 - -___ - -### once - -▸ **once**(`event`, `listener`): [`BaseContract`](verida_web3._internal_.BaseContract.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | `string` \| [`EventFilter`](../modules/verida_web3._internal_.md#eventfilter) | -| `listener` | [`Listener`](../modules/verida_web3._internal_.md#listener) | - -#### Returns - -[`BaseContract`](verida_web3._internal_.BaseContract.md) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:126 - -___ - -### queryFilter - -▸ **queryFilter**(`event`, `fromBlockOrBlockhash?`, `toBlock?`): `Promise`<[`Event`](../interfaces/verida_web3._internal_.Event.md)[]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | `string` \| [`EventFilter`](../modules/verida_web3._internal_.md#eventfilter) | -| `fromBlockOrBlockhash?` | [`BlockTag`](../modules/verida_web3._internal_.md#blocktag) | -| `toBlock?` | [`BlockTag`](../modules/verida_web3._internal_.md#blocktag) | - -#### Returns - -`Promise`<[`Event`](../interfaces/verida_web3._internal_.Event.md)[]\> - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:124 - -___ - -### removeAllListeners - -▸ **removeAllListeners**(`eventName?`): [`BaseContract`](verida_web3._internal_.BaseContract.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName?` | `string` \| [`EventFilter`](../modules/verida_web3._internal_.md#eventfilter) | - -#### Returns - -[`BaseContract`](verida_web3._internal_.BaseContract.md) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:130 - -___ - -### removeListener - -▸ **removeListener**(`eventName`, `listener`): [`BaseContract`](verida_web3._internal_.BaseContract.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | `string` \| [`EventFilter`](../modules/verida_web3._internal_.md#eventfilter) | -| `listener` | [`Listener`](../modules/verida_web3._internal_.md#listener) | - -#### Returns - -[`BaseContract`](verida_web3._internal_.BaseContract.md) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:132 - -___ - -### getContractAddress - -▸ `Static` **getContractAddress**(`transaction`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transaction` | `Object` | -| `transaction.from` | `string` | -| `transaction.nonce` | [`BigNumberish`](../modules/verida_web3._internal_.md#bignumberish) | - -#### Returns - -`string` - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:108 - -___ - -### getInterface - -▸ `Static` **getInterface**(`contractInterface`): [`Interface`](verida_web3._internal_.Interface.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contractInterface` | [`ContractInterface`](../modules/verida_web3._internal_.md#contractinterface) | - -#### Returns - -[`Interface`](verida_web3._internal_.Interface.md) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:112 - -___ - -### isIndexed - -▸ `Static` **isIndexed**(`value`): value is Indexed - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `any` | - -#### Returns - -value is Indexed - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:118 diff --git a/docs/api/verida-js/classes/verida_web3._internal_.BigNumber.md b/docs/api/verida-js/classes/verida_web3._internal_.BigNumber.md deleted file mode 100644 index f5e822b..0000000 --- a/docs/api/verida-js/classes/verida_web3._internal_.BigNumber.md +++ /dev/null @@ -1,631 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web3](../modules/verida_web3.md) / [](../modules/verida_web3._internal_.md) / BigNumber - -# Class: BigNumber - -[@verida/web3](../modules/verida_web3.md).[](../modules/verida_web3._internal_.md).BigNumber - -## Implements - -- [`Hexable`](../interfaces/verida_web3._internal_.Hexable.md) - -## Table of contents - -### Constructors - -- [constructor](verida_web3._internal_.BigNumber.md#constructor) - -### Properties - -- [\_hex](verida_web3._internal_.BigNumber.md#_hex) -- [\_isBigNumber](verida_web3._internal_.BigNumber.md#_isbignumber) - -### Methods - -- [abs](verida_web3._internal_.BigNumber.md#abs) -- [add](verida_web3._internal_.BigNumber.md#add) -- [and](verida_web3._internal_.BigNumber.md#and) -- [div](verida_web3._internal_.BigNumber.md#div) -- [eq](verida_web3._internal_.BigNumber.md#eq) -- [fromTwos](verida_web3._internal_.BigNumber.md#fromtwos) -- [gt](verida_web3._internal_.BigNumber.md#gt) -- [gte](verida_web3._internal_.BigNumber.md#gte) -- [isNegative](verida_web3._internal_.BigNumber.md#isnegative) -- [isZero](verida_web3._internal_.BigNumber.md#iszero) -- [lt](verida_web3._internal_.BigNumber.md#lt) -- [lte](verida_web3._internal_.BigNumber.md#lte) -- [mask](verida_web3._internal_.BigNumber.md#mask) -- [mod](verida_web3._internal_.BigNumber.md#mod) -- [mul](verida_web3._internal_.BigNumber.md#mul) -- [or](verida_web3._internal_.BigNumber.md#or) -- [pow](verida_web3._internal_.BigNumber.md#pow) -- [shl](verida_web3._internal_.BigNumber.md#shl) -- [shr](verida_web3._internal_.BigNumber.md#shr) -- [sub](verida_web3._internal_.BigNumber.md#sub) -- [toBigInt](verida_web3._internal_.BigNumber.md#tobigint) -- [toHexString](verida_web3._internal_.BigNumber.md#tohexstring) -- [toJSON](verida_web3._internal_.BigNumber.md#tojson) -- [toNumber](verida_web3._internal_.BigNumber.md#tonumber) -- [toString](verida_web3._internal_.BigNumber.md#tostring) -- [toTwos](verida_web3._internal_.BigNumber.md#totwos) -- [xor](verida_web3._internal_.BigNumber.md#xor) -- [from](verida_web3._internal_.BigNumber.md#from) -- [isBigNumber](verida_web3._internal_.BigNumber.md#isbignumber) - -## Constructors - -### constructor - -• **new BigNumber**(`constructorGuard`, `hex`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `constructorGuard` | `any` | -| `hex` | `string` | - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:7 - -## Properties - -### \_hex - -• `Readonly` **\_hex**: `string` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:5 - -___ - -### \_isBigNumber - -• `Readonly` **\_isBigNumber**: `boolean` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:6 - -## Methods - -### abs - -▸ **abs**(): [`BigNumber`](verida_web3._internal_.BigNumber.md) - -#### Returns - -[`BigNumber`](verida_web3._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:10 - -___ - -### add - -▸ **add**(`other`): [`BigNumber`](verida_web3._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_web3._internal_.md#bignumberish) | - -#### Returns - -[`BigNumber`](verida_web3._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:11 - -___ - -### and - -▸ **and**(`other`): [`BigNumber`](verida_web3._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_web3._internal_.md#bignumberish) | - -#### Returns - -[`BigNumber`](verida_web3._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:17 - -___ - -### div - -▸ **div**(`other`): [`BigNumber`](verida_web3._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_web3._internal_.md#bignumberish) | - -#### Returns - -[`BigNumber`](verida_web3._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:13 - -___ - -### eq - -▸ **eq**(`other`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_web3._internal_.md#bignumberish) | - -#### Returns - -`boolean` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:23 - -___ - -### fromTwos - -▸ **fromTwos**(`value`): [`BigNumber`](verida_web3._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `number` | - -#### Returns - -[`BigNumber`](verida_web3._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:8 - -___ - -### gt - -▸ **gt**(`other`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_web3._internal_.md#bignumberish) | - -#### Returns - -`boolean` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:26 - -___ - -### gte - -▸ **gte**(`other`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_web3._internal_.md#bignumberish) | - -#### Returns - -`boolean` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:27 - -___ - -### isNegative - -▸ **isNegative**(): `boolean` - -#### Returns - -`boolean` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:28 - -___ - -### isZero - -▸ **isZero**(): `boolean` - -#### Returns - -`boolean` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:29 - -___ - -### lt - -▸ **lt**(`other`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_web3._internal_.md#bignumberish) | - -#### Returns - -`boolean` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:24 - -___ - -### lte - -▸ **lte**(`other`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_web3._internal_.md#bignumberish) | - -#### Returns - -`boolean` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:25 - -___ - -### mask - -▸ **mask**(`value`): [`BigNumber`](verida_web3._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `number` | - -#### Returns - -[`BigNumber`](verida_web3._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:20 - -___ - -### mod - -▸ **mod**(`other`): [`BigNumber`](verida_web3._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_web3._internal_.md#bignumberish) | - -#### Returns - -[`BigNumber`](verida_web3._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:15 - -___ - -### mul - -▸ **mul**(`other`): [`BigNumber`](verida_web3._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_web3._internal_.md#bignumberish) | - -#### Returns - -[`BigNumber`](verida_web3._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:14 - -___ - -### or - -▸ **or**(`other`): [`BigNumber`](verida_web3._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_web3._internal_.md#bignumberish) | - -#### Returns - -[`BigNumber`](verida_web3._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:18 - -___ - -### pow - -▸ **pow**(`other`): [`BigNumber`](verida_web3._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_web3._internal_.md#bignumberish) | - -#### Returns - -[`BigNumber`](verida_web3._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:16 - -___ - -### shl - -▸ **shl**(`value`): [`BigNumber`](verida_web3._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `number` | - -#### Returns - -[`BigNumber`](verida_web3._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:21 - -___ - -### shr - -▸ **shr**(`value`): [`BigNumber`](verida_web3._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `number` | - -#### Returns - -[`BigNumber`](verida_web3._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:22 - -___ - -### sub - -▸ **sub**(`other`): [`BigNumber`](verida_web3._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_web3._internal_.md#bignumberish) | - -#### Returns - -[`BigNumber`](verida_web3._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:12 - -___ - -### toBigInt - -▸ **toBigInt**(): `bigint` - -#### Returns - -`bigint` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:31 - -___ - -### toHexString - -▸ **toHexString**(): `string` - -#### Returns - -`string` - -#### Implementation of - -[Hexable](../interfaces/verida_web3._internal_.Hexable.md).[toHexString](../interfaces/verida_web3._internal_.Hexable.md#tohexstring) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:33 - -___ - -### toJSON - -▸ **toJSON**(`key?`): `any` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `key?` | `string` | - -#### Returns - -`any` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:34 - -___ - -### toNumber - -▸ **toNumber**(): `number` - -#### Returns - -`number` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:30 - -___ - -### toString - -▸ **toString**(): `string` - -#### Returns - -`string` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:32 - -___ - -### toTwos - -▸ **toTwos**(`value`): [`BigNumber`](verida_web3._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `number` | - -#### Returns - -[`BigNumber`](verida_web3._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:9 - -___ - -### xor - -▸ **xor**(`other`): [`BigNumber`](verida_web3._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_web3._internal_.md#bignumberish) | - -#### Returns - -[`BigNumber`](verida_web3._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:19 - -___ - -### from - -▸ `Static` **from**(`value`): [`BigNumber`](verida_web3._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `any` | - -#### Returns - -[`BigNumber`](verida_web3._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:35 - -___ - -### isBigNumber - -▸ `Static` **isBigNumber**(`value`): value is BigNumber - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `any` | - -#### Returns - -value is BigNumber - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:36 diff --git a/docs/api/verida-js/classes/verida_web3._internal_.Coder.md b/docs/api/verida-js/classes/verida_web3._internal_.Coder.md deleted file mode 100644 index 157d201..0000000 --- a/docs/api/verida-js/classes/verida_web3._internal_.Coder.md +++ /dev/null @@ -1,160 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web3](../modules/verida_web3.md) / [](../modules/verida_web3._internal_.md) / Coder - -# Class: Coder - -[@verida/web3](../modules/verida_web3.md).[](../modules/verida_web3._internal_.md).Coder - -## Table of contents - -### Constructors - -- [constructor](verida_web3._internal_.Coder.md#constructor) - -### Properties - -- [dynamic](verida_web3._internal_.Coder.md#dynamic) -- [localName](verida_web3._internal_.Coder.md#localname) -- [name](verida_web3._internal_.Coder.md#name) -- [type](verida_web3._internal_.Coder.md#type) - -### Methods - -- [\_throwError](verida_web3._internal_.Coder.md#_throwerror) -- [decode](verida_web3._internal_.Coder.md#decode) -- [defaultValue](verida_web3._internal_.Coder.md#defaultvalue) -- [encode](verida_web3._internal_.Coder.md#encode) - -## Constructors - -### constructor - -• **new Coder**(`name`, `type`, `localName`, `dynamic`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` | -| `type` | `string` | -| `localName` | `string` | -| `dynamic` | `boolean` | - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:16 - -## Properties - -### dynamic - -• `Readonly` **dynamic**: `boolean` - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:15 - -___ - -### localName - -• `Readonly` **localName**: `string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:14 - -___ - -### name - -• `Readonly` **name**: `string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:12 - -___ - -### type - -• `Readonly` **type**: `string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:13 - -## Methods - -### \_throwError - -▸ **_throwError**(`message`, `value`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `message` | `string` | -| `value` | `any` | - -#### Returns - -`void` - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:17 - -___ - -### decode - -▸ `Abstract` **decode**(`reader`): `any` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `reader` | [`Reader`](verida_web3._internal_.Reader.md) | - -#### Returns - -`any` - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:19 - -___ - -### defaultValue - -▸ `Abstract` **defaultValue**(): `any` - -#### Returns - -`any` - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:20 - -___ - -### encode - -▸ `Abstract` **encode**(`writer`, `value`): `number` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `writer` | [`Writer`](verida_web3._internal_.Writer.md) | -| `value` | `any` | - -#### Returns - -`number` - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:18 diff --git a/docs/api/verida-js/classes/verida_web3._internal_.ConstructorFragment.md b/docs/api/verida-js/classes/verida_web3._internal_.ConstructorFragment.md deleted file mode 100644 index 365fca2..0000000 --- a/docs/api/verida-js/classes/verida_web3._internal_.ConstructorFragment.md +++ /dev/null @@ -1,285 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web3](../modules/verida_web3.md) / [](../modules/verida_web3._internal_.md) / ConstructorFragment - -# Class: ConstructorFragment - -[@verida/web3](../modules/verida_web3.md).[](../modules/verida_web3._internal_.md).ConstructorFragment - -## Hierarchy - -- [`Fragment`](verida_web3._internal_.Fragment.md) - - ↳ **`ConstructorFragment`** - - ↳↳ [`FunctionFragment`](verida_web3._internal_.FunctionFragment.md) - -## Table of contents - -### Constructors - -- [constructor](verida_web3._internal_.ConstructorFragment.md#constructor) - -### Properties - -- [\_isFragment](verida_web3._internal_.ConstructorFragment.md#_isfragment) -- [gas](verida_web3._internal_.ConstructorFragment.md#gas) -- [inputs](verida_web3._internal_.ConstructorFragment.md#inputs) -- [name](verida_web3._internal_.ConstructorFragment.md#name) -- [payable](verida_web3._internal_.ConstructorFragment.md#payable) -- [stateMutability](verida_web3._internal_.ConstructorFragment.md#statemutability) -- [type](verida_web3._internal_.ConstructorFragment.md#type) - -### Methods - -- [format](verida_web3._internal_.ConstructorFragment.md#format) -- [from](verida_web3._internal_.ConstructorFragment.md#from) -- [fromObject](verida_web3._internal_.ConstructorFragment.md#fromobject) -- [fromString](verida_web3._internal_.ConstructorFragment.md#fromstring) -- [isConstructorFragment](verida_web3._internal_.ConstructorFragment.md#isconstructorfragment) -- [isFragment](verida_web3._internal_.ConstructorFragment.md#isfragment) - -## Constructors - -### constructor - -• **new ConstructorFragment**(`constructorGuard`, `params`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `constructorGuard` | `any` | -| `params` | `any` | - -#### Inherited from - -[Fragment](verida_web3._internal_.Fragment.md).[constructor](verida_web3._internal_.Fragment.md#constructor) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:44 - -## Properties - -### \_isFragment - -• `Readonly` **\_isFragment**: `boolean` - -#### Inherited from - -[Fragment](verida_web3._internal_.Fragment.md).[_isFragment](verida_web3._internal_.Fragment.md#_isfragment) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:43 - -___ - -### gas - -• `Optional` **gas**: [`BigNumber`](verida_web3._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:62 - -___ - -### inputs - -• `Readonly` **inputs**: [`ParamType`](verida_web3._internal_.ParamType.md)[] - -#### Inherited from - -[Fragment](verida_web3._internal_.Fragment.md).[inputs](verida_web3._internal_.Fragment.md#inputs) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:42 - -___ - -### name - -• `Readonly` **name**: `string` - -#### Inherited from - -[Fragment](verida_web3._internal_.Fragment.md).[name](verida_web3._internal_.Fragment.md#name) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:41 - -___ - -### payable - -• **payable**: `boolean` - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:61 - -___ - -### stateMutability - -• **stateMutability**: `string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:60 - -___ - -### type - -• `Readonly` **type**: `string` - -#### Inherited from - -[Fragment](verida_web3._internal_.Fragment.md).[type](verida_web3._internal_.Fragment.md#type) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:40 - -## Methods - -### format - -▸ **format**(`format?`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `format?` | `string` | - -#### Returns - -`string` - -#### Overrides - -[Fragment](verida_web3._internal_.Fragment.md).[format](verida_web3._internal_.Fragment.md#format) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:63 - -___ - -### from - -▸ `Static` **from**(`value`): [`ConstructorFragment`](verida_web3._internal_.ConstructorFragment.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `string` \| [`JsonFragment`](../interfaces/verida_web3._internal_.JsonFragment.md) \| [`ConstructorFragment`](verida_web3._internal_.ConstructorFragment.md) | - -#### Returns - -[`ConstructorFragment`](verida_web3._internal_.ConstructorFragment.md) - -#### Overrides - -[Fragment](verida_web3._internal_.Fragment.md).[from](verida_web3._internal_.Fragment.md#from) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:64 - -___ - -### fromObject - -▸ `Static` **fromObject**(`value`): [`ConstructorFragment`](verida_web3._internal_.ConstructorFragment.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | [`JsonFragment`](../interfaces/verida_web3._internal_.JsonFragment.md) \| [`ConstructorFragment`](verida_web3._internal_.ConstructorFragment.md) | - -#### Returns - -[`ConstructorFragment`](verida_web3._internal_.ConstructorFragment.md) - -#### Overrides - -[Fragment](verida_web3._internal_.Fragment.md).[fromObject](verida_web3._internal_.Fragment.md#fromobject) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:65 - -___ - -### fromString - -▸ `Static` **fromString**(`value`): [`ConstructorFragment`](verida_web3._internal_.ConstructorFragment.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `string` | - -#### Returns - -[`ConstructorFragment`](verida_web3._internal_.ConstructorFragment.md) - -#### Overrides - -[Fragment](verida_web3._internal_.Fragment.md).[fromString](verida_web3._internal_.Fragment.md#fromstring) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:66 - -___ - -### isConstructorFragment - -▸ `Static` **isConstructorFragment**(`value`): value is ConstructorFragment - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `any` | - -#### Returns - -value is ConstructorFragment - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:67 - -___ - -### isFragment - -▸ `Static` **isFragment**(`value`): value is Fragment - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `any` | - -#### Returns - -value is Fragment - -#### Inherited from - -[Fragment](verida_web3._internal_.Fragment.md).[isFragment](verida_web3._internal_.Fragment.md#isfragment) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:49 diff --git a/docs/api/verida-js/classes/verida_web3._internal_.Contract.md b/docs/api/verida-js/classes/verida_web3._internal_.Contract.md deleted file mode 100644 index 07d7b77..0000000 --- a/docs/api/verida-js/classes/verida_web3._internal_.Contract.md +++ /dev/null @@ -1,767 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web3](../modules/verida_web3.md) / [](../modules/verida_web3._internal_.md) / Contract - -# Class: Contract - -[@verida/web3](../modules/verida_web3.md).[](../modules/verida_web3._internal_.md).Contract - -## Hierarchy - -- [`BaseContract`](verida_web3._internal_.BaseContract.md) - - ↳ **`Contract`** - -## Indexable - -▪ [key: `string`]: [`ContractFunction`](../modules/verida_web3._internal_.md#contractfunction) \| `any` - -## Table of contents - -### Constructors - -- [constructor](verida_web3._internal_.Contract.md#constructor) - -### Properties - -- [\_deployedPromise](verida_web3._internal_.Contract.md#_deployedpromise) -- [\_runningEvents](verida_web3._internal_.Contract.md#_runningevents) -- [\_wrappedEmits](verida_web3._internal_.Contract.md#_wrappedemits) -- [address](verida_web3._internal_.Contract.md#address) -- [callStatic](verida_web3._internal_.Contract.md#callstatic) -- [deployTransaction](verida_web3._internal_.Contract.md#deploytransaction) -- [estimateGas](verida_web3._internal_.Contract.md#estimategas) -- [filters](verida_web3._internal_.Contract.md#filters) -- [functions](verida_web3._internal_.Contract.md#functions) -- [interface](verida_web3._internal_.Contract.md#interface) -- [populateTransaction](verida_web3._internal_.Contract.md#populatetransaction) -- [provider](verida_web3._internal_.Contract.md#provider) -- [resolvedAddress](verida_web3._internal_.Contract.md#resolvedaddress) -- [signer](verida_web3._internal_.Contract.md#signer) - -### Methods - -- [\_checkRunningEvents](verida_web3._internal_.Contract.md#_checkrunningevents) -- [\_deployed](verida_web3._internal_.Contract.md#_deployed) -- [\_wrapEvent](verida_web3._internal_.Contract.md#_wrapevent) -- [attach](verida_web3._internal_.Contract.md#attach) -- [connect](verida_web3._internal_.Contract.md#connect) -- [deployed](verida_web3._internal_.Contract.md#deployed) -- [emit](verida_web3._internal_.Contract.md#emit) -- [fallback](verida_web3._internal_.Contract.md#fallback) -- [listenerCount](verida_web3._internal_.Contract.md#listenercount) -- [listeners](verida_web3._internal_.Contract.md#listeners) -- [off](verida_web3._internal_.Contract.md#off) -- [on](verida_web3._internal_.Contract.md#on) -- [once](verida_web3._internal_.Contract.md#once) -- [queryFilter](verida_web3._internal_.Contract.md#queryfilter) -- [removeAllListeners](verida_web3._internal_.Contract.md#removealllisteners) -- [removeListener](verida_web3._internal_.Contract.md#removelistener) -- [getContractAddress](verida_web3._internal_.Contract.md#getcontractaddress) -- [getInterface](verida_web3._internal_.Contract.md#getinterface) -- [isIndexed](verida_web3._internal_.Contract.md#isindexed) - -## Constructors - -### constructor - -• **new Contract**(`addressOrName`, `contractInterface`, `signerOrProvider?`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `addressOrName` | `string` | -| `contractInterface` | [`ContractInterface`](../modules/verida_web3._internal_.md#contractinterface) | -| `signerOrProvider?` | [`Signer`](verida_web3._internal_.Signer.md) \| [`Provider`](verida_web3._internal_.Provider.md) | - -#### Inherited from - -[BaseContract](verida_web3._internal_.BaseContract.md).[constructor](verida_web3._internal_.BaseContract.md#constructor) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:107 - -## Properties - -### \_deployedPromise - -• **\_deployedPromise**: `Promise`<[`Contract`](verida_web3._internal_.Contract.md)\> - -#### Inherited from - -[BaseContract](verida_web3._internal_.BaseContract.md).[_deployedPromise](verida_web3._internal_.BaseContract.md#_deployedpromise) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:100 - -___ - -### \_runningEvents - -• **\_runningEvents**: `Object` - -#### Index signature - -▪ [eventTag: `string`]: [`RunningEvent`](verida_web3._internal_.RunningEvent.md) - -#### Inherited from - -[BaseContract](verida_web3._internal_.BaseContract.md).[_runningEvents](verida_web3._internal_.BaseContract.md#_runningevents) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:101 - -___ - -### \_wrappedEmits - -• **\_wrappedEmits**: `Object` - -#### Index signature - -▪ [eventTag: `string`]: (...`args`: `any`[]) => `void` - -#### Inherited from - -[BaseContract](verida_web3._internal_.BaseContract.md).[_wrappedEmits](verida_web3._internal_.BaseContract.md#_wrappedemits) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:104 - -___ - -### address - -• `Readonly` **address**: `string` - -#### Inherited from - -[BaseContract](verida_web3._internal_.BaseContract.md).[address](verida_web3._internal_.BaseContract.md#address) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:79 - -___ - -### callStatic - -• `Readonly` **callStatic**: `Object` - -#### Index signature - -▪ [name: `string`]: [`ContractFunction`](../modules/verida_web3._internal_.md#contractfunction) - -#### Inherited from - -[BaseContract](verida_web3._internal_.BaseContract.md).[callStatic](verida_web3._internal_.BaseContract.md#callstatic) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:86 - -___ - -### deployTransaction - -• `Readonly` **deployTransaction**: [`TransactionResponse`](../interfaces/verida_web3._internal_.TransactionResponse.md) - -#### Inherited from - -[BaseContract](verida_web3._internal_.BaseContract.md).[deployTransaction](verida_web3._internal_.BaseContract.md#deploytransaction) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:99 - -___ - -### estimateGas - -• `Readonly` **estimateGas**: `Object` - -#### Index signature - -▪ [name: `string`]: [`ContractFunction`](../modules/verida_web3._internal_.md#contractfunction)<[`BigNumber`](verida_web3._internal_.BigNumber.md)\> - -#### Inherited from - -[BaseContract](verida_web3._internal_.BaseContract.md).[estimateGas](verida_web3._internal_.BaseContract.md#estimategas) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:89 - -___ - -### filters - -• `Readonly` **filters**: `Object` - -#### Index signature - -▪ [name: `string`]: (...`args`: `any`[]) => [`EventFilter`](../modules/verida_web3._internal_.md#eventfilter) - -#### Inherited from - -[BaseContract](verida_web3._internal_.BaseContract.md).[filters](verida_web3._internal_.BaseContract.md#filters) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:95 - -___ - -### functions - -• `Readonly` **functions**: `Object` - -#### Index signature - -▪ [name: `string`]: [`ContractFunction`](../modules/verida_web3._internal_.md#contractfunction) - -#### Inherited from - -[BaseContract](verida_web3._internal_.BaseContract.md).[functions](verida_web3._internal_.BaseContract.md#functions) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:83 - -___ - -### interface - -• `Readonly` **interface**: [`Interface`](verida_web3._internal_.Interface.md) - -#### Inherited from - -[BaseContract](verida_web3._internal_.BaseContract.md).[interface](verida_web3._internal_.BaseContract.md#interface) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:80 - -___ - -### populateTransaction - -• `Readonly` **populateTransaction**: `Object` - -#### Index signature - -▪ [name: `string`]: [`ContractFunction`](../modules/verida_web3._internal_.md#contractfunction)<[`PopulatedTransaction`](../interfaces/verida_web3._internal_.PopulatedTransaction.md)\> - -#### Inherited from - -[BaseContract](verida_web3._internal_.BaseContract.md).[populateTransaction](verida_web3._internal_.BaseContract.md#populatetransaction) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:92 - -___ - -### provider - -• `Readonly` **provider**: [`Provider`](verida_web3._internal_.Provider.md) - -#### Inherited from - -[BaseContract](verida_web3._internal_.BaseContract.md).[provider](verida_web3._internal_.BaseContract.md#provider) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:82 - -___ - -### resolvedAddress - -• `Readonly` **resolvedAddress**: `Promise`<`string`\> - -#### Inherited from - -[BaseContract](verida_web3._internal_.BaseContract.md).[resolvedAddress](verida_web3._internal_.BaseContract.md#resolvedaddress) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:98 - -___ - -### signer - -• `Readonly` **signer**: [`Signer`](verida_web3._internal_.Signer.md) - -#### Inherited from - -[BaseContract](verida_web3._internal_.BaseContract.md).[signer](verida_web3._internal_.BaseContract.md#signer) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:81 - -## Methods - -### \_checkRunningEvents - -▸ **_checkRunningEvents**(`runningEvent`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `runningEvent` | [`RunningEvent`](verida_web3._internal_.RunningEvent.md) | - -#### Returns - -`void` - -#### Inherited from - -[BaseContract](verida_web3._internal_.BaseContract.md).[_checkRunningEvents](verida_web3._internal_.BaseContract.md#_checkrunningevents) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:121 - -___ - -### \_deployed - -▸ **_deployed**(`blockTag?`): `Promise`<[`Contract`](verida_web3._internal_.Contract.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `blockTag?` | [`BlockTag`](../modules/verida_web3._internal_.md#blocktag) | - -#### Returns - -`Promise`<[`Contract`](verida_web3._internal_.Contract.md)\> - -#### Inherited from - -[BaseContract](verida_web3._internal_.BaseContract.md).[_deployed](verida_web3._internal_.BaseContract.md#_deployed) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:114 - -___ - -### \_wrapEvent - -▸ **_wrapEvent**(`runningEvent`, `log`, `listener`): [`Event`](../interfaces/verida_web3._internal_.Event.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `runningEvent` | [`RunningEvent`](verida_web3._internal_.RunningEvent.md) | -| `log` | [`Log`](../interfaces/verida_web3._internal_.Log.md) | -| `listener` | [`Listener`](../modules/verida_web3._internal_.md#listener) | - -#### Returns - -[`Event`](../interfaces/verida_web3._internal_.Event.md) - -#### Inherited from - -[BaseContract](verida_web3._internal_.BaseContract.md).[_wrapEvent](verida_web3._internal_.BaseContract.md#_wrapevent) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:122 - -___ - -### attach - -▸ **attach**(`addressOrName`): [`Contract`](verida_web3._internal_.Contract.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `addressOrName` | `string` | - -#### Returns - -[`Contract`](verida_web3._internal_.Contract.md) - -#### Inherited from - -[BaseContract](verida_web3._internal_.BaseContract.md).[attach](verida_web3._internal_.BaseContract.md#attach) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:117 - -___ - -### connect - -▸ **connect**(`signerOrProvider`): [`Contract`](verida_web3._internal_.Contract.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `signerOrProvider` | `string` \| [`Signer`](verida_web3._internal_.Signer.md) \| [`Provider`](verida_web3._internal_.Provider.md) | - -#### Returns - -[`Contract`](verida_web3._internal_.Contract.md) - -#### Inherited from - -[BaseContract](verida_web3._internal_.BaseContract.md).[connect](verida_web3._internal_.BaseContract.md#connect) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:116 - -___ - -### deployed - -▸ **deployed**(): `Promise`<[`Contract`](verida_web3._internal_.Contract.md)\> - -#### Returns - -`Promise`<[`Contract`](verida_web3._internal_.Contract.md)\> - -#### Inherited from - -[BaseContract](verida_web3._internal_.BaseContract.md).[deployed](verida_web3._internal_.BaseContract.md#deployed) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:113 - -___ - -### emit - -▸ **emit**(`eventName`, ...`args`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | `string` \| [`EventFilter`](../modules/verida_web3._internal_.md#eventfilter) | -| `...args` | `any`[] | - -#### Returns - -`boolean` - -#### Inherited from - -[BaseContract](verida_web3._internal_.BaseContract.md).[emit](verida_web3._internal_.BaseContract.md#emit) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:127 - -___ - -### fallback - -▸ **fallback**(`overrides?`): `Promise`<[`TransactionResponse`](../interfaces/verida_web3._internal_.TransactionResponse.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `overrides?` | [`TransactionRequest`](../modules/verida_web3._internal_.md#transactionrequest) | - -#### Returns - -`Promise`<[`TransactionResponse`](../interfaces/verida_web3._internal_.TransactionResponse.md)\> - -#### Inherited from - -[BaseContract](verida_web3._internal_.BaseContract.md).[fallback](verida_web3._internal_.BaseContract.md#fallback) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:115 - -___ - -### listenerCount - -▸ **listenerCount**(`eventName?`): `number` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName?` | `string` \| [`EventFilter`](../modules/verida_web3._internal_.md#eventfilter) | - -#### Returns - -`number` - -#### Inherited from - -[BaseContract](verida_web3._internal_.BaseContract.md).[listenerCount](verida_web3._internal_.BaseContract.md#listenercount) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:128 - -___ - -### listeners - -▸ **listeners**(`eventName?`): [`Listener`](../modules/verida_web3._internal_.md#listener)[] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName?` | `string` \| [`EventFilter`](../modules/verida_web3._internal_.md#eventfilter) | - -#### Returns - -[`Listener`](../modules/verida_web3._internal_.md#listener)[] - -#### Inherited from - -[BaseContract](verida_web3._internal_.BaseContract.md).[listeners](verida_web3._internal_.BaseContract.md#listeners) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:129 - -___ - -### off - -▸ **off**(`eventName`, `listener`): [`Contract`](verida_web3._internal_.Contract.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | `string` \| [`EventFilter`](../modules/verida_web3._internal_.md#eventfilter) | -| `listener` | [`Listener`](../modules/verida_web3._internal_.md#listener) | - -#### Returns - -[`Contract`](verida_web3._internal_.Contract.md) - -#### Inherited from - -[BaseContract](verida_web3._internal_.BaseContract.md).[off](verida_web3._internal_.BaseContract.md#off) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:131 - -___ - -### on - -▸ **on**(`event`, `listener`): [`Contract`](verida_web3._internal_.Contract.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | `string` \| [`EventFilter`](../modules/verida_web3._internal_.md#eventfilter) | -| `listener` | [`Listener`](../modules/verida_web3._internal_.md#listener) | - -#### Returns - -[`Contract`](verida_web3._internal_.Contract.md) - -#### Inherited from - -[BaseContract](verida_web3._internal_.BaseContract.md).[on](verida_web3._internal_.BaseContract.md#on) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:125 - -___ - -### once - -▸ **once**(`event`, `listener`): [`Contract`](verida_web3._internal_.Contract.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | `string` \| [`EventFilter`](../modules/verida_web3._internal_.md#eventfilter) | -| `listener` | [`Listener`](../modules/verida_web3._internal_.md#listener) | - -#### Returns - -[`Contract`](verida_web3._internal_.Contract.md) - -#### Inherited from - -[BaseContract](verida_web3._internal_.BaseContract.md).[once](verida_web3._internal_.BaseContract.md#once) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:126 - -___ - -### queryFilter - -▸ **queryFilter**(`event`, `fromBlockOrBlockhash?`, `toBlock?`): `Promise`<[`Event`](../interfaces/verida_web3._internal_.Event.md)[]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | `string` \| [`EventFilter`](../modules/verida_web3._internal_.md#eventfilter) | -| `fromBlockOrBlockhash?` | [`BlockTag`](../modules/verida_web3._internal_.md#blocktag) | -| `toBlock?` | [`BlockTag`](../modules/verida_web3._internal_.md#blocktag) | - -#### Returns - -`Promise`<[`Event`](../interfaces/verida_web3._internal_.Event.md)[]\> - -#### Inherited from - -[BaseContract](verida_web3._internal_.BaseContract.md).[queryFilter](verida_web3._internal_.BaseContract.md#queryfilter) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:124 - -___ - -### removeAllListeners - -▸ **removeAllListeners**(`eventName?`): [`Contract`](verida_web3._internal_.Contract.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName?` | `string` \| [`EventFilter`](../modules/verida_web3._internal_.md#eventfilter) | - -#### Returns - -[`Contract`](verida_web3._internal_.Contract.md) - -#### Inherited from - -[BaseContract](verida_web3._internal_.BaseContract.md).[removeAllListeners](verida_web3._internal_.BaseContract.md#removealllisteners) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:130 - -___ - -### removeListener - -▸ **removeListener**(`eventName`, `listener`): [`Contract`](verida_web3._internal_.Contract.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | `string` \| [`EventFilter`](../modules/verida_web3._internal_.md#eventfilter) | -| `listener` | [`Listener`](../modules/verida_web3._internal_.md#listener) | - -#### Returns - -[`Contract`](verida_web3._internal_.Contract.md) - -#### Inherited from - -[BaseContract](verida_web3._internal_.BaseContract.md).[removeListener](verida_web3._internal_.BaseContract.md#removelistener) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:132 - -___ - -### getContractAddress - -▸ `Static` **getContractAddress**(`transaction`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transaction` | `Object` | -| `transaction.from` | `string` | -| `transaction.nonce` | [`BigNumberish`](../modules/verida_web3._internal_.md#bignumberish) | - -#### Returns - -`string` - -#### Inherited from - -[BaseContract](verida_web3._internal_.BaseContract.md).[getContractAddress](verida_web3._internal_.BaseContract.md#getcontractaddress) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:108 - -___ - -### getInterface - -▸ `Static` **getInterface**(`contractInterface`): [`Interface`](verida_web3._internal_.Interface.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contractInterface` | [`ContractInterface`](../modules/verida_web3._internal_.md#contractinterface) | - -#### Returns - -[`Interface`](verida_web3._internal_.Interface.md) - -#### Inherited from - -[BaseContract](verida_web3._internal_.BaseContract.md).[getInterface](verida_web3._internal_.BaseContract.md#getinterface) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:112 - -___ - -### isIndexed - -▸ `Static` **isIndexed**(`value`): value is Indexed - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `any` | - -#### Returns - -value is Indexed - -#### Inherited from - -[BaseContract](verida_web3._internal_.BaseContract.md).[isIndexed](verida_web3._internal_.BaseContract.md#isindexed) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:118 diff --git a/docs/api/verida-js/classes/verida_web3._internal_.Description.md b/docs/api/verida-js/classes/verida_web3._internal_.Description.md deleted file mode 100644 index 1e95829..0000000 --- a/docs/api/verida-js/classes/verida_web3._internal_.Description.md +++ /dev/null @@ -1,53 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web3](../modules/verida_web3.md) / [](../modules/verida_web3._internal_.md) / Description - -# Class: Description - -[@verida/web3](../modules/verida_web3.md).[](../modules/verida_web3._internal_.md).Description - -## Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `any` | - -## Hierarchy - -- **`Description`** - - ↳ [`Indexed`](verida_web3._internal_.Indexed.md) - - ↳ [`TransactionDescription`](verida_web3._internal_.TransactionDescription.md) - - ↳ [`LogDescription`](verida_web3._internal_.LogDescription.md) - - ↳ [`ErrorDescription`](verida_web3._internal_.ErrorDescription.md) - - ↳ [`ForkEvent`](verida_web3._internal_.ForkEvent.md) - -## Table of contents - -### Constructors - -- [constructor](verida_web3._internal_.Description.md#constructor) - -## Constructors - -### constructor - -• **new Description**<`T`\>(`info`) - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `any` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `info` | { [K in string \| number \| symbol]: T[K] } | - -#### Defined in - -node_modules/@ethersproject/properties/lib/index.d.ts:13 diff --git a/docs/api/verida-js/classes/verida_web3._internal_.ErrorDescription.md b/docs/api/verida-js/classes/verida_web3._internal_.ErrorDescription.md deleted file mode 100644 index e63b17c..0000000 --- a/docs/api/verida-js/classes/verida_web3._internal_.ErrorDescription.md +++ /dev/null @@ -1,100 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web3](../modules/verida_web3.md) / [](../modules/verida_web3._internal_.md) / ErrorDescription - -# Class: ErrorDescription - -[@verida/web3](../modules/verida_web3.md).[](../modules/verida_web3._internal_.md).ErrorDescription - -## Hierarchy - -- [`Description`](verida_web3._internal_.Description.md)<[`ErrorDescription`](verida_web3._internal_.ErrorDescription.md)\> - - ↳ **`ErrorDescription`** - -## Table of contents - -### Constructors - -- [constructor](verida_web3._internal_.ErrorDescription.md#constructor) - -### Properties - -- [args](verida_web3._internal_.ErrorDescription.md#args) -- [errorFragment](verida_web3._internal_.ErrorDescription.md#errorfragment) -- [name](verida_web3._internal_.ErrorDescription.md#name) -- [sighash](verida_web3._internal_.ErrorDescription.md#sighash) -- [signature](verida_web3._internal_.ErrorDescription.md#signature) - -## Constructors - -### constructor - -• **new ErrorDescription**(`info`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `info` | `Object` | -| `info.args` | [`Result`](../interfaces/verida_web3._internal_.Result.md) | -| `info.errorFragment` | [`ErrorFragment`](verida_web3._internal_.ErrorFragment.md) | -| `info.name` | `string` | -| `info.sighash` | `string` | -| `info.signature` | `string` | - -#### Inherited from - -[Description](verida_web3._internal_.Description.md).[constructor](verida_web3._internal_.Description.md#constructor) - -#### Defined in - -node_modules/@ethersproject/properties/lib/index.d.ts:13 - -## Properties - -### args - -• `Readonly` **args**: [`Result`](../interfaces/verida_web3._internal_.Result.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:26 - -___ - -### errorFragment - -• `Readonly` **errorFragment**: [`ErrorFragment`](verida_web3._internal_.ErrorFragment.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:24 - -___ - -### name - -• `Readonly` **name**: `string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:25 - -___ - -### sighash - -• `Readonly` **sighash**: `string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:28 - -___ - -### signature - -• `Readonly` **signature**: `string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:27 diff --git a/docs/api/verida-js/classes/verida_web3._internal_.ErrorFragment.md b/docs/api/verida-js/classes/verida_web3._internal_.ErrorFragment.md deleted file mode 100644 index 2f90c11..0000000 --- a/docs/api/verida-js/classes/verida_web3._internal_.ErrorFragment.md +++ /dev/null @@ -1,250 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web3](../modules/verida_web3.md) / [](../modules/verida_web3._internal_.md) / ErrorFragment - -# Class: ErrorFragment - -[@verida/web3](../modules/verida_web3.md).[](../modules/verida_web3._internal_.md).ErrorFragment - -## Hierarchy - -- [`Fragment`](verida_web3._internal_.Fragment.md) - - ↳ **`ErrorFragment`** - -## Table of contents - -### Constructors - -- [constructor](verida_web3._internal_.ErrorFragment.md#constructor) - -### Properties - -- [\_isFragment](verida_web3._internal_.ErrorFragment.md#_isfragment) -- [inputs](verida_web3._internal_.ErrorFragment.md#inputs) -- [name](verida_web3._internal_.ErrorFragment.md#name) -- [type](verida_web3._internal_.ErrorFragment.md#type) - -### Methods - -- [format](verida_web3._internal_.ErrorFragment.md#format) -- [from](verida_web3._internal_.ErrorFragment.md#from) -- [fromObject](verida_web3._internal_.ErrorFragment.md#fromobject) -- [fromString](verida_web3._internal_.ErrorFragment.md#fromstring) -- [isErrorFragment](verida_web3._internal_.ErrorFragment.md#iserrorfragment) -- [isFragment](verida_web3._internal_.ErrorFragment.md#isfragment) - -## Constructors - -### constructor - -• **new ErrorFragment**(`constructorGuard`, `params`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `constructorGuard` | `any` | -| `params` | `any` | - -#### Inherited from - -[Fragment](verida_web3._internal_.Fragment.md).[constructor](verida_web3._internal_.Fragment.md#constructor) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:44 - -## Properties - -### \_isFragment - -• `Readonly` **\_isFragment**: `boolean` - -#### Inherited from - -[Fragment](verida_web3._internal_.Fragment.md).[_isFragment](verida_web3._internal_.Fragment.md#_isfragment) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:43 - -___ - -### inputs - -• `Readonly` **inputs**: [`ParamType`](verida_web3._internal_.ParamType.md)[] - -#### Inherited from - -[Fragment](verida_web3._internal_.Fragment.md).[inputs](verida_web3._internal_.Fragment.md#inputs) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:42 - -___ - -### name - -• `Readonly` **name**: `string` - -#### Inherited from - -[Fragment](verida_web3._internal_.Fragment.md).[name](verida_web3._internal_.Fragment.md#name) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:41 - -___ - -### type - -• `Readonly` **type**: `string` - -#### Inherited from - -[Fragment](verida_web3._internal_.Fragment.md).[type](verida_web3._internal_.Fragment.md#type) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:40 - -## Methods - -### format - -▸ **format**(`format?`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `format?` | `string` | - -#### Returns - -`string` - -#### Overrides - -[Fragment](verida_web3._internal_.Fragment.md).[format](verida_web3._internal_.Fragment.md#format) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:79 - -___ - -### from - -▸ `Static` **from**(`value`): [`ErrorFragment`](verida_web3._internal_.ErrorFragment.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `string` \| [`JsonFragment`](../interfaces/verida_web3._internal_.JsonFragment.md) \| [`ErrorFragment`](verida_web3._internal_.ErrorFragment.md) | - -#### Returns - -[`ErrorFragment`](verida_web3._internal_.ErrorFragment.md) - -#### Overrides - -[Fragment](verida_web3._internal_.Fragment.md).[from](verida_web3._internal_.Fragment.md#from) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:80 - -___ - -### fromObject - -▸ `Static` **fromObject**(`value`): [`ErrorFragment`](verida_web3._internal_.ErrorFragment.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | [`JsonFragment`](../interfaces/verida_web3._internal_.JsonFragment.md) \| [`ErrorFragment`](verida_web3._internal_.ErrorFragment.md) | - -#### Returns - -[`ErrorFragment`](verida_web3._internal_.ErrorFragment.md) - -#### Overrides - -[Fragment](verida_web3._internal_.Fragment.md).[fromObject](verida_web3._internal_.Fragment.md#fromobject) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:81 - -___ - -### fromString - -▸ `Static` **fromString**(`value`): [`ErrorFragment`](verida_web3._internal_.ErrorFragment.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `string` | - -#### Returns - -[`ErrorFragment`](verida_web3._internal_.ErrorFragment.md) - -#### Overrides - -[Fragment](verida_web3._internal_.Fragment.md).[fromString](verida_web3._internal_.Fragment.md#fromstring) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:82 - -___ - -### isErrorFragment - -▸ `Static` **isErrorFragment**(`value`): value is ErrorFragment - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `any` | - -#### Returns - -value is ErrorFragment - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:83 - -___ - -### isFragment - -▸ `Static` **isFragment**(`value`): value is Fragment - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `any` | - -#### Returns - -value is Fragment - -#### Inherited from - -[Fragment](verida_web3._internal_.Fragment.md).[isFragment](verida_web3._internal_.Fragment.md#isfragment) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:49 diff --git a/docs/api/verida-js/classes/verida_web3._internal_.EventFragment.md b/docs/api/verida-js/classes/verida_web3._internal_.EventFragment.md deleted file mode 100644 index 7faeeee..0000000 --- a/docs/api/verida-js/classes/verida_web3._internal_.EventFragment.md +++ /dev/null @@ -1,261 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web3](../modules/verida_web3.md) / [](../modules/verida_web3._internal_.md) / EventFragment - -# Class: EventFragment - -[@verida/web3](../modules/verida_web3.md).[](../modules/verida_web3._internal_.md).EventFragment - -## Hierarchy - -- [`Fragment`](verida_web3._internal_.Fragment.md) - - ↳ **`EventFragment`** - -## Table of contents - -### Constructors - -- [constructor](verida_web3._internal_.EventFragment.md#constructor) - -### Properties - -- [\_isFragment](verida_web3._internal_.EventFragment.md#_isfragment) -- [anonymous](verida_web3._internal_.EventFragment.md#anonymous) -- [inputs](verida_web3._internal_.EventFragment.md#inputs) -- [name](verida_web3._internal_.EventFragment.md#name) -- [type](verida_web3._internal_.EventFragment.md#type) - -### Methods - -- [format](verida_web3._internal_.EventFragment.md#format) -- [from](verida_web3._internal_.EventFragment.md#from) -- [fromObject](verida_web3._internal_.EventFragment.md#fromobject) -- [fromString](verida_web3._internal_.EventFragment.md#fromstring) -- [isEventFragment](verida_web3._internal_.EventFragment.md#iseventfragment) -- [isFragment](verida_web3._internal_.EventFragment.md#isfragment) - -## Constructors - -### constructor - -• **new EventFragment**(`constructorGuard`, `params`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `constructorGuard` | `any` | -| `params` | `any` | - -#### Inherited from - -[Fragment](verida_web3._internal_.Fragment.md).[constructor](verida_web3._internal_.Fragment.md#constructor) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:44 - -## Properties - -### \_isFragment - -• `Readonly` **\_isFragment**: `boolean` - -#### Inherited from - -[Fragment](verida_web3._internal_.Fragment.md).[_isFragment](verida_web3._internal_.Fragment.md#_isfragment) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:43 - -___ - -### anonymous - -• `Readonly` **anonymous**: `boolean` - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:52 - -___ - -### inputs - -• `Readonly` **inputs**: [`ParamType`](verida_web3._internal_.ParamType.md)[] - -#### Inherited from - -[Fragment](verida_web3._internal_.Fragment.md).[inputs](verida_web3._internal_.Fragment.md#inputs) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:42 - -___ - -### name - -• `Readonly` **name**: `string` - -#### Inherited from - -[Fragment](verida_web3._internal_.Fragment.md).[name](verida_web3._internal_.Fragment.md#name) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:41 - -___ - -### type - -• `Readonly` **type**: `string` - -#### Inherited from - -[Fragment](verida_web3._internal_.Fragment.md).[type](verida_web3._internal_.Fragment.md#type) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:40 - -## Methods - -### format - -▸ **format**(`format?`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `format?` | `string` | - -#### Returns - -`string` - -#### Overrides - -[Fragment](verida_web3._internal_.Fragment.md).[format](verida_web3._internal_.Fragment.md#format) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:53 - -___ - -### from - -▸ `Static` **from**(`value`): [`EventFragment`](verida_web3._internal_.EventFragment.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `string` \| [`JsonFragment`](../interfaces/verida_web3._internal_.JsonFragment.md) \| [`EventFragment`](verida_web3._internal_.EventFragment.md) | - -#### Returns - -[`EventFragment`](verida_web3._internal_.EventFragment.md) - -#### Overrides - -[Fragment](verida_web3._internal_.Fragment.md).[from](verida_web3._internal_.Fragment.md#from) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:54 - -___ - -### fromObject - -▸ `Static` **fromObject**(`value`): [`EventFragment`](verida_web3._internal_.EventFragment.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | [`JsonFragment`](../interfaces/verida_web3._internal_.JsonFragment.md) \| [`EventFragment`](verida_web3._internal_.EventFragment.md) | - -#### Returns - -[`EventFragment`](verida_web3._internal_.EventFragment.md) - -#### Overrides - -[Fragment](verida_web3._internal_.Fragment.md).[fromObject](verida_web3._internal_.Fragment.md#fromobject) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:55 - -___ - -### fromString - -▸ `Static` **fromString**(`value`): [`EventFragment`](verida_web3._internal_.EventFragment.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `string` | - -#### Returns - -[`EventFragment`](verida_web3._internal_.EventFragment.md) - -#### Overrides - -[Fragment](verida_web3._internal_.Fragment.md).[fromString](verida_web3._internal_.Fragment.md#fromstring) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:56 - -___ - -### isEventFragment - -▸ `Static` **isEventFragment**(`value`): value is EventFragment - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `any` | - -#### Returns - -value is EventFragment - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:57 - -___ - -### isFragment - -▸ `Static` **isFragment**(`value`): value is Fragment - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `any` | - -#### Returns - -value is Fragment - -#### Inherited from - -[Fragment](verida_web3._internal_.Fragment.md).[isFragment](verida_web3._internal_.Fragment.md#isfragment) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:49 diff --git a/docs/api/verida-js/classes/verida_web3._internal_.ForkEvent.md b/docs/api/verida-js/classes/verida_web3._internal_.ForkEvent.md deleted file mode 100644 index 91f3e88..0000000 --- a/docs/api/verida-js/classes/verida_web3._internal_.ForkEvent.md +++ /dev/null @@ -1,86 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web3](../modules/verida_web3.md) / [](../modules/verida_web3._internal_.md) / ForkEvent - -# Class: ForkEvent - -[@verida/web3](../modules/verida_web3.md).[](../modules/verida_web3._internal_.md).ForkEvent - -## Hierarchy - -- [`Description`](verida_web3._internal_.Description.md) - - ↳ **`ForkEvent`** - -## Table of contents - -### Constructors - -- [constructor](verida_web3._internal_.ForkEvent.md#constructor) - -### Properties - -- [\_isForkEvent](verida_web3._internal_.ForkEvent.md#_isforkevent) -- [expiry](verida_web3._internal_.ForkEvent.md#expiry) - -### Methods - -- [isForkEvent](verida_web3._internal_.ForkEvent.md#isforkevent) - -## Constructors - -### constructor - -• **new ForkEvent**(`info`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `info` | `Object` | - -#### Inherited from - -[Description](verida_web3._internal_.Description.md).[constructor](verida_web3._internal_.Description.md#constructor) - -#### Defined in - -node_modules/@ethersproject/properties/lib/index.d.ts:13 - -## Properties - -### \_isForkEvent - -• `Optional` `Readonly` **\_isForkEvent**: `boolean` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:103 - -___ - -### expiry - -• `Readonly` **expiry**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:102 - -## Methods - -### isForkEvent - -▸ `Static` **isForkEvent**(`value`): value is ForkEvent - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `any` | - -#### Returns - -value is ForkEvent - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:104 diff --git a/docs/api/verida-js/classes/verida_web3._internal_.Fragment.md b/docs/api/verida-js/classes/verida_web3._internal_.Fragment.md deleted file mode 100644 index 2cbfbc6..0000000 --- a/docs/api/verida-js/classes/verida_web3._internal_.Fragment.md +++ /dev/null @@ -1,193 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web3](../modules/verida_web3.md) / [](../modules/verida_web3._internal_.md) / Fragment - -# Class: Fragment - -[@verida/web3](../modules/verida_web3.md).[](../modules/verida_web3._internal_.md).Fragment - -## Hierarchy - -- **`Fragment`** - - ↳ [`ConstructorFragment`](verida_web3._internal_.ConstructorFragment.md) - - ↳ [`EventFragment`](verida_web3._internal_.EventFragment.md) - - ↳ [`ErrorFragment`](verida_web3._internal_.ErrorFragment.md) - -## Table of contents - -### Constructors - -- [constructor](verida_web3._internal_.Fragment.md#constructor) - -### Properties - -- [\_isFragment](verida_web3._internal_.Fragment.md#_isfragment) -- [inputs](verida_web3._internal_.Fragment.md#inputs) -- [name](verida_web3._internal_.Fragment.md#name) -- [type](verida_web3._internal_.Fragment.md#type) - -### Methods - -- [format](verida_web3._internal_.Fragment.md#format) -- [from](verida_web3._internal_.Fragment.md#from) -- [fromObject](verida_web3._internal_.Fragment.md#fromobject) -- [fromString](verida_web3._internal_.Fragment.md#fromstring) -- [isFragment](verida_web3._internal_.Fragment.md#isfragment) - -## Constructors - -### constructor - -• **new Fragment**(`constructorGuard`, `params`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `constructorGuard` | `any` | -| `params` | `any` | - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:44 - -## Properties - -### \_isFragment - -• `Readonly` **\_isFragment**: `boolean` - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:43 - -___ - -### inputs - -• `Readonly` **inputs**: [`ParamType`](verida_web3._internal_.ParamType.md)[] - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:42 - -___ - -### name - -• `Readonly` **name**: `string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:41 - -___ - -### type - -• `Readonly` **type**: `string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:40 - -## Methods - -### format - -▸ `Abstract` **format**(`format?`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `format?` | `string` | - -#### Returns - -`string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:45 - -___ - -### from - -▸ `Static` **from**(`value`): [`Fragment`](verida_web3._internal_.Fragment.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `string` \| [`Fragment`](verida_web3._internal_.Fragment.md) \| [`JsonFragment`](../interfaces/verida_web3._internal_.JsonFragment.md) | - -#### Returns - -[`Fragment`](verida_web3._internal_.Fragment.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:46 - -___ - -### fromObject - -▸ `Static` **fromObject**(`value`): [`Fragment`](verida_web3._internal_.Fragment.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | [`Fragment`](verida_web3._internal_.Fragment.md) \| [`JsonFragment`](../interfaces/verida_web3._internal_.JsonFragment.md) | - -#### Returns - -[`Fragment`](verida_web3._internal_.Fragment.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:47 - -___ - -### fromString - -▸ `Static` **fromString**(`value`): [`Fragment`](verida_web3._internal_.Fragment.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `string` | - -#### Returns - -[`Fragment`](verida_web3._internal_.Fragment.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:48 - -___ - -### isFragment - -▸ `Static` **isFragment**(`value`): value is Fragment - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `any` | - -#### Returns - -value is Fragment - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:49 diff --git a/docs/api/verida-js/classes/verida_web3._internal_.FunctionFragment.md b/docs/api/verida-js/classes/verida_web3._internal_.FunctionFragment.md deleted file mode 100644 index 0e020a3..0000000 --- a/docs/api/verida-js/classes/verida_web3._internal_.FunctionFragment.md +++ /dev/null @@ -1,342 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web3](../modules/verida_web3.md) / [](../modules/verida_web3._internal_.md) / FunctionFragment - -# Class: FunctionFragment - -[@verida/web3](../modules/verida_web3.md).[](../modules/verida_web3._internal_.md).FunctionFragment - -## Hierarchy - -- [`ConstructorFragment`](verida_web3._internal_.ConstructorFragment.md) - - ↳ **`FunctionFragment`** - -## Table of contents - -### Constructors - -- [constructor](verida_web3._internal_.FunctionFragment.md#constructor) - -### Properties - -- [\_isFragment](verida_web3._internal_.FunctionFragment.md#_isfragment) -- [constant](verida_web3._internal_.FunctionFragment.md#constant) -- [gas](verida_web3._internal_.FunctionFragment.md#gas) -- [inputs](verida_web3._internal_.FunctionFragment.md#inputs) -- [name](verida_web3._internal_.FunctionFragment.md#name) -- [outputs](verida_web3._internal_.FunctionFragment.md#outputs) -- [payable](verida_web3._internal_.FunctionFragment.md#payable) -- [stateMutability](verida_web3._internal_.FunctionFragment.md#statemutability) -- [type](verida_web3._internal_.FunctionFragment.md#type) - -### Methods - -- [format](verida_web3._internal_.FunctionFragment.md#format) -- [from](verida_web3._internal_.FunctionFragment.md#from) -- [fromObject](verida_web3._internal_.FunctionFragment.md#fromobject) -- [fromString](verida_web3._internal_.FunctionFragment.md#fromstring) -- [isConstructorFragment](verida_web3._internal_.FunctionFragment.md#isconstructorfragment) -- [isFragment](verida_web3._internal_.FunctionFragment.md#isfragment) -- [isFunctionFragment](verida_web3._internal_.FunctionFragment.md#isfunctionfragment) - -## Constructors - -### constructor - -• **new FunctionFragment**(`constructorGuard`, `params`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `constructorGuard` | `any` | -| `params` | `any` | - -#### Inherited from - -[ConstructorFragment](verida_web3._internal_.ConstructorFragment.md).[constructor](verida_web3._internal_.ConstructorFragment.md#constructor) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:44 - -## Properties - -### \_isFragment - -• `Readonly` **\_isFragment**: `boolean` - -#### Inherited from - -[ConstructorFragment](verida_web3._internal_.ConstructorFragment.md).[_isFragment](verida_web3._internal_.ConstructorFragment.md#_isfragment) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:43 - -___ - -### constant - -• **constant**: `boolean` - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:70 - -___ - -### gas - -• `Optional` **gas**: [`BigNumber`](verida_web3._internal_.BigNumber.md) - -#### Inherited from - -[ConstructorFragment](verida_web3._internal_.ConstructorFragment.md).[gas](verida_web3._internal_.ConstructorFragment.md#gas) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:62 - -___ - -### inputs - -• `Readonly` **inputs**: [`ParamType`](verida_web3._internal_.ParamType.md)[] - -#### Inherited from - -[ConstructorFragment](verida_web3._internal_.ConstructorFragment.md).[inputs](verida_web3._internal_.ConstructorFragment.md#inputs) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:42 - -___ - -### name - -• `Readonly` **name**: `string` - -#### Inherited from - -[ConstructorFragment](verida_web3._internal_.ConstructorFragment.md).[name](verida_web3._internal_.ConstructorFragment.md#name) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:41 - -___ - -### outputs - -• `Optional` **outputs**: [`ParamType`](verida_web3._internal_.ParamType.md)[] - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:71 - -___ - -### payable - -• **payable**: `boolean` - -#### Inherited from - -[ConstructorFragment](verida_web3._internal_.ConstructorFragment.md).[payable](verida_web3._internal_.ConstructorFragment.md#payable) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:61 - -___ - -### stateMutability - -• **stateMutability**: `string` - -#### Inherited from - -[ConstructorFragment](verida_web3._internal_.ConstructorFragment.md).[stateMutability](verida_web3._internal_.ConstructorFragment.md#statemutability) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:60 - -___ - -### type - -• `Readonly` **type**: `string` - -#### Inherited from - -[ConstructorFragment](verida_web3._internal_.ConstructorFragment.md).[type](verida_web3._internal_.ConstructorFragment.md#type) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:40 - -## Methods - -### format - -▸ **format**(`format?`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `format?` | `string` | - -#### Returns - -`string` - -#### Overrides - -[ConstructorFragment](verida_web3._internal_.ConstructorFragment.md).[format](verida_web3._internal_.ConstructorFragment.md#format) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:72 - -___ - -### from - -▸ `Static` **from**(`value`): [`FunctionFragment`](verida_web3._internal_.FunctionFragment.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `string` \| [`JsonFragment`](../interfaces/verida_web3._internal_.JsonFragment.md) \| [`FunctionFragment`](verida_web3._internal_.FunctionFragment.md) | - -#### Returns - -[`FunctionFragment`](verida_web3._internal_.FunctionFragment.md) - -#### Overrides - -[ConstructorFragment](verida_web3._internal_.ConstructorFragment.md).[from](verida_web3._internal_.ConstructorFragment.md#from) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:73 - -___ - -### fromObject - -▸ `Static` **fromObject**(`value`): [`FunctionFragment`](verida_web3._internal_.FunctionFragment.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | [`JsonFragment`](../interfaces/verida_web3._internal_.JsonFragment.md) \| [`FunctionFragment`](verida_web3._internal_.FunctionFragment.md) | - -#### Returns - -[`FunctionFragment`](verida_web3._internal_.FunctionFragment.md) - -#### Overrides - -[ConstructorFragment](verida_web3._internal_.ConstructorFragment.md).[fromObject](verida_web3._internal_.ConstructorFragment.md#fromobject) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:74 - -___ - -### fromString - -▸ `Static` **fromString**(`value`): [`FunctionFragment`](verida_web3._internal_.FunctionFragment.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `string` | - -#### Returns - -[`FunctionFragment`](verida_web3._internal_.FunctionFragment.md) - -#### Overrides - -[ConstructorFragment](verida_web3._internal_.ConstructorFragment.md).[fromString](verida_web3._internal_.ConstructorFragment.md#fromstring) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:75 - -___ - -### isConstructorFragment - -▸ `Static` **isConstructorFragment**(`value`): value is ConstructorFragment - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `any` | - -#### Returns - -value is ConstructorFragment - -#### Inherited from - -[ConstructorFragment](verida_web3._internal_.ConstructorFragment.md).[isConstructorFragment](verida_web3._internal_.ConstructorFragment.md#isconstructorfragment) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:67 - -___ - -### isFragment - -▸ `Static` **isFragment**(`value`): value is Fragment - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `any` | - -#### Returns - -value is Fragment - -#### Inherited from - -[ConstructorFragment](verida_web3._internal_.ConstructorFragment.md).[isFragment](verida_web3._internal_.ConstructorFragment.md#isfragment) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:49 - -___ - -### isFunctionFragment - -▸ `Static` **isFunctionFragment**(`value`): value is FunctionFragment - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `any` | - -#### Returns - -value is FunctionFragment - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:76 diff --git a/docs/api/verida-js/classes/verida_web3._internal_.Indexed.md b/docs/api/verida-js/classes/verida_web3._internal_.Indexed.md deleted file mode 100644 index f0b447c..0000000 --- a/docs/api/verida-js/classes/verida_web3._internal_.Indexed.md +++ /dev/null @@ -1,88 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web3](../modules/verida_web3.md) / [](../modules/verida_web3._internal_.md) / Indexed - -# Class: Indexed - -[@verida/web3](../modules/verida_web3.md).[](../modules/verida_web3._internal_.md).Indexed - -## Hierarchy - -- [`Description`](verida_web3._internal_.Description.md)<[`Indexed`](verida_web3._internal_.Indexed.md)\> - - ↳ **`Indexed`** - -## Table of contents - -### Constructors - -- [constructor](verida_web3._internal_.Indexed.md#constructor) - -### Properties - -- [\_isIndexed](verida_web3._internal_.Indexed.md#_isindexed) -- [hash](verida_web3._internal_.Indexed.md#hash) - -### Methods - -- [isIndexed](verida_web3._internal_.Indexed.md#isindexed) - -## Constructors - -### constructor - -• **new Indexed**(`info`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `info` | `Object` | -| `info._isIndexed` | `boolean` | -| `info.hash` | `string` | - -#### Inherited from - -[Description](verida_web3._internal_.Description.md).[constructor](verida_web3._internal_.Description.md#constructor) - -#### Defined in - -node_modules/@ethersproject/properties/lib/index.d.ts:13 - -## Properties - -### \_isIndexed - -• `Readonly` **\_isIndexed**: `boolean` - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:32 - -___ - -### hash - -• `Readonly` **hash**: `string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:31 - -## Methods - -### isIndexed - -▸ `Static` **isIndexed**(`value`): value is Indexed - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `any` | - -#### Returns - -value is Indexed - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:33 diff --git a/docs/api/verida-js/classes/verida_web3._internal_.Interface.md b/docs/api/verida-js/classes/verida_web3._internal_.Interface.md deleted file mode 100644 index 18fa187..0000000 --- a/docs/api/verida-js/classes/verida_web3._internal_.Interface.md +++ /dev/null @@ -1,698 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web3](../modules/verida_web3.md) / [](../modules/verida_web3._internal_.md) / Interface - -# Class: Interface - -[@verida/web3](../modules/verida_web3.md).[](../modules/verida_web3._internal_.md).Interface - -## Table of contents - -### Constructors - -- [constructor](verida_web3._internal_.Interface.md#constructor) - -### Properties - -- [\_abiCoder](verida_web3._internal_.Interface.md#_abicoder) -- [\_isInterface](verida_web3._internal_.Interface.md#_isinterface) -- [deploy](verida_web3._internal_.Interface.md#deploy) -- [errors](verida_web3._internal_.Interface.md#errors) -- [events](verida_web3._internal_.Interface.md#events) -- [fragments](verida_web3._internal_.Interface.md#fragments) -- [functions](verida_web3._internal_.Interface.md#functions) -- [structs](verida_web3._internal_.Interface.md#structs) - -### Methods - -- [\_decodeParams](verida_web3._internal_.Interface.md#_decodeparams) -- [\_encodeParams](verida_web3._internal_.Interface.md#_encodeparams) -- [decodeErrorResult](verida_web3._internal_.Interface.md#decodeerrorresult) -- [decodeEventLog](verida_web3._internal_.Interface.md#decodeeventlog) -- [decodeFunctionData](verida_web3._internal_.Interface.md#decodefunctiondata) -- [decodeFunctionResult](verida_web3._internal_.Interface.md#decodefunctionresult) -- [encodeDeploy](verida_web3._internal_.Interface.md#encodedeploy) -- [encodeErrorResult](verida_web3._internal_.Interface.md#encodeerrorresult) -- [encodeEventLog](verida_web3._internal_.Interface.md#encodeeventlog) -- [encodeFilterTopics](verida_web3._internal_.Interface.md#encodefiltertopics) -- [encodeFunctionData](verida_web3._internal_.Interface.md#encodefunctiondata) -- [encodeFunctionResult](verida_web3._internal_.Interface.md#encodefunctionresult) -- [format](verida_web3._internal_.Interface.md#format) -- [getError](verida_web3._internal_.Interface.md#geterror) -- [getEvent](verida_web3._internal_.Interface.md#getevent) -- [getEventTopic](verida_web3._internal_.Interface.md#geteventtopic) -- [getFunction](verida_web3._internal_.Interface.md#getfunction) -- [getSighash](verida_web3._internal_.Interface.md#getsighash) -- [parseError](verida_web3._internal_.Interface.md#parseerror) -- [parseLog](verida_web3._internal_.Interface.md#parselog) -- [parseTransaction](verida_web3._internal_.Interface.md#parsetransaction) -- [getAbiCoder](verida_web3._internal_.Interface.md#getabicoder) -- [getAddress](verida_web3._internal_.Interface.md#getaddress) -- [getEventTopic](verida_web3._internal_.Interface.md#geteventtopic) -- [getSighash](verida_web3._internal_.Interface.md#getsighash) -- [isInterface](verida_web3._internal_.Interface.md#isinterface) - -## Constructors - -### constructor - -• **new Interface**(`fragments`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `fragments` | `string` \| readonly (`string` \| [`Fragment`](verida_web3._internal_.Fragment.md) \| [`JsonFragment`](../interfaces/verida_web3._internal_.JsonFragment.md))[] | - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:52 - -## Properties - -### \_abiCoder - -• `Readonly` **\_abiCoder**: [`AbiCoder`](verida_web3._internal_.AbiCoder.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:50 - -___ - -### \_isInterface - -• `Readonly` **\_isInterface**: `boolean` - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:51 - -___ - -### deploy - -• `Readonly` **deploy**: [`ConstructorFragment`](verida_web3._internal_.ConstructorFragment.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:49 - -___ - -### errors - -• `Readonly` **errors**: `Object` - -#### Index signature - -▪ [name: `string`]: [`ErrorFragment`](verida_web3._internal_.ErrorFragment.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:37 - -___ - -### events - -• `Readonly` **events**: `Object` - -#### Index signature - -▪ [name: `string`]: [`EventFragment`](verida_web3._internal_.EventFragment.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:40 - -___ - -### fragments - -• `Readonly` **fragments**: readonly [`Fragment`](verida_web3._internal_.Fragment.md)[] - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:36 - -___ - -### functions - -• `Readonly` **functions**: `Object` - -#### Index signature - -▪ [name: `string`]: [`FunctionFragment`](verida_web3._internal_.FunctionFragment.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:43 - -___ - -### structs - -• `Readonly` **structs**: `Object` - -#### Index signature - -▪ [name: `string`]: `any` - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:46 - -## Methods - -### \_decodeParams - -▸ **_decodeParams**(`params`, `data`): [`Result`](../interfaces/verida_web3._internal_.Result.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `params` | readonly [`ParamType`](verida_web3._internal_.ParamType.md)[] | -| `data` | [`BytesLike`](../modules/verida_web3._internal_.md#byteslike) | - -#### Returns - -[`Result`](../interfaces/verida_web3._internal_.Result.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:63 - -___ - -### \_encodeParams - -▸ **_encodeParams**(`params`, `values`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `params` | readonly [`ParamType`](verida_web3._internal_.ParamType.md)[] | -| `values` | readonly `any`[] | - -#### Returns - -`string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:64 - -___ - -### decodeErrorResult - -▸ **decodeErrorResult**(`fragment`, `data`): [`Result`](../interfaces/verida_web3._internal_.Result.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `fragment` | `string` \| [`ErrorFragment`](verida_web3._internal_.ErrorFragment.md) | -| `data` | [`BytesLike`](../modules/verida_web3._internal_.md#byteslike) | - -#### Returns - -[`Result`](../interfaces/verida_web3._internal_.Result.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:66 - -___ - -### decodeEventLog - -▸ **decodeEventLog**(`eventFragment`, `data`, `topics?`): [`Result`](../interfaces/verida_web3._internal_.Result.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventFragment` | `string` \| [`EventFragment`](verida_web3._internal_.EventFragment.md) | -| `data` | [`BytesLike`](../modules/verida_web3._internal_.md#byteslike) | -| `topics?` | readonly `string`[] | - -#### Returns - -[`Result`](../interfaces/verida_web3._internal_.Result.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:77 - -___ - -### decodeFunctionData - -▸ **decodeFunctionData**(`functionFragment`, `data`): [`Result`](../interfaces/verida_web3._internal_.Result.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `functionFragment` | `string` \| [`FunctionFragment`](verida_web3._internal_.FunctionFragment.md) | -| `data` | [`BytesLike`](../modules/verida_web3._internal_.md#byteslike) | - -#### Returns - -[`Result`](../interfaces/verida_web3._internal_.Result.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:68 - -___ - -### decodeFunctionResult - -▸ **decodeFunctionResult**(`functionFragment`, `data`): [`Result`](../interfaces/verida_web3._internal_.Result.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `functionFragment` | `string` \| [`FunctionFragment`](verida_web3._internal_.FunctionFragment.md) | -| `data` | [`BytesLike`](../modules/verida_web3._internal_.md#byteslike) | - -#### Returns - -[`Result`](../interfaces/verida_web3._internal_.Result.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:70 - -___ - -### encodeDeploy - -▸ **encodeDeploy**(`values?`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `values?` | readonly `any`[] | - -#### Returns - -`string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:65 - -___ - -### encodeErrorResult - -▸ **encodeErrorResult**(`fragment`, `values?`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `fragment` | `string` \| [`ErrorFragment`](verida_web3._internal_.ErrorFragment.md) | -| `values?` | readonly `any`[] | - -#### Returns - -`string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:67 - -___ - -### encodeEventLog - -▸ **encodeEventLog**(`eventFragment`, `values`): `Object` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventFragment` | `string` \| [`EventFragment`](verida_web3._internal_.EventFragment.md) | -| `values` | readonly `any`[] | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `data` | `string` | -| `topics` | `string`[] | - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:73 - -___ - -### encodeFilterTopics - -▸ **encodeFilterTopics**(`eventFragment`, `values`): (`string` \| `string`[])[] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventFragment` | `string` \| [`EventFragment`](verida_web3._internal_.EventFragment.md) | -| `values` | readonly `any`[] | - -#### Returns - -(`string` \| `string`[])[] - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:72 - -___ - -### encodeFunctionData - -▸ **encodeFunctionData**(`functionFragment`, `values?`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `functionFragment` | `string` \| [`FunctionFragment`](verida_web3._internal_.FunctionFragment.md) | -| `values?` | readonly `any`[] | - -#### Returns - -`string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:69 - -___ - -### encodeFunctionResult - -▸ **encodeFunctionResult**(`functionFragment`, `values?`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `functionFragment` | `string` \| [`FunctionFragment`](verida_web3._internal_.FunctionFragment.md) | -| `values?` | readonly `any`[] | - -#### Returns - -`string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:71 - -___ - -### format - -▸ **format**(`format?`): `string` \| `string`[] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `format?` | `string` | - -#### Returns - -`string` \| `string`[] - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:53 - -___ - -### getError - -▸ **getError**(`nameOrSignatureOrSighash`): [`ErrorFragment`](verida_web3._internal_.ErrorFragment.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `nameOrSignatureOrSighash` | `string` | - -#### Returns - -[`ErrorFragment`](verida_web3._internal_.ErrorFragment.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:60 - -___ - -### getEvent - -▸ **getEvent**(`nameOrSignatureOrTopic`): [`EventFragment`](verida_web3._internal_.EventFragment.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `nameOrSignatureOrTopic` | `string` | - -#### Returns - -[`EventFragment`](verida_web3._internal_.EventFragment.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:59 - -___ - -### getEventTopic - -▸ **getEventTopic**(`eventFragment`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventFragment` | `string` \| [`EventFragment`](verida_web3._internal_.EventFragment.md) | - -#### Returns - -`string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:62 - -___ - -### getFunction - -▸ **getFunction**(`nameOrSignatureOrSighash`): [`FunctionFragment`](verida_web3._internal_.FunctionFragment.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `nameOrSignatureOrSighash` | `string` | - -#### Returns - -[`FunctionFragment`](verida_web3._internal_.FunctionFragment.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:58 - -___ - -### getSighash - -▸ **getSighash**(`fragment`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `fragment` | `string` \| [`ErrorFragment`](verida_web3._internal_.ErrorFragment.md) \| [`FunctionFragment`](verida_web3._internal_.FunctionFragment.md) | - -#### Returns - -`string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:61 - -___ - -### parseError - -▸ **parseError**(`data`): [`ErrorDescription`](verida_web3._internal_.ErrorDescription.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | [`BytesLike`](../modules/verida_web3._internal_.md#byteslike) | - -#### Returns - -[`ErrorDescription`](verida_web3._internal_.ErrorDescription.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:86 - -___ - -### parseLog - -▸ **parseLog**(`log`): [`LogDescription`](verida_web3._internal_.LogDescription.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `log` | `Object` | -| `log.data` | `string` | -| `log.topics` | `string`[] | - -#### Returns - -[`LogDescription`](verida_web3._internal_.LogDescription.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:82 - -___ - -### parseTransaction - -▸ **parseTransaction**(`tx`): [`TransactionDescription`](verida_web3._internal_.TransactionDescription.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `tx` | `Object` | -| `tx.data` | `string` | -| `tx.value?` | [`BigNumberish`](../modules/verida_web3._internal_.md#bignumberish) | - -#### Returns - -[`TransactionDescription`](verida_web3._internal_.TransactionDescription.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:78 - -___ - -### getAbiCoder - -▸ `Static` **getAbiCoder**(): [`AbiCoder`](verida_web3._internal_.AbiCoder.md) - -#### Returns - -[`AbiCoder`](verida_web3._internal_.AbiCoder.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:54 - -___ - -### getAddress - -▸ `Static` **getAddress**(`address`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `address` | `string` | - -#### Returns - -`string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:55 - -___ - -### getEventTopic - -▸ `Static` **getEventTopic**(`eventFragment`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventFragment` | [`EventFragment`](verida_web3._internal_.EventFragment.md) | - -#### Returns - -`string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:57 - -___ - -### getSighash - -▸ `Static` **getSighash**(`fragment`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `fragment` | [`ErrorFragment`](verida_web3._internal_.ErrorFragment.md) \| [`FunctionFragment`](verida_web3._internal_.FunctionFragment.md) | - -#### Returns - -`string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:56 - -___ - -### isInterface - -▸ `Static` **isInterface**(`value`): value is Interface - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `any` | - -#### Returns - -value is Interface - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:87 diff --git a/docs/api/verida-js/classes/verida_web3._internal_.LogDescription.md b/docs/api/verida-js/classes/verida_web3._internal_.LogDescription.md deleted file mode 100644 index 0ae0980..0000000 --- a/docs/api/verida-js/classes/verida_web3._internal_.LogDescription.md +++ /dev/null @@ -1,100 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web3](../modules/verida_web3.md) / [](../modules/verida_web3._internal_.md) / LogDescription - -# Class: LogDescription - -[@verida/web3](../modules/verida_web3.md).[](../modules/verida_web3._internal_.md).LogDescription - -## Hierarchy - -- [`Description`](verida_web3._internal_.Description.md)<[`LogDescription`](verida_web3._internal_.LogDescription.md)\> - - ↳ **`LogDescription`** - -## Table of contents - -### Constructors - -- [constructor](verida_web3._internal_.LogDescription.md#constructor) - -### Properties - -- [args](verida_web3._internal_.LogDescription.md#args) -- [eventFragment](verida_web3._internal_.LogDescription.md#eventfragment) -- [name](verida_web3._internal_.LogDescription.md#name) -- [signature](verida_web3._internal_.LogDescription.md#signature) -- [topic](verida_web3._internal_.LogDescription.md#topic) - -## Constructors - -### constructor - -• **new LogDescription**(`info`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `info` | `Object` | -| `info.args` | [`Result`](../interfaces/verida_web3._internal_.Result.md) | -| `info.eventFragment` | [`EventFragment`](verida_web3._internal_.EventFragment.md) | -| `info.name` | `string` | -| `info.signature` | `string` | -| `info.topic` | `string` | - -#### Inherited from - -[Description](verida_web3._internal_.Description.md).[constructor](verida_web3._internal_.Description.md#constructor) - -#### Defined in - -node_modules/@ethersproject/properties/lib/index.d.ts:13 - -## Properties - -### args - -• `Readonly` **args**: [`Result`](../interfaces/verida_web3._internal_.Result.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:13 - -___ - -### eventFragment - -• `Readonly` **eventFragment**: [`EventFragment`](verida_web3._internal_.EventFragment.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:9 - -___ - -### name - -• `Readonly` **name**: `string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:10 - -___ - -### signature - -• `Readonly` **signature**: `string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:11 - -___ - -### topic - -• `Readonly` **topic**: `string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:12 diff --git a/docs/api/verida-js/classes/verida_web3._internal_.ParamType.md b/docs/api/verida-js/classes/verida_web3._internal_.ParamType.md deleted file mode 100644 index 3327077..0000000 --- a/docs/api/verida-js/classes/verida_web3._internal_.ParamType.md +++ /dev/null @@ -1,229 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web3](../modules/verida_web3.md) / [](../modules/verida_web3._internal_.md) / ParamType - -# Class: ParamType - -[@verida/web3](../modules/verida_web3.md).[](../modules/verida_web3._internal_.md).ParamType - -## Table of contents - -### Constructors - -- [constructor](verida_web3._internal_.ParamType.md#constructor) - -### Properties - -- [\_isParamType](verida_web3._internal_.ParamType.md#_isparamtype) -- [arrayChildren](verida_web3._internal_.ParamType.md#arraychildren) -- [arrayLength](verida_web3._internal_.ParamType.md#arraylength) -- [baseType](verida_web3._internal_.ParamType.md#basetype) -- [components](verida_web3._internal_.ParamType.md#components) -- [indexed](verida_web3._internal_.ParamType.md#indexed) -- [name](verida_web3._internal_.ParamType.md#name) -- [type](verida_web3._internal_.ParamType.md#type) - -### Methods - -- [format](verida_web3._internal_.ParamType.md#format) -- [from](verida_web3._internal_.ParamType.md#from) -- [fromObject](verida_web3._internal_.ParamType.md#fromobject) -- [fromString](verida_web3._internal_.ParamType.md#fromstring) -- [isParamType](verida_web3._internal_.ParamType.md#isparamtype) - -## Constructors - -### constructor - -• **new ParamType**(`constructorGuard`, `params`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `constructorGuard` | `any` | -| `params` | `any` | - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:32 - -## Properties - -### \_isParamType - -• `Readonly` **\_isParamType**: `boolean` - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:31 - -___ - -### arrayChildren - -• `Readonly` **arrayChildren**: [`ParamType`](verida_web3._internal_.ParamType.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:30 - -___ - -### arrayLength - -• `Readonly` **arrayLength**: `number` - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:29 - -___ - -### baseType - -• `Readonly` **baseType**: `string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:26 - -___ - -### components - -• `Readonly` **components**: [`ParamType`](verida_web3._internal_.ParamType.md)[] - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:28 - -___ - -### indexed - -• `Readonly` **indexed**: `boolean` - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:27 - -___ - -### name - -• `Readonly` **name**: `string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:24 - -___ - -### type - -• `Readonly` **type**: `string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:25 - -## Methods - -### format - -▸ **format**(`format?`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `format?` | `string` | - -#### Returns - -`string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:33 - -___ - -### from - -▸ `Static` **from**(`value`, `allowIndexed?`): [`ParamType`](verida_web3._internal_.ParamType.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `string` \| [`ParamType`](verida_web3._internal_.ParamType.md) \| [`JsonFragmentType`](../interfaces/verida_web3._internal_.JsonFragmentType.md) | -| `allowIndexed?` | `boolean` | - -#### Returns - -[`ParamType`](verida_web3._internal_.ParamType.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:34 - -___ - -### fromObject - -▸ `Static` **fromObject**(`value`): [`ParamType`](verida_web3._internal_.ParamType.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | [`ParamType`](verida_web3._internal_.ParamType.md) \| [`JsonFragmentType`](../interfaces/verida_web3._internal_.JsonFragmentType.md) | - -#### Returns - -[`ParamType`](verida_web3._internal_.ParamType.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:35 - -___ - -### fromString - -▸ `Static` **fromString**(`value`, `allowIndexed?`): [`ParamType`](verida_web3._internal_.ParamType.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `string` | -| `allowIndexed?` | `boolean` | - -#### Returns - -[`ParamType`](verida_web3._internal_.ParamType.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:36 - -___ - -### isParamType - -▸ `Static` **isParamType**(`value`): value is ParamType - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `any` | - -#### Returns - -value is ParamType - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:37 diff --git a/docs/api/verida-js/classes/verida_web3._internal_.Provider.md b/docs/api/verida-js/classes/verida_web3._internal_.Provider.md deleted file mode 100644 index 29cd90b..0000000 --- a/docs/api/verida-js/classes/verida_web3._internal_.Provider.md +++ /dev/null @@ -1,645 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web3](../modules/verida_web3.md) / [](../modules/verida_web3._internal_.md) / Provider - -# Class: Provider - -[@verida/web3](../modules/verida_web3.md).[](../modules/verida_web3._internal_.md).Provider - -## Implements - -- [`OnceBlockable`](../interfaces/verida_web3._internal_.OnceBlockable.md) - -## Table of contents - -### Constructors - -- [constructor](verida_web3._internal_.Provider.md#constructor) - -### Properties - -- [\_isProvider](verida_web3._internal_.Provider.md#_isprovider) - -### Methods - -- [addListener](verida_web3._internal_.Provider.md#addlistener) -- [call](verida_web3._internal_.Provider.md#call) -- [emit](verida_web3._internal_.Provider.md#emit) -- [estimateGas](verida_web3._internal_.Provider.md#estimategas) -- [getBalance](verida_web3._internal_.Provider.md#getbalance) -- [getBlock](verida_web3._internal_.Provider.md#getblock) -- [getBlockNumber](verida_web3._internal_.Provider.md#getblocknumber) -- [getBlockWithTransactions](verida_web3._internal_.Provider.md#getblockwithtransactions) -- [getCode](verida_web3._internal_.Provider.md#getcode) -- [getFeeData](verida_web3._internal_.Provider.md#getfeedata) -- [getGasPrice](verida_web3._internal_.Provider.md#getgasprice) -- [getLogs](verida_web3._internal_.Provider.md#getlogs) -- [getNetwork](verida_web3._internal_.Provider.md#getnetwork) -- [getStorageAt](verida_web3._internal_.Provider.md#getstorageat) -- [getTransaction](verida_web3._internal_.Provider.md#gettransaction) -- [getTransactionCount](verida_web3._internal_.Provider.md#gettransactioncount) -- [getTransactionReceipt](verida_web3._internal_.Provider.md#gettransactionreceipt) -- [listenerCount](verida_web3._internal_.Provider.md#listenercount) -- [listeners](verida_web3._internal_.Provider.md#listeners) -- [lookupAddress](verida_web3._internal_.Provider.md#lookupaddress) -- [off](verida_web3._internal_.Provider.md#off) -- [on](verida_web3._internal_.Provider.md#on) -- [once](verida_web3._internal_.Provider.md#once) -- [removeAllListeners](verida_web3._internal_.Provider.md#removealllisteners) -- [removeListener](verida_web3._internal_.Provider.md#removelistener) -- [resolveName](verida_web3._internal_.Provider.md#resolvename) -- [sendTransaction](verida_web3._internal_.Provider.md#sendtransaction) -- [waitForTransaction](verida_web3._internal_.Provider.md#waitfortransaction) -- [isProvider](verida_web3._internal_.Provider.md#isprovider) - -## Constructors - -### constructor - -• **new Provider**() - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:153 - -## Properties - -### \_isProvider - -• `Readonly` **\_isProvider**: `boolean` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:152 - -## Methods - -### addListener - -▸ **addListener**(`eventName`, `listener`): [`Provider`](verida_web3._internal_.Provider.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | [`EventType`](../modules/verida_web3._internal_.md#eventtype) | -| `listener` | [`Listener`](../modules/verida_web3._internal_.md#listener) | - -#### Returns - -[`Provider`](verida_web3._internal_.Provider.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:149 - -___ - -### call - -▸ `Abstract` **call**(`transaction`, `blockTag?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transaction` | [`Deferrable`](../modules/verida_web3._internal_.md#deferrable)<[`TransactionRequest`](../modules/verida_web3._internal_.md#transactionrequest)\> | -| `blockTag?` | [`BlockTag`](../modules/verida_web3._internal_.md#blocktag) \| `Promise`<[`BlockTag`](../modules/verida_web3._internal_.md#blocktag)\> | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:133 - -___ - -### emit - -▸ `Abstract` **emit**(`eventName`, ...`args`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | [`EventType`](../modules/verida_web3._internal_.md#eventtype) | -| `...args` | `any`[] | - -#### Returns - -`boolean` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:144 - -___ - -### estimateGas - -▸ `Abstract` **estimateGas**(`transaction`): `Promise`<[`BigNumber`](verida_web3._internal_.BigNumber.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transaction` | [`Deferrable`](../modules/verida_web3._internal_.md#deferrable)<[`TransactionRequest`](../modules/verida_web3._internal_.md#transactionrequest)\> | - -#### Returns - -`Promise`<[`BigNumber`](verida_web3._internal_.BigNumber.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:134 - -___ - -### getBalance - -▸ `Abstract` **getBalance**(`addressOrName`, `blockTag?`): `Promise`<[`BigNumber`](verida_web3._internal_.BigNumber.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `addressOrName` | `string` \| `Promise`<`string`\> | -| `blockTag?` | [`BlockTag`](../modules/verida_web3._internal_.md#blocktag) \| `Promise`<[`BlockTag`](../modules/verida_web3._internal_.md#blocktag)\> | - -#### Returns - -`Promise`<[`BigNumber`](verida_web3._internal_.BigNumber.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:128 - -___ - -### getBlock - -▸ `Abstract` **getBlock**(`blockHashOrBlockTag`): `Promise`<[`Block`](../interfaces/verida_web3._internal_.Block.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `blockHashOrBlockTag` | [`BlockTag`](../modules/verida_web3._internal_.md#blocktag) \| `Promise`<[`BlockTag`](../modules/verida_web3._internal_.md#blocktag)\> | - -#### Returns - -`Promise`<[`Block`](../interfaces/verida_web3._internal_.Block.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:135 - -___ - -### getBlockNumber - -▸ `Abstract` **getBlockNumber**(): `Promise`<`number`\> - -#### Returns - -`Promise`<`number`\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:125 - -___ - -### getBlockWithTransactions - -▸ `Abstract` **getBlockWithTransactions**(`blockHashOrBlockTag`): `Promise`<[`BlockWithTransactions`](../interfaces/verida_web3._internal_.BlockWithTransactions.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `blockHashOrBlockTag` | [`BlockTag`](../modules/verida_web3._internal_.md#blocktag) \| `Promise`<[`BlockTag`](../modules/verida_web3._internal_.md#blocktag)\> | - -#### Returns - -`Promise`<[`BlockWithTransactions`](../interfaces/verida_web3._internal_.BlockWithTransactions.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:136 - -___ - -### getCode - -▸ `Abstract` **getCode**(`addressOrName`, `blockTag?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `addressOrName` | `string` \| `Promise`<`string`\> | -| `blockTag?` | [`BlockTag`](../modules/verida_web3._internal_.md#blocktag) \| `Promise`<[`BlockTag`](../modules/verida_web3._internal_.md#blocktag)\> | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:130 - -___ - -### getFeeData - -▸ **getFeeData**(): `Promise`<[`FeeData`](../interfaces/verida_web3._internal_.FeeData.md)\> - -#### Returns - -`Promise`<[`FeeData`](../interfaces/verida_web3._internal_.FeeData.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:127 - -___ - -### getGasPrice - -▸ `Abstract` **getGasPrice**(): `Promise`<[`BigNumber`](verida_web3._internal_.BigNumber.md)\> - -#### Returns - -`Promise`<[`BigNumber`](verida_web3._internal_.BigNumber.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:126 - -___ - -### getLogs - -▸ `Abstract` **getLogs**(`filter`): `Promise`<[`Log`](../interfaces/verida_web3._internal_.Log.md)[]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `filter` | [`Filter`](../interfaces/verida_web3._internal_.Filter.md) | - -#### Returns - -`Promise`<[`Log`](../interfaces/verida_web3._internal_.Log.md)[]\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:139 - -___ - -### getNetwork - -▸ `Abstract` **getNetwork**(): `Promise`<[`Network`](../modules/verida_web3._internal_.md#network)\> - -#### Returns - -`Promise`<[`Network`](../modules/verida_web3._internal_.md#network)\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:124 - -___ - -### getStorageAt - -▸ `Abstract` **getStorageAt**(`addressOrName`, `position`, `blockTag?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `addressOrName` | `string` \| `Promise`<`string`\> | -| `position` | [`BigNumberish`](../modules/verida_web3._internal_.md#bignumberish) \| `Promise`<[`BigNumberish`](../modules/verida_web3._internal_.md#bignumberish)\> | -| `blockTag?` | [`BlockTag`](../modules/verida_web3._internal_.md#blocktag) \| `Promise`<[`BlockTag`](../modules/verida_web3._internal_.md#blocktag)\> | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:131 - -___ - -### getTransaction - -▸ `Abstract` **getTransaction**(`transactionHash`): `Promise`<[`TransactionResponse`](../interfaces/verida_web3._internal_.TransactionResponse.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transactionHash` | `string` | - -#### Returns - -`Promise`<[`TransactionResponse`](../interfaces/verida_web3._internal_.TransactionResponse.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:137 - -___ - -### getTransactionCount - -▸ `Abstract` **getTransactionCount**(`addressOrName`, `blockTag?`): `Promise`<`number`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `addressOrName` | `string` \| `Promise`<`string`\> | -| `blockTag?` | [`BlockTag`](../modules/verida_web3._internal_.md#blocktag) \| `Promise`<[`BlockTag`](../modules/verida_web3._internal_.md#blocktag)\> | - -#### Returns - -`Promise`<`number`\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:129 - -___ - -### getTransactionReceipt - -▸ `Abstract` **getTransactionReceipt**(`transactionHash`): `Promise`<[`TransactionReceipt`](../interfaces/verida_web3._internal_.TransactionReceipt.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transactionHash` | `string` | - -#### Returns - -`Promise`<[`TransactionReceipt`](../interfaces/verida_web3._internal_.TransactionReceipt.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:138 - -___ - -### listenerCount - -▸ `Abstract` **listenerCount**(`eventName?`): `number` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName?` | [`EventType`](../modules/verida_web3._internal_.md#eventtype) | - -#### Returns - -`number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:145 - -___ - -### listeners - -▸ `Abstract` **listeners**(`eventName?`): [`Listener`](../modules/verida_web3._internal_.md#listener)[] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName?` | [`EventType`](../modules/verida_web3._internal_.md#eventtype) | - -#### Returns - -[`Listener`](../modules/verida_web3._internal_.md#listener)[] - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:146 - -___ - -### lookupAddress - -▸ `Abstract` **lookupAddress**(`address`): `Promise`<``null`` \| `string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `address` | `string` \| `Promise`<`string`\> | - -#### Returns - -`Promise`<``null`` \| `string`\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:141 - -___ - -### off - -▸ `Abstract` **off**(`eventName`, `listener?`): [`Provider`](verida_web3._internal_.Provider.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | [`EventType`](../modules/verida_web3._internal_.md#eventtype) | -| `listener?` | [`Listener`](../modules/verida_web3._internal_.md#listener) | - -#### Returns - -[`Provider`](verida_web3._internal_.Provider.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:147 - -___ - -### on - -▸ `Abstract` **on**(`eventName`, `listener`): [`Provider`](verida_web3._internal_.Provider.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | [`EventType`](../modules/verida_web3._internal_.md#eventtype) | -| `listener` | [`Listener`](../modules/verida_web3._internal_.md#listener) | - -#### Returns - -[`Provider`](verida_web3._internal_.Provider.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:142 - -___ - -### once - -▸ `Abstract` **once**(`eventName`, `listener`): [`Provider`](verida_web3._internal_.Provider.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | [`EventType`](../modules/verida_web3._internal_.md#eventtype) | -| `listener` | [`Listener`](../modules/verida_web3._internal_.md#listener) | - -#### Returns - -[`Provider`](verida_web3._internal_.Provider.md) - -#### Implementation of - -[OnceBlockable](../interfaces/verida_web3._internal_.OnceBlockable.md).[once](../interfaces/verida_web3._internal_.OnceBlockable.md#once) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:143 - -___ - -### removeAllListeners - -▸ `Abstract` **removeAllListeners**(`eventName?`): [`Provider`](verida_web3._internal_.Provider.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName?` | [`EventType`](../modules/verida_web3._internal_.md#eventtype) | - -#### Returns - -[`Provider`](verida_web3._internal_.Provider.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:148 - -___ - -### removeListener - -▸ **removeListener**(`eventName`, `listener`): [`Provider`](verida_web3._internal_.Provider.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | [`EventType`](../modules/verida_web3._internal_.md#eventtype) | -| `listener` | [`Listener`](../modules/verida_web3._internal_.md#listener) | - -#### Returns - -[`Provider`](verida_web3._internal_.Provider.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:150 - -___ - -### resolveName - -▸ `Abstract` **resolveName**(`name`): `Promise`<``null`` \| `string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` \| `Promise`<`string`\> | - -#### Returns - -`Promise`<``null`` \| `string`\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:140 - -___ - -### sendTransaction - -▸ `Abstract` **sendTransaction**(`signedTransaction`): `Promise`<[`TransactionResponse`](../interfaces/verida_web3._internal_.TransactionResponse.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `signedTransaction` | `string` \| `Promise`<`string`\> | - -#### Returns - -`Promise`<[`TransactionResponse`](../interfaces/verida_web3._internal_.TransactionResponse.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:132 - -___ - -### waitForTransaction - -▸ `Abstract` **waitForTransaction**(`transactionHash`, `confirmations?`, `timeout?`): `Promise`<[`TransactionReceipt`](../interfaces/verida_web3._internal_.TransactionReceipt.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transactionHash` | `string` | -| `confirmations?` | `number` | -| `timeout?` | `number` | - -#### Returns - -`Promise`<[`TransactionReceipt`](../interfaces/verida_web3._internal_.TransactionReceipt.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:151 - -___ - -### isProvider - -▸ `Static` **isProvider**(`value`): value is Provider - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `any` | - -#### Returns - -value is Provider - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:154 diff --git a/docs/api/verida-js/classes/verida_web3._internal_.Reader.md b/docs/api/verida-js/classes/verida_web3._internal_.Reader.md deleted file mode 100644 index 597b90e..0000000 --- a/docs/api/verida-js/classes/verida_web3._internal_.Reader.md +++ /dev/null @@ -1,249 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web3](../modules/verida_web3.md) / [](../modules/verida_web3._internal_.md) / Reader - -# Class: Reader - -[@verida/web3](../modules/verida_web3.md).[](../modules/verida_web3._internal_.md).Reader - -## Table of contents - -### Constructors - -- [constructor](verida_web3._internal_.Reader.md#constructor) - -### Properties - -- [\_coerceFunc](verida_web3._internal_.Reader.md#_coercefunc) -- [\_data](verida_web3._internal_.Reader.md#_data) -- [\_offset](verida_web3._internal_.Reader.md#_offset) -- [allowLoose](verida_web3._internal_.Reader.md#allowloose) -- [wordSize](verida_web3._internal_.Reader.md#wordsize) - -### Accessors - -- [consumed](verida_web3._internal_.Reader.md#consumed) -- [data](verida_web3._internal_.Reader.md#data) - -### Methods - -- [\_peekBytes](verida_web3._internal_.Reader.md#_peekbytes) -- [coerce](verida_web3._internal_.Reader.md#coerce) -- [readBytes](verida_web3._internal_.Reader.md#readbytes) -- [readValue](verida_web3._internal_.Reader.md#readvalue) -- [subReader](verida_web3._internal_.Reader.md#subreader) -- [coerce](verida_web3._internal_.Reader.md#coerce) - -## Constructors - -### constructor - -• **new Reader**(`data`, `wordSize?`, `coerceFunc?`, `allowLoose?`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | [`BytesLike`](../modules/verida_web3._internal_.md#byteslike) | -| `wordSize?` | `number` | -| `coerceFunc?` | [`CoerceFunc`](../modules/verida_web3._internal_.md#coercefunc) | -| `allowLoose?` | `boolean` | - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:43 - -## Properties - -### \_coerceFunc - -• `Readonly` **\_coerceFunc**: [`CoerceFunc`](../modules/verida_web3._internal_.md#coercefunc) - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:41 - -___ - -### \_data - -• `Readonly` **\_data**: `Uint8Array` - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:40 - -___ - -### \_offset - -• **\_offset**: `number` - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:42 - -___ - -### allowLoose - -• `Readonly` **allowLoose**: `boolean` - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:39 - -___ - -### wordSize - -• `Readonly` **wordSize**: `number` - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:38 - -## Accessors - -### consumed - -• `get` **consumed**(): `number` - -#### Returns - -`number` - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:45 - -___ - -### data - -• `get` **data**(): `string` - -#### Returns - -`string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:44 - -## Methods - -### \_peekBytes - -▸ **_peekBytes**(`offset`, `length`, `loose?`): `Uint8Array` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `offset` | `number` | -| `length` | `number` | -| `loose?` | `boolean` | - -#### Returns - -`Uint8Array` - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:48 - -___ - -### coerce - -▸ **coerce**(`name`, `value`): `any` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` | -| `value` | `any` | - -#### Returns - -`any` - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:47 - -___ - -### readBytes - -▸ **readBytes**(`length`, `loose?`): `Uint8Array` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `length` | `number` | -| `loose?` | `boolean` | - -#### Returns - -`Uint8Array` - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:50 - -___ - -### readValue - -▸ **readValue**(): [`BigNumber`](verida_web3._internal_.BigNumber.md) - -#### Returns - -[`BigNumber`](verida_web3._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:51 - -___ - -### subReader - -▸ **subReader**(`offset`): [`Reader`](verida_web3._internal_.Reader.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `offset` | `number` | - -#### Returns - -[`Reader`](verida_web3._internal_.Reader.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:49 - -___ - -### coerce - -▸ `Static` **coerce**(`name`, `value`): `any` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` | -| `value` | `any` | - -#### Returns - -`any` - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:46 diff --git a/docs/api/verida-js/classes/verida_web3._internal_.RunningEvent.md b/docs/api/verida-js/classes/verida_web3._internal_.RunningEvent.md deleted file mode 100644 index df0d582..0000000 --- a/docs/api/verida-js/classes/verida_web3._internal_.RunningEvent.md +++ /dev/null @@ -1,218 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web3](../modules/verida_web3.md) / [](../modules/verida_web3._internal_.md) / RunningEvent - -# Class: RunningEvent - -[@verida/web3](../modules/verida_web3.md).[](../modules/verida_web3._internal_.md).RunningEvent - -## Table of contents - -### Constructors - -- [constructor](verida_web3._internal_.RunningEvent.md#constructor) - -### Properties - -- [\_listeners](verida_web3._internal_.RunningEvent.md#_listeners) -- [filter](verida_web3._internal_.RunningEvent.md#filter) -- [tag](verida_web3._internal_.RunningEvent.md#tag) - -### Methods - -- [addListener](verida_web3._internal_.RunningEvent.md#addlistener) -- [getEmit](verida_web3._internal_.RunningEvent.md#getemit) -- [listenerCount](verida_web3._internal_.RunningEvent.md#listenercount) -- [listeners](verida_web3._internal_.RunningEvent.md#listeners) -- [prepareEvent](verida_web3._internal_.RunningEvent.md#prepareevent) -- [removeAllListeners](verida_web3._internal_.RunningEvent.md#removealllisteners) -- [removeListener](verida_web3._internal_.RunningEvent.md#removelistener) -- [run](verida_web3._internal_.RunningEvent.md#run) - -## Constructors - -### constructor - -• **new RunningEvent**(`tag`, `filter`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `tag` | `string` | -| `filter` | [`EventFilter`](../modules/verida_web3._internal_.md#eventfilter) | - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:67 - -## Properties - -### \_listeners - -• `Private` **\_listeners**: `any` - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:66 - -___ - -### filter - -• `Readonly` **filter**: [`EventFilter`](../modules/verida_web3._internal_.md#eventfilter) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:65 - -___ - -### tag - -• `Readonly` **tag**: `string` - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:64 - -## Methods - -### addListener - -▸ **addListener**(`listener`, `once`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `listener` | [`Listener`](../modules/verida_web3._internal_.md#listener) | -| `once` | `boolean` | - -#### Returns - -`void` - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:68 - -___ - -### getEmit - -▸ **getEmit**(`event`): `any`[] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | [`Event`](../interfaces/verida_web3._internal_.Event.md) | - -#### Returns - -`any`[] - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:75 - -___ - -### listenerCount - -▸ **listenerCount**(): `number` - -#### Returns - -`number` - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:72 - -___ - -### listeners - -▸ **listeners**(): [`Listener`](../modules/verida_web3._internal_.md#listener)[] - -#### Returns - -[`Listener`](../modules/verida_web3._internal_.md#listener)[] - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:71 - -___ - -### prepareEvent - -▸ **prepareEvent**(`event`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | [`Event`](../interfaces/verida_web3._internal_.Event.md) | - -#### Returns - -`void` - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:74 - -___ - -### removeAllListeners - -▸ **removeAllListeners**(): `void` - -#### Returns - -`void` - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:70 - -___ - -### removeListener - -▸ **removeListener**(`listener`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `listener` | [`Listener`](../modules/verida_web3._internal_.md#listener) | - -#### Returns - -`void` - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:69 - -___ - -### run - -▸ **run**(`args`): `number` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `args` | `any`[] | - -#### Returns - -`number` - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:73 diff --git a/docs/api/verida-js/classes/verida_web3._internal_.Signer.md b/docs/api/verida-js/classes/verida_web3._internal_.Signer.md deleted file mode 100644 index f12d691..0000000 --- a/docs/api/verida-js/classes/verida_web3._internal_.Signer.md +++ /dev/null @@ -1,383 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web3](../modules/verida_web3.md) / [](../modules/verida_web3._internal_.md) / Signer - -# Class: Signer - -[@verida/web3](../modules/verida_web3.md).[](../modules/verida_web3._internal_.md).Signer - -## Table of contents - -### Constructors - -- [constructor](verida_web3._internal_.Signer.md#constructor) - -### Properties - -- [\_isSigner](verida_web3._internal_.Signer.md#_issigner) -- [provider](verida_web3._internal_.Signer.md#provider) - -### Methods - -- [\_checkProvider](verida_web3._internal_.Signer.md#_checkprovider) -- [call](verida_web3._internal_.Signer.md#call) -- [checkTransaction](verida_web3._internal_.Signer.md#checktransaction) -- [connect](verida_web3._internal_.Signer.md#connect) -- [estimateGas](verida_web3._internal_.Signer.md#estimategas) -- [getAddress](verida_web3._internal_.Signer.md#getaddress) -- [getBalance](verida_web3._internal_.Signer.md#getbalance) -- [getChainId](verida_web3._internal_.Signer.md#getchainid) -- [getFeeData](verida_web3._internal_.Signer.md#getfeedata) -- [getGasPrice](verida_web3._internal_.Signer.md#getgasprice) -- [getTransactionCount](verida_web3._internal_.Signer.md#gettransactioncount) -- [populateTransaction](verida_web3._internal_.Signer.md#populatetransaction) -- [resolveName](verida_web3._internal_.Signer.md#resolvename) -- [sendTransaction](verida_web3._internal_.Signer.md#sendtransaction) -- [signMessage](verida_web3._internal_.Signer.md#signmessage) -- [signTransaction](verida_web3._internal_.Signer.md#signtransaction) -- [isSigner](verida_web3._internal_.Signer.md#issigner) - -## Constructors - -### constructor - -• **new Signer**() - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:30 - -## Properties - -### \_isSigner - -• `Readonly` **\_isSigner**: `boolean` - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:29 - -___ - -### provider - -• `Optional` `Readonly` **provider**: [`Provider`](verida_web3._internal_.Provider.md) - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:24 - -## Methods - -### \_checkProvider - -▸ **_checkProvider**(`operation?`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `operation?` | `string` | - -#### Returns - -`void` - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:42 - -___ - -### call - -▸ **call**(`transaction`, `blockTag?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transaction` | [`Deferrable`](../modules/verida_web3._internal_.md#deferrable)<[`TransactionRequest`](../modules/verida_web3._internal_.md#transactionrequest)\> | -| `blockTag?` | [`BlockTag`](../modules/verida_web3._internal_.md#blocktag) | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:34 - -___ - -### checkTransaction - -▸ **checkTransaction**(`transaction`): [`Deferrable`](../modules/verida_web3._internal_.md#deferrable)<[`TransactionRequest`](../modules/verida_web3._internal_.md#transactionrequest)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transaction` | [`Deferrable`](../modules/verida_web3._internal_.md#deferrable)<[`TransactionRequest`](../modules/verida_web3._internal_.md#transactionrequest)\> | - -#### Returns - -[`Deferrable`](../modules/verida_web3._internal_.md#deferrable)<[`TransactionRequest`](../modules/verida_web3._internal_.md#transactionrequest)\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:40 - -___ - -### connect - -▸ `Abstract` **connect**(`provider`): [`Signer`](verida_web3._internal_.Signer.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `provider` | [`Provider`](verida_web3._internal_.Provider.md) | - -#### Returns - -[`Signer`](verida_web3._internal_.Signer.md) - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:28 - -___ - -### estimateGas - -▸ **estimateGas**(`transaction`): `Promise`<[`BigNumber`](verida_web3._internal_.BigNumber.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transaction` | [`Deferrable`](../modules/verida_web3._internal_.md#deferrable)<[`TransactionRequest`](../modules/verida_web3._internal_.md#transactionrequest)\> | - -#### Returns - -`Promise`<[`BigNumber`](verida_web3._internal_.BigNumber.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:33 - -___ - -### getAddress - -▸ `Abstract` **getAddress**(): `Promise`<`string`\> - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:25 - -___ - -### getBalance - -▸ **getBalance**(`blockTag?`): `Promise`<[`BigNumber`](verida_web3._internal_.BigNumber.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `blockTag?` | [`BlockTag`](../modules/verida_web3._internal_.md#blocktag) | - -#### Returns - -`Promise`<[`BigNumber`](verida_web3._internal_.BigNumber.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:31 - -___ - -### getChainId - -▸ **getChainId**(): `Promise`<`number`\> - -#### Returns - -`Promise`<`number`\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:36 - -___ - -### getFeeData - -▸ **getFeeData**(): `Promise`<[`FeeData`](../interfaces/verida_web3._internal_.FeeData.md)\> - -#### Returns - -`Promise`<[`FeeData`](../interfaces/verida_web3._internal_.FeeData.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:38 - -___ - -### getGasPrice - -▸ **getGasPrice**(): `Promise`<[`BigNumber`](verida_web3._internal_.BigNumber.md)\> - -#### Returns - -`Promise`<[`BigNumber`](verida_web3._internal_.BigNumber.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:37 - -___ - -### getTransactionCount - -▸ **getTransactionCount**(`blockTag?`): `Promise`<`number`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `blockTag?` | [`BlockTag`](../modules/verida_web3._internal_.md#blocktag) | - -#### Returns - -`Promise`<`number`\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:32 - -___ - -### populateTransaction - -▸ **populateTransaction**(`transaction`): `Promise`<[`TransactionRequest`](../modules/verida_web3._internal_.md#transactionrequest)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transaction` | [`Deferrable`](../modules/verida_web3._internal_.md#deferrable)<[`TransactionRequest`](../modules/verida_web3._internal_.md#transactionrequest)\> | - -#### Returns - -`Promise`<[`TransactionRequest`](../modules/verida_web3._internal_.md#transactionrequest)\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:41 - -___ - -### resolveName - -▸ **resolveName**(`name`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:39 - -___ - -### sendTransaction - -▸ **sendTransaction**(`transaction`): `Promise`<[`TransactionResponse`](../interfaces/verida_web3._internal_.TransactionResponse.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transaction` | [`Deferrable`](../modules/verida_web3._internal_.md#deferrable)<[`TransactionRequest`](../modules/verida_web3._internal_.md#transactionrequest)\> | - -#### Returns - -`Promise`<[`TransactionResponse`](../interfaces/verida_web3._internal_.TransactionResponse.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:35 - -___ - -### signMessage - -▸ `Abstract` **signMessage**(`message`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `message` | `string` \| [`Bytes`](../modules/verida_web3._internal_.md#bytes) | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:26 - -___ - -### signTransaction - -▸ `Abstract` **signTransaction**(`transaction`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transaction` | [`Deferrable`](../modules/verida_web3._internal_.md#deferrable)<[`TransactionRequest`](../modules/verida_web3._internal_.md#transactionrequest)\> | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:27 - -___ - -### isSigner - -▸ `Static` **isSigner**(`value`): value is Signer - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `any` | - -#### Returns - -value is Signer - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:43 diff --git a/docs/api/verida-js/classes/verida_web3._internal_.TransactionDescription.md b/docs/api/verida-js/classes/verida_web3._internal_.TransactionDescription.md deleted file mode 100644 index a45da15..0000000 --- a/docs/api/verida-js/classes/verida_web3._internal_.TransactionDescription.md +++ /dev/null @@ -1,112 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web3](../modules/verida_web3.md) / [](../modules/verida_web3._internal_.md) / TransactionDescription - -# Class: TransactionDescription - -[@verida/web3](../modules/verida_web3.md).[](../modules/verida_web3._internal_.md).TransactionDescription - -## Hierarchy - -- [`Description`](verida_web3._internal_.Description.md)<[`TransactionDescription`](verida_web3._internal_.TransactionDescription.md)\> - - ↳ **`TransactionDescription`** - -## Table of contents - -### Constructors - -- [constructor](verida_web3._internal_.TransactionDescription.md#constructor) - -### Properties - -- [args](verida_web3._internal_.TransactionDescription.md#args) -- [functionFragment](verida_web3._internal_.TransactionDescription.md#functionfragment) -- [name](verida_web3._internal_.TransactionDescription.md#name) -- [sighash](verida_web3._internal_.TransactionDescription.md#sighash) -- [signature](verida_web3._internal_.TransactionDescription.md#signature) -- [value](verida_web3._internal_.TransactionDescription.md#value) - -## Constructors - -### constructor - -• **new TransactionDescription**(`info`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `info` | `Object` | -| `info.args` | [`Result`](../interfaces/verida_web3._internal_.Result.md) | -| `info.functionFragment` | [`FunctionFragment`](verida_web3._internal_.FunctionFragment.md) | -| `info.name` | `string` | -| `info.sighash` | `string` | -| `info.signature` | `string` | -| `info.value` | [`BigNumber`](verida_web3._internal_.BigNumber.md) | - -#### Inherited from - -[Description](verida_web3._internal_.Description.md).[constructor](verida_web3._internal_.Description.md#constructor) - -#### Defined in - -node_modules/@ethersproject/properties/lib/index.d.ts:13 - -## Properties - -### args - -• `Readonly` **args**: [`Result`](../interfaces/verida_web3._internal_.Result.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:18 - -___ - -### functionFragment - -• `Readonly` **functionFragment**: [`FunctionFragment`](verida_web3._internal_.FunctionFragment.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:16 - -___ - -### name - -• `Readonly` **name**: `string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:17 - -___ - -### sighash - -• `Readonly` **sighash**: `string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:20 - -___ - -### signature - -• `Readonly` **signature**: `string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:19 - -___ - -### value - -• `Readonly` **value**: [`BigNumber`](verida_web3._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/abi/lib/interface.d.ts:21 diff --git a/docs/api/verida-js/classes/verida_web3._internal_.Writer.md b/docs/api/verida-js/classes/verida_web3._internal_.Writer.md deleted file mode 100644 index 3947139..0000000 --- a/docs/api/verida-js/classes/verida_web3._internal_.Writer.md +++ /dev/null @@ -1,242 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web3](../modules/verida_web3.md) / [](../modules/verida_web3._internal_.md) / Writer - -# Class: Writer - -[@verida/web3](../modules/verida_web3.md).[](../modules/verida_web3._internal_.md).Writer - -## Table of contents - -### Constructors - -- [constructor](verida_web3._internal_.Writer.md#constructor) - -### Properties - -- [\_data](verida_web3._internal_.Writer.md#_data) -- [\_dataLength](verida_web3._internal_.Writer.md#_datalength) -- [\_padding](verida_web3._internal_.Writer.md#_padding) -- [wordSize](verida_web3._internal_.Writer.md#wordsize) - -### Accessors - -- [data](verida_web3._internal_.Writer.md#data) -- [length](verida_web3._internal_.Writer.md#length) - -### Methods - -- [\_getValue](verida_web3._internal_.Writer.md#_getvalue) -- [\_writeData](verida_web3._internal_.Writer.md#_writedata) -- [appendWriter](verida_web3._internal_.Writer.md#appendwriter) -- [writeBytes](verida_web3._internal_.Writer.md#writebytes) -- [writeUpdatableValue](verida_web3._internal_.Writer.md#writeupdatablevalue) -- [writeValue](verida_web3._internal_.Writer.md#writevalue) - -## Constructors - -### constructor - -• **new Writer**(`wordSize?`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `wordSize?` | `number` | - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:27 - -## Properties - -### \_data - -• **\_data**: `Uint8Array`[] - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:24 - -___ - -### \_dataLength - -• **\_dataLength**: `number` - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:25 - -___ - -### \_padding - -• **\_padding**: `Uint8Array` - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:26 - -___ - -### wordSize - -• `Readonly` **wordSize**: `number` - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:23 - -## Accessors - -### data - -• `get` **data**(): `string` - -#### Returns - -`string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:28 - -___ - -### length - -• `get` **length**(): `number` - -#### Returns - -`number` - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:29 - -## Methods - -### \_getValue - -▸ **_getValue**(`value`): `Uint8Array` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | [`BigNumberish`](../modules/verida_web3._internal_.md#bignumberish) | - -#### Returns - -`Uint8Array` - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:33 - -___ - -### \_writeData - -▸ **_writeData**(`data`): `number` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `Uint8Array` | - -#### Returns - -`number` - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:30 - -___ - -### appendWriter - -▸ **appendWriter**(`writer`): `number` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `writer` | [`Writer`](verida_web3._internal_.Writer.md) | - -#### Returns - -`number` - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:31 - -___ - -### writeBytes - -▸ **writeBytes**(`value`): `number` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | [`BytesLike`](../modules/verida_web3._internal_.md#byteslike) | - -#### Returns - -`number` - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:32 - -___ - -### writeUpdatableValue - -▸ **writeUpdatableValue**(): (`value`: [`BigNumberish`](../modules/verida_web3._internal_.md#bignumberish)) => `void` - -#### Returns - -`fn` - -▸ (`value`): `void` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | [`BigNumberish`](../modules/verida_web3._internal_.md#bignumberish) | - -##### Returns - -`void` - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:35 - -___ - -### writeValue - -▸ **writeValue**(`value`): `number` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | [`BigNumberish`](../modules/verida_web3._internal_.md#bignumberish) | - -#### Returns - -`number` - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:34 diff --git a/docs/api/verida-js/classes/verida_web_helpers._internal_.Ajv2020.md b/docs/api/verida-js/classes/verida_web_helpers._internal_.Ajv2020.md deleted file mode 100644 index 0b79ee1..0000000 --- a/docs/api/verida-js/classes/verida_web_helpers._internal_.Ajv2020.md +++ /dev/null @@ -1,1047 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / Ajv2020 - -# Class: Ajv2020 - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).Ajv2020 - -## Hierarchy - -- [`default`](verida_web_helpers._internal_.default-3.md) - - ↳ **`Ajv2020`** - -## Table of contents - -### Constructors - -- [constructor](verida_web_helpers._internal_.Ajv2020.md#constructor) - -### Properties - -- [RULES](verida_web_helpers._internal_.Ajv2020.md#rules) -- [\_compilations](verida_web_helpers._internal_.Ajv2020.md#_compilations) -- [errors](verida_web_helpers._internal_.Ajv2020.md#errors) -- [formats](verida_web_helpers._internal_.Ajv2020.md#formats) -- [logger](verida_web_helpers._internal_.Ajv2020.md#logger) -- [opts](verida_web_helpers._internal_.Ajv2020.md#opts) -- [refs](verida_web_helpers._internal_.Ajv2020.md#refs) -- [schemas](verida_web_helpers._internal_.Ajv2020.md#schemas) -- [scope](verida_web_helpers._internal_.Ajv2020.md#scope) -- [MissingRefError](verida_web_helpers._internal_.Ajv2020.md#missingreferror) -- [ValidationError](verida_web_helpers._internal_.Ajv2020.md#validationerror) - -### Methods - -- [$dataMetaSchema](verida_web_helpers._internal_.Ajv2020.md#$datametaschema) -- [\_addDefaultMetaSchema](verida_web_helpers._internal_.Ajv2020.md#_adddefaultmetaschema) -- [\_addSchema](verida_web_helpers._internal_.Ajv2020.md#_addschema) -- [\_addVocabularies](verida_web_helpers._internal_.Ajv2020.md#_addvocabularies) -- [addFormat](verida_web_helpers._internal_.Ajv2020.md#addformat) -- [addKeyword](verida_web_helpers._internal_.Ajv2020.md#addkeyword) -- [addMetaSchema](verida_web_helpers._internal_.Ajv2020.md#addmetaschema) -- [addSchema](verida_web_helpers._internal_.Ajv2020.md#addschema) -- [addVocabulary](verida_web_helpers._internal_.Ajv2020.md#addvocabulary) -- [compile](verida_web_helpers._internal_.Ajv2020.md#compile) -- [compileAsync](verida_web_helpers._internal_.Ajv2020.md#compileasync) -- [defaultMeta](verida_web_helpers._internal_.Ajv2020.md#defaultmeta) -- [errorsText](verida_web_helpers._internal_.Ajv2020.md#errorstext) -- [getKeyword](verida_web_helpers._internal_.Ajv2020.md#getkeyword) -- [getSchema](verida_web_helpers._internal_.Ajv2020.md#getschema) -- [removeKeyword](verida_web_helpers._internal_.Ajv2020.md#removekeyword) -- [removeSchema](verida_web_helpers._internal_.Ajv2020.md#removeschema) -- [validate](verida_web_helpers._internal_.Ajv2020.md#validate) -- [validateSchema](verida_web_helpers._internal_.Ajv2020.md#validateschema) - -## Constructors - -### constructor - -• **new Ajv2020**(`opts?`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `opts?` | [`Options`](../modules/verida_web_helpers._internal_.md#options) | - -#### Overrides - -[default](verida_web_helpers._internal_.default-3.md).[constructor](verida_web_helpers._internal_.default-3.md#constructor) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/2020.d.ts:4 - -## Properties - -### RULES - -• `Readonly` **RULES**: [`ValidationRules`](../interfaces/verida_web_helpers._internal_.ValidationRules.md) - -#### Inherited from - -[default](verida_web_helpers._internal_.default-3.md).[RULES](verida_web_helpers._internal_.default-3.md#rules) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:120 - -___ - -### \_compilations - -• `Readonly` **\_compilations**: `Set`<[`SchemaEnv`](verida_web_helpers._internal_.SchemaEnv.md)\> - -#### Inherited from - -[default](verida_web_helpers._internal_.default-3.md).[_compilations](verida_web_helpers._internal_.default-3.md#_compilations) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:121 - -___ - -### errors - -• `Optional` **errors**: ``null`` \| [`ErrorObject`](../interfaces/verida_web_helpers._internal_.ErrorObject.md)<`string`, [`Record`](../modules/verida_web_helpers._internal_.md#record)<`string`, `any`\>, `unknown`\>[] - -#### Inherited from - -[default](verida_web_helpers._internal_.default-3.md).[errors](verida_web_helpers._internal_.default-3.md#errors) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:108 - -___ - -### formats - -• `Readonly` **formats**: `Object` - -#### Inherited from - -[default](verida_web_helpers._internal_.default-3.md).[formats](verida_web_helpers._internal_.default-3.md#formats) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:117 - -___ - -### logger - -• **logger**: [`Logger`](../interfaces/verida_web_helpers._internal_.Logger.md) - -#### Inherited from - -[default](verida_web_helpers._internal_.default-3.md).[logger](verida_web_helpers._internal_.default-3.md#logger) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:109 - -___ - -### opts - -• **opts**: [`InstanceOptions`](../modules/verida_web_helpers._internal_.md#instanceoptions) - -#### Inherited from - -[default](verida_web_helpers._internal_.default-3.md).[opts](verida_web_helpers._internal_.default-3.md#opts) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:107 - -___ - -### refs - -• `Readonly` **refs**: `Object` - -#### Inherited from - -[default](verida_web_helpers._internal_.default-3.md).[refs](verida_web_helpers._internal_.default-3.md#refs) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:114 - -___ - -### schemas - -• `Readonly` **schemas**: `Object` - -#### Inherited from - -[default](verida_web_helpers._internal_.default-3.md).[schemas](verida_web_helpers._internal_.default-3.md#schemas) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:111 - -___ - -### scope - -• `Readonly` **scope**: [`ValueScope`](verida_web_helpers._internal_.ValueScope.md) - -#### Inherited from - -[default](verida_web_helpers._internal_.default-3.md).[scope](verida_web_helpers._internal_.default-3.md#scope) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:110 - -___ - -### MissingRefError - -▪ `Static` **MissingRefError**: typeof [`default`](verida_web_helpers._internal_.default-5.md) - -#### Inherited from - -[default](verida_web_helpers._internal_.default-3.md).[MissingRefError](verida_web_helpers._internal_.default-3.md#missingreferror) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:126 - -___ - -### ValidationError - -▪ `Static` **ValidationError**: typeof [`default`](verida_web_helpers._internal_.default-4.md) - -#### Inherited from - -[default](verida_web_helpers._internal_.default-3.md).[ValidationError](verida_web_helpers._internal_.default-3.md#validationerror) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:125 - -## Methods - -### $dataMetaSchema - -▸ **$dataMetaSchema**(`metaSchema`, `keywordsJsonPointers`): [`AnySchemaObject`](../modules/verida_web_helpers._internal_.md#anyschemaobject) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `metaSchema` | [`AnySchemaObject`](../modules/verida_web_helpers._internal_.md#anyschemaobject) | -| `keywordsJsonPointers` | `string`[] | - -#### Returns - -[`AnySchemaObject`](../modules/verida_web_helpers._internal_.md#anyschemaobject) - -#### Inherited from - -[default](verida_web_helpers._internal_.default-3.md).[$dataMetaSchema](verida_web_helpers._internal_.default-3.md#$datametaschema) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:163 - -___ - -### \_addDefaultMetaSchema - -▸ **_addDefaultMetaSchema**(): `void` - -#### Returns - -`void` - -#### Overrides - -[default](verida_web_helpers._internal_.default-3.md).[_addDefaultMetaSchema](verida_web_helpers._internal_.default-3.md#_adddefaultmetaschema) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/2020.d.ts:6 - -___ - -### \_addSchema - -▸ **_addSchema**(`schema`, `meta?`, `baseId?`, `validateSchema?`, `addSchema?`): [`SchemaEnv`](verida_web_helpers._internal_.SchemaEnv.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schema` | [`AnySchema`](../modules/verida_web_helpers._internal_.md#anyschema) | -| `meta?` | `boolean` | -| `baseId?` | `string` | -| `validateSchema?` | `boolean` \| ``"log"`` | -| `addSchema?` | `boolean` | - -#### Returns - -[`SchemaEnv`](verida_web_helpers._internal_.SchemaEnv.md) - -#### Inherited from - -[default](verida_web_helpers._internal_.default-3.md).[_addSchema](verida_web_helpers._internal_.default-3.md#_addschema) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:165 - -___ - -### \_addVocabularies - -▸ **_addVocabularies**(): `void` - -#### Returns - -`void` - -#### Overrides - -[default](verida_web_helpers._internal_.default-3.md).[_addVocabularies](verida_web_helpers._internal_.default-3.md#_addvocabularies) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/2020.d.ts:5 - -___ - -### addFormat - -▸ **addFormat**(`name`, `format`): [`default`](verida_web_helpers._internal_.default-3.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` | -| `format` | [`Format`](../modules/verida_web_helpers._internal_.md#format) | - -#### Returns - -[`default`](verida_web_helpers._internal_.default-3.md) - -#### Inherited from - -[default](verida_web_helpers._internal_.default-3.md).[addFormat](verida_web_helpers._internal_.default-3.md#addformat) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:160 - -___ - -### addKeyword - -▸ **addKeyword**(`kwdOrDef`, `def?`): [`default`](verida_web_helpers._internal_.default-3.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `kwdOrDef` | `string` \| [`KeywordDefinition`](../modules/verida_web_helpers._internal_.md#keyworddefinition) | -| `def?` | [`KeywordDefinition`](../modules/verida_web_helpers._internal_.md#keyworddefinition) | - -#### Returns - -[`default`](verida_web_helpers._internal_.default-3.md) - -#### Inherited from - -[default](verida_web_helpers._internal_.default-3.md).[addKeyword](verida_web_helpers._internal_.default-3.md#addkeyword) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:157 - -___ - -### addMetaSchema - -▸ **addMetaSchema**(`schema`, `key?`, `_validateSchema?`): [`default`](verida_web_helpers._internal_.default-3.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schema` | [`AnySchemaObject`](../modules/verida_web_helpers._internal_.md#anyschemaobject) | -| `key?` | `string` | -| `_validateSchema?` | `boolean` \| ``"log"`` | - -#### Returns - -[`default`](verida_web_helpers._internal_.default-3.md) - -#### Inherited from - -[default](verida_web_helpers._internal_.default-3.md).[addMetaSchema](verida_web_helpers._internal_.default-3.md#addmetaschema) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:151 - -___ - -### addSchema - -▸ **addSchema**(`schema`, `key?`, `_meta?`, `_validateSchema?`): [`default`](verida_web_helpers._internal_.default-3.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schema` | [`AnySchema`](../modules/verida_web_helpers._internal_.md#anyschema) \| [`AnySchema`](../modules/verida_web_helpers._internal_.md#anyschema)[] | -| `key?` | `string` | -| `_meta?` | `boolean` | -| `_validateSchema?` | `boolean` \| ``"log"`` | - -#### Returns - -[`default`](verida_web_helpers._internal_.default-3.md) - -#### Inherited from - -[default](verida_web_helpers._internal_.default-3.md).[addSchema](verida_web_helpers._internal_.default-3.md#addschema) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:147 - -___ - -### addVocabulary - -▸ **addVocabulary**(`definitions`): [`default`](verida_web_helpers._internal_.default-3.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `definitions` | [`Vocabulary`](../modules/verida_web_helpers._internal_.md#vocabulary) | - -#### Returns - -[`default`](verida_web_helpers._internal_.default-3.md) - -#### Inherited from - -[default](verida_web_helpers._internal_.default-3.md).[addVocabulary](verida_web_helpers._internal_.default-3.md#addvocabulary) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:156 - -___ - -### compile - -▸ **compile**<`T`\>(`schema`, `_meta?`): [`ValidateFunction`](../interfaces/verida_web_helpers._internal_.ValidateFunction.md)<`T`\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `unknown` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schema` | [`Schema`](../modules/verida_web_helpers._internal_.md#schema) \| [`UncheckedJSONSchemaType`](../modules/verida_web_helpers._internal_.md#uncheckedjsonschematype)<`T`, ``false``\> | -| `_meta?` | `boolean` | - -#### Returns - -[`ValidateFunction`](../interfaces/verida_web_helpers._internal_.ValidateFunction.md)<`T`\> - -#### Inherited from - -[default](verida_web_helpers._internal_.default-3.md).[compile](verida_web_helpers._internal_.default-3.md#compile) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:138 - -▸ **compile**<`T`\>(`schema`, `_meta?`): [`ValidateFunction`](../interfaces/verida_web_helpers._internal_.ValidateFunction.md)<`T`\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `unknown` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schema` | [`JTDSchemaType`](../modules/verida_web_helpers._internal_.md#jtdschematype)<`T`, [`Record`](../modules/verida_web_helpers._internal_.md#record)<`string`, `never`\>\> | -| `_meta?` | `boolean` | - -#### Returns - -[`ValidateFunction`](../interfaces/verida_web_helpers._internal_.ValidateFunction.md)<`T`\> - -#### Inherited from - -[default](verida_web_helpers._internal_.default-3.md).[compile](verida_web_helpers._internal_.default-3.md#compile) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:139 - -▸ **compile**<`N`, `T`\>(`schema`, `_meta?`): [`ValidateFunction`](../interfaces/verida_web_helpers._internal_.ValidateFunction.md)<[`JTDDataType`](../modules/verida_web_helpers._internal_.md#jtddatatype)<`T`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `N` | extends `never` | -| `T` | extends [`SomeJTDSchemaType`](../modules/verida_web_helpers._internal_.md#somejtdschematype) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schema` | `T` | -| `_meta?` | `boolean` | - -#### Returns - -[`ValidateFunction`](../interfaces/verida_web_helpers._internal_.ValidateFunction.md)<[`JTDDataType`](../modules/verida_web_helpers._internal_.md#jtddatatype)<`T`\>\> - -#### Inherited from - -[default](verida_web_helpers._internal_.default-3.md).[compile](verida_web_helpers._internal_.default-3.md#compile) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:140 - -▸ **compile**<`T`\>(`schema`, `_meta?`): [`AsyncValidateFunction`](../interfaces/verida_web_helpers._internal_.AsyncValidateFunction.md)<`T`\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `unknown` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schema` | [`AsyncSchema`](../interfaces/verida_web_helpers._internal_.AsyncSchema.md) | -| `_meta?` | `boolean` | - -#### Returns - -[`AsyncValidateFunction`](../interfaces/verida_web_helpers._internal_.AsyncValidateFunction.md)<`T`\> - -#### Inherited from - -[default](verida_web_helpers._internal_.default-3.md).[compile](verida_web_helpers._internal_.default-3.md#compile) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:141 - -▸ **compile**<`T`\>(`schema`, `_meta?`): [`AnyValidateFunction`](../modules/verida_web_helpers._internal_.md#anyvalidatefunction)<`T`\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `unknown` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schema` | [`AnySchema`](../modules/verida_web_helpers._internal_.md#anyschema) | -| `_meta?` | `boolean` | - -#### Returns - -[`AnyValidateFunction`](../modules/verida_web_helpers._internal_.md#anyvalidatefunction)<`T`\> - -#### Inherited from - -[default](verida_web_helpers._internal_.default-3.md).[compile](verida_web_helpers._internal_.default-3.md#compile) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:142 - -___ - -### compileAsync - -▸ **compileAsync**<`T`\>(`schema`, `_meta?`): `Promise`<[`ValidateFunction`](../interfaces/verida_web_helpers._internal_.ValidateFunction.md)<`T`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `unknown` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schema` | [`SchemaObject`](../interfaces/verida_web_helpers._internal_.SchemaObject.md) \| [`UncheckedJSONSchemaType`](../modules/verida_web_helpers._internal_.md#uncheckedjsonschematype)<`T`, ``false``\> | -| `_meta?` | `boolean` | - -#### Returns - -`Promise`<[`ValidateFunction`](../interfaces/verida_web_helpers._internal_.ValidateFunction.md)<`T`\>\> - -#### Inherited from - -[default](verida_web_helpers._internal_.default-3.md).[compileAsync](verida_web_helpers._internal_.default-3.md#compileasync) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:143 - -▸ **compileAsync**<`T`\>(`schema`, `_meta?`): `Promise`<[`ValidateFunction`](../interfaces/verida_web_helpers._internal_.ValidateFunction.md)<`T`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `unknown` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schema` | [`JTDSchemaType`](../modules/verida_web_helpers._internal_.md#jtdschematype)<`T`, [`Record`](../modules/verida_web_helpers._internal_.md#record)<`string`, `never`\>\> | -| `_meta?` | `boolean` | - -#### Returns - -`Promise`<[`ValidateFunction`](../interfaces/verida_web_helpers._internal_.ValidateFunction.md)<`T`\>\> - -#### Inherited from - -[default](verida_web_helpers._internal_.default-3.md).[compileAsync](verida_web_helpers._internal_.default-3.md#compileasync) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:144 - -▸ **compileAsync**<`T`\>(`schema`, `meta?`): `Promise`<[`AsyncValidateFunction`](../interfaces/verida_web_helpers._internal_.AsyncValidateFunction.md)<`T`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `unknown` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schema` | [`AsyncSchema`](../interfaces/verida_web_helpers._internal_.AsyncSchema.md) | -| `meta?` | `boolean` | - -#### Returns - -`Promise`<[`AsyncValidateFunction`](../interfaces/verida_web_helpers._internal_.AsyncValidateFunction.md)<`T`\>\> - -#### Inherited from - -[default](verida_web_helpers._internal_.default-3.md).[compileAsync](verida_web_helpers._internal_.default-3.md#compileasync) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:145 - -▸ **compileAsync**<`T`\>(`schema`, `meta?`): `Promise`<[`AnyValidateFunction`](../modules/verida_web_helpers._internal_.md#anyvalidatefunction)<`T`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `unknown` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schema` | [`AnySchemaObject`](../modules/verida_web_helpers._internal_.md#anyschemaobject) | -| `meta?` | `boolean` | - -#### Returns - -`Promise`<[`AnyValidateFunction`](../modules/verida_web_helpers._internal_.md#anyvalidatefunction)<`T`\>\> - -#### Inherited from - -[default](verida_web_helpers._internal_.default-3.md).[compileAsync](verida_web_helpers._internal_.default-3.md#compileasync) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:146 - -___ - -### defaultMeta - -▸ **defaultMeta**(): `undefined` \| `string` \| [`AnySchemaObject`](../modules/verida_web_helpers._internal_.md#anyschemaobject) - -#### Returns - -`undefined` \| `string` \| [`AnySchemaObject`](../modules/verida_web_helpers._internal_.md#anyschemaobject) - -#### Overrides - -[default](verida_web_helpers._internal_.default-3.md).[defaultMeta](verida_web_helpers._internal_.default-3.md#defaultmeta) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/2020.d.ts:7 - -___ - -### errorsText - -▸ **errorsText**(`errors?`, `__namedParameters?`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `errors?` | ``null`` \| [`ErrorObject`](../interfaces/verida_web_helpers._internal_.ErrorObject.md)<`string`, [`Record`](../modules/verida_web_helpers._internal_.md#record)<`string`, `any`\>, `unknown`\>[] | -| `__namedParameters?` | [`ErrorsTextOptions`](../interfaces/verida_web_helpers._internal_.ErrorsTextOptions.md) | - -#### Returns - -`string` - -#### Inherited from - -[default](verida_web_helpers._internal_.default-3.md).[errorsText](verida_web_helpers._internal_.default-3.md#errorstext) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:161 - -___ - -### getKeyword - -▸ **getKeyword**(`keyword`): `boolean` \| [`AddedKeywordDefinition`](../modules/verida_web_helpers._internal_.md#addedkeyworddefinition) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `keyword` | `string` | - -#### Returns - -`boolean` \| [`AddedKeywordDefinition`](../modules/verida_web_helpers._internal_.md#addedkeyworddefinition) - -#### Inherited from - -[default](verida_web_helpers._internal_.default-3.md).[getKeyword](verida_web_helpers._internal_.default-3.md#getkeyword) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:158 - -___ - -### getSchema - -▸ **getSchema**<`T`\>(`keyRef`): `undefined` \| [`AnyValidateFunction`](../modules/verida_web_helpers._internal_.md#anyvalidatefunction)<`T`\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `unknown` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `keyRef` | `string` | - -#### Returns - -`undefined` \| [`AnyValidateFunction`](../modules/verida_web_helpers._internal_.md#anyvalidatefunction)<`T`\> - -#### Inherited from - -[default](verida_web_helpers._internal_.default-3.md).[getSchema](verida_web_helpers._internal_.default-3.md#getschema) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:154 - -___ - -### removeKeyword - -▸ **removeKeyword**(`keyword`): [`default`](verida_web_helpers._internal_.default-3.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `keyword` | `string` | - -#### Returns - -[`default`](verida_web_helpers._internal_.default-3.md) - -#### Inherited from - -[default](verida_web_helpers._internal_.default-3.md).[removeKeyword](verida_web_helpers._internal_.default-3.md#removekeyword) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:159 - -___ - -### removeSchema - -▸ **removeSchema**(`schemaKeyRef?`): [`default`](verida_web_helpers._internal_.default-3.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schemaKeyRef?` | `string` \| `RegExp` \| [`AnySchema`](../modules/verida_web_helpers._internal_.md#anyschema) | - -#### Returns - -[`default`](verida_web_helpers._internal_.default-3.md) - -#### Inherited from - -[default](verida_web_helpers._internal_.default-3.md).[removeSchema](verida_web_helpers._internal_.default-3.md#removeschema) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:155 - -___ - -### validate - -▸ **validate**(`schema`, `data`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schema` | `string` \| [`Schema`](../modules/verida_web_helpers._internal_.md#schema) | -| `data` | `unknown` | - -#### Returns - -`boolean` - -#### Inherited from - -[default](verida_web_helpers._internal_.default-3.md).[validate](verida_web_helpers._internal_.default-3.md#validate) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:131 - -▸ **validate**(`schemaKeyRef`, `data`): `boolean` \| `Promise`<`unknown`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schemaKeyRef` | `string` \| [`AnySchema`](../modules/verida_web_helpers._internal_.md#anyschema) | -| `data` | `unknown` | - -#### Returns - -`boolean` \| `Promise`<`unknown`\> - -#### Inherited from - -[default](verida_web_helpers._internal_.default-3.md).[validate](verida_web_helpers._internal_.default-3.md#validate) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:132 - -▸ **validate**<`T`\>(`schema`, `data`): data is T - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schema` | `string` \| [`Schema`](../modules/verida_web_helpers._internal_.md#schema) \| [`UncheckedJSONSchemaType`](../modules/verida_web_helpers._internal_.md#uncheckedjsonschematype)<`T`, ``false``\> | -| `data` | `unknown` | - -#### Returns - -data is T - -#### Inherited from - -[default](verida_web_helpers._internal_.default-3.md).[validate](verida_web_helpers._internal_.default-3.md#validate) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:133 - -▸ **validate**<`T`\>(`schema`, `data`): data is T - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schema` | [`JTDSchemaType`](../modules/verida_web_helpers._internal_.md#jtdschematype)<`T`, [`Record`](../modules/verida_web_helpers._internal_.md#record)<`string`, `never`\>\> | -| `data` | `unknown` | - -#### Returns - -data is T - -#### Inherited from - -[default](verida_web_helpers._internal_.default-3.md).[validate](verida_web_helpers._internal_.default-3.md#validate) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:134 - -▸ **validate**<`N`, `T`\>(`schema`, `data`): data is JTDDataType - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `N` | extends `never` | -| `T` | extends [`SomeJTDSchemaType`](../modules/verida_web_helpers._internal_.md#somejtdschematype) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schema` | `T` | -| `data` | `unknown` | - -#### Returns - -data is JTDDataType - -#### Inherited from - -[default](verida_web_helpers._internal_.default-3.md).[validate](verida_web_helpers._internal_.default-3.md#validate) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:135 - -▸ **validate**<`T`\>(`schema`, `data`): `Promise`<`T`\> - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schema` | [`AsyncSchema`](../interfaces/verida_web_helpers._internal_.AsyncSchema.md) | -| `data` | `unknown` | - -#### Returns - -`Promise`<`T`\> - -#### Inherited from - -[default](verida_web_helpers._internal_.default-3.md).[validate](verida_web_helpers._internal_.default-3.md#validate) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:136 - -▸ **validate**<`T`\>(`schemaKeyRef`, `data`): data is T \| Promise - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schemaKeyRef` | `string` \| [`AnySchema`](../modules/verida_web_helpers._internal_.md#anyschema) | -| `data` | `unknown` | - -#### Returns - -data is T \| Promise - -#### Inherited from - -[default](verida_web_helpers._internal_.default-3.md).[validate](verida_web_helpers._internal_.default-3.md#validate) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:137 - -___ - -### validateSchema - -▸ **validateSchema**(`schema`, `throwOrLogError?`): `boolean` \| `Promise`<`unknown`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schema` | [`AnySchema`](../modules/verida_web_helpers._internal_.md#anyschema) | -| `throwOrLogError?` | `boolean` | - -#### Returns - -`boolean` \| `Promise`<`unknown`\> - -#### Inherited from - -[default](verida_web_helpers._internal_.default-3.md).[validateSchema](verida_web_helpers._internal_.default-3.md#validateschema) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:153 diff --git a/docs/api/verida-js/classes/verida_web_helpers._internal_.BigNumber.md b/docs/api/verida-js/classes/verida_web_helpers._internal_.BigNumber.md deleted file mode 100644 index c9aa1e5..0000000 --- a/docs/api/verida-js/classes/verida_web_helpers._internal_.BigNumber.md +++ /dev/null @@ -1,631 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / BigNumber - -# Class: BigNumber - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).BigNumber - -## Implements - -- [`Hexable`](../interfaces/verida_web_helpers._internal_.Hexable.md) - -## Table of contents - -### Constructors - -- [constructor](verida_web_helpers._internal_.BigNumber.md#constructor) - -### Properties - -- [\_hex](verida_web_helpers._internal_.BigNumber.md#_hex) -- [\_isBigNumber](verida_web_helpers._internal_.BigNumber.md#_isbignumber) - -### Methods - -- [abs](verida_web_helpers._internal_.BigNumber.md#abs) -- [add](verida_web_helpers._internal_.BigNumber.md#add) -- [and](verida_web_helpers._internal_.BigNumber.md#and) -- [div](verida_web_helpers._internal_.BigNumber.md#div) -- [eq](verida_web_helpers._internal_.BigNumber.md#eq) -- [fromTwos](verida_web_helpers._internal_.BigNumber.md#fromtwos) -- [gt](verida_web_helpers._internal_.BigNumber.md#gt) -- [gte](verida_web_helpers._internal_.BigNumber.md#gte) -- [isNegative](verida_web_helpers._internal_.BigNumber.md#isnegative) -- [isZero](verida_web_helpers._internal_.BigNumber.md#iszero) -- [lt](verida_web_helpers._internal_.BigNumber.md#lt) -- [lte](verida_web_helpers._internal_.BigNumber.md#lte) -- [mask](verida_web_helpers._internal_.BigNumber.md#mask) -- [mod](verida_web_helpers._internal_.BigNumber.md#mod) -- [mul](verida_web_helpers._internal_.BigNumber.md#mul) -- [or](verida_web_helpers._internal_.BigNumber.md#or) -- [pow](verida_web_helpers._internal_.BigNumber.md#pow) -- [shl](verida_web_helpers._internal_.BigNumber.md#shl) -- [shr](verida_web_helpers._internal_.BigNumber.md#shr) -- [sub](verida_web_helpers._internal_.BigNumber.md#sub) -- [toBigInt](verida_web_helpers._internal_.BigNumber.md#tobigint) -- [toHexString](verida_web_helpers._internal_.BigNumber.md#tohexstring) -- [toJSON](verida_web_helpers._internal_.BigNumber.md#tojson) -- [toNumber](verida_web_helpers._internal_.BigNumber.md#tonumber) -- [toString](verida_web_helpers._internal_.BigNumber.md#tostring) -- [toTwos](verida_web_helpers._internal_.BigNumber.md#totwos) -- [xor](verida_web_helpers._internal_.BigNumber.md#xor) -- [from](verida_web_helpers._internal_.BigNumber.md#from) -- [isBigNumber](verida_web_helpers._internal_.BigNumber.md#isbignumber) - -## Constructors - -### constructor - -• **new BigNumber**(`constructorGuard`, `hex`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `constructorGuard` | `any` | -| `hex` | `string` | - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:7 - -## Properties - -### \_hex - -• `Readonly` **\_hex**: `string` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:5 - -___ - -### \_isBigNumber - -• `Readonly` **\_isBigNumber**: `boolean` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:6 - -## Methods - -### abs - -▸ **abs**(): [`BigNumber`](verida_web_helpers._internal_.BigNumber.md) - -#### Returns - -[`BigNumber`](verida_web_helpers._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:10 - -___ - -### add - -▸ **add**(`other`): [`BigNumber`](verida_web_helpers._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_web_helpers._internal_.md#bignumberish) | - -#### Returns - -[`BigNumber`](verida_web_helpers._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:11 - -___ - -### and - -▸ **and**(`other`): [`BigNumber`](verida_web_helpers._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_web_helpers._internal_.md#bignumberish) | - -#### Returns - -[`BigNumber`](verida_web_helpers._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:17 - -___ - -### div - -▸ **div**(`other`): [`BigNumber`](verida_web_helpers._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_web_helpers._internal_.md#bignumberish) | - -#### Returns - -[`BigNumber`](verida_web_helpers._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:13 - -___ - -### eq - -▸ **eq**(`other`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_web_helpers._internal_.md#bignumberish) | - -#### Returns - -`boolean` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:23 - -___ - -### fromTwos - -▸ **fromTwos**(`value`): [`BigNumber`](verida_web_helpers._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `number` | - -#### Returns - -[`BigNumber`](verida_web_helpers._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:8 - -___ - -### gt - -▸ **gt**(`other`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_web_helpers._internal_.md#bignumberish) | - -#### Returns - -`boolean` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:26 - -___ - -### gte - -▸ **gte**(`other`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_web_helpers._internal_.md#bignumberish) | - -#### Returns - -`boolean` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:27 - -___ - -### isNegative - -▸ **isNegative**(): `boolean` - -#### Returns - -`boolean` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:28 - -___ - -### isZero - -▸ **isZero**(): `boolean` - -#### Returns - -`boolean` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:29 - -___ - -### lt - -▸ **lt**(`other`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_web_helpers._internal_.md#bignumberish) | - -#### Returns - -`boolean` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:24 - -___ - -### lte - -▸ **lte**(`other`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_web_helpers._internal_.md#bignumberish) | - -#### Returns - -`boolean` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:25 - -___ - -### mask - -▸ **mask**(`value`): [`BigNumber`](verida_web_helpers._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `number` | - -#### Returns - -[`BigNumber`](verida_web_helpers._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:20 - -___ - -### mod - -▸ **mod**(`other`): [`BigNumber`](verida_web_helpers._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_web_helpers._internal_.md#bignumberish) | - -#### Returns - -[`BigNumber`](verida_web_helpers._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:15 - -___ - -### mul - -▸ **mul**(`other`): [`BigNumber`](verida_web_helpers._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_web_helpers._internal_.md#bignumberish) | - -#### Returns - -[`BigNumber`](verida_web_helpers._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:14 - -___ - -### or - -▸ **or**(`other`): [`BigNumber`](verida_web_helpers._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_web_helpers._internal_.md#bignumberish) | - -#### Returns - -[`BigNumber`](verida_web_helpers._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:18 - -___ - -### pow - -▸ **pow**(`other`): [`BigNumber`](verida_web_helpers._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_web_helpers._internal_.md#bignumberish) | - -#### Returns - -[`BigNumber`](verida_web_helpers._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:16 - -___ - -### shl - -▸ **shl**(`value`): [`BigNumber`](verida_web_helpers._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `number` | - -#### Returns - -[`BigNumber`](verida_web_helpers._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:21 - -___ - -### shr - -▸ **shr**(`value`): [`BigNumber`](verida_web_helpers._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `number` | - -#### Returns - -[`BigNumber`](verida_web_helpers._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:22 - -___ - -### sub - -▸ **sub**(`other`): [`BigNumber`](verida_web_helpers._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_web_helpers._internal_.md#bignumberish) | - -#### Returns - -[`BigNumber`](verida_web_helpers._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:12 - -___ - -### toBigInt - -▸ **toBigInt**(): `bigint` - -#### Returns - -`bigint` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:31 - -___ - -### toHexString - -▸ **toHexString**(): `string` - -#### Returns - -`string` - -#### Implementation of - -[Hexable](../interfaces/verida_web_helpers._internal_.Hexable.md).[toHexString](../interfaces/verida_web_helpers._internal_.Hexable.md#tohexstring) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:33 - -___ - -### toJSON - -▸ **toJSON**(`key?`): `any` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `key?` | `string` | - -#### Returns - -`any` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:34 - -___ - -### toNumber - -▸ **toNumber**(): `number` - -#### Returns - -`number` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:30 - -___ - -### toString - -▸ **toString**(): `string` - -#### Returns - -`string` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:32 - -___ - -### toTwos - -▸ **toTwos**(`value`): [`BigNumber`](verida_web_helpers._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `number` | - -#### Returns - -[`BigNumber`](verida_web_helpers._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:9 - -___ - -### xor - -▸ **xor**(`other`): [`BigNumber`](verida_web_helpers._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`BigNumberish`](../modules/verida_web_helpers._internal_.md#bignumberish) | - -#### Returns - -[`BigNumber`](verida_web_helpers._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:19 - -___ - -### from - -▸ `Static` **from**(`value`): [`BigNumber`](verida_web_helpers._internal_.BigNumber.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `any` | - -#### Returns - -[`BigNumber`](verida_web_helpers._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:35 - -___ - -### isBigNumber - -▸ `Static` **isBigNumber**(`value`): value is BigNumber - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `any` | - -#### Returns - -value is BigNumber - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:36 diff --git a/docs/api/verida-js/classes/verida_web_helpers._internal_.Client.md b/docs/api/verida-js/classes/verida_web_helpers._internal_.Client.md deleted file mode 100644 index 7068ab7..0000000 --- a/docs/api/verida-js/classes/verida_web_helpers._internal_.Client.md +++ /dev/null @@ -1,511 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / Client - -# Class: Client - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).Client - -## Implements - -- [`IClient`](../interfaces/verida_web_helpers._internal_.IClient.md) - -## Table of contents - -### Constructors - -- [constructor](verida_web_helpers._internal_.Client.md#constructor) - -### Properties - -- [account](verida_web_helpers._internal_.Client.md#account) -- [config](verida_web_helpers._internal_.Client.md#config) -- [did](verida_web_helpers._internal_.Client.md#did) -- [didClient](verida_web_helpers._internal_.Client.md#didclient) -- [didContextManager](verida_web_helpers._internal_.Client.md#didcontextmanager) -- [environment](verida_web_helpers._internal_.Client.md#environment) -- [nameClient](verida_web_helpers._internal_.Client.md#nameclient) - -### Methods - -- [connect](verida_web_helpers._internal_.Client.md#connect) -- [destroyAccount](verida_web_helpers._internal_.Client.md#destroyaccount) -- [destroyContext](verida_web_helpers._internal_.Client.md#destroycontext) -- [getConfig](verida_web_helpers._internal_.Client.md#getconfig) -- [getContextConfig](verida_web_helpers._internal_.Client.md#getcontextconfig) -- [getContextNameFromHash](verida_web_helpers._internal_.Client.md#getcontextnamefromhash) -- [getDID](verida_web_helpers._internal_.Client.md#getdid) -- [getSchema](verida_web_helpers._internal_.Client.md#getschema) -- [getUsernames](verida_web_helpers._internal_.Client.md#getusernames) -- [getValidDataSignatures](verida_web_helpers._internal_.Client.md#getvaliddatasignatures) -- [isConnected](verida_web_helpers._internal_.Client.md#isconnected) -- [openContext](verida_web_helpers._internal_.Client.md#opencontext) -- [openExternalContext](verida_web_helpers._internal_.Client.md#openexternalcontext) -- [openPublicProfile](verida_web_helpers._internal_.Client.md#openpublicprofile) -- [parseDid](verida_web_helpers._internal_.Client.md#parsedid) - -## Constructors - -### constructor - -• **new Client**(`userConfig`) - -Create a client connection to the Verida network - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `userConfig` | [`ClientConfig`](../interfaces/verida_web_helpers._internal_.ClientConfig.md) | ClientConfig Configuration for establishing a connection to the Verida network | - -#### Defined in - -packages/client-ts/dist/client.d.ts:40 - -## Properties - -### account - -• `Private` `Optional` **account**: `any` - -Connected account instance - -#### Defined in - -packages/client-ts/dist/client.d.ts:21 - -___ - -### config - -• `Private` **config**: `any` - -Current configuration for this client - -#### Defined in - -packages/client-ts/dist/client.d.ts:34 - -___ - -### did - -• `Private` `Optional` **did**: `any` - -DID of connected account - -#### Defined in - -packages/client-ts/dist/client.d.ts:25 - -___ - -### didClient - -• **didClient**: [`DIDClient`](verida_web_helpers._internal_.DIDClient.md) - -Connection to the Verida DID Registry - -#### Defined in - -packages/client-ts/dist/client.d.ts:13 - -___ - -### didContextManager - -• `Private` **didContextManager**: `any` - -Helper instance to manage DID contexts - -#### Defined in - -packages/client-ts/dist/client.d.ts:17 - -___ - -### environment - -• `Private` **environment**: `any` - -Currently selected environment - -#### Defined in - -packages/client-ts/dist/client.d.ts:29 - -___ - -### nameClient - -• `Private` **nameClient**: `any` - -#### Defined in - -packages/client-ts/dist/client.d.ts:30 - -## Methods - -### connect - -▸ **connect**(`account`): `Promise`<`void`\> - -Connect an Account to this client. - -Sets the account owner who can then create storage contexts, -authenticate with databases, send messages etc. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `account` | [`IAccount`](../interfaces/verida_web_helpers._internal_.IAccount.md) | AccountInterface | - -#### Returns - -`Promise`<`void`\> - -#### Implementation of - -[IClient](../interfaces/verida_web_helpers._internal_.IClient.md).[connect](../interfaces/verida_web_helpers._internal_.IClient.md#connect) - -#### Defined in - -packages/client-ts/dist/client.d.ts:49 - -___ - -### destroyAccount - -▸ **destroyAccount**(): `Promise`<`void`\> - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -packages/client-ts/dist/client.d.ts:106 - -___ - -### destroyContext - -▸ **destroyContext**(`contextName`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -packages/client-ts/dist/client.d.ts:107 - -___ - -### getConfig - -▸ **getConfig**(): [`DefaultClientConfig`](../interfaces/verida_web_helpers._internal_.DefaultClientConfig.md) - -#### Returns - -[`DefaultClientConfig`](../interfaces/verida_web_helpers._internal_.DefaultClientConfig.md) - -#### Defined in - -packages/client-ts/dist/client.d.ts:81 - -___ - -### getContextConfig - -▸ **getContextConfig**(`did`, `contextName`): `Promise`<`undefined` \| [`SecureContextConfig`](../interfaces/verida_web_helpers._internal_.SecureContextConfig.md)\> - -Get the storage configuration of an application context for a given DID. - -This provides the public details about the database, storage and messaging endpoints stored on did-client/did-document for the requested `did`. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `did` | `string` | | -| `contextName` | `string` | The name of the context OR a context hash (starting with 0x) | - -#### Returns - -`Promise`<`undefined` \| [`SecureContextConfig`](../interfaces/verida_web_helpers._internal_.SecureContextConfig.md)\> - -SecureContextConfig | undefined - -#### Implementation of - -[IClient](../interfaces/verida_web_helpers._internal_.IClient.md).[getContextConfig](../interfaces/verida_web_helpers._internal_.IClient.md#getcontextconfig) - -#### Defined in - -packages/client-ts/dist/client.d.ts:80 - -___ - -### getContextNameFromHash - -▸ **getContextNameFromHash**(`contextHash`, `didDocument?`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextHash` | `string` | -| `didDocument?` | [`default`](verida_web_helpers._internal_.default-2.md) | - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -packages/client-ts/dist/client.d.ts:108 - -___ - -### getDID - -▸ **getDID**(`username`): `Promise`<`string`\> - -Get the DID linked to a username - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `username` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -packages/client-ts/dist/client.d.ts:130 - -___ - -### getSchema - -▸ **getSchema**(`schemaUri`): `Promise`<[`Schema`](verida_web_helpers._internal_.Schema.md)\> - -Get a Schama instance by URL. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `schemaUri` | `string` | URL of the schema | - -#### Returns - -`Promise`<[`Schema`](verida_web_helpers._internal_.Schema.md)\> - -Schema A schema object - -#### Implementation of - -[IClient](../interfaces/verida_web_helpers._internal_.IClient.md).[getSchema](../interfaces/verida_web_helpers._internal_.IClient.md#getschema) - -#### Defined in - -packages/client-ts/dist/client.d.ts:115 - -___ - -### getUsernames - -▸ **getUsernames**(`did`): `Promise`<`string`[]\> - -Get an array of usernames linked to a DID - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did` | `string` | - -#### Returns - -`Promise`<`string`[]\> - -#### Defined in - -packages/client-ts/dist/client.d.ts:137 - -___ - -### getValidDataSignatures - -▸ **getValidDataSignatures**(`data`, `did?`): `Promise`<`string`[]\> - -Get the valid data signatures for a given database record. - -Iterates through all the signatures attached to a database record and validates each signature. - -Only returns the signatures that are valid. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `data` | `any` | A single database record | -| `did?` | `string` | An optional did to filter the results by | - -#### Returns - -`Promise`<`string`[]\> - -string[] Array of DIDs that have validly signed the data - -#### Implementation of - -[IClient](../interfaces/verida_web_helpers._internal_.IClient.md).[getValidDataSignatures](../interfaces/verida_web_helpers._internal_.IClient.md#getvaliddatasignatures) - -#### Defined in - -packages/client-ts/dist/client.d.ts:105 - -___ - -### isConnected - -▸ **isConnected**(): `boolean` - -Check if an account is connected to this client. - -#### Returns - -`boolean` - -boolean True of an account is connected - -#### Implementation of - -[IClient](../interfaces/verida_web_helpers._internal_.IClient.md).[isConnected](../interfaces/verida_web_helpers._internal_.IClient.md#isconnected) - -#### Defined in - -packages/client-ts/dist/client.d.ts:55 - -___ - -### openContext - -▸ **openContext**(`contextName`, `forceCreate?`): `Promise`<`undefined` \| [`IContext`](../interfaces/verida_web_helpers._internal_.IContext.md)\> - -Open a storage context for the current account. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `contextName` | `string` | string Name of the `context` to open. | -| `forceCreate?` | `boolean` | boolean If the `context` doesn't already exist for the connected account, create it. Depending on the type of `Account` connected, this may open a prompt for the user to confirm (and sign). | - -#### Returns - -`Promise`<`undefined` \| [`IContext`](../interfaces/verida_web_helpers._internal_.IContext.md)\> - -Context | undefined - -#### Implementation of - -[IClient](../interfaces/verida_web_helpers._internal_.IClient.md).[openContext](../interfaces/verida_web_helpers._internal_.IClient.md#opencontext) - -#### Defined in - -packages/client-ts/dist/client.d.ts:63 - -___ - -### openExternalContext - -▸ **openExternalContext**(`contextName`, `did`): `Promise`<[`IContext`](../interfaces/verida_web_helpers._internal_.IContext.md)\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `contextName` | `string` | The name of the context OR a context hash (starting with 0x) | -| `did` | `string` | | - -#### Returns - -`Promise`<[`IContext`](../interfaces/verida_web_helpers._internal_.IContext.md)\> - -#### Implementation of - -[IClient](../interfaces/verida_web_helpers._internal_.IClient.md).[openExternalContext](../interfaces/verida_web_helpers._internal_.IClient.md#openexternalcontext) - -#### Defined in - -packages/client-ts/dist/client.d.ts:70 - -___ - -### openPublicProfile - -▸ **openPublicProfile**(`did`, `contextName`, `profileName?`, `fallbackContext?`): `Promise`<`undefined` \| [`IProfile`](../interfaces/verida_web_helpers._internal_.IProfile.md)\> - -Open the public profile of any user in read only mode. - -Every application context has the ability to have it's own public profiles. - -You most likely want to request the `Verida: Vault` context. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did` | `string` | -| `contextName` | `string` | -| `profileName?` | `string` | -| `fallbackContext?` | ``null`` \| `string` | - -#### Returns - -`Promise`<`undefined` \| [`IProfile`](../interfaces/verida_web_helpers._internal_.IProfile.md)\> - -`` - -#### Implementation of - -[IClient](../interfaces/verida_web_helpers._internal_.IClient.md).[openPublicProfile](../interfaces/verida_web_helpers._internal_.IClient.md#openpublicprofile) - -#### Defined in - -packages/client-ts/dist/client.d.ts:93 - -___ - -### parseDid - -▸ **parseDid**(`didOrUsername`): `Promise`<`string`\> - -Converts a string that may be either a valid DID or a valid Verida username into -a Verida username. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `didOrUsername` | `string` | DID string or Verida username string (ending in `.vda`) | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -packages/client-ts/dist/client.d.ts:123 diff --git a/docs/api/verida-js/classes/verida_web_helpers._internal_.CodeGen.md b/docs/api/verida-js/classes/verida_web_helpers._internal_.CodeGen.md deleted file mode 100644 index ca6553d..0000000 --- a/docs/api/verida-js/classes/verida_web_helpers._internal_.CodeGen.md +++ /dev/null @@ -1,913 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / CodeGen - -# Class: CodeGen - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).CodeGen - -## Table of contents - -### Constructors - -- [constructor](verida_web_helpers._internal_.CodeGen.md#constructor) - -### Properties - -- [\_blockNode](verida_web_helpers._internal_.CodeGen.md#_blocknode) -- [\_blockStarts](verida_web_helpers._internal_.CodeGen.md#_blockstarts) -- [\_constants](verida_web_helpers._internal_.CodeGen.md#_constants) -- [\_def](verida_web_helpers._internal_.CodeGen.md#_def) -- [\_elseNode](verida_web_helpers._internal_.CodeGen.md#_elsenode) -- [\_endBlockNode](verida_web_helpers._internal_.CodeGen.md#_endblocknode) -- [\_extScope](verida_web_helpers._internal_.CodeGen.md#_extscope) -- [\_for](verida_web_helpers._internal_.CodeGen.md#_for) -- [\_leafNode](verida_web_helpers._internal_.CodeGen.md#_leafnode) -- [\_nodes](verida_web_helpers._internal_.CodeGen.md#_nodes) -- [\_scope](verida_web_helpers._internal_.CodeGen.md#_scope) -- [\_values](verida_web_helpers._internal_.CodeGen.md#_values) -- [opts](verida_web_helpers._internal_.CodeGen.md#opts) - -### Accessors - -- [\_currNode](verida_web_helpers._internal_.CodeGen.md#_currnode) -- [\_root](verida_web_helpers._internal_.CodeGen.md#_root) - -### Methods - -- [add](verida_web_helpers._internal_.CodeGen.md#add) -- [assign](verida_web_helpers._internal_.CodeGen.md#assign) -- [block](verida_web_helpers._internal_.CodeGen.md#block) -- [break](verida_web_helpers._internal_.CodeGen.md#break) -- [code](verida_web_helpers._internal_.CodeGen.md#code) -- [const](verida_web_helpers._internal_.CodeGen.md#const) -- [else](verida_web_helpers._internal_.CodeGen.md#else) -- [elseIf](verida_web_helpers._internal_.CodeGen.md#elseif) -- [endBlock](verida_web_helpers._internal_.CodeGen.md#endblock) -- [endFor](verida_web_helpers._internal_.CodeGen.md#endfor) -- [endFunc](verida_web_helpers._internal_.CodeGen.md#endfunc) -- [endIf](verida_web_helpers._internal_.CodeGen.md#endif) -- [for](verida_web_helpers._internal_.CodeGen.md#for) -- [forIn](verida_web_helpers._internal_.CodeGen.md#forin) -- [forOf](verida_web_helpers._internal_.CodeGen.md#forof) -- [forRange](verida_web_helpers._internal_.CodeGen.md#forrange) -- [func](verida_web_helpers._internal_.CodeGen.md#func) -- [getScopeValue](verida_web_helpers._internal_.CodeGen.md#getscopevalue) -- [if](verida_web_helpers._internal_.CodeGen.md#if) -- [label](verida_web_helpers._internal_.CodeGen.md#label) -- [let](verida_web_helpers._internal_.CodeGen.md#let) -- [name](verida_web_helpers._internal_.CodeGen.md#name) -- [object](verida_web_helpers._internal_.CodeGen.md#object) -- [optimize](verida_web_helpers._internal_.CodeGen.md#optimize) -- [return](verida_web_helpers._internal_.CodeGen.md#return) -- [scopeCode](verida_web_helpers._internal_.CodeGen.md#scopecode) -- [scopeName](verida_web_helpers._internal_.CodeGen.md#scopename) -- [scopeRefs](verida_web_helpers._internal_.CodeGen.md#scoperefs) -- [scopeValue](verida_web_helpers._internal_.CodeGen.md#scopevalue) -- [throw](verida_web_helpers._internal_.CodeGen.md#throw) -- [toString](verida_web_helpers._internal_.CodeGen.md#tostring) -- [try](verida_web_helpers._internal_.CodeGen.md#try) -- [var](verida_web_helpers._internal_.CodeGen.md#var) - -## Constructors - -### constructor - -• **new CodeGen**(`extScope`, `opts?`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `extScope` | [`ValueScope`](verida_web_helpers._internal_.ValueScope.md) | -| `opts?` | [`CodeGenOptions`](../interfaces/verida_web_helpers._internal_.CodeGenOptions.md) | - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/index.d.ts:33 - -## Properties - -### \_blockNode - -• `Private` **\_blockNode**: `any` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/index.d.ts:70 - -___ - -### \_blockStarts - -• `Private` `Readonly` **\_blockStarts**: `any` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/index.d.ts:30 - -___ - -### \_constants - -• `Private` `Readonly` **\_constants**: `any` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/index.d.ts:31 - -___ - -### \_def - -• `Private` **\_def**: `any` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/index.d.ts:41 - -___ - -### \_elseNode - -• `Private` **\_elseNode**: `any` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/index.d.ts:72 - -___ - -### \_endBlockNode - -• `Private` **\_endBlockNode**: `any` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/index.d.ts:71 - -___ - -### \_extScope - -• `Readonly` **\_extScope**: [`ValueScope`](verida_web_helpers._internal_.ValueScope.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/index.d.ts:27 - -___ - -### \_for - -• `Private` **\_for**: `any` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/index.d.ts:53 - -___ - -### \_leafNode - -• `Private` **\_leafNode**: `any` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/index.d.ts:69 - -___ - -### \_nodes - -• `Private` `Readonly` **\_nodes**: `any` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/index.d.ts:29 - -___ - -### \_scope - -• `Readonly` **\_scope**: [`Scope`](verida_web_helpers._internal_.Scope.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/index.d.ts:26 - -___ - -### \_values - -• `Readonly` **\_values**: [`ScopeValueSets`](../modules/verida_web_helpers._internal_.md#scopevaluesets) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/index.d.ts:28 - -___ - -### opts - -• `Private` `Readonly` **opts**: `any` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/index.d.ts:32 - -## Accessors - -### \_currNode - -• `Private` `get` **_currNode**(): `any` - -#### Returns - -`any` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/index.d.ts:74 - -• `Private` `set` **_currNode**(`value`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `any` | - -#### Returns - -`void` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/index.d.ts:75 - -___ - -### \_root - -• `Private` `get` **_root**(): `any` - -#### Returns - -`any` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/index.d.ts:73 - -## Methods - -### add - -▸ **add**(`lhs`, `rhs`): [`CodeGen`](verida_web_helpers._internal_.CodeGen.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `lhs` | [`Code`](../modules/verida_web_helpers._internal_.md#code) | -| `rhs` | [`SafeExpr`](../modules/verida_web_helpers._internal_.md#safeexpr) | - -#### Returns - -[`CodeGen`](verida_web_helpers._internal_.CodeGen.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/index.d.ts:46 - -___ - -### assign - -▸ **assign**(`lhs`, `rhs`, `sideEffects?`): [`CodeGen`](verida_web_helpers._internal_.CodeGen.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `lhs` | [`Code`](../modules/verida_web_helpers._internal_.md#code) | -| `rhs` | [`SafeExpr`](../modules/verida_web_helpers._internal_.md#safeexpr) | -| `sideEffects?` | `boolean` | - -#### Returns - -[`CodeGen`](verida_web_helpers._internal_.CodeGen.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/index.d.ts:45 - -___ - -### block - -▸ **block**(`body?`, `nodeCount?`): [`CodeGen`](verida_web_helpers._internal_.CodeGen.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `body?` | [`Block`](../modules/verida_web_helpers._internal_.md#block) | -| `nodeCount?` | `number` | - -#### Returns - -[`CodeGen`](verida_web_helpers._internal_.CodeGen.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/index.d.ts:64 - -___ - -### break - -▸ **break**(`label?`): [`CodeGen`](verida_web_helpers._internal_.CodeGen.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `label?` | [`Code`](../modules/verida_web_helpers._internal_.md#code) | - -#### Returns - -[`CodeGen`](verida_web_helpers._internal_.CodeGen.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/index.d.ts:60 - -___ - -### code - -▸ **code**(`c`): [`CodeGen`](verida_web_helpers._internal_.CodeGen.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `c` | ``null`` \| `number` \| `boolean` \| [`Name`](verida_web_helpers._internal_.Name.md) \| [`_Code`](verida_web_helpers._internal_._Code.md) \| () => `void` | - -#### Returns - -[`CodeGen`](verida_web_helpers._internal_.CodeGen.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/index.d.ts:47 - -___ - -### const - -▸ **const**(`nameOrPrefix`, `rhs`, `_constant?`): [`Name`](verida_web_helpers._internal_.Name.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `nameOrPrefix` | `string` \| [`Name`](verida_web_helpers._internal_.Name.md) | -| `rhs` | [`SafeExpr`](../modules/verida_web_helpers._internal_.md#safeexpr) | -| `_constant?` | `boolean` | - -#### Returns - -[`Name`](verida_web_helpers._internal_.Name.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/index.d.ts:42 - -___ - -### else - -▸ **else**(): [`CodeGen`](verida_web_helpers._internal_.CodeGen.md) - -#### Returns - -[`CodeGen`](verida_web_helpers._internal_.CodeGen.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/index.d.ts:51 - -___ - -### elseIf - -▸ **elseIf**(`condition`): [`CodeGen`](verida_web_helpers._internal_.CodeGen.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `condition` | `boolean` \| [`Code`](../modules/verida_web_helpers._internal_.md#code) | - -#### Returns - -[`CodeGen`](verida_web_helpers._internal_.CodeGen.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/index.d.ts:50 - -___ - -### endBlock - -▸ **endBlock**(`nodeCount?`): [`CodeGen`](verida_web_helpers._internal_.CodeGen.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `nodeCount?` | `number` | - -#### Returns - -[`CodeGen`](verida_web_helpers._internal_.CodeGen.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/index.d.ts:65 - -___ - -### endFor - -▸ **endFor**(): [`CodeGen`](verida_web_helpers._internal_.CodeGen.md) - -#### Returns - -[`CodeGen`](verida_web_helpers._internal_.CodeGen.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/index.d.ts:58 - -___ - -### endFunc - -▸ **endFunc**(): [`CodeGen`](verida_web_helpers._internal_.CodeGen.md) - -#### Returns - -[`CodeGen`](verida_web_helpers._internal_.CodeGen.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/index.d.ts:67 - -___ - -### endIf - -▸ **endIf**(): [`CodeGen`](verida_web_helpers._internal_.CodeGen.md) - -#### Returns - -[`CodeGen`](verida_web_helpers._internal_.CodeGen.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/index.d.ts:52 - -___ - -### for - -▸ **for**(`iteration`, `forBody?`): [`CodeGen`](verida_web_helpers._internal_.CodeGen.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `iteration` | [`Code`](../modules/verida_web_helpers._internal_.md#code) | -| `forBody?` | [`Block`](../modules/verida_web_helpers._internal_.md#block) | - -#### Returns - -[`CodeGen`](verida_web_helpers._internal_.CodeGen.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/index.d.ts:54 - -___ - -### forIn - -▸ **forIn**(`nameOrPrefix`, `obj`, `forBody`, `varKind?`): [`CodeGen`](verida_web_helpers._internal_.CodeGen.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `nameOrPrefix` | `string` \| [`Name`](verida_web_helpers._internal_.Name.md) | -| `obj` | [`Code`](../modules/verida_web_helpers._internal_.md#code) | -| `forBody` | (`item`: [`Name`](verida_web_helpers._internal_.Name.md)) => `void` | -| `varKind?` | [`Code`](../modules/verida_web_helpers._internal_.md#code) | - -#### Returns - -[`CodeGen`](verida_web_helpers._internal_.CodeGen.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/index.d.ts:57 - -___ - -### forOf - -▸ **forOf**(`nameOrPrefix`, `iterable`, `forBody`, `varKind?`): [`CodeGen`](verida_web_helpers._internal_.CodeGen.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `nameOrPrefix` | `string` \| [`Name`](verida_web_helpers._internal_.Name.md) | -| `iterable` | [`Code`](../modules/verida_web_helpers._internal_.md#code) | -| `forBody` | (`item`: [`Name`](verida_web_helpers._internal_.Name.md)) => `void` | -| `varKind?` | [`Code`](../modules/verida_web_helpers._internal_.md#code) | - -#### Returns - -[`CodeGen`](verida_web_helpers._internal_.CodeGen.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/index.d.ts:56 - -___ - -### forRange - -▸ **forRange**(`nameOrPrefix`, `from`, `to`, `forBody`, `varKind?`): [`CodeGen`](verida_web_helpers._internal_.CodeGen.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `nameOrPrefix` | `string` \| [`Name`](verida_web_helpers._internal_.Name.md) | -| `from` | [`SafeExpr`](../modules/verida_web_helpers._internal_.md#safeexpr) | -| `to` | [`SafeExpr`](../modules/verida_web_helpers._internal_.md#safeexpr) | -| `forBody` | (`index`: [`Name`](verida_web_helpers._internal_.Name.md)) => `void` | -| `varKind?` | [`Code`](../modules/verida_web_helpers._internal_.md#code) | - -#### Returns - -[`CodeGen`](verida_web_helpers._internal_.CodeGen.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/index.d.ts:55 - -___ - -### func - -▸ **func**(`name`, `args?`, `async?`, `funcBody?`): [`CodeGen`](verida_web_helpers._internal_.CodeGen.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | [`Name`](verida_web_helpers._internal_.Name.md) | -| `args?` | [`Code`](../modules/verida_web_helpers._internal_.md#code) | -| `async?` | `boolean` | -| `funcBody?` | [`Block`](../modules/verida_web_helpers._internal_.md#block) | - -#### Returns - -[`CodeGen`](verida_web_helpers._internal_.CodeGen.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/index.d.ts:66 - -___ - -### getScopeValue - -▸ **getScopeValue**(`prefix`, `keyOrRef`): `undefined` \| [`ValueScopeName`](verida_web_helpers._internal_.ValueScopeName.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `prefix` | `string` | -| `keyOrRef` | `unknown` | - -#### Returns - -`undefined` \| [`ValueScopeName`](verida_web_helpers._internal_.ValueScopeName.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/index.d.ts:38 - -___ - -### if - -▸ **if**(`condition`, `thenBody?`, `elseBody?`): [`CodeGen`](verida_web_helpers._internal_.CodeGen.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `condition` | `boolean` \| [`Code`](../modules/verida_web_helpers._internal_.md#code) | -| `thenBody?` | [`Block`](../modules/verida_web_helpers._internal_.md#block) | -| `elseBody?` | [`Block`](../modules/verida_web_helpers._internal_.md#block) | - -#### Returns - -[`CodeGen`](verida_web_helpers._internal_.CodeGen.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/index.d.ts:49 - -___ - -### label - -▸ **label**(`label`): [`CodeGen`](verida_web_helpers._internal_.CodeGen.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `label` | [`Name`](verida_web_helpers._internal_.Name.md) | - -#### Returns - -[`CodeGen`](verida_web_helpers._internal_.CodeGen.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/index.d.ts:59 - -___ - -### let - -▸ **let**(`nameOrPrefix`, `rhs?`, `_constant?`): [`Name`](verida_web_helpers._internal_.Name.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `nameOrPrefix` | `string` \| [`Name`](verida_web_helpers._internal_.Name.md) | -| `rhs?` | [`SafeExpr`](../modules/verida_web_helpers._internal_.md#safeexpr) | -| `_constant?` | `boolean` | - -#### Returns - -[`Name`](verida_web_helpers._internal_.Name.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/index.d.ts:43 - -___ - -### name - -▸ **name**(`prefix`): [`Name`](verida_web_helpers._internal_.Name.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `prefix` | `string` | - -#### Returns - -[`Name`](verida_web_helpers._internal_.Name.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/index.d.ts:35 - -___ - -### object - -▸ **object**(...`keyValues`): [`_Code`](verida_web_helpers._internal_._Code.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `...keyValues` | [`string` \| [`Name`](verida_web_helpers._internal_.Name.md), `string` \| [`SafeExpr`](../modules/verida_web_helpers._internal_.md#safeexpr)][] | - -#### Returns - -[`_Code`](verida_web_helpers._internal_._Code.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/index.d.ts:48 - -___ - -### optimize - -▸ **optimize**(`n?`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `n?` | `number` | - -#### Returns - -`void` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/index.d.ts:68 - -___ - -### return - -▸ **return**(`value`): [`CodeGen`](verida_web_helpers._internal_.CodeGen.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | ``null`` \| `number` \| `boolean` \| [`Name`](verida_web_helpers._internal_.Name.md) \| [`_Code`](verida_web_helpers._internal_._Code.md) \| () => `void` | - -#### Returns - -[`CodeGen`](verida_web_helpers._internal_.CodeGen.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/index.d.ts:61 - -___ - -### scopeCode - -▸ **scopeCode**(): [`Code`](../modules/verida_web_helpers._internal_.md#code) - -#### Returns - -[`Code`](../modules/verida_web_helpers._internal_.md#code) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/index.d.ts:40 - -___ - -### scopeName - -▸ **scopeName**(`prefix`): [`ValueScopeName`](verida_web_helpers._internal_.ValueScopeName.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `prefix` | `string` | - -#### Returns - -[`ValueScopeName`](verida_web_helpers._internal_.ValueScopeName.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/index.d.ts:36 - -___ - -### scopeRefs - -▸ **scopeRefs**(`scopeName`): [`Code`](../modules/verida_web_helpers._internal_.md#code) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `scopeName` | [`Name`](verida_web_helpers._internal_.Name.md) | - -#### Returns - -[`Code`](../modules/verida_web_helpers._internal_.md#code) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/index.d.ts:39 - -___ - -### scopeValue - -▸ **scopeValue**(`prefixOrName`, `value`): [`Name`](verida_web_helpers._internal_.Name.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `prefixOrName` | `string` \| [`ValueScopeName`](verida_web_helpers._internal_.ValueScopeName.md) | -| `value` | [`NameValue`](../interfaces/verida_web_helpers._internal_.NameValue.md) | - -#### Returns - -[`Name`](verida_web_helpers._internal_.Name.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/index.d.ts:37 - -___ - -### throw - -▸ **throw**(`error`): [`CodeGen`](verida_web_helpers._internal_.CodeGen.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `error` | [`Code`](../modules/verida_web_helpers._internal_.md#code) | - -#### Returns - -[`CodeGen`](verida_web_helpers._internal_.CodeGen.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/index.d.ts:63 - -___ - -### toString - -▸ **toString**(): `string` - -#### Returns - -`string` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/index.d.ts:34 - -___ - -### try - -▸ **try**(`tryBody`, `catchCode?`, `finallyCode?`): [`CodeGen`](verida_web_helpers._internal_.CodeGen.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `tryBody` | [`Block`](../modules/verida_web_helpers._internal_.md#block) | -| `catchCode?` | (`e`: [`Name`](verida_web_helpers._internal_.Name.md)) => `void` | -| `finallyCode?` | [`Block`](../modules/verida_web_helpers._internal_.md#block) | - -#### Returns - -[`CodeGen`](verida_web_helpers._internal_.CodeGen.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/index.d.ts:62 - -___ - -### var - -▸ **var**(`nameOrPrefix`, `rhs?`, `_constant?`): [`Name`](verida_web_helpers._internal_.Name.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `nameOrPrefix` | `string` \| [`Name`](verida_web_helpers._internal_.Name.md) | -| `rhs?` | [`SafeExpr`](../modules/verida_web_helpers._internal_.md#safeexpr) | -| `_constant?` | `boolean` | - -#### Returns - -[`Name`](verida_web_helpers._internal_.Name.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/index.d.ts:44 diff --git a/docs/api/verida-js/classes/verida_web_helpers._internal_.Context.md b/docs/api/verida-js/classes/verida_web_helpers._internal_.Context.md deleted file mode 100644 index f0b0895..0000000 --- a/docs/api/verida-js/classes/verida_web_helpers._internal_.Context.md +++ /dev/null @@ -1,1719 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / Context - -# Class: Context - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).Context - -## Hierarchy - -- [`EventEmitter`](verida_web_helpers._internal_.EventEmitter-1.md) - - ↳ **`Context`** - -## Implements - -- [`IContext`](../interfaces/verida_web_helpers._internal_.IContext.md) - -## Table of contents - -### Constructors - -- [constructor](verida_web_helpers._internal_.Context.md#constructor) - -### Properties - -- [account](verida_web_helpers._internal_.Context.md#account) -- [client](verida_web_helpers._internal_.Context.md#client) -- [contextName](verida_web_helpers._internal_.Context.md#contextname) -- [databaseCache](verida_web_helpers._internal_.Context.md#databasecache) -- [databaseEngines](verida_web_helpers._internal_.Context.md#databaseengines) -- [dbRegistry](verida_web_helpers._internal_.Context.md#dbregistry) -- [didContextManager](verida_web_helpers._internal_.Context.md#didcontextmanager) -- [messagingEngine](verida_web_helpers._internal_.Context.md#messagingengine) -- [notificationEngine](verida_web_helpers._internal_.Context.md#notificationengine) -- [captureRejectionSymbol](verida_web_helpers._internal_.Context.md#capturerejectionsymbol) -- [captureRejections](verida_web_helpers._internal_.Context.md#capturerejections) -- [defaultMaxListeners](verida_web_helpers._internal_.Context.md#defaultmaxlisteners) -- [errorMonitor](verida_web_helpers._internal_.Context.md#errormonitor) - -### Methods - -- [addEndpoint](verida_web_helpers._internal_.Context.md#addendpoint) -- [addListener](verida_web_helpers._internal_.Context.md#addlistener) -- [clearDatabaseCache](verida_web_helpers._internal_.Context.md#cleardatabasecache) -- [close](verida_web_helpers._internal_.Context.md#close) -- [deleteDatabase](verida_web_helpers._internal_.Context.md#deletedatabase) -- [disconnect](verida_web_helpers._internal_.Context.md#disconnect) -- [emit](verida_web_helpers._internal_.Context.md#emit) -- [eventNames](verida_web_helpers._internal_.Context.md#eventnames) -- [getAccount](verida_web_helpers._internal_.Context.md#getaccount) -- [getAuthContext](verida_web_helpers._internal_.Context.md#getauthcontext) -- [getClient](verida_web_helpers._internal_.Context.md#getclient) -- [getContextConfig](verida_web_helpers._internal_.Context.md#getcontextconfig) -- [getContextName](verida_web_helpers._internal_.Context.md#getcontextname) -- [getDatabaseEngine](verida_web_helpers._internal_.Context.md#getdatabaseengine) -- [getDbRegistry](verida_web_helpers._internal_.Context.md#getdbregistry) -- [getDidContextManager](verida_web_helpers._internal_.Context.md#getdidcontextmanager) -- [getMaxListeners](verida_web_helpers._internal_.Context.md#getmaxlisteners) -- [getMessaging](verida_web_helpers._internal_.Context.md#getmessaging) -- [getNotification](verida_web_helpers._internal_.Context.md#getnotification) -- [info](verida_web_helpers._internal_.Context.md#info) -- [listenerCount](verida_web_helpers._internal_.Context.md#listenercount) -- [listeners](verida_web_helpers._internal_.Context.md#listeners) -- [off](verida_web_helpers._internal_.Context.md#off) -- [on](verida_web_helpers._internal_.Context.md#on) -- [once](verida_web_helpers._internal_.Context.md#once) -- [openDatabase](verida_web_helpers._internal_.Context.md#opendatabase) -- [openDatastore](verida_web_helpers._internal_.Context.md#opendatastore) -- [openExternalDatabase](verida_web_helpers._internal_.Context.md#openexternaldatabase) -- [openExternalDatastore](verida_web_helpers._internal_.Context.md#openexternaldatastore) -- [openProfile](verida_web_helpers._internal_.Context.md#openprofile) -- [prependListener](verida_web_helpers._internal_.Context.md#prependlistener) -- [prependOnceListener](verida_web_helpers._internal_.Context.md#prependoncelistener) -- [rawListeners](verida_web_helpers._internal_.Context.md#rawlisteners) -- [removeAllListeners](verida_web_helpers._internal_.Context.md#removealllisteners) -- [removeListener](verida_web_helpers._internal_.Context.md#removelistener) -- [setMaxListeners](verida_web_helpers._internal_.Context.md#setmaxlisteners) -- [getEventListeners](verida_web_helpers._internal_.Context.md#geteventlisteners) -- [listenerCount](verida_web_helpers._internal_.Context.md#listenercount) -- [on](verida_web_helpers._internal_.Context.md#on) -- [once](verida_web_helpers._internal_.Context.md#once) - -## Constructors - -### constructor - -• **new Context**(`client`, `contextName`, `didContextManager`, `account?`) - -Instantiate a new context. - -**Do not use directly**. Use `client.openContext()` or `Network.connect()`. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `client` | [`Client`](verida_web_helpers._internal_.Client.md) | -| `contextName` | `string` | -| `didContextManager` | [`DIDContextManager`](verida_web_helpers._internal_.DIDContextManager.md) | -| `account?` | [`IAccount`](../interfaces/verida_web_helpers._internal_.IAccount.md) | - -#### Overrides - -[EventEmitter](verida_web_helpers._internal_.EventEmitter-1.md).[constructor](verida_web_helpers._internal_.EventEmitter-1.md#constructor) - -#### Defined in - -packages/client-ts/dist/context/context.d.ts:42 - -## Properties - -### account - -• `Private` `Optional` **account**: `any` - -#### Defined in - -packages/client-ts/dist/context/context.d.ts:24 - -___ - -### client - -• `Private` **client**: `any` - -#### Defined in - -packages/client-ts/dist/context/context.d.ts:23 - -___ - -### contextName - -• `Private` **contextName**: `any` - -#### Defined in - -packages/client-ts/dist/context/context.d.ts:27 - -___ - -### databaseCache - -• `Private` **databaseCache**: `any` - -#### Defined in - -packages/client-ts/dist/context/context.d.ts:31 - -___ - -### databaseEngines - -• `Private` **databaseEngines**: `any` - -#### Defined in - -packages/client-ts/dist/context/context.d.ts:29 - -___ - -### dbRegistry - -• `Private` **dbRegistry**: `any` - -#### Defined in - -packages/client-ts/dist/context/context.d.ts:30 - -___ - -### didContextManager - -• `Private` **didContextManager**: `any` - -#### Defined in - -packages/client-ts/dist/context/context.d.ts:28 - -___ - -### messagingEngine - -• `Private` `Optional` **messagingEngine**: `any` - -#### Defined in - -packages/client-ts/dist/context/context.d.ts:25 - -___ - -### notificationEngine - -• `Private` `Optional` **notificationEngine**: `any` - -#### Defined in - -packages/client-ts/dist/context/context.d.ts:26 - -___ - -### captureRejectionSymbol - -▪ `Static` `Readonly` **captureRejectionSymbol**: typeof [`captureRejectionSymbol`](../modules/verida_web_helpers.md#capturerejectionsymbol) - -#### Inherited from - -[EventEmitter](verida_web_helpers._internal_.EventEmitter-1.md).[captureRejectionSymbol](verida_web_helpers._internal_.EventEmitter-1.md#capturerejectionsymbol) - -#### Defined in - -node_modules/@types/node/events.d.ts:273 - -___ - -### captureRejections - -▪ `Static` **captureRejections**: `boolean` - -Sets or gets the default captureRejection value for all emitters. - -#### Inherited from - -[EventEmitter](verida_web_helpers._internal_.EventEmitter-1.md).[captureRejections](verida_web_helpers._internal_.EventEmitter-1.md#capturerejections) - -#### Defined in - -node_modules/@types/node/events.d.ts:278 - -___ - -### defaultMaxListeners - -▪ `Static` **defaultMaxListeners**: `number` - -#### Inherited from - -[EventEmitter](verida_web_helpers._internal_.EventEmitter-1.md).[defaultMaxListeners](verida_web_helpers._internal_.EventEmitter-1.md#defaultmaxlisteners) - -#### Defined in - -node_modules/@types/node/events.d.ts:279 - -___ - -### errorMonitor - -▪ `Static` `Readonly` **errorMonitor**: typeof [`errorMonitor`](../modules/verida_web_helpers.md#errormonitor) - -This symbol shall be used to install a listener for only monitoring `'error'` -events. Listeners installed using this symbol are called before the regular -`'error'` listeners are called. - -Installing a listener using this symbol does not change the behavior once an -`'error'` event is emitted, therefore the process will still crash if no -regular `'error'` listener is installed. - -#### Inherited from - -[EventEmitter](verida_web_helpers._internal_.EventEmitter-1.md).[errorMonitor](verida_web_helpers._internal_.EventEmitter-1.md#errormonitor) - -#### Defined in - -node_modules/@types/node/events.d.ts:272 - -## Methods - -### addEndpoint - -▸ **addEndpoint**(`engineType`, `endpointUri`): `Promise`<`void`\> - -Emits `progress` event when adding the endpoint has progressed (ie: replicating databases to the new endpoint). - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `engineType` | [`ContextEngineType`](../enums/verida_web_helpers._internal_.ContextEngineType.md) | -| `endpointUri` | `string` | - -#### Returns - -`Promise`<`void`\> - -#### Implementation of - -[IContext](../interfaces/verida_web_helpers._internal_.IContext.md).[addEndpoint](../interfaces/verida_web_helpers._internal_.IContext.md#addendpoint) - -#### Defined in - -packages/client-ts/dist/context/context.d.ts:123 - -___ - -### addListener - -▸ **addListener**(`eventName`, `listener`): [`Context`](verida_web_helpers._internal_.Context.md) - -Alias for `emitter.on(eventName, listener)`. - -**`since`** v0.1.26 - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | `string` \| `symbol` | -| `listener` | (...`args`: `any`[]) => `void` | - -#### Returns - -[`Context`](verida_web_helpers._internal_.Context.md) - -#### Inherited from - -[EventEmitter](verida_web_helpers._internal_.EventEmitter-1.md).[addListener](verida_web_helpers._internal_.EventEmitter-1.md#addlistener) - -#### Defined in - -node_modules/@types/node/events.d.ts:299 - -___ - -### clearDatabaseCache - -▸ **clearDatabaseCache**(`did`, `databaseName`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did` | `string` | -| `databaseName` | `string` | - -#### Returns - -`Promise`<`void`\> - -#### Implementation of - -[IContext](../interfaces/verida_web_helpers._internal_.IContext.md).[clearDatabaseCache](../interfaces/verida_web_helpers._internal_.IContext.md#cleardatabasecache) - -#### Defined in - -packages/client-ts/dist/context/context.d.ts:130 - -___ - -### close - -▸ **close**(`options?`): `Promise`<`void`\> - -Close this context. - -Closes all open database connections, returns resources, cancels event listeners - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options?` | [`ContextCloseOptions`](../interfaces/verida_web_helpers._internal_.ContextCloseOptions.md) | - -#### Returns - -`Promise`<`void`\> - -#### Implementation of - -[IContext](../interfaces/verida_web_helpers._internal_.IContext.md).[close](../interfaces/verida_web_helpers._internal_.IContext.md#close) - -#### Defined in - -packages/client-ts/dist/context/context.d.ts:129 - -___ - -### deleteDatabase - -▸ **deleteDatabase**(`databaseName`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `databaseName` | `string` | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -packages/client-ts/dist/context/context.d.ts:91 - -___ - -### disconnect - -▸ **disconnect**(): `Promise`<`boolean`\> - -#### Returns - -`Promise`<`boolean`\> - -#### Implementation of - -[IContext](../interfaces/verida_web_helpers._internal_.IContext.md).[disconnect](../interfaces/verida_web_helpers._internal_.IContext.md#disconnect) - -#### Defined in - -packages/client-ts/dist/context/context.d.ts:48 - -___ - -### emit - -▸ **emit**(`eventName`, ...`args`): `boolean` - -Synchronously calls each of the listeners registered for the event named`eventName`, in the order they were registered, passing the supplied arguments -to each. - -Returns `true` if the event had listeners, `false` otherwise. - -```js -const EventEmitter = require('events'); -const myEmitter = new EventEmitter(); - -// First listener -myEmitter.on('event', function firstListener() { - console.log('Helloooo! first listener'); -}); -// Second listener -myEmitter.on('event', function secondListener(arg1, arg2) { - console.log(`event with parameters ${arg1}, ${arg2} in second listener`); -}); -// Third listener -myEmitter.on('event', function thirdListener(...args) { - const parameters = args.join(', '); - console.log(`event with parameters ${parameters} in third listener`); -}); - -console.log(myEmitter.listeners('event')); - -myEmitter.emit('event', 1, 2, 3, 4, 5); - -// Prints: -// [ -// [Function: firstListener], -// [Function: secondListener], -// [Function: thirdListener] -// ] -// Helloooo! first listener -// event with parameters 1, 2 in second listener -// event with parameters 1, 2, 3, 4, 5 in third listener -``` - -**`since`** v0.1.26 - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | `string` \| `symbol` | -| `...args` | `any`[] | - -#### Returns - -`boolean` - -#### Inherited from - -[EventEmitter](verida_web_helpers._internal_.EventEmitter-1.md).[emit](verida_web_helpers._internal_.EventEmitter-1.md#emit) - -#### Defined in - -node_modules/@types/node/events.d.ts:555 - -___ - -### eventNames - -▸ **eventNames**(): (`string` \| `symbol`)[] - -Returns an array listing the events for which the emitter has registered -listeners. The values in the array are strings or `Symbol`s. - -```js -const EventEmitter = require('events'); -const myEE = new EventEmitter(); -myEE.on('foo', () => {}); -myEE.on('bar', () => {}); - -const sym = Symbol('symbol'); -myEE.on(sym, () => {}); - -console.log(myEE.eventNames()); -// Prints: [ 'foo', 'bar', Symbol(symbol) ] -``` - -**`since`** v6.0.0 - -#### Returns - -(`string` \| `symbol`)[] - -#### Inherited from - -[EventEmitter](verida_web_helpers._internal_.EventEmitter-1.md).[eventNames](verida_web_helpers._internal_.EventEmitter-1.md#eventnames) - -#### Defined in - -node_modules/@types/node/events.d.ts:614 - -___ - -### getAccount - -▸ **getAccount**(): [`IAccount`](../interfaces/verida_web_helpers._internal_.IAccount.md) - -#### Returns - -[`IAccount`](../interfaces/verida_web_helpers._internal_.IAccount.md) - -#### Implementation of - -[IContext](../interfaces/verida_web_helpers._internal_.IContext.md).[getAccount](../interfaces/verida_web_helpers._internal_.IContext.md#getaccount) - -#### Defined in - -packages/client-ts/dist/context/context.d.ts:45 - -___ - -### getAuthContext - -▸ **getAuthContext**(`authConfig?`, `authType?`): `Promise`<[`AuthContext`](../interfaces/verida_web_helpers._internal_.AuthContext.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `authConfig?` | [`AuthTypeConfig`](../interfaces/verida_web_helpers._internal_.AuthTypeConfig.md) | -| `authType?` | `string` | - -#### Returns - -`Promise`<[`AuthContext`](../interfaces/verida_web_helpers._internal_.AuthContext.md)\> - -#### Implementation of - -[IContext](../interfaces/verida_web_helpers._internal_.IContext.md).[getAuthContext](../interfaces/verida_web_helpers._internal_.IContext.md#getauthcontext) - -#### Defined in - -packages/client-ts/dist/context/context.d.ts:116 - -___ - -### getClient - -▸ **getClient**(): [`Client`](verida_web_helpers._internal_.Client.md) - -#### Returns - -[`Client`](verida_web_helpers._internal_.Client.md) - -#### Implementation of - -[IContext](../interfaces/verida_web_helpers._internal_.IContext.md).[getClient](../interfaces/verida_web_helpers._internal_.IContext.md#getclient) - -#### Defined in - -packages/client-ts/dist/context/context.d.ts:47 - -___ - -### getContextConfig - -▸ **getContextConfig**(`did?`, `forceCreate?`, `customContextName?`): `Promise`<[`SecureContextConfig`](../interfaces/verida_web_helpers._internal_.SecureContextConfig.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did?` | `string` | -| `forceCreate?` | `boolean` | -| `customContextName?` | `string` | - -#### Returns - -`Promise`<[`SecureContextConfig`](../interfaces/verida_web_helpers._internal_.SecureContextConfig.md)\> - -#### Implementation of - -[IContext](../interfaces/verida_web_helpers._internal_.IContext.md).[getContextConfig](../interfaces/verida_web_helpers._internal_.IContext.md#getcontextconfig) - -#### Defined in - -packages/client-ts/dist/context/context.d.ts:43 - -___ - -### getContextName - -▸ **getContextName**(): `string` - -#### Returns - -`string` - -#### Implementation of - -[IContext](../interfaces/verida_web_helpers._internal_.IContext.md).[getContextName](../interfaces/verida_web_helpers._internal_.IContext.md#getcontextname) - -#### Defined in - -packages/client-ts/dist/context/context.d.ts:44 - -___ - -### getDatabaseEngine - -▸ **getDatabaseEngine**(`did`, `createContext?`): `Promise`<[`IStorageEngine`](../interfaces/verida_web_helpers._internal_.IStorageEngine.md)\> - -Get a storage engine for a given DID and this contextName - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did` | `string` | -| `createContext?` | `boolean` | - -#### Returns - -`Promise`<[`IStorageEngine`](../interfaces/verida_web_helpers._internal_.IStorageEngine.md)\> - -#### Implementation of - -[IContext](../interfaces/verida_web_helpers._internal_.IContext.md).[getDatabaseEngine](../interfaces/verida_web_helpers._internal_.IContext.md#getdatabaseengine) - -#### Defined in - -packages/client-ts/dist/context/context.d.ts:55 - -___ - -### getDbRegistry - -▸ **getDbRegistry**(): [`DbRegistry`](verida_web_helpers._internal_.DbRegistry.md) - -#### Returns - -[`DbRegistry`](verida_web_helpers._internal_.DbRegistry.md) - -#### Implementation of - -[IContext](../interfaces/verida_web_helpers._internal_.IContext.md).[getDbRegistry](../interfaces/verida_web_helpers._internal_.IContext.md#getdbregistry) - -#### Defined in - -packages/client-ts/dist/context/context.d.ts:109 - -___ - -### getDidContextManager - -▸ **getDidContextManager**(): [`DIDContextManager`](verida_web_helpers._internal_.DIDContextManager.md) - -#### Returns - -[`DIDContextManager`](verida_web_helpers._internal_.DIDContextManager.md) - -#### Implementation of - -[IContext](../interfaces/verida_web_helpers._internal_.IContext.md).[getDidContextManager](../interfaces/verida_web_helpers._internal_.IContext.md#getdidcontextmanager) - -#### Defined in - -packages/client-ts/dist/context/context.d.ts:46 - -___ - -### getMaxListeners - -▸ **getMaxListeners**(): `number` - -Returns the current max listener value for the `EventEmitter` which is either -set by `emitter.setMaxListeners(n)` or defaults to [defaultMaxListeners](verida_web_helpers._internal_.Context.md#defaultmaxlisteners). - -**`since`** v1.0.0 - -#### Returns - -`number` - -#### Inherited from - -[EventEmitter](verida_web_helpers._internal_.EventEmitter-1.md).[getMaxListeners](verida_web_helpers._internal_.EventEmitter-1.md#getmaxlisteners) - -#### Defined in - -node_modules/@types/node/events.d.ts:471 - -___ - -### getMessaging - -▸ **getMessaging**(`messageConfig?`): `Promise`<[`IMessaging`](../interfaces/verida_web_helpers._internal_.IMessaging.md)\> - -Get a messaging instance for this application context. - -Allows you to send and receive messages as the currently connected account. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `messageConfig?` | [`MessagesConfig`](../interfaces/verida_web_helpers._internal_.MessagesConfig.md) | - -#### Returns - -`Promise`<[`IMessaging`](../interfaces/verida_web_helpers._internal_.IMessaging.md)\> - -Messaging instance - -#### Implementation of - -[IContext](../interfaces/verida_web_helpers._internal_.IContext.md).[getMessaging](../interfaces/verida_web_helpers._internal_.IContext.md#getmessaging) - -#### Defined in - -packages/client-ts/dist/context/context.d.ts:63 - -___ - -### getNotification - -▸ **getNotification**(`did`, `contextName`): `Promise`<`undefined` \| [`INotification`](../interfaces/verida_web_helpers._internal_.INotification.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did` | `string` | -| `contextName` | `string` | - -#### Returns - -`Promise`<`undefined` \| [`INotification`](../interfaces/verida_web_helpers._internal_.INotification.md)\> - -#### Implementation of - -[IContext](../interfaces/verida_web_helpers._internal_.IContext.md).[getNotification](../interfaces/verida_web_helpers._internal_.IContext.md#getnotification) - -#### Defined in - -packages/client-ts/dist/context/context.d.ts:64 - -___ - -### info - -▸ **info**(): `Promise`<[`ContextInfo`](../interfaces/verida_web_helpers._internal_.ContextInfo.md)\> - -Get the status of this context for databases, their connected endpoints and databases - -#### Returns - -`Promise`<[`ContextInfo`](../interfaces/verida_web_helpers._internal_.ContextInfo.md)\> - -#### Implementation of - -[IContext](../interfaces/verida_web_helpers._internal_.IContext.md).[info](../interfaces/verida_web_helpers._internal_.IContext.md#info) - -#### Defined in - -packages/client-ts/dist/context/context.d.ts:115 - -___ - -### listenerCount - -▸ **listenerCount**(`eventName`): `number` - -Returns the number of listeners listening to the event named `eventName`. - -**`since`** v3.2.0 - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `eventName` | `string` \| `symbol` | The name of the event being listened for | - -#### Returns - -`number` - -#### Inherited from - -[EventEmitter](verida_web_helpers._internal_.EventEmitter-1.md).[listenerCount](verida_web_helpers._internal_.EventEmitter-1.md#listenercount) - -#### Defined in - -node_modules/@types/node/events.d.ts:561 - -___ - -### listeners - -▸ **listeners**(`eventName`): `Function`[] - -Returns a copy of the array of listeners for the event named `eventName`. - -```js -server.on('connection', (stream) => { - console.log('someone connected!'); -}); -console.log(util.inspect(server.listeners('connection'))); -// Prints: [ [Function] ] -``` - -**`since`** v0.1.26 - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | `string` \| `symbol` | - -#### Returns - -`Function`[] - -#### Inherited from - -[EventEmitter](verida_web_helpers._internal_.EventEmitter-1.md).[listeners](verida_web_helpers._internal_.EventEmitter-1.md#listeners) - -#### Defined in - -node_modules/@types/node/events.d.ts:484 - -___ - -### off - -▸ **off**(`eventName`, `listener`): [`Context`](verida_web_helpers._internal_.Context.md) - -Alias for `emitter.removeListener()`. - -**`since`** v10.0.0 - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | `string` \| `symbol` | -| `listener` | (...`args`: `any`[]) => `void` | - -#### Returns - -[`Context`](verida_web_helpers._internal_.Context.md) - -#### Inherited from - -[EventEmitter](verida_web_helpers._internal_.EventEmitter-1.md).[off](verida_web_helpers._internal_.EventEmitter-1.md#off) - -#### Defined in - -node_modules/@types/node/events.d.ts:444 - -___ - -### on - -▸ **on**(`eventName`, `listener`): [`Context`](verida_web_helpers._internal_.Context.md) - -Adds the `listener` function to the end of the listeners array for the -event named `eventName`. No checks are made to see if the `listener` has -already been added. Multiple calls passing the same combination of `eventName`and `listener` will result in the `listener` being added, and called, multiple -times. - -```js -server.on('connection', (stream) => { - console.log('someone connected!'); -}); -``` - -Returns a reference to the `EventEmitter`, so that calls can be chained. - -By default, event listeners are invoked in the order they are added. The`emitter.prependListener()` method can be used as an alternative to add the -event listener to the beginning of the listeners array. - -```js -const myEE = new EventEmitter(); -myEE.on('foo', () => console.log('a')); -myEE.prependListener('foo', () => console.log('b')); -myEE.emit('foo'); -// Prints: -// b -// a -``` - -**`since`** v0.1.101 - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `eventName` | `string` \| `symbol` | The name of the event. | -| `listener` | (...`args`: `any`[]) => `void` | The callback function | - -#### Returns - -[`Context`](verida_web_helpers._internal_.Context.md) - -#### Inherited from - -[EventEmitter](verida_web_helpers._internal_.EventEmitter-1.md).[on](verida_web_helpers._internal_.EventEmitter-1.md#on) - -#### Defined in - -node_modules/@types/node/events.d.ts:330 - -___ - -### once - -▸ **once**(`eventName`, `listener`): [`Context`](verida_web_helpers._internal_.Context.md) - -Adds a **one-time**`listener` function for the event named `eventName`. The -next time `eventName` is triggered, this listener is removed and then invoked. - -```js -server.once('connection', (stream) => { - console.log('Ah, we have our first user!'); -}); -``` - -Returns a reference to the `EventEmitter`, so that calls can be chained. - -By default, event listeners are invoked in the order they are added. The`emitter.prependOnceListener()` method can be used as an alternative to add the -event listener to the beginning of the listeners array. - -```js -const myEE = new EventEmitter(); -myEE.once('foo', () => console.log('a')); -myEE.prependOnceListener('foo', () => console.log('b')); -myEE.emit('foo'); -// Prints: -// b -// a -``` - -**`since`** v0.3.0 - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `eventName` | `string` \| `symbol` | The name of the event. | -| `listener` | (...`args`: `any`[]) => `void` | The callback function | - -#### Returns - -[`Context`](verida_web_helpers._internal_.Context.md) - -#### Inherited from - -[EventEmitter](verida_web_helpers._internal_.EventEmitter-1.md).[once](verida_web_helpers._internal_.EventEmitter-1.md#once) - -#### Defined in - -node_modules/@types/node/events.d.ts:359 - -___ - -### openDatabase - -▸ **openDatabase**(`databaseName`, `config?`): `Promise`<[`IDatabase`](../interfaces/verida_web_helpers._internal_.IDatabase.md)\> - -Open a database owned by this account. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `databaseName` | `string` | Name of the database to open | -| `config?` | [`DatabaseOpenConfig`](../interfaces/verida_web_helpers._internal_.DatabaseOpenConfig.md) | - | - -#### Returns - -`Promise`<[`IDatabase`](../interfaces/verida_web_helpers._internal_.IDatabase.md)\> - -#### Implementation of - -[IContext](../interfaces/verida_web_helpers._internal_.IContext.md).[openDatabase](../interfaces/verida_web_helpers._internal_.IContext.md#opendatabase) - -#### Defined in - -packages/client-ts/dist/context/context.d.ts:81 - -___ - -### openDatastore - -▸ **openDatastore**(`schemaUri`, `config?`): `Promise`<[`Datastore`](verida_web_helpers._internal_.Datastore.md)\> - -Open a dataastore owned by this account. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `schemaUri` | `string` | URI of the schema to open (ie: https://common.schemas.verida.io/health/activity/latest/schema.json) | -| `config?` | [`DatastoreOpenConfig`](../interfaces/verida_web_helpers._internal_.DatastoreOpenConfig.md) | Optional datastore configuration | - -#### Returns - -`Promise`<[`Datastore`](verida_web_helpers._internal_.Datastore.md)\> - -#### Implementation of - -[IContext](../interfaces/verida_web_helpers._internal_.IContext.md).[openDatastore](../interfaces/verida_web_helpers._internal_.IContext.md#opendatastore) - -#### Defined in - -packages/client-ts/dist/context/context.d.ts:99 - -___ - -### openExternalDatabase - -▸ **openExternalDatabase**(`databaseName`, `did`, `config?`): `Promise`<[`IDatabase`](../interfaces/verida_web_helpers._internal_.IDatabase.md)\> - -Open an external database owned by an account that isn't the currently connected account. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `databaseName` | `string` | Name of the database to open | -| `did` | `string` | DID of the external account that owns the database | -| `config?` | [`DatabaseOpenConfig`](../interfaces/verida_web_helpers._internal_.DatabaseOpenConfig.md) | - | - -#### Returns - -`Promise`<[`IDatabase`](../interfaces/verida_web_helpers._internal_.IDatabase.md)\> - -#### Implementation of - -[IContext](../interfaces/verida_web_helpers._internal_.IContext.md).[openExternalDatabase](../interfaces/verida_web_helpers._internal_.IContext.md#openexternaldatabase) - -#### Defined in - -packages/client-ts/dist/context/context.d.ts:90 - -___ - -### openExternalDatastore - -▸ **openExternalDatastore**(`schemaUri`, `did`, `options?`): `Promise`<[`Datastore`](verida_web_helpers._internal_.Datastore.md)\> - -Open an external datastore owned by an account that isn't the currently connected account. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `schemaUri` | `string` | URI of the schema to open (ie: https://common.schemas.verida.io/health/activity/latest/schema.json) | -| `did` | `string` | DID of the external account that owns the database | -| `options?` | [`DatastoreOpenConfig`](../interfaces/verida_web_helpers._internal_.DatastoreOpenConfig.md) | Optional database configuration | - -#### Returns - -`Promise`<[`Datastore`](verida_web_helpers._internal_.Datastore.md)\> - -#### Implementation of - -[IContext](../interfaces/verida_web_helpers._internal_.IContext.md).[openExternalDatastore](../interfaces/verida_web_helpers._internal_.IContext.md#openexternaldatastore) - -#### Defined in - -packages/client-ts/dist/context/context.d.ts:108 - -___ - -### openProfile - -▸ **openProfile**(`profileName?`, `did?`): `Promise`<`undefined` \| [`Profile`](verida_web_helpers._internal_.Profile.md)\> - -Get a user's profile. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `profileName?` | `string` | string Name of the Verida profile schema to load | -| `did?` | `string` | string DID of the profile to get. Leave blank to fetch a read/write profile for the currently authenticated user | - -#### Returns - -`Promise`<`undefined` \| [`Profile`](verida_web_helpers._internal_.Profile.md)\> - -#### Implementation of - -[IContext](../interfaces/verida_web_helpers._internal_.IContext.md).[openProfile](../interfaces/verida_web_helpers._internal_.IContext.md#openprofile) - -#### Defined in - -packages/client-ts/dist/context/context.d.ts:72 - -___ - -### prependListener - -▸ **prependListener**(`eventName`, `listener`): [`Context`](verida_web_helpers._internal_.Context.md) - -Adds the `listener` function to the _beginning_ of the listeners array for the -event named `eventName`. No checks are made to see if the `listener` has -already been added. Multiple calls passing the same combination of `eventName`and `listener` will result in the `listener` being added, and called, multiple -times. - -```js -server.prependListener('connection', (stream) => { - console.log('someone connected!'); -}); -``` - -Returns a reference to the `EventEmitter`, so that calls can be chained. - -**`since`** v6.0.0 - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `eventName` | `string` \| `symbol` | The name of the event. | -| `listener` | (...`args`: `any`[]) => `void` | The callback function | - -#### Returns - -[`Context`](verida_web_helpers._internal_.Context.md) - -#### Inherited from - -[EventEmitter](verida_web_helpers._internal_.EventEmitter-1.md).[prependListener](verida_web_helpers._internal_.EventEmitter-1.md#prependlistener) - -#### Defined in - -node_modules/@types/node/events.d.ts:579 - -___ - -### prependOnceListener - -▸ **prependOnceListener**(`eventName`, `listener`): [`Context`](verida_web_helpers._internal_.Context.md) - -Adds a **one-time**`listener` function for the event named `eventName` to the_beginning_ of the listeners array. The next time `eventName` is triggered, this -listener is removed, and then invoked. - -```js -server.prependOnceListener('connection', (stream) => { - console.log('Ah, we have our first user!'); -}); -``` - -Returns a reference to the `EventEmitter`, so that calls can be chained. - -**`since`** v6.0.0 - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `eventName` | `string` \| `symbol` | The name of the event. | -| `listener` | (...`args`: `any`[]) => `void` | The callback function | - -#### Returns - -[`Context`](verida_web_helpers._internal_.Context.md) - -#### Inherited from - -[EventEmitter](verida_web_helpers._internal_.EventEmitter-1.md).[prependOnceListener](verida_web_helpers._internal_.EventEmitter-1.md#prependoncelistener) - -#### Defined in - -node_modules/@types/node/events.d.ts:595 - -___ - -### rawListeners - -▸ **rawListeners**(`eventName`): `Function`[] - -Returns a copy of the array of listeners for the event named `eventName`, -including any wrappers (such as those created by `.once()`). - -```js -const emitter = new EventEmitter(); -emitter.once('log', () => console.log('log once')); - -// Returns a new Array with a function `onceWrapper` which has a property -// `listener` which contains the original listener bound above -const listeners = emitter.rawListeners('log'); -const logFnWrapper = listeners[0]; - -// Logs "log once" to the console and does not unbind the `once` event -logFnWrapper.listener(); - -// Logs "log once" to the console and removes the listener -logFnWrapper(); - -emitter.on('log', () => console.log('log persistently')); -// Will return a new Array with a single function bound by `.on()` above -const newListeners = emitter.rawListeners('log'); - -// Logs "log persistently" twice -newListeners[0](); -emitter.emit('log'); -``` - -**`since`** v9.4.0 - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | `string` \| `symbol` | - -#### Returns - -`Function`[] - -#### Inherited from - -[EventEmitter](verida_web_helpers._internal_.EventEmitter-1.md).[rawListeners](verida_web_helpers._internal_.EventEmitter-1.md#rawlisteners) - -#### Defined in - -node_modules/@types/node/events.d.ts:514 - -___ - -### removeAllListeners - -▸ **removeAllListeners**(`event?`): [`Context`](verida_web_helpers._internal_.Context.md) - -Removes all listeners, or those of the specified `eventName`. - -It is bad practice to remove listeners added elsewhere in the code, -particularly when the `EventEmitter` instance was created by some other -component or module (e.g. sockets or file streams). - -Returns a reference to the `EventEmitter`, so that calls can be chained. - -**`since`** v0.1.26 - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event?` | `string` \| `symbol` | - -#### Returns - -[`Context`](verida_web_helpers._internal_.Context.md) - -#### Inherited from - -[EventEmitter](verida_web_helpers._internal_.EventEmitter-1.md).[removeAllListeners](verida_web_helpers._internal_.EventEmitter-1.md#removealllisteners) - -#### Defined in - -node_modules/@types/node/events.d.ts:455 - -___ - -### removeListener - -▸ **removeListener**(`eventName`, `listener`): [`Context`](verida_web_helpers._internal_.Context.md) - -Removes the specified `listener` from the listener array for the event named`eventName`. - -```js -const callback = (stream) => { - console.log('someone connected!'); -}; -server.on('connection', callback); -// ... -server.removeListener('connection', callback); -``` - -`removeListener()` will remove, at most, one instance of a listener from the -listener array. If any single listener has been added multiple times to the -listener array for the specified `eventName`, then `removeListener()` must be -called multiple times to remove each instance. - -Once an event is emitted, all listeners attached to it at the -time of emitting are called in order. This implies that any`removeListener()` or `removeAllListeners()` calls _after_ emitting and_before_ the last listener finishes execution will -not remove them from`emit()` in progress. Subsequent events behave as expected. - -```js -const myEmitter = new MyEmitter(); - -const callbackA = () => { - console.log('A'); - myEmitter.removeListener('event', callbackB); -}; - -const callbackB = () => { - console.log('B'); -}; - -myEmitter.on('event', callbackA); - -myEmitter.on('event', callbackB); - -// callbackA removes listener callbackB but it will still be called. -// Internal listener array at time of emit [callbackA, callbackB] -myEmitter.emit('event'); -// Prints: -// A -// B - -// callbackB is now removed. -// Internal listener array [callbackA] -myEmitter.emit('event'); -// Prints: -// A -``` - -Because listeners are managed using an internal array, calling this will -change the position indices of any listener registered _after_ the listener -being removed. This will not impact the order in which listeners are called, -but it means that any copies of the listener array as returned by -the `emitter.listeners()` method will need to be recreated. - -When a single function has been added as a handler multiple times for a single -event (as in the example below), `removeListener()` will remove the most -recently added instance. In the example the `once('ping')`listener is removed: - -```js -const ee = new EventEmitter(); - -function pong() { - console.log('pong'); -} - -ee.on('ping', pong); -ee.once('ping', pong); -ee.removeListener('ping', pong); - -ee.emit('ping'); -ee.emit('ping'); -``` - -Returns a reference to the `EventEmitter`, so that calls can be chained. - -**`since`** v0.1.26 - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | `string` \| `symbol` | -| `listener` | (...`args`: `any`[]) => `void` | - -#### Returns - -[`Context`](verida_web_helpers._internal_.Context.md) - -#### Inherited from - -[EventEmitter](verida_web_helpers._internal_.EventEmitter-1.md).[removeListener](verida_web_helpers._internal_.EventEmitter-1.md#removelistener) - -#### Defined in - -node_modules/@types/node/events.d.ts:439 - -___ - -### setMaxListeners - -▸ **setMaxListeners**(`n`): [`Context`](verida_web_helpers._internal_.Context.md) - -By default `EventEmitter`s will print a warning if more than `10` listeners are -added for a particular event. This is a useful default that helps finding -memory leaks. The `emitter.setMaxListeners()` method allows the limit to be -modified for this specific `EventEmitter` instance. The value can be set to`Infinity` (or `0`) to indicate an unlimited number of listeners. - -Returns a reference to the `EventEmitter`, so that calls can be chained. - -**`since`** v0.3.5 - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `n` | `number` | - -#### Returns - -[`Context`](verida_web_helpers._internal_.Context.md) - -#### Inherited from - -[EventEmitter](verida_web_helpers._internal_.EventEmitter-1.md).[setMaxListeners](verida_web_helpers._internal_.EventEmitter-1.md#setmaxlisteners) - -#### Defined in - -node_modules/@types/node/events.d.ts:465 - -___ - -### getEventListeners - -▸ `Static` **getEventListeners**(`emitter`, `name`): `Function`[] - -Returns a copy of the array of listeners for the event named `eventName`. - -For `EventEmitter`s this behaves exactly the same as calling `.listeners` on -the emitter. - -For `EventTarget`s this is the only way to get the event listeners for the -event target. This is useful for debugging and diagnostic purposes. - -```js -const { getEventListeners, EventEmitter } = require('events'); - -{ - const ee = new EventEmitter(); - const listener = () => console.log('Events are fun'); - ee.on('foo', listener); - getEventListeners(ee, 'foo'); // [listener] -} -{ - const et = new EventTarget(); - const listener = () => console.log('Events are fun'); - et.addEventListener('foo', listener); - getEventListeners(et, 'foo'); // [listener] -} -``` - -**`since`** v15.2.0 - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `emitter` | [`DOMEventTarget`](../interfaces/verida_web_helpers._internal_.DOMEventTarget.md) \| `EventEmitter` | -| `name` | `string` \| `symbol` | - -#### Returns - -`Function`[] - -#### Inherited from - -[EventEmitter](verida_web_helpers._internal_.EventEmitter-1.md).[getEventListeners](verida_web_helpers._internal_.EventEmitter-1.md#geteventlisteners) - -#### Defined in - -node_modules/@types/node/events.d.ts:262 - -___ - -### listenerCount - -▸ `Static` **listenerCount**(`emitter`, `eventName`): `number` - -A class method that returns the number of listeners for the given `eventName`registered on the given `emitter`. - -```js -const { EventEmitter, listenerCount } = require('events'); -const myEmitter = new EventEmitter(); -myEmitter.on('event', () => {}); -myEmitter.on('event', () => {}); -console.log(listenerCount(myEmitter, 'event')); -// Prints: 2 -``` - -**`since`** v0.9.12 - -**`deprecated`** Since v3.2.0 - Use `listenerCount` instead. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `emitter` | `EventEmitter` | The emitter to query | -| `eventName` | `string` \| `symbol` | The event name | - -#### Returns - -`number` - -#### Inherited from - -[EventEmitter](verida_web_helpers._internal_.EventEmitter-1.md).[listenerCount](verida_web_helpers._internal_.EventEmitter-1.md#listenercount) - -#### Defined in - -node_modules/@types/node/events.d.ts:234 - -___ - -### on - -▸ `Static` **on**(`emitter`, `eventName`, `options?`): [`AsyncIterableIterator`](../interfaces/verida_web_helpers._internal_.AsyncIterableIterator.md)<`any`\> - -```js -const { on, EventEmitter } = require('events'); - -(async () => { - const ee = new EventEmitter(); - - // Emit later on - process.nextTick(() => { - ee.emit('foo', 'bar'); - ee.emit('foo', 42); - }); - - for await (const event of on(ee, 'foo')) { - // The execution of this inner block is synchronous and it - // processes one event at a time (even with await). Do not use - // if concurrent execution is required. - console.log(event); // prints ['bar'] [42] - } - // Unreachable here -})(); -``` - -Returns an `AsyncIterator` that iterates `eventName` events. It will throw -if the `EventEmitter` emits `'error'`. It removes all listeners when -exiting the loop. The `value` returned by each iteration is an array -composed of the emitted event arguments. - -An `AbortSignal` can be used to cancel waiting on events: - -```js -const { on, EventEmitter } = require('events'); -const ac = new AbortController(); - -(async () => { - const ee = new EventEmitter(); - - // Emit later on - process.nextTick(() => { - ee.emit('foo', 'bar'); - ee.emit('foo', 42); - }); - - for await (const event of on(ee, 'foo', { signal: ac.signal })) { - // The execution of this inner block is synchronous and it - // processes one event at a time (even with await). Do not use - // if concurrent execution is required. - console.log(event); // prints ['bar'] [42] - } - // Unreachable here -})(); - -process.nextTick(() => ac.abort()); -``` - -**`since`** v13.6.0, v12.16.0 - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `emitter` | `EventEmitter` | - | -| `eventName` | `string` | The name of the event being listened for | -| `options?` | [`StaticEventEmitterOptions`](../interfaces/verida_web_helpers._internal_.StaticEventEmitterOptions.md) | - | - -#### Returns - -[`AsyncIterableIterator`](../interfaces/verida_web_helpers._internal_.AsyncIterableIterator.md)<`any`\> - -that iterates `eventName` events emitted by the `emitter` - -#### Inherited from - -[EventEmitter](verida_web_helpers._internal_.EventEmitter-1.md).[on](verida_web_helpers._internal_.EventEmitter-1.md#on) - -#### Defined in - -node_modules/@types/node/events.d.ts:217 - -___ - -### once - -▸ `Static` **once**(`emitter`, `eventName`, `options?`): `Promise`<`any`[]\> - -Creates a `Promise` that is fulfilled when the `EventEmitter` emits the given -event or that is rejected if the `EventEmitter` emits `'error'` while waiting. -The `Promise` will resolve with an array of all the arguments emitted to the -given event. - -This method is intentionally generic and works with the web platform[EventTarget](https://dom.spec.whatwg.org/#interface-eventtarget) interface, which has no special`'error'` event -semantics and does not listen to the `'error'` event. - -```js -const { once, EventEmitter } = require('events'); - -async function run() { - const ee = new EventEmitter(); - - process.nextTick(() => { - ee.emit('myevent', 42); - }); - - const [value] = await once(ee, 'myevent'); - console.log(value); - - const err = new Error('kaboom'); - process.nextTick(() => { - ee.emit('error', err); - }); - - try { - await once(ee, 'myevent'); - } catch (err) { - console.log('error happened', err); - } -} - -run(); -``` - -The special handling of the `'error'` event is only used when `events.once()`is used to wait for another event. If `events.once()` is used to wait for the -'`error'` event itself, then it is treated as any other kind of event without -special handling: - -```js -const { EventEmitter, once } = require('events'); - -const ee = new EventEmitter(); - -once(ee, 'error') - .then(([err]) => console.log('ok', err.message)) - .catch((err) => console.log('error', err.message)); - -ee.emit('error', new Error('boom')); - -// Prints: ok boom -``` - -An `AbortSignal` can be used to cancel waiting for the event: - -```js -const { EventEmitter, once } = require('events'); - -const ee = new EventEmitter(); -const ac = new AbortController(); - -async function foo(emitter, event, signal) { - try { - await once(emitter, event, { signal }); - console.log('event emitted!'); - } catch (error) { - if (error.name === 'AbortError') { - console.error('Waiting for the event was canceled!'); - } else { - console.error('There was an error', error.message); - } - } -} - -foo(ee, 'foo', ac.signal); -ac.abort(); // Abort waiting for the event -ee.emit('foo'); // Prints: Waiting for the event was canceled! -``` - -**`since`** v11.13.0, v10.16.0 - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `emitter` | [`NodeEventTarget`](../interfaces/verida_web_helpers._internal_.NodeEventTarget.md) | -| `eventName` | `string` \| `symbol` | -| `options?` | [`StaticEventEmitterOptions`](../interfaces/verida_web_helpers._internal_.StaticEventEmitterOptions.md) | - -#### Returns - -`Promise`<`any`[]\> - -#### Inherited from - -[EventEmitter](verida_web_helpers._internal_.EventEmitter-1.md).[once](verida_web_helpers._internal_.EventEmitter-1.md#once) - -#### Defined in - -node_modules/@types/node/events.d.ts:157 - -▸ `Static` **once**(`emitter`, `eventName`, `options?`): `Promise`<`any`[]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `emitter` | [`DOMEventTarget`](../interfaces/verida_web_helpers._internal_.DOMEventTarget.md) | -| `eventName` | `string` | -| `options?` | [`StaticEventEmitterOptions`](../interfaces/verida_web_helpers._internal_.StaticEventEmitterOptions.md) | - -#### Returns - -`Promise`<`any`[]\> - -#### Inherited from - -[EventEmitter](verida_web_helpers._internal_.EventEmitter-1.md).[once](verida_web_helpers._internal_.EventEmitter-1.md#once) - -#### Defined in - -node_modules/@types/node/events.d.ts:158 diff --git a/docs/api/verida-js/classes/verida_web_helpers._internal_.DIDClient.md b/docs/api/verida-js/classes/verida_web_helpers._internal_.DIDClient.md deleted file mode 100644 index fe5d75b..0000000 --- a/docs/api/verida-js/classes/verida_web_helpers._internal_.DIDClient.md +++ /dev/null @@ -1,305 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / DIDClient - -# Class: DIDClient - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).DIDClient - -## Implements - -- [`IDIDClient`](../interfaces/verida_web_helpers._internal_.IDIDClient.md) - -## Table of contents - -### Constructors - -- [constructor](verida_web_helpers._internal_.DIDClient.md#constructor) - -### Properties - -- [config](verida_web_helpers._internal_.DIDClient.md#config) -- [defaultEndpoints](verida_web_helpers._internal_.DIDClient.md#defaultendpoints) -- [didResolver](verida_web_helpers._internal_.DIDClient.md#didresolver) -- [endpointErrors](verida_web_helpers._internal_.DIDClient.md#endpointerrors) -- [vdaDid](verida_web_helpers._internal_.DIDClient.md#vdadid) -- [veridaWallet](verida_web_helpers._internal_.DIDClient.md#veridawallet) - -### Methods - -- [authenticate](verida_web_helpers._internal_.DIDClient.md#authenticate) -- [authenticated](verida_web_helpers._internal_.DIDClient.md#authenticated) -- [destroy](verida_web_helpers._internal_.DIDClient.md#destroy) -- [get](verida_web_helpers._internal_.DIDClient.md#get) -- [getDid](verida_web_helpers._internal_.DIDClient.md#getdid) -- [getLastEndpointErrors](verida_web_helpers._internal_.DIDClient.md#getlastendpointerrors) -- [getPublicKey](verida_web_helpers._internal_.DIDClient.md#getpublickey) -- [getRpcUrl](verida_web_helpers._internal_.DIDClient.md#getrpcurl) -- [save](verida_web_helpers._internal_.DIDClient.md#save) - -## Constructors - -### constructor - -• **new DIDClient**(`config`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | [`DIDClientConfig`](../interfaces/verida_web_helpers._internal_.DIDClientConfig.md) | - -#### Defined in - -packages/did-client/dist/did-client.d.ts:10 - -## Properties - -### config - -• `Private` **config**: `any` - -#### Defined in - -packages/did-client/dist/did-client.d.ts:4 - -___ - -### defaultEndpoints - -• `Private` `Optional` **defaultEndpoints**: `any` - -#### Defined in - -packages/did-client/dist/did-client.d.ts:8 - -___ - -### didResolver - -• `Private` **didResolver**: `any` - -#### Defined in - -packages/did-client/dist/did-client.d.ts:5 - -___ - -### endpointErrors - -• `Private` `Optional` **endpointErrors**: `any` - -#### Defined in - -packages/did-client/dist/did-client.d.ts:9 - -___ - -### vdaDid - -• `Private` `Optional` **vdaDid**: `any` - -#### Defined in - -packages/did-client/dist/did-client.d.ts:6 - -___ - -### veridaWallet - -• `Private` **veridaWallet**: `any` - -#### Defined in - -packages/did-client/dist/did-client.d.ts:7 - -## Methods - -### authenticate - -▸ **authenticate**(`veridaPrivateKey`, `callType`, `web3Config`, `defaultEndpoints`): `void` - -Unlock save() function by providing verida signing key. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `veridaPrivateKey` | `string` | Private key of a Verida Account. Used to sign transactions in the DID Registry to verify the request originated from the DID owner / controller | -| `callType` | [`Web3CallType`](../modules/verida_web_helpers._internal_.md#web3calltype) | Blockchain interaction mode. 'web3' \| 'gasless' | -| `web3Config` | [`Web3SelfTransactionConfigPart`](../interfaces/verida_web_helpers._internal_.Web3SelfTransactionConfigPart.md) \| [`Web3MetaTransactionConfig`](../interfaces/verida_web_helpers._internal_.Web3MetaTransactionConfig.md) | Web3 configuration. If `web3`, you must provide `privateKey` (MATIC private key that will pay for gas). If `gasless` you must specify `endpointUrl` (URL of the meta transaction server) and any appropriate `serverConfig` and `postConfig`. | -| `defaultEndpoints` | `string`[] | - | - -#### Returns - -`void` - -#### Implementation of - -[IDIDClient](../interfaces/verida_web_helpers._internal_.IDIDClient.md).[authenticate](../interfaces/verida_web_helpers._internal_.IDIDClient.md#authenticate) - -#### Defined in - -packages/did-client/dist/did-client.d.ts:19 - -___ - -### authenticated - -▸ **authenticated**(): `boolean` - -#### Returns - -`boolean` - -#### Implementation of - -[IDIDClient](../interfaces/verida_web_helpers._internal_.IDIDClient.md).[authenticated](../interfaces/verida_web_helpers._internal_.IDIDClient.md#authenticated) - -#### Defined in - -packages/did-client/dist/did-client.d.ts:20 - -___ - -### destroy - -▸ **destroy**(): `Promise`<[`VdaDidEndpointResponses`](../modules/verida_web_helpers._internal_.md#vdadidendpointresponses)\> - -Destroy this DID - -Note: This can not be reversed and is written to the blockchain - -#### Returns - -`Promise`<[`VdaDidEndpointResponses`](../modules/verida_web_helpers._internal_.md#vdadidendpointresponses)\> - -#### Defined in - -packages/did-client/dist/did-client.d.ts:28 - -___ - -### get - -▸ **get**(`did`): `Promise`<[`default`](verida_web_helpers._internal_.default-2.md)\> - -Get original document loaded from blockchain. Creates a new document if it didn't exist - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did` | `string` | - -#### Returns - -`Promise`<[`default`](verida_web_helpers._internal_.default-2.md)\> - -DID Document instance - -#### Implementation of - -[IDIDClient](../interfaces/verida_web_helpers._internal_.IDIDClient.md).[get](../interfaces/verida_web_helpers._internal_.IDIDClient.md#get) - -#### Defined in - -packages/did-client/dist/did-client.d.ts:42 - -___ - -### getDid - -▸ **getDid**(): `undefined` \| `string` - -#### Returns - -`undefined` \| `string` - -#### Implementation of - -[IDIDClient](../interfaces/verida_web_helpers._internal_.IDIDClient.md).[getDid](../interfaces/verida_web_helpers._internal_.IDIDClient.md#getdid) - -#### Defined in - -packages/did-client/dist/did-client.d.ts:21 - -___ - -### getLastEndpointErrors - -▸ **getLastEndpointErrors**(): [`VdaDidEndpointResponses`](../modules/verida_web_helpers._internal_.md#vdadidendpointresponses) - -#### Returns - -[`VdaDidEndpointResponses`](../modules/verida_web_helpers._internal_.md#vdadidendpointresponses) - -#### Implementation of - -[IDIDClient](../interfaces/verida_web_helpers._internal_.IDIDClient.md).[getLastEndpointErrors](../interfaces/verida_web_helpers._internal_.IDIDClient.md#getlastendpointerrors) - -#### Defined in - -packages/did-client/dist/did-client.d.ts:36 - -___ - -### getPublicKey - -▸ **getPublicKey**(): `undefined` \| `string` - -#### Returns - -`undefined` \| `string` - -#### Implementation of - -[IDIDClient](../interfaces/verida_web_helpers._internal_.IDIDClient.md).[getPublicKey](../interfaces/verida_web_helpers._internal_.IDIDClient.md#getpublickey) - -#### Defined in - -packages/did-client/dist/did-client.d.ts:22 - -___ - -### getRpcUrl - -▸ **getRpcUrl**(): `string` - -#### Returns - -`string` - -#### Implementation of - -[IDIDClient](../interfaces/verida_web_helpers._internal_.IDIDClient.md).[getRpcUrl](../interfaces/verida_web_helpers._internal_.IDIDClient.md#getrpcurl) - -#### Defined in - -packages/did-client/dist/did-client.d.ts:11 - -___ - -### save - -▸ **save**(`document`): `Promise`<[`VdaDidEndpointResponses`](../modules/verida_web_helpers._internal_.md#vdadidendpointresponses)\> - -Save DIDDocument to the chain - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `document` | [`default`](verida_web_helpers._internal_.default-2.md) | Updated DIDDocuent | - -#### Returns - -`Promise`<[`VdaDidEndpointResponses`](../modules/verida_web_helpers._internal_.md#vdadidendpointresponses)\> - -true if success. - -#### Implementation of - -[IDIDClient](../interfaces/verida_web_helpers._internal_.IDIDClient.md).[save](../interfaces/verida_web_helpers._internal_.IDIDClient.md#save) - -#### Defined in - -packages/did-client/dist/did-client.d.ts:35 diff --git a/docs/api/verida-js/classes/verida_web_helpers._internal_.DIDContextManager.md b/docs/api/verida-js/classes/verida_web_helpers._internal_.DIDContextManager.md deleted file mode 100644 index 006b2cb..0000000 --- a/docs/api/verida-js/classes/verida_web_helpers._internal_.DIDContextManager.md +++ /dev/null @@ -1,201 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / DIDContextManager - -# Class: DIDContextManager - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).DIDContextManager - -## Table of contents - -### Constructors - -- [constructor](verida_web_helpers._internal_.DIDContextManager.md#constructor) - -### Properties - -- [account](verida_web_helpers._internal_.DIDContextManager.md#account) -- [didClient](verida_web_helpers._internal_.DIDContextManager.md#didclient) -- [didContexts](verida_web_helpers._internal_.DIDContextManager.md#didcontexts) - -### Methods - -- [getContextDatabaseServer](verida_web_helpers._internal_.DIDContextManager.md#getcontextdatabaseserver) -- [getContextMessageServer](verida_web_helpers._internal_.DIDContextManager.md#getcontextmessageserver) -- [getContextStorageServer](verida_web_helpers._internal_.DIDContextManager.md#getcontextstorageserver) -- [getDIDContextConfig](verida_web_helpers._internal_.DIDContextManager.md#getdidcontextconfig) -- [getDIDContextHashConfig](verida_web_helpers._internal_.DIDContextManager.md#getdidcontexthashconfig) -- [setAccount](verida_web_helpers._internal_.DIDContextManager.md#setaccount) - -## Constructors - -### constructor - -• **new DIDContextManager**(`didClient`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `didClient` | [`DIDClient`](verida_web_helpers._internal_.DIDClient.md) | - -#### Defined in - -packages/client-ts/dist/did-context-manager.d.ts:16 - -## Properties - -### account - -• `Private` `Optional` **account**: `any` - -#### Defined in - -packages/client-ts/dist/did-context-manager.d.ts:15 - -___ - -### didClient - -• `Private` **didClient**: `any` - -#### Defined in - -packages/client-ts/dist/did-context-manager.d.ts:14 - -___ - -### didContexts - -• `Private` **didContexts**: `any` - -#### Defined in - -packages/client-ts/dist/did-context-manager.d.ts:13 - -## Methods - -### getContextDatabaseServer - -▸ **getContextDatabaseServer**(`did`, `contextName`, `forceCreate?`): `Promise`<[`SecureContextEndpoint`](../interfaces/verida_web_helpers._internal_.SecureContextEndpoint.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did` | `string` | -| `contextName` | `string` | -| `forceCreate?` | `boolean` | - -#### Returns - -`Promise`<[`SecureContextEndpoint`](../interfaces/verida_web_helpers._internal_.SecureContextEndpoint.md)\> - -#### Defined in - -packages/client-ts/dist/did-context-manager.d.ts:18 - -___ - -### getContextMessageServer - -▸ **getContextMessageServer**(`did`, `contextName`, `forceCreate?`): `Promise`<[`SecureContextEndpoint`](../interfaces/verida_web_helpers._internal_.SecureContextEndpoint.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did` | `string` | -| `contextName` | `string` | -| `forceCreate?` | `boolean` | - -#### Returns - -`Promise`<[`SecureContextEndpoint`](../interfaces/verida_web_helpers._internal_.SecureContextEndpoint.md)\> - -#### Defined in - -packages/client-ts/dist/did-context-manager.d.ts:20 - -___ - -### getContextStorageServer - -▸ **getContextStorageServer**(`did`, `contextName`, `forceCreate?`): `Promise`<[`SecureContextEndpoint`](../interfaces/verida_web_helpers._internal_.SecureContextEndpoint.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did` | `string` | -| `contextName` | `string` | -| `forceCreate?` | `boolean` | - -#### Returns - -`Promise`<[`SecureContextEndpoint`](../interfaces/verida_web_helpers._internal_.SecureContextEndpoint.md)\> - -#### Defined in - -packages/client-ts/dist/did-context-manager.d.ts:19 - -___ - -### getDIDContextConfig - -▸ **getDIDContextConfig**(`did`, `contextName`, `forceCreate?`): `Promise`<[`SecureContextConfig`](../interfaces/verida_web_helpers._internal_.SecureContextConfig.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did` | `string` | -| `contextName` | `string` | -| `forceCreate?` | `boolean` | - -#### Returns - -`Promise`<[`SecureContextConfig`](../interfaces/verida_web_helpers._internal_.SecureContextConfig.md)\> - -#### Defined in - -packages/client-ts/dist/did-context-manager.d.ts:22 - -___ - -### getDIDContextHashConfig - -▸ **getDIDContextHashConfig**(`did`, `contextHash`): `Promise`<[`SecureContextConfig`](../interfaces/verida_web_helpers._internal_.SecureContextConfig.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did` | `string` | -| `contextHash` | `string` | - -#### Returns - -`Promise`<[`SecureContextConfig`](../interfaces/verida_web_helpers._internal_.SecureContextConfig.md)\> - -#### Defined in - -packages/client-ts/dist/did-context-manager.d.ts:21 - -___ - -### setAccount - -▸ **setAccount**(`account`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `account` | [`IAccount`](../interfaces/verida_web_helpers._internal_.IAccount.md) | - -#### Returns - -`void` - -#### Defined in - -packages/client-ts/dist/did-context-manager.d.ts:17 diff --git a/docs/api/verida-js/classes/verida_web_helpers._internal_.Datastore.md b/docs/api/verida-js/classes/verida_web_helpers._internal_.Datastore.md deleted file mode 100644 index bf1c52f..0000000 --- a/docs/api/verida-js/classes/verida_web_helpers._internal_.Datastore.md +++ /dev/null @@ -1,487 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / Datastore - -# Class: Datastore - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).Datastore - -## Implements - -- [`IDatastore`](../interfaces/verida_web_helpers._internal_.IDatastore.md) - -## Table of contents - -### Constructors - -- [constructor](verida_web_helpers._internal_.Datastore.md#constructor) - -### Properties - -- [config](verida_web_helpers._internal_.Datastore.md#config) -- [context](verida_web_helpers._internal_.Datastore.md#context) -- [db](verida_web_helpers._internal_.Datastore.md#db) -- [errors](verida_web_helpers._internal_.Datastore.md#errors) -- [init](verida_web_helpers._internal_.Datastore.md#init) -- [schema](verida_web_helpers._internal_.Datastore.md#schema) -- [schemaName](verida_web_helpers._internal_.Datastore.md#schemaname) -- [schemaPath](verida_web_helpers._internal_.Datastore.md#schemapath) - -### Methods - -- [changes](verida_web_helpers._internal_.Datastore.md#changes) -- [close](verida_web_helpers._internal_.Datastore.md#close) -- [delete](verida_web_helpers._internal_.Datastore.md#delete) -- [deleteAll](verida_web_helpers._internal_.Datastore.md#deleteall) -- [ensureIndexes](verida_web_helpers._internal_.Datastore.md#ensureindexes) -- [get](verida_web_helpers._internal_.Datastore.md#get) -- [getDb](verida_web_helpers._internal_.Datastore.md#getdb) -- [getMany](verida_web_helpers._internal_.Datastore.md#getmany) -- [getOne](verida_web_helpers._internal_.Datastore.md#getone) -- [save](verida_web_helpers._internal_.Datastore.md#save) -- [updateUsers](verida_web_helpers._internal_.Datastore.md#updateusers) - -## Constructors - -### constructor - -• **new Datastore**(`schemaName`, `context`, `config?`) - -Create a new Datastore. - -**Do not instantiate directly.** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schemaName` | `string` | -| `context` | [`Context`](verida_web_helpers._internal_.Context.md) | -| `config?` | [`DatastoreOpenConfig`](../interfaces/verida_web_helpers._internal_.DatastoreOpenConfig.md) | - -#### Defined in - -packages/client-ts/dist/context/datastore.d.ts:33 - -## Properties - -### config - -• `Protected` **config**: [`DatastoreOpenConfig`](../interfaces/verida_web_helpers._internal_.DatastoreOpenConfig.md) - -#### Defined in - -packages/client-ts/dist/context/datastore.d.ts:18 - -___ - -### context - -• `Protected` **context**: [`Context`](verida_web_helpers._internal_.Context.md) - -#### Defined in - -packages/client-ts/dist/context/datastore.d.ts:17 - -___ - -### db - -• `Private` **db**: `any` - -#### Defined in - -packages/client-ts/dist/context/datastore.d.ts:19 - -___ - -### errors - -• **errors**: `object` - -A list of the latest database errors. - -Any errors from saving a record will be available on this public object. - -The errors remain until they are replaced by any new errors. - -#### Implementation of - -[IDatastore](../interfaces/verida_web_helpers._internal_.IDatastore.md).[errors](../interfaces/verida_web_helpers._internal_.IDatastore.md#errors) - -#### Defined in - -packages/client-ts/dist/context/datastore.d.ts:27 - -___ - -### init - -• `Private` **init**: `any` - -Initialize this datastore instance before use. - -**`todo:`** move this into context.openDatastore??? - -#### Defined in - -packages/client-ts/dist/context/datastore.d.ts:128 - -___ - -### schema - -• `Protected` `Optional` **schema**: `any` - -#### Defined in - -packages/client-ts/dist/context/datastore.d.ts:16 - -___ - -### schemaName - -• `Protected` **schemaName**: `string` - -#### Defined in - -packages/client-ts/dist/context/datastore.d.ts:14 - -___ - -### schemaPath - -• `Protected` `Optional` **schemaPath**: `string` - -#### Defined in - -packages/client-ts/dist/context/datastore.d.ts:15 - -## Methods - -### changes - -▸ **changes**(`cb`, `options?`): `Promise`<`any`\> - -Bind to changes to this datastore - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `cb` | `any` | Callback function that fires when new data is received | -| `options?` | `any` | Options to be passed to the listener. See https://pouchdb.com/api.html#changes | - -#### Returns - -`Promise`<`any`\> - -Returns an object with a `.cancel()` method to cancel the listener - -#### Implementation of - -[IDatastore](../interfaces/verida_web_helpers._internal_.IDatastore.md).[changes](../interfaces/verida_web_helpers._internal_.IDatastore.md#changes) - -#### Defined in - -packages/client-ts/dist/context/datastore.d.ts:122 - -___ - -### close - -▸ **close**(`options?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options?` | [`DatabaseCloseOptions`](../interfaces/verida_web_helpers._internal_.DatabaseCloseOptions.md) | - -#### Returns - -`Promise`<`void`\> - -#### Implementation of - -[IDatastore](../interfaces/verida_web_helpers._internal_.IDatastore.md).[close](../interfaces/verida_web_helpers._internal_.IDatastore.md#close) - -#### Defined in - -packages/client-ts/dist/context/datastore.d.ts:143 - -___ - -### delete - -▸ **delete**(`docId`): `Promise`<`any`\> - -Delete a record by ID. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `docId` | `string` | Unique ID of the record to delete | - -#### Returns - -`Promise`<`any`\> - -#### Implementation of - -[IDatastore](../interfaces/verida_web_helpers._internal_.IDatastore.md).[delete](../interfaces/verida_web_helpers._internal_.IDatastore.md#delete) - -#### Defined in - -packages/client-ts/dist/context/datastore.d.ts:107 - -___ - -### deleteAll - -▸ **deleteAll**(): `Promise`<`void`\> - -#### Returns - -`Promise`<`void`\> - -#### Implementation of - -[IDatastore](../interfaces/verida_web_helpers._internal_.IDatastore.md).[deleteAll](../interfaces/verida_web_helpers._internal_.IDatastore.md#deleteall) - -#### Defined in - -packages/client-ts/dist/context/datastore.d.ts:108 - -___ - -### ensureIndexes - -▸ **ensureIndexes**(`indexes`): `Promise`<`void`\> - -**`todo:`** Support removing indexes that were deleted from the spec - -**`todo:`** Validate indexes - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `indexes` | `any` | - -#### Returns - -`Promise`<`void`\> - -#### Implementation of - -[IDatastore](../interfaces/verida_web_helpers._internal_.IDatastore.md).[ensureIndexes](../interfaces/verida_web_helpers._internal_.IDatastore.md#ensureindexes) - -#### Defined in - -packages/client-ts/dist/context/datastore.d.ts:135 - -___ - -### get - -▸ **get**(`key`, `options?`): `Promise`<`any`\> - -Get a record by ID. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `key` | `string` | Unique ID of the record to fetch | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`any`\> - -#### Implementation of - -[IDatastore](../interfaces/verida_web_helpers._internal_.IDatastore.md).[get](../interfaces/verida_web_helpers._internal_.IDatastore.md#get) - -#### Defined in - -packages/client-ts/dist/context/datastore.d.ts:101 - -___ - -### getDb - -▸ **getDb**(): `Promise`<`any`\> - -Get the underlying database instance associated with this datastore. - -**Note: Do not use unless you know what you're doing as you can easily corrupt a database by breaking schema data.** - -#### Returns - -`Promise`<`any`\> - -#### Implementation of - -[IDatastore](../interfaces/verida_web_helpers._internal_.IDatastore.md).[getDb](../interfaces/verida_web_helpers._internal_.IDatastore.md#getdb) - -#### Defined in - -packages/client-ts/dist/context/datastore.d.ts:114 - -___ - -### getMany - -▸ **getMany**(`customFilter?`, `options?`): `Promise`<`object`[]\> - -Fetch a list of records from this Datastore. - -Only returns records that belong to this Datastore's schema. - -Example filters and options: - -``` -let filter = { - organization: 'Google' -}; - -let options = { - limit: 20, - skip: 0, - sort: ['firstName' -}; -``` - -**`example`** -let results = datastore.getMany({ - name: 'John' -}); - -console.log(results); - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `customFilter?` | `any` | -| `options?` | `any` | - -#### Returns - -`Promise`<`object`[]\> - -An array of database records. - -#### Implementation of - -[IDatastore](../interfaces/verida_web_helpers._internal_.IDatastore.md).[getMany](../interfaces/verida_web_helpers._internal_.IDatastore.md#getmany) - -#### Defined in - -packages/client-ts/dist/context/datastore.d.ts:86 - -___ - -### getOne - -▸ **getOne**(`customFilter?`, `options?`): `Promise`<`undefined` \| `object`\> - -Get a single database record that matches. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `customFilter?` | `any` | -| `options?` | `any` | - -#### Returns - -`Promise`<`undefined` \| `object`\> - -A database record - -#### Implementation of - -[IDatastore](../interfaces/verida_web_helpers._internal_.IDatastore.md).[getOne](../interfaces/verida_web_helpers._internal_.IDatastore.md#getone) - -#### Defined in - -packages/client-ts/dist/context/datastore.d.ts:94 - -___ - -### save - -▸ **save**(`data`, `options?`): `Promise`<`boolean` \| `object`\> - -Save data to an application schema. - -**`fires`** Database#beforeInsert Event fired before inserting a new record - -**`fires`** Database#beforeUpdate Event fired before updating a new record - -**`fires`** Database#afterInsert Event fired after inserting a new record - -**`fires`** Database#afterUpdate Event fired after updating a new record - -**`example`** -let result = await datastore.save({ - "firstName": "John", - "lastName": "Doe" -}); - -if (!result) { - console.errors(datastore.errors); -} else { - console.log("Successfully saved"); -} - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `data` | `any` | Data to be saved. Will be validated against the schema associated with this Datastore. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`boolean` \| `object`\> - -Boolean indicating if the save was successful. If not successful `this.errors` will be populated. - -#### Implementation of - -[IDatastore](../interfaces/verida_web_helpers._internal_.IDatastore.md).[save](../interfaces/verida_web_helpers._internal_.IDatastore.md#save) - -#### Defined in - -packages/client-ts/dist/context/datastore.d.ts:56 - -___ - -### updateUsers - -▸ **updateUsers**(`readList?`, `writeList?`): `Promise`<`void`\> - -Update the list of valid users for this datastore. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `readList?` | `string`[] | List of DID's that can read from this datastore. | -| `writeList?` | `string`[] | List of DID's that can write to this datastore. | - -#### Returns - -`Promise`<`void`\> - -#### Implementation of - -[IDatastore](../interfaces/verida_web_helpers._internal_.IDatastore.md).[updateUsers](../interfaces/verida_web_helpers._internal_.IDatastore.md#updateusers) - -#### Defined in - -packages/client-ts/dist/context/datastore.d.ts:142 diff --git a/docs/api/verida-js/classes/verida_web_helpers._internal_.DbRegistry.md b/docs/api/verida-js/classes/verida_web_helpers._internal_.DbRegistry.md deleted file mode 100644 index 2745500..0000000 --- a/docs/api/verida-js/classes/verida_web_helpers._internal_.DbRegistry.md +++ /dev/null @@ -1,195 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / DbRegistry - -# Class: DbRegistry - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).DbRegistry - -## Implements - -- [`IDbRegistry`](../interfaces/verida_web_helpers._internal_.IDbRegistry.md) - -## Table of contents - -### Constructors - -- [constructor](verida_web_helpers._internal_.DbRegistry.md#constructor) - -### Properties - -- [buildDatabaseId](verida_web_helpers._internal_.DbRegistry.md#builddatabaseid) -- [context](verida_web_helpers._internal_.DbRegistry.md#context) -- [dbStore](verida_web_helpers._internal_.DbRegistry.md#dbstore) - -### Methods - -- [get](verida_web_helpers._internal_.DbRegistry.md#get) -- [getMany](verida_web_helpers._internal_.DbRegistry.md#getmany) -- [init](verida_web_helpers._internal_.DbRegistry.md#init) -- [removeDb](verida_web_helpers._internal_.DbRegistry.md#removedb) -- [saveDb](verida_web_helpers._internal_.DbRegistry.md#savedb) - -## Constructors - -### constructor - -• **new DbRegistry**(`context`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `context` | [`Context`](verida_web_helpers._internal_.Context.md) | - -#### Defined in - -packages/client-ts/dist/context/db-registry.d.ts:14 - -## Properties - -### buildDatabaseId - -• `Private` **buildDatabaseId**: `any` - -#### Defined in - -packages/client-ts/dist/context/db-registry.d.ts:28 - -___ - -### context - -• `Private` **context**: `any` - -#### Defined in - -packages/client-ts/dist/context/db-registry.d.ts:12 - -___ - -### dbStore - -• `Private` `Optional` **dbStore**: `any` - -#### Defined in - -packages/client-ts/dist/context/db-registry.d.ts:13 - -## Methods - -### get - -▸ **get**(`dbName`, `did`, `contextName`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `dbName` | `string` | -| `did` | `string` | -| `contextName` | `string` | - -#### Returns - -`Promise`<`any`\> - -#### Implementation of - -[IDbRegistry](../interfaces/verida_web_helpers._internal_.IDbRegistry.md).[get](../interfaces/verida_web_helpers._internal_.IDbRegistry.md#get) - -#### Defined in - -packages/client-ts/dist/context/db-registry.d.ts:27 - -___ - -### getMany - -▸ **getMany**(`filter?`, `options?`): `Promise`<`object`[]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `filter?` | `any` | -| `options?` | `any` | - -#### Returns - -`Promise`<`object`[]\> - -#### Implementation of - -[IDbRegistry](../interfaces/verida_web_helpers._internal_.IDbRegistry.md).[getMany](../interfaces/verida_web_helpers._internal_.IDbRegistry.md#getmany) - -#### Defined in - -packages/client-ts/dist/context/db-registry.d.ts:26 - -___ - -### init - -▸ **init**(): `Promise`<`void`\> - -#### Returns - -`Promise`<`void`\> - -#### Implementation of - -[IDbRegistry](../interfaces/verida_web_helpers._internal_.IDbRegistry.md).[init](../interfaces/verida_web_helpers._internal_.IDbRegistry.md#init) - -#### Defined in - -packages/client-ts/dist/context/db-registry.d.ts:29 - -___ - -### removeDb - -▸ **removeDb**(`databaseName`, `did`, `contextName`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `databaseName` | `string` | -| `did` | `string` | -| `contextName` | `string` | - -#### Returns - -`Promise`<`boolean`\> - -#### Implementation of - -[IDbRegistry](../interfaces/verida_web_helpers._internal_.IDbRegistry.md).[removeDb](../interfaces/verida_web_helpers._internal_.IDbRegistry.md#removedb) - -#### Defined in - -packages/client-ts/dist/context/db-registry.d.ts:25 - -___ - -### saveDb - -▸ **saveDb**(`database`, `checkPermissions?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `database` | [`IDatabase`](../interfaces/verida_web_helpers._internal_.IDatabase.md) | -| `checkPermissions?` | `boolean` | - -#### Returns - -`Promise`<`void`\> - -#### Implementation of - -[IDbRegistry](../interfaces/verida_web_helpers._internal_.IDbRegistry.md).[saveDb](../interfaces/verida_web_helpers._internal_.IDbRegistry.md#savedb) - -#### Defined in - -packages/client-ts/dist/context/db-registry.d.ts:24 diff --git a/docs/api/verida-js/classes/verida_web_helpers._internal_.Description.md b/docs/api/verida-js/classes/verida_web_helpers._internal_.Description.md deleted file mode 100644 index a4033e2..0000000 --- a/docs/api/verida-js/classes/verida_web_helpers._internal_.Description.md +++ /dev/null @@ -1,45 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / Description - -# Class: Description - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).Description - -## Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `any` | - -## Hierarchy - -- **`Description`** - - ↳ [`ForkEvent`](verida_web_helpers._internal_.ForkEvent.md) - -## Table of contents - -### Constructors - -- [constructor](verida_web_helpers._internal_.Description.md#constructor) - -## Constructors - -### constructor - -• **new Description**<`T`\>(`info`) - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `any` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `info` | { [K in string \| number \| symbol]: T[K] } | - -#### Defined in - -node_modules/@ethersproject/properties/lib/index.d.ts:13 diff --git a/docs/api/verida-js/classes/verida_web_helpers._internal_.EventEmitter-1.md b/docs/api/verida-js/classes/verida_web_helpers._internal_.EventEmitter-1.md deleted file mode 100644 index 501d88a..0000000 --- a/docs/api/verida-js/classes/verida_web_helpers._internal_.EventEmitter-1.md +++ /dev/null @@ -1,1085 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / EventEmitter - -# Class: EventEmitter - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).EventEmitter - -The `EventEmitter` class is defined and exposed by the `events` module: - -```js -const EventEmitter = require('events'); -``` - -All `EventEmitter`s emit the event `'newListener'` when new listeners are -added and `'removeListener'` when existing listeners are removed. - -It supports the following option: - -**`since`** v0.1.26 - -## Hierarchy - -- `EventEmitter` - - ↳ **`EventEmitter`** - - ↳↳ [`Context`](verida_web_helpers._internal_.Context.md) - -## Table of contents - -### Constructors - -- [constructor](verida_web_helpers._internal_.EventEmitter-1.md#constructor) - -### Properties - -- [captureRejectionSymbol](verida_web_helpers._internal_.EventEmitter-1.md#capturerejectionsymbol) -- [captureRejections](verida_web_helpers._internal_.EventEmitter-1.md#capturerejections) -- [defaultMaxListeners](verida_web_helpers._internal_.EventEmitter-1.md#defaultmaxlisteners) -- [errorMonitor](verida_web_helpers._internal_.EventEmitter-1.md#errormonitor) - -### Methods - -- [addListener](verida_web_helpers._internal_.EventEmitter-1.md#addlistener) -- [emit](verida_web_helpers._internal_.EventEmitter-1.md#emit) -- [eventNames](verida_web_helpers._internal_.EventEmitter-1.md#eventnames) -- [getMaxListeners](verida_web_helpers._internal_.EventEmitter-1.md#getmaxlisteners) -- [listenerCount](verida_web_helpers._internal_.EventEmitter-1.md#listenercount) -- [listeners](verida_web_helpers._internal_.EventEmitter-1.md#listeners) -- [off](verida_web_helpers._internal_.EventEmitter-1.md#off) -- [on](verida_web_helpers._internal_.EventEmitter-1.md#on) -- [once](verida_web_helpers._internal_.EventEmitter-1.md#once) -- [prependListener](verida_web_helpers._internal_.EventEmitter-1.md#prependlistener) -- [prependOnceListener](verida_web_helpers._internal_.EventEmitter-1.md#prependoncelistener) -- [rawListeners](verida_web_helpers._internal_.EventEmitter-1.md#rawlisteners) -- [removeAllListeners](verida_web_helpers._internal_.EventEmitter-1.md#removealllisteners) -- [removeListener](verida_web_helpers._internal_.EventEmitter-1.md#removelistener) -- [setMaxListeners](verida_web_helpers._internal_.EventEmitter-1.md#setmaxlisteners) -- [getEventListeners](verida_web_helpers._internal_.EventEmitter-1.md#geteventlisteners) -- [listenerCount](verida_web_helpers._internal_.EventEmitter-1.md#listenercount) -- [on](verida_web_helpers._internal_.EventEmitter-1.md#on) -- [once](verida_web_helpers._internal_.EventEmitter-1.md#once) - -## Constructors - -### constructor - -• **new EventEmitter**(`options?`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options?` | [`EventEmitterOptions`](../interfaces/verida_web_helpers._internal_.EventEmitterOptions.md) | - -#### Inherited from - -NodeJS.EventEmitter.constructor - -#### Defined in - -node_modules/@types/node/events.d.ts:74 - -## Properties - -### captureRejectionSymbol - -▪ `Static` `Readonly` **captureRejectionSymbol**: typeof [`captureRejectionSymbol`](../modules/verida_web_helpers.md#capturerejectionsymbol) - -#### Defined in - -node_modules/@types/node/events.d.ts:273 - -___ - -### captureRejections - -▪ `Static` **captureRejections**: `boolean` - -Sets or gets the default captureRejection value for all emitters. - -#### Defined in - -node_modules/@types/node/events.d.ts:278 - -___ - -### defaultMaxListeners - -▪ `Static` **defaultMaxListeners**: `number` - -#### Defined in - -node_modules/@types/node/events.d.ts:279 - -___ - -### errorMonitor - -▪ `Static` `Readonly` **errorMonitor**: typeof [`errorMonitor`](../modules/verida_web_helpers.md#errormonitor) - -This symbol shall be used to install a listener for only monitoring `'error'` -events. Listeners installed using this symbol are called before the regular -`'error'` listeners are called. - -Installing a listener using this symbol does not change the behavior once an -`'error'` event is emitted, therefore the process will still crash if no -regular `'error'` listener is installed. - -#### Defined in - -node_modules/@types/node/events.d.ts:272 - -## Methods - -### addListener - -▸ **addListener**(`eventName`, `listener`): [`EventEmitter`](verida_web_helpers._internal_.EventEmitter-1.md) - -Alias for `emitter.on(eventName, listener)`. - -**`since`** v0.1.26 - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | `string` \| `symbol` | -| `listener` | (...`args`: `any`[]) => `void` | - -#### Returns - -[`EventEmitter`](verida_web_helpers._internal_.EventEmitter-1.md) - -#### Inherited from - -NodeJS.EventEmitter.addListener - -#### Defined in - -node_modules/@types/node/events.d.ts:299 - -___ - -### emit - -▸ **emit**(`eventName`, ...`args`): `boolean` - -Synchronously calls each of the listeners registered for the event named`eventName`, in the order they were registered, passing the supplied arguments -to each. - -Returns `true` if the event had listeners, `false` otherwise. - -```js -const EventEmitter = require('events'); -const myEmitter = new EventEmitter(); - -// First listener -myEmitter.on('event', function firstListener() { - console.log('Helloooo! first listener'); -}); -// Second listener -myEmitter.on('event', function secondListener(arg1, arg2) { - console.log(`event with parameters ${arg1}, ${arg2} in second listener`); -}); -// Third listener -myEmitter.on('event', function thirdListener(...args) { - const parameters = args.join(', '); - console.log(`event with parameters ${parameters} in third listener`); -}); - -console.log(myEmitter.listeners('event')); - -myEmitter.emit('event', 1, 2, 3, 4, 5); - -// Prints: -// [ -// [Function: firstListener], -// [Function: secondListener], -// [Function: thirdListener] -// ] -// Helloooo! first listener -// event with parameters 1, 2 in second listener -// event with parameters 1, 2, 3, 4, 5 in third listener -``` - -**`since`** v0.1.26 - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | `string` \| `symbol` | -| `...args` | `any`[] | - -#### Returns - -`boolean` - -#### Inherited from - -NodeJS.EventEmitter.emit - -#### Defined in - -node_modules/@types/node/events.d.ts:555 - -___ - -### eventNames - -▸ **eventNames**(): (`string` \| `symbol`)[] - -Returns an array listing the events for which the emitter has registered -listeners. The values in the array are strings or `Symbol`s. - -```js -const EventEmitter = require('events'); -const myEE = new EventEmitter(); -myEE.on('foo', () => {}); -myEE.on('bar', () => {}); - -const sym = Symbol('symbol'); -myEE.on(sym, () => {}); - -console.log(myEE.eventNames()); -// Prints: [ 'foo', 'bar', Symbol(symbol) ] -``` - -**`since`** v6.0.0 - -#### Returns - -(`string` \| `symbol`)[] - -#### Inherited from - -NodeJS.EventEmitter.eventNames - -#### Defined in - -node_modules/@types/node/events.d.ts:614 - -___ - -### getMaxListeners - -▸ **getMaxListeners**(): `number` - -Returns the current max listener value for the `EventEmitter` which is either -set by `emitter.setMaxListeners(n)` or defaults to [defaultMaxListeners](verida_web_helpers._internal_.EventEmitter-1.md#defaultmaxlisteners). - -**`since`** v1.0.0 - -#### Returns - -`number` - -#### Inherited from - -NodeJS.EventEmitter.getMaxListeners - -#### Defined in - -node_modules/@types/node/events.d.ts:471 - -___ - -### listenerCount - -▸ **listenerCount**(`eventName`): `number` - -Returns the number of listeners listening to the event named `eventName`. - -**`since`** v3.2.0 - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `eventName` | `string` \| `symbol` | The name of the event being listened for | - -#### Returns - -`number` - -#### Inherited from - -NodeJS.EventEmitter.listenerCount - -#### Defined in - -node_modules/@types/node/events.d.ts:561 - -___ - -### listeners - -▸ **listeners**(`eventName`): `Function`[] - -Returns a copy of the array of listeners for the event named `eventName`. - -```js -server.on('connection', (stream) => { - console.log('someone connected!'); -}); -console.log(util.inspect(server.listeners('connection'))); -// Prints: [ [Function] ] -``` - -**`since`** v0.1.26 - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | `string` \| `symbol` | - -#### Returns - -`Function`[] - -#### Inherited from - -NodeJS.EventEmitter.listeners - -#### Defined in - -node_modules/@types/node/events.d.ts:484 - -___ - -### off - -▸ **off**(`eventName`, `listener`): [`EventEmitter`](verida_web_helpers._internal_.EventEmitter-1.md) - -Alias for `emitter.removeListener()`. - -**`since`** v10.0.0 - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | `string` \| `symbol` | -| `listener` | (...`args`: `any`[]) => `void` | - -#### Returns - -[`EventEmitter`](verida_web_helpers._internal_.EventEmitter-1.md) - -#### Inherited from - -NodeJS.EventEmitter.off - -#### Defined in - -node_modules/@types/node/events.d.ts:444 - -___ - -### on - -▸ **on**(`eventName`, `listener`): [`EventEmitter`](verida_web_helpers._internal_.EventEmitter-1.md) - -Adds the `listener` function to the end of the listeners array for the -event named `eventName`. No checks are made to see if the `listener` has -already been added. Multiple calls passing the same combination of `eventName`and `listener` will result in the `listener` being added, and called, multiple -times. - -```js -server.on('connection', (stream) => { - console.log('someone connected!'); -}); -``` - -Returns a reference to the `EventEmitter`, so that calls can be chained. - -By default, event listeners are invoked in the order they are added. The`emitter.prependListener()` method can be used as an alternative to add the -event listener to the beginning of the listeners array. - -```js -const myEE = new EventEmitter(); -myEE.on('foo', () => console.log('a')); -myEE.prependListener('foo', () => console.log('b')); -myEE.emit('foo'); -// Prints: -// b -// a -``` - -**`since`** v0.1.101 - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `eventName` | `string` \| `symbol` | The name of the event. | -| `listener` | (...`args`: `any`[]) => `void` | The callback function | - -#### Returns - -[`EventEmitter`](verida_web_helpers._internal_.EventEmitter-1.md) - -#### Inherited from - -NodeJS.EventEmitter.on - -#### Defined in - -node_modules/@types/node/events.d.ts:330 - -___ - -### once - -▸ **once**(`eventName`, `listener`): [`EventEmitter`](verida_web_helpers._internal_.EventEmitter-1.md) - -Adds a **one-time**`listener` function for the event named `eventName`. The -next time `eventName` is triggered, this listener is removed and then invoked. - -```js -server.once('connection', (stream) => { - console.log('Ah, we have our first user!'); -}); -``` - -Returns a reference to the `EventEmitter`, so that calls can be chained. - -By default, event listeners are invoked in the order they are added. The`emitter.prependOnceListener()` method can be used as an alternative to add the -event listener to the beginning of the listeners array. - -```js -const myEE = new EventEmitter(); -myEE.once('foo', () => console.log('a')); -myEE.prependOnceListener('foo', () => console.log('b')); -myEE.emit('foo'); -// Prints: -// b -// a -``` - -**`since`** v0.3.0 - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `eventName` | `string` \| `symbol` | The name of the event. | -| `listener` | (...`args`: `any`[]) => `void` | The callback function | - -#### Returns - -[`EventEmitter`](verida_web_helpers._internal_.EventEmitter-1.md) - -#### Inherited from - -NodeJS.EventEmitter.once - -#### Defined in - -node_modules/@types/node/events.d.ts:359 - -___ - -### prependListener - -▸ **prependListener**(`eventName`, `listener`): [`EventEmitter`](verida_web_helpers._internal_.EventEmitter-1.md) - -Adds the `listener` function to the _beginning_ of the listeners array for the -event named `eventName`. No checks are made to see if the `listener` has -already been added. Multiple calls passing the same combination of `eventName`and `listener` will result in the `listener` being added, and called, multiple -times. - -```js -server.prependListener('connection', (stream) => { - console.log('someone connected!'); -}); -``` - -Returns a reference to the `EventEmitter`, so that calls can be chained. - -**`since`** v6.0.0 - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `eventName` | `string` \| `symbol` | The name of the event. | -| `listener` | (...`args`: `any`[]) => `void` | The callback function | - -#### Returns - -[`EventEmitter`](verida_web_helpers._internal_.EventEmitter-1.md) - -#### Inherited from - -NodeJS.EventEmitter.prependListener - -#### Defined in - -node_modules/@types/node/events.d.ts:579 - -___ - -### prependOnceListener - -▸ **prependOnceListener**(`eventName`, `listener`): [`EventEmitter`](verida_web_helpers._internal_.EventEmitter-1.md) - -Adds a **one-time**`listener` function for the event named `eventName` to the_beginning_ of the listeners array. The next time `eventName` is triggered, this -listener is removed, and then invoked. - -```js -server.prependOnceListener('connection', (stream) => { - console.log('Ah, we have our first user!'); -}); -``` - -Returns a reference to the `EventEmitter`, so that calls can be chained. - -**`since`** v6.0.0 - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `eventName` | `string` \| `symbol` | The name of the event. | -| `listener` | (...`args`: `any`[]) => `void` | The callback function | - -#### Returns - -[`EventEmitter`](verida_web_helpers._internal_.EventEmitter-1.md) - -#### Inherited from - -NodeJS.EventEmitter.prependOnceListener - -#### Defined in - -node_modules/@types/node/events.d.ts:595 - -___ - -### rawListeners - -▸ **rawListeners**(`eventName`): `Function`[] - -Returns a copy of the array of listeners for the event named `eventName`, -including any wrappers (such as those created by `.once()`). - -```js -const emitter = new EventEmitter(); -emitter.once('log', () => console.log('log once')); - -// Returns a new Array with a function `onceWrapper` which has a property -// `listener` which contains the original listener bound above -const listeners = emitter.rawListeners('log'); -const logFnWrapper = listeners[0]; - -// Logs "log once" to the console and does not unbind the `once` event -logFnWrapper.listener(); - -// Logs "log once" to the console and removes the listener -logFnWrapper(); - -emitter.on('log', () => console.log('log persistently')); -// Will return a new Array with a single function bound by `.on()` above -const newListeners = emitter.rawListeners('log'); - -// Logs "log persistently" twice -newListeners[0](); -emitter.emit('log'); -``` - -**`since`** v9.4.0 - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | `string` \| `symbol` | - -#### Returns - -`Function`[] - -#### Inherited from - -NodeJS.EventEmitter.rawListeners - -#### Defined in - -node_modules/@types/node/events.d.ts:514 - -___ - -### removeAllListeners - -▸ **removeAllListeners**(`event?`): [`EventEmitter`](verida_web_helpers._internal_.EventEmitter-1.md) - -Removes all listeners, or those of the specified `eventName`. - -It is bad practice to remove listeners added elsewhere in the code, -particularly when the `EventEmitter` instance was created by some other -component or module (e.g. sockets or file streams). - -Returns a reference to the `EventEmitter`, so that calls can be chained. - -**`since`** v0.1.26 - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event?` | `string` \| `symbol` | - -#### Returns - -[`EventEmitter`](verida_web_helpers._internal_.EventEmitter-1.md) - -#### Inherited from - -NodeJS.EventEmitter.removeAllListeners - -#### Defined in - -node_modules/@types/node/events.d.ts:455 - -___ - -### removeListener - -▸ **removeListener**(`eventName`, `listener`): [`EventEmitter`](verida_web_helpers._internal_.EventEmitter-1.md) - -Removes the specified `listener` from the listener array for the event named`eventName`. - -```js -const callback = (stream) => { - console.log('someone connected!'); -}; -server.on('connection', callback); -// ... -server.removeListener('connection', callback); -``` - -`removeListener()` will remove, at most, one instance of a listener from the -listener array. If any single listener has been added multiple times to the -listener array for the specified `eventName`, then `removeListener()` must be -called multiple times to remove each instance. - -Once an event is emitted, all listeners attached to it at the -time of emitting are called in order. This implies that any`removeListener()` or `removeAllListeners()` calls _after_ emitting and_before_ the last listener finishes execution will -not remove them from`emit()` in progress. Subsequent events behave as expected. - -```js -const myEmitter = new MyEmitter(); - -const callbackA = () => { - console.log('A'); - myEmitter.removeListener('event', callbackB); -}; - -const callbackB = () => { - console.log('B'); -}; - -myEmitter.on('event', callbackA); - -myEmitter.on('event', callbackB); - -// callbackA removes listener callbackB but it will still be called. -// Internal listener array at time of emit [callbackA, callbackB] -myEmitter.emit('event'); -// Prints: -// A -// B - -// callbackB is now removed. -// Internal listener array [callbackA] -myEmitter.emit('event'); -// Prints: -// A -``` - -Because listeners are managed using an internal array, calling this will -change the position indices of any listener registered _after_ the listener -being removed. This will not impact the order in which listeners are called, -but it means that any copies of the listener array as returned by -the `emitter.listeners()` method will need to be recreated. - -When a single function has been added as a handler multiple times for a single -event (as in the example below), `removeListener()` will remove the most -recently added instance. In the example the `once('ping')`listener is removed: - -```js -const ee = new EventEmitter(); - -function pong() { - console.log('pong'); -} - -ee.on('ping', pong); -ee.once('ping', pong); -ee.removeListener('ping', pong); - -ee.emit('ping'); -ee.emit('ping'); -``` - -Returns a reference to the `EventEmitter`, so that calls can be chained. - -**`since`** v0.1.26 - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | `string` \| `symbol` | -| `listener` | (...`args`: `any`[]) => `void` | - -#### Returns - -[`EventEmitter`](verida_web_helpers._internal_.EventEmitter-1.md) - -#### Inherited from - -NodeJS.EventEmitter.removeListener - -#### Defined in - -node_modules/@types/node/events.d.ts:439 - -___ - -### setMaxListeners - -▸ **setMaxListeners**(`n`): [`EventEmitter`](verida_web_helpers._internal_.EventEmitter-1.md) - -By default `EventEmitter`s will print a warning if more than `10` listeners are -added for a particular event. This is a useful default that helps finding -memory leaks. The `emitter.setMaxListeners()` method allows the limit to be -modified for this specific `EventEmitter` instance. The value can be set to`Infinity` (or `0`) to indicate an unlimited number of listeners. - -Returns a reference to the `EventEmitter`, so that calls can be chained. - -**`since`** v0.3.5 - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `n` | `number` | - -#### Returns - -[`EventEmitter`](verida_web_helpers._internal_.EventEmitter-1.md) - -#### Inherited from - -NodeJS.EventEmitter.setMaxListeners - -#### Defined in - -node_modules/@types/node/events.d.ts:465 - -___ - -### getEventListeners - -▸ `Static` **getEventListeners**(`emitter`, `name`): `Function`[] - -Returns a copy of the array of listeners for the event named `eventName`. - -For `EventEmitter`s this behaves exactly the same as calling `.listeners` on -the emitter. - -For `EventTarget`s this is the only way to get the event listeners for the -event target. This is useful for debugging and diagnostic purposes. - -```js -const { getEventListeners, EventEmitter } = require('events'); - -{ - const ee = new EventEmitter(); - const listener = () => console.log('Events are fun'); - ee.on('foo', listener); - getEventListeners(ee, 'foo'); // [listener] -} -{ - const et = new EventTarget(); - const listener = () => console.log('Events are fun'); - et.addEventListener('foo', listener); - getEventListeners(et, 'foo'); // [listener] -} -``` - -**`since`** v15.2.0 - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `emitter` | [`DOMEventTarget`](../interfaces/verida_web_helpers._internal_.DOMEventTarget.md) \| `EventEmitter` | -| `name` | `string` \| `symbol` | - -#### Returns - -`Function`[] - -#### Defined in - -node_modules/@types/node/events.d.ts:262 - -___ - -### listenerCount - -▸ `Static` **listenerCount**(`emitter`, `eventName`): `number` - -A class method that returns the number of listeners for the given `eventName`registered on the given `emitter`. - -```js -const { EventEmitter, listenerCount } = require('events'); -const myEmitter = new EventEmitter(); -myEmitter.on('event', () => {}); -myEmitter.on('event', () => {}); -console.log(listenerCount(myEmitter, 'event')); -// Prints: 2 -``` - -**`since`** v0.9.12 - -**`deprecated`** Since v3.2.0 - Use `listenerCount` instead. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `emitter` | `EventEmitter` | The emitter to query | -| `eventName` | `string` \| `symbol` | The event name | - -#### Returns - -`number` - -#### Inherited from - -NodeJS.EventEmitter.listenerCount - -#### Defined in - -node_modules/@types/node/events.d.ts:234 - -___ - -### on - -▸ `Static` **on**(`emitter`, `eventName`, `options?`): [`AsyncIterableIterator`](../interfaces/verida_web_helpers._internal_.AsyncIterableIterator.md)<`any`\> - -```js -const { on, EventEmitter } = require('events'); - -(async () => { - const ee = new EventEmitter(); - - // Emit later on - process.nextTick(() => { - ee.emit('foo', 'bar'); - ee.emit('foo', 42); - }); - - for await (const event of on(ee, 'foo')) { - // The execution of this inner block is synchronous and it - // processes one event at a time (even with await). Do not use - // if concurrent execution is required. - console.log(event); // prints ['bar'] [42] - } - // Unreachable here -})(); -``` - -Returns an `AsyncIterator` that iterates `eventName` events. It will throw -if the `EventEmitter` emits `'error'`. It removes all listeners when -exiting the loop. The `value` returned by each iteration is an array -composed of the emitted event arguments. - -An `AbortSignal` can be used to cancel waiting on events: - -```js -const { on, EventEmitter } = require('events'); -const ac = new AbortController(); - -(async () => { - const ee = new EventEmitter(); - - // Emit later on - process.nextTick(() => { - ee.emit('foo', 'bar'); - ee.emit('foo', 42); - }); - - for await (const event of on(ee, 'foo', { signal: ac.signal })) { - // The execution of this inner block is synchronous and it - // processes one event at a time (even with await). Do not use - // if concurrent execution is required. - console.log(event); // prints ['bar'] [42] - } - // Unreachable here -})(); - -process.nextTick(() => ac.abort()); -``` - -**`since`** v13.6.0, v12.16.0 - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `emitter` | `EventEmitter` | - | -| `eventName` | `string` | The name of the event being listened for | -| `options?` | [`StaticEventEmitterOptions`](../interfaces/verida_web_helpers._internal_.StaticEventEmitterOptions.md) | - | - -#### Returns - -[`AsyncIterableIterator`](../interfaces/verida_web_helpers._internal_.AsyncIterableIterator.md)<`any`\> - -that iterates `eventName` events emitted by the `emitter` - -#### Inherited from - -NodeJS.EventEmitter.on - -#### Defined in - -node_modules/@types/node/events.d.ts:217 - -___ - -### once - -▸ `Static` **once**(`emitter`, `eventName`, `options?`): `Promise`<`any`[]\> - -Creates a `Promise` that is fulfilled when the `EventEmitter` emits the given -event or that is rejected if the `EventEmitter` emits `'error'` while waiting. -The `Promise` will resolve with an array of all the arguments emitted to the -given event. - -This method is intentionally generic and works with the web platform[EventTarget](https://dom.spec.whatwg.org/#interface-eventtarget) interface, which has no special`'error'` event -semantics and does not listen to the `'error'` event. - -```js -const { once, EventEmitter } = require('events'); - -async function run() { - const ee = new EventEmitter(); - - process.nextTick(() => { - ee.emit('myevent', 42); - }); - - const [value] = await once(ee, 'myevent'); - console.log(value); - - const err = new Error('kaboom'); - process.nextTick(() => { - ee.emit('error', err); - }); - - try { - await once(ee, 'myevent'); - } catch (err) { - console.log('error happened', err); - } -} - -run(); -``` - -The special handling of the `'error'` event is only used when `events.once()`is used to wait for another event. If `events.once()` is used to wait for the -'`error'` event itself, then it is treated as any other kind of event without -special handling: - -```js -const { EventEmitter, once } = require('events'); - -const ee = new EventEmitter(); - -once(ee, 'error') - .then(([err]) => console.log('ok', err.message)) - .catch((err) => console.log('error', err.message)); - -ee.emit('error', new Error('boom')); - -// Prints: ok boom -``` - -An `AbortSignal` can be used to cancel waiting for the event: - -```js -const { EventEmitter, once } = require('events'); - -const ee = new EventEmitter(); -const ac = new AbortController(); - -async function foo(emitter, event, signal) { - try { - await once(emitter, event, { signal }); - console.log('event emitted!'); - } catch (error) { - if (error.name === 'AbortError') { - console.error('Waiting for the event was canceled!'); - } else { - console.error('There was an error', error.message); - } - } -} - -foo(ee, 'foo', ac.signal); -ac.abort(); // Abort waiting for the event -ee.emit('foo'); // Prints: Waiting for the event was canceled! -``` - -**`since`** v11.13.0, v10.16.0 - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `emitter` | [`NodeEventTarget`](../interfaces/verida_web_helpers._internal_.NodeEventTarget.md) | -| `eventName` | `string` \| `symbol` | -| `options?` | [`StaticEventEmitterOptions`](../interfaces/verida_web_helpers._internal_.StaticEventEmitterOptions.md) | - -#### Returns - -`Promise`<`any`[]\> - -#### Inherited from - -NodeJS.EventEmitter.once - -#### Defined in - -node_modules/@types/node/events.d.ts:157 - -▸ `Static` **once**(`emitter`, `eventName`, `options?`): `Promise`<`any`[]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `emitter` | [`DOMEventTarget`](../interfaces/verida_web_helpers._internal_.DOMEventTarget.md) | -| `eventName` | `string` | -| `options?` | [`StaticEventEmitterOptions`](../interfaces/verida_web_helpers._internal_.StaticEventEmitterOptions.md) | - -#### Returns - -`Promise`<`any`[]\> - -#### Inherited from - -NodeJS.EventEmitter.once - -#### Defined in - -node_modules/@types/node/events.d.ts:158 diff --git a/docs/api/verida-js/classes/verida_web_helpers._internal_.ForkEvent.md b/docs/api/verida-js/classes/verida_web_helpers._internal_.ForkEvent.md deleted file mode 100644 index 8cde1b0..0000000 --- a/docs/api/verida-js/classes/verida_web_helpers._internal_.ForkEvent.md +++ /dev/null @@ -1,86 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / ForkEvent - -# Class: ForkEvent - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).ForkEvent - -## Hierarchy - -- [`Description`](verida_web_helpers._internal_.Description.md) - - ↳ **`ForkEvent`** - -## Table of contents - -### Constructors - -- [constructor](verida_web_helpers._internal_.ForkEvent.md#constructor) - -### Properties - -- [\_isForkEvent](verida_web_helpers._internal_.ForkEvent.md#_isforkevent) -- [expiry](verida_web_helpers._internal_.ForkEvent.md#expiry) - -### Methods - -- [isForkEvent](verida_web_helpers._internal_.ForkEvent.md#isforkevent) - -## Constructors - -### constructor - -• **new ForkEvent**(`info`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `info` | `Object` | - -#### Inherited from - -[Description](verida_web_helpers._internal_.Description.md).[constructor](verida_web_helpers._internal_.Description.md#constructor) - -#### Defined in - -node_modules/@ethersproject/properties/lib/index.d.ts:13 - -## Properties - -### \_isForkEvent - -• `Optional` `Readonly` **\_isForkEvent**: `boolean` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:103 - -___ - -### expiry - -• `Readonly` **expiry**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:102 - -## Methods - -### isForkEvent - -▸ `Static` **isForkEvent**(`value`): value is ForkEvent - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `any` | - -#### Returns - -value is ForkEvent - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:104 diff --git a/docs/api/verida-js/classes/verida_web_helpers._internal_.KeywordCxt.md b/docs/api/verida-js/classes/verida_web_helpers._internal_.KeywordCxt.md deleted file mode 100644 index 1ebc620..0000000 --- a/docs/api/verida-js/classes/verida_web_helpers._internal_.KeywordCxt.md +++ /dev/null @@ -1,584 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / KeywordCxt - -# Class: KeywordCxt - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).KeywordCxt - -## Implements - -- [`KeywordErrorCxt`](../interfaces/verida_web_helpers._internal_.KeywordErrorCxt.md) - -## Table of contents - -### Constructors - -- [constructor](verida_web_helpers._internal_.KeywordCxt.md#constructor) - -### Properties - -- [$data](verida_web_helpers._internal_.KeywordCxt.md#$data) -- [\_error](verida_web_helpers._internal_.KeywordCxt.md#_error) -- [allErrors](verida_web_helpers._internal_.KeywordCxt.md#allerrors) -- [data](verida_web_helpers._internal_.KeywordCxt.md#data) -- [def](verida_web_helpers._internal_.KeywordCxt.md#def) -- [errsCount](verida_web_helpers._internal_.KeywordCxt.md#errscount) -- [gen](verida_web_helpers._internal_.KeywordCxt.md#gen) -- [it](verida_web_helpers._internal_.KeywordCxt.md#it) -- [keyword](verida_web_helpers._internal_.KeywordCxt.md#keyword) -- [params](verida_web_helpers._internal_.KeywordCxt.md#params) -- [parentSchema](verida_web_helpers._internal_.KeywordCxt.md#parentschema) -- [schema](verida_web_helpers._internal_.KeywordCxt.md#schema) -- [schemaCode](verida_web_helpers._internal_.KeywordCxt.md#schemacode) -- [schemaType](verida_web_helpers._internal_.KeywordCxt.md#schematype) -- [schemaValue](verida_web_helpers._internal_.KeywordCxt.md#schemavalue) - -### Methods - -- [$dataError](verida_web_helpers._internal_.KeywordCxt.md#$dataerror) -- [block$data](verida_web_helpers._internal_.KeywordCxt.md#block$data) -- [check$data](verida_web_helpers._internal_.KeywordCxt.md#check$data) -- [error](verida_web_helpers._internal_.KeywordCxt.md#error) -- [fail](verida_web_helpers._internal_.KeywordCxt.md#fail) -- [fail$data](verida_web_helpers._internal_.KeywordCxt.md#fail$data) -- [failResult](verida_web_helpers._internal_.KeywordCxt.md#failresult) -- [invalid$data](verida_web_helpers._internal_.KeywordCxt.md#invalid$data) -- [mergeEvaluated](verida_web_helpers._internal_.KeywordCxt.md#mergeevaluated) -- [mergeValidEvaluated](verida_web_helpers._internal_.KeywordCxt.md#mergevalidevaluated) -- [ok](verida_web_helpers._internal_.KeywordCxt.md#ok) -- [pass](verida_web_helpers._internal_.KeywordCxt.md#pass) -- [reset](verida_web_helpers._internal_.KeywordCxt.md#reset) -- [result](verida_web_helpers._internal_.KeywordCxt.md#result) -- [setParams](verida_web_helpers._internal_.KeywordCxt.md#setparams) -- [subschema](verida_web_helpers._internal_.KeywordCxt.md#subschema) - -## Constructors - -### constructor - -• **new KeywordCxt**(`it`, `def`, `keyword`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `it` | [`SchemaObjCxt`](../interfaces/verida_web_helpers._internal_.SchemaObjCxt.md) | -| `def` | [`AddedKeywordDefinition`](../modules/verida_web_helpers._internal_.md#addedkeyworddefinition) | -| `keyword` | `string` | - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/validate/index.d.ts:23 - -## Properties - -### $data - -• `Optional` `Readonly` **$data**: `string` \| ``false`` - -#### Implementation of - -[KeywordErrorCxt](../interfaces/verida_web_helpers._internal_.KeywordErrorCxt.md).[$data](../interfaces/verida_web_helpers._internal_.KeywordErrorCxt.md#$data) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/validate/index.d.ts:13 - -___ - -### \_error - -• `Private` **\_error**: `any` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/validate/index.d.ts:30 - -___ - -### allErrors - -• `Optional` `Readonly` **allErrors**: `boolean` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/validate/index.d.ts:10 - -___ - -### data - -• `Readonly` **data**: [`Name`](verida_web_helpers._internal_.Name.md) - -#### Implementation of - -[KeywordErrorCxt](../interfaces/verida_web_helpers._internal_.KeywordErrorCxt.md).[data](../interfaces/verida_web_helpers._internal_.KeywordErrorCxt.md#data) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/validate/index.d.ts:12 - -___ - -### def - -• `Readonly` **def**: [`AddedKeywordDefinition`](../modules/verida_web_helpers._internal_.md#addedkeyworddefinition) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/validate/index.d.ts:22 - -___ - -### errsCount - -• `Optional` `Readonly` **errsCount**: [`Name`](verida_web_helpers._internal_.Name.md) - -#### Implementation of - -[KeywordErrorCxt](../interfaces/verida_web_helpers._internal_.KeywordErrorCxt.md).[errsCount](../interfaces/verida_web_helpers._internal_.KeywordErrorCxt.md#errscount) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/validate/index.d.ts:19 - -___ - -### gen - -• `Readonly` **gen**: [`CodeGen`](verida_web_helpers._internal_.CodeGen.md) - -#### Implementation of - -[KeywordErrorCxt](../interfaces/verida_web_helpers._internal_.KeywordErrorCxt.md).[gen](../interfaces/verida_web_helpers._internal_.KeywordErrorCxt.md#gen) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/validate/index.d.ts:9 - -___ - -### it - -• `Readonly` **it**: [`SchemaObjCxt`](../interfaces/verida_web_helpers._internal_.SchemaObjCxt.md) - -#### Implementation of - -[KeywordErrorCxt](../interfaces/verida_web_helpers._internal_.KeywordErrorCxt.md).[it](../interfaces/verida_web_helpers._internal_.KeywordErrorCxt.md#it) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/validate/index.d.ts:21 - -___ - -### keyword - -• `Readonly` **keyword**: `string` - -#### Implementation of - -[KeywordErrorCxt](../interfaces/verida_web_helpers._internal_.KeywordErrorCxt.md).[keyword](../interfaces/verida_web_helpers._internal_.KeywordErrorCxt.md#keyword) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/validate/index.d.ts:11 - -___ - -### params - -• **params**: [`KeywordCxtParams`](../modules/verida_web_helpers._internal_.md#keywordcxtparams) - -#### Implementation of - -[KeywordErrorCxt](../interfaces/verida_web_helpers._internal_.KeywordErrorCxt.md).[params](../interfaces/verida_web_helpers._internal_.KeywordErrorCxt.md#params) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/validate/index.d.ts:20 - -___ - -### parentSchema - -• `Readonly` **parentSchema**: [`AnySchemaObject`](../modules/verida_web_helpers._internal_.md#anyschemaobject) - -#### Implementation of - -[KeywordErrorCxt](../interfaces/verida_web_helpers._internal_.KeywordErrorCxt.md).[parentSchema](../interfaces/verida_web_helpers._internal_.KeywordErrorCxt.md#parentschema) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/validate/index.d.ts:18 - -___ - -### schema - -• **schema**: `any` - -#### Implementation of - -[KeywordErrorCxt](../interfaces/verida_web_helpers._internal_.KeywordErrorCxt.md).[schema](../interfaces/verida_web_helpers._internal_.KeywordErrorCxt.md#schema) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/validate/index.d.ts:14 - -___ - -### schemaCode - -• `Readonly` **schemaCode**: `number` \| `boolean` \| [`Code`](../modules/verida_web_helpers._internal_.md#code) - -#### Implementation of - -[KeywordErrorCxt](../interfaces/verida_web_helpers._internal_.KeywordErrorCxt.md).[schemaCode](../interfaces/verida_web_helpers._internal_.KeywordErrorCxt.md#schemacode) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/validate/index.d.ts:16 - -___ - -### schemaType - -• `Readonly` **schemaType**: (``"string"`` \| ``"number"`` \| ``"boolean"`` \| ``"object"`` \| ``"integer"`` \| ``"array"`` \| ``"null"``)[] - -#### Implementation of - -[KeywordErrorCxt](../interfaces/verida_web_helpers._internal_.KeywordErrorCxt.md).[schemaType](../interfaces/verida_web_helpers._internal_.KeywordErrorCxt.md#schematype) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/validate/index.d.ts:17 - -___ - -### schemaValue - -• `Readonly` **schemaValue**: `number` \| `boolean` \| [`Code`](../modules/verida_web_helpers._internal_.md#code) - -#### Implementation of - -[KeywordErrorCxt](../interfaces/verida_web_helpers._internal_.KeywordErrorCxt.md).[schemaValue](../interfaces/verida_web_helpers._internal_.KeywordErrorCxt.md#schemavalue) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/validate/index.d.ts:15 - -## Methods - -### $dataError - -▸ **$dataError**(): `void` - -#### Returns - -`void` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/validate/index.d.ts:31 - -___ - -### block$data - -▸ **block$data**(`valid`, `codeBlock`, `$dataValid?`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `valid` | [`Name`](verida_web_helpers._internal_.Name.md) | -| `codeBlock` | () => `void` | -| `$dataValid?` | [`Code`](../modules/verida_web_helpers._internal_.md#code) | - -#### Returns - -`void` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/validate/index.d.ts:35 - -___ - -### check$data - -▸ **check$data**(`valid?`, `$dataValid?`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `valid?` | [`Name`](verida_web_helpers._internal_.Name.md) | -| `$dataValid?` | [`Code`](../modules/verida_web_helpers._internal_.md#code) | - -#### Returns - -`void` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/validate/index.d.ts:36 - -___ - -### error - -▸ **error**(`append?`, `errorParams?`, `errorPaths?`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `append?` | `boolean` | -| `errorParams?` | [`KeywordCxtParams`](../modules/verida_web_helpers._internal_.md#keywordcxtparams) | -| `errorPaths?` | [`ErrorPaths`](../interfaces/verida_web_helpers._internal_.ErrorPaths.md) | - -#### Returns - -`void` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/validate/index.d.ts:29 - -___ - -### fail - -▸ **fail**(`condition?`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `condition?` | [`Code`](../modules/verida_web_helpers._internal_.md#code) | - -#### Returns - -`void` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/validate/index.d.ts:27 - -___ - -### fail$data - -▸ **fail$data**(`condition`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `condition` | [`Code`](../modules/verida_web_helpers._internal_.md#code) | - -#### Returns - -`void` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/validate/index.d.ts:28 - -___ - -### failResult - -▸ **failResult**(`condition`, `successAction?`, `failAction?`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `condition` | [`Code`](../modules/verida_web_helpers._internal_.md#code) | -| `successAction?` | () => `void` | -| `failAction?` | () => `void` | - -#### Returns - -`void` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/validate/index.d.ts:25 - -___ - -### invalid$data - -▸ **invalid$data**(): [`Code`](../modules/verida_web_helpers._internal_.md#code) - -#### Returns - -[`Code`](../modules/verida_web_helpers._internal_.md#code) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/validate/index.d.ts:37 - -___ - -### mergeEvaluated - -▸ **mergeEvaluated**(`schemaCxt`, `toName?`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schemaCxt` | [`SchemaCxt`](../interfaces/verida_web_helpers._internal_.SchemaCxt.md) | -| `toName?` | typeof [`Name`](verida_web_helpers._internal_.Name.md) | - -#### Returns - -`void` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/validate/index.d.ts:39 - -___ - -### mergeValidEvaluated - -▸ **mergeValidEvaluated**(`schemaCxt`, `valid`): `boolean` \| `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schemaCxt` | [`SchemaCxt`](../interfaces/verida_web_helpers._internal_.SchemaCxt.md) | -| `valid` | [`Name`](verida_web_helpers._internal_.Name.md) | - -#### Returns - -`boolean` \| `void` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/validate/index.d.ts:40 - -___ - -### ok - -▸ **ok**(`cond`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `cond` | `boolean` \| [`Code`](../modules/verida_web_helpers._internal_.md#code) | - -#### Returns - -`void` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/validate/index.d.ts:33 - -___ - -### pass - -▸ **pass**(`condition`, `failAction?`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `condition` | [`Code`](../modules/verida_web_helpers._internal_.md#code) | -| `failAction?` | () => `void` | - -#### Returns - -`void` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/validate/index.d.ts:26 - -___ - -### reset - -▸ **reset**(): `void` - -#### Returns - -`void` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/validate/index.d.ts:32 - -___ - -### result - -▸ **result**(`condition`, `successAction?`, `failAction?`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `condition` | [`Code`](../modules/verida_web_helpers._internal_.md#code) | -| `successAction?` | () => `void` | -| `failAction?` | () => `void` | - -#### Returns - -`void` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/validate/index.d.ts:24 - -___ - -### setParams - -▸ **setParams**(`obj`, `assign?`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `obj` | [`KeywordCxtParams`](../modules/verida_web_helpers._internal_.md#keywordcxtparams) | -| `assign?` | ``true`` | - -#### Returns - -`void` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/validate/index.d.ts:34 - -___ - -### subschema - -▸ **subschema**(`appl`, `valid`): [`SchemaCxt`](../interfaces/verida_web_helpers._internal_.SchemaCxt.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `appl` | [`Partial`](../modules/verida_web_helpers._internal_.md#partial)<{ `allErrors`: `boolean` ; `compositeRule`: ``true`` ; `createErrors`: `boolean` ; `data`: [`Code`](../modules/verida_web_helpers._internal_.md#code) ; `dataProp`: `string` \| `number` \| [`Code`](../modules/verida_web_helpers._internal_.md#code) ; `dataPropType`: [`Type`](../enums/verida_web_helpers._internal_.Type.md) ; `dataTypes`: (``"string"`` \| ``"number"`` \| ``"boolean"`` \| ``"object"`` \| ``"integer"`` \| ``"array"`` \| ``"null"``)[] ; `definedProperties`: `Set`<`string`\> ; `errSchemaPath`: `string` ; `jtdDiscriminator`: `string` ; `jtdMetadata`: `boolean` ; `keyword`: `string` ; `propertyName`: [`Name`](verida_web_helpers._internal_.Name.md) ; `schema`: [`AnySchema`](../modules/verida_web_helpers._internal_.md#anyschema) ; `schemaPath`: [`Code`](../modules/verida_web_helpers._internal_.md#code) ; `schemaProp`: `string` \| `number` ; `topSchemaRef`: [`Code`](../modules/verida_web_helpers._internal_.md#code) }\> | -| `valid` | [`Name`](verida_web_helpers._internal_.Name.md) | - -#### Returns - -[`SchemaCxt`](../interfaces/verida_web_helpers._internal_.SchemaCxt.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/validate/index.d.ts:38 diff --git a/docs/api/verida-js/classes/verida_web_helpers._internal_.Name.md b/docs/api/verida-js/classes/verida_web_helpers._internal_.Name.md deleted file mode 100644 index 242c6eb..0000000 --- a/docs/api/verida-js/classes/verida_web_helpers._internal_.Name.md +++ /dev/null @@ -1,120 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / Name - -# Class: Name - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).Name - -## Hierarchy - -- [`_CodeOrName`](verida_web_helpers._internal_._CodeOrName.md) - - ↳ **`Name`** - - ↳↳ [`ValueScopeName`](verida_web_helpers._internal_.ValueScopeName.md) - -## Table of contents - -### Constructors - -- [constructor](verida_web_helpers._internal_.Name.md#constructor) - -### Properties - -- [str](verida_web_helpers._internal_.Name.md#str) - -### Accessors - -- [names](verida_web_helpers._internal_.Name.md#names) - -### Methods - -- [emptyStr](verida_web_helpers._internal_.Name.md#emptystr) -- [toString](verida_web_helpers._internal_.Name.md#tostring) - -## Constructors - -### constructor - -• **new Name**(`s`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `s` | `string` | - -#### Overrides - -[_CodeOrName](verida_web_helpers._internal_._CodeOrName.md).[constructor](verida_web_helpers._internal_._CodeOrName.md#constructor) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/code.d.ts:10 - -## Properties - -### str - -• `Readonly` **str**: `string` - -#### Overrides - -[_CodeOrName](verida_web_helpers._internal_._CodeOrName.md).[str](verida_web_helpers._internal_._CodeOrName.md#str) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/code.d.ts:9 - -## Accessors - -### names - -• `get` **names**(): [`UsedNames`](../modules/verida_web_helpers._internal_.md#usednames) - -#### Returns - -[`UsedNames`](../modules/verida_web_helpers._internal_.md#usednames) - -#### Overrides - -\_CodeOrName.names - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/code.d.ts:13 - -## Methods - -### emptyStr - -▸ **emptyStr**(): `boolean` - -#### Returns - -`boolean` - -#### Overrides - -[_CodeOrName](verida_web_helpers._internal_._CodeOrName.md).[emptyStr](verida_web_helpers._internal_._CodeOrName.md#emptystr) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/code.d.ts:12 - -___ - -### toString - -▸ **toString**(): `string` - -#### Returns - -`string` - -#### Overrides - -[_CodeOrName](verida_web_helpers._internal_._CodeOrName.md).[toString](verida_web_helpers._internal_._CodeOrName.md#tostring) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/code.d.ts:11 diff --git a/docs/api/verida-js/classes/verida_web_helpers._internal_.Profile.md b/docs/api/verida-js/classes/verida_web_helpers._internal_.Profile.md deleted file mode 100644 index 160aeb9..0000000 --- a/docs/api/verida-js/classes/verida_web_helpers._internal_.Profile.md +++ /dev/null @@ -1,370 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / Profile - -# Class: Profile - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).Profile - -## Hierarchy - -- [`EventEmitter`](../modules/verida_web_helpers._internal_.md#eventemitter) - - ↳ **`Profile`** - -## Implements - -- [`IProfile`](../interfaces/verida_web_helpers._internal_.IProfile.md) - -## Table of contents - -### Constructors - -- [constructor](verida_web_helpers._internal_.Profile.md#constructor) - -### Properties - -- [context](verida_web_helpers._internal_.Profile.md#context) -- [did](verida_web_helpers._internal_.Profile.md#did) -- [errors](verida_web_helpers._internal_.Profile.md#errors) -- [getRecord](verida_web_helpers._internal_.Profile.md#getrecord) -- [init](verida_web_helpers._internal_.Profile.md#init) -- [isPrivate](verida_web_helpers._internal_.Profile.md#isprivate) -- [profileName](verida_web_helpers._internal_.Profile.md#profilename) -- [saveRecord](verida_web_helpers._internal_.Profile.md#saverecord) -- [store](verida_web_helpers._internal_.Profile.md#store) -- [writeAccess](verida_web_helpers._internal_.Profile.md#writeaccess) - -### Methods - -- [delete](verida_web_helpers._internal_.Profile.md#delete) -- [get](verida_web_helpers._internal_.Profile.md#get) -- [getMany](verida_web_helpers._internal_.Profile.md#getmany) -- [listen](verida_web_helpers._internal_.Profile.md#listen) -- [set](verida_web_helpers._internal_.Profile.md#set) -- [setMany](verida_web_helpers._internal_.Profile.md#setmany) -- [verifyWebsite](verida_web_helpers._internal_.Profile.md#verifywebsite) - -## Constructors - -### constructor - -• **new Profile**(`context`, `did`, `profileName`, `writeAccess`, `isPrivate?`) - -Create a new user profile. - -**Do not instantiate directly.** - -Access the current user's profile via {@link App.profile} - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `context` | [`Context`](verida_web_helpers._internal_.Context.md) | -| `did` | `string` | -| `profileName` | `string` | -| `writeAccess` | `boolean` | -| `isPrivate?` | `boolean` | - -#### Overrides - -EventEmitter.constructor - -#### Defined in - -packages/client-ts/dist/context/profiles/profile.d.ts:29 - -## Properties - -### context - -• `Private` **context**: `any` - -#### Defined in - -packages/client-ts/dist/context/profiles/profile.d.ts:13 - -___ - -### did - -• `Private` **did**: `any` - -#### Defined in - -packages/client-ts/dist/context/profiles/profile.d.ts:14 - -___ - -### errors - -• **errors**: `object` - -#### Defined in - -packages/client-ts/dist/context/profiles/profile.d.ts:19 - -___ - -### getRecord - -• `Private` **getRecord**: `any` - -#### Defined in - -packages/client-ts/dist/context/profiles/profile.d.ts:87 - -___ - -### init - -• `Private` **init**: `any` - -#### Defined in - -packages/client-ts/dist/context/profiles/profile.d.ts:89 - -___ - -### isPrivate - -• `Private` **isPrivate**: `any` - -#### Defined in - -packages/client-ts/dist/context/profiles/profile.d.ts:18 - -___ - -### profileName - -• `Private` **profileName**: `any` - -#### Defined in - -packages/client-ts/dist/context/profiles/profile.d.ts:15 - -___ - -### saveRecord - -• `Private` **saveRecord**: `any` - -#### Defined in - -packages/client-ts/dist/context/profiles/profile.d.ts:88 - -___ - -### store - -• `Private` `Optional` **store**: `any` - -#### Defined in - -packages/client-ts/dist/context/profiles/profile.d.ts:16 - -___ - -### writeAccess - -• `Private` **writeAccess**: `any` - -#### Defined in - -packages/client-ts/dist/context/profiles/profile.d.ts:17 - -## Methods - -### delete - -▸ **delete**(`key`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `key` | `string` | Profile key to delete (ie: `email`) | - -#### Returns - -`Promise`<`boolean`\> - -Boolean indicating if the delete was successful - -#### Implementation of - -[IProfile](../interfaces/verida_web_helpers._internal_.IProfile.md).[delete](../interfaces/verida_web_helpers._internal_.IProfile.md#delete) - -#### Defined in - -packages/client-ts/dist/context/profiles/profile.d.ts:50 - -___ - -### get - -▸ **get**(`key`, `options?`, `extended?`): `Promise`<`any`\> - -Get a profile value by key - -**`example`** -let emailDoc = app.wallet.profile.get('email'); - -// key = email -// value = john@doe.com -console.log(emailDoc.key, emailDoc.value); - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `key` | `string` | Profile key to get (ie: `email`) | -| `options?` | `any` | | -| `extended?` | `boolean` | | - -#### Returns - -`Promise`<`any`\> - -Database record for this profile key. Object has keys [`key`, `value`, `_id`, `_rev`]. - -#### Implementation of - -[IProfile](../interfaces/verida_web_helpers._internal_.IProfile.md).[get](../interfaces/verida_web_helpers._internal_.IProfile.md#get) - -#### Defined in - -packages/client-ts/dist/context/profiles/profile.d.ts:44 - -___ - -### getMany - -▸ **getMany**(`filter`, `options`): `Promise`<`any`\> - -Get many profile values. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `filter` | `any` | -| `options` | `any` | - -#### Returns - -`Promise`<`any`\> - -#### Implementation of - -[IProfile](../interfaces/verida_web_helpers._internal_.IProfile.md).[getMany](../interfaces/verida_web_helpers._internal_.IProfile.md#getmany) - -#### Defined in - -packages/client-ts/dist/context/profiles/profile.d.ts:57 - -___ - -### listen - -▸ **listen**(`callback`): `Promise`<`any`\> - -Listen for changes to the public profile - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `callback` | `any` | - -#### Returns - -`Promise`<`any`\> - -#### Implementation of - -[IProfile](../interfaces/verida_web_helpers._internal_.IProfile.md).[listen](../interfaces/verida_web_helpers._internal_.IProfile.md#listen) - -#### Defined in - -packages/client-ts/dist/context/profiles/profile.d.ts:85 - -___ - -### set - -▸ **set**(`key`, `value`): `Promise`<`any`\> - -Set a profile value by key - -**`example`** -// Set a profile value by key -app.wallet.profile.set('name', 'John'); - -// Update a profile value from an existing document -let emailDoc = app.wallet.profile.get('email'); -app.wallet.profile.set(emailDoc, 'john@doe.com'); - -// Update a profile profile by key -app.wallet.profile.set('email', 'john@doe.com'); - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `key` | `string` | Profile key to set (ie: `email`) | -| `value` | `any` | Value to save | - -#### Returns - -`Promise`<`any`\> - -Boolean indicating if the save was successful - -#### Implementation of - -[IProfile](../interfaces/verida_web_helpers._internal_.IProfile.md).[set](../interfaces/verida_web_helpers._internal_.IProfile.md#set) - -#### Defined in - -packages/client-ts/dist/context/profiles/profile.d.ts:75 - -___ - -### setMany - -▸ **setMany**(`data`): `Promise`<`any`\> - -Set many profile key / values at once - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `any` | - -#### Returns - -`Promise`<`any`\> - -#### Implementation of - -[IProfile](../interfaces/verida_web_helpers._internal_.IProfile.md).[setMany](../interfaces/verida_web_helpers._internal_.IProfile.md#setmany) - -#### Defined in - -packages/client-ts/dist/context/profiles/profile.d.ts:81 - -___ - -### verifyWebsite - -▸ **verifyWebsite**(): `Promise`<`boolean`\> - -#### Returns - -`Promise`<`boolean`\> - -#### Defined in - -packages/client-ts/dist/context/profiles/profile.d.ts:86 diff --git a/docs/api/verida-js/classes/verida_web_helpers._internal_.Provider.md b/docs/api/verida-js/classes/verida_web_helpers._internal_.Provider.md deleted file mode 100644 index 1b59a8c..0000000 --- a/docs/api/verida-js/classes/verida_web_helpers._internal_.Provider.md +++ /dev/null @@ -1,645 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / Provider - -# Class: Provider - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).Provider - -## Implements - -- [`OnceBlockable`](../interfaces/verida_web_helpers._internal_.OnceBlockable.md) - -## Table of contents - -### Constructors - -- [constructor](verida_web_helpers._internal_.Provider.md#constructor) - -### Properties - -- [\_isProvider](verida_web_helpers._internal_.Provider.md#_isprovider) - -### Methods - -- [addListener](verida_web_helpers._internal_.Provider.md#addlistener) -- [call](verida_web_helpers._internal_.Provider.md#call) -- [emit](verida_web_helpers._internal_.Provider.md#emit) -- [estimateGas](verida_web_helpers._internal_.Provider.md#estimategas) -- [getBalance](verida_web_helpers._internal_.Provider.md#getbalance) -- [getBlock](verida_web_helpers._internal_.Provider.md#getblock) -- [getBlockNumber](verida_web_helpers._internal_.Provider.md#getblocknumber) -- [getBlockWithTransactions](verida_web_helpers._internal_.Provider.md#getblockwithtransactions) -- [getCode](verida_web_helpers._internal_.Provider.md#getcode) -- [getFeeData](verida_web_helpers._internal_.Provider.md#getfeedata) -- [getGasPrice](verida_web_helpers._internal_.Provider.md#getgasprice) -- [getLogs](verida_web_helpers._internal_.Provider.md#getlogs) -- [getNetwork](verida_web_helpers._internal_.Provider.md#getnetwork) -- [getStorageAt](verida_web_helpers._internal_.Provider.md#getstorageat) -- [getTransaction](verida_web_helpers._internal_.Provider.md#gettransaction) -- [getTransactionCount](verida_web_helpers._internal_.Provider.md#gettransactioncount) -- [getTransactionReceipt](verida_web_helpers._internal_.Provider.md#gettransactionreceipt) -- [listenerCount](verida_web_helpers._internal_.Provider.md#listenercount) -- [listeners](verida_web_helpers._internal_.Provider.md#listeners) -- [lookupAddress](verida_web_helpers._internal_.Provider.md#lookupaddress) -- [off](verida_web_helpers._internal_.Provider.md#off) -- [on](verida_web_helpers._internal_.Provider.md#on) -- [once](verida_web_helpers._internal_.Provider.md#once) -- [removeAllListeners](verida_web_helpers._internal_.Provider.md#removealllisteners) -- [removeListener](verida_web_helpers._internal_.Provider.md#removelistener) -- [resolveName](verida_web_helpers._internal_.Provider.md#resolvename) -- [sendTransaction](verida_web_helpers._internal_.Provider.md#sendtransaction) -- [waitForTransaction](verida_web_helpers._internal_.Provider.md#waitfortransaction) -- [isProvider](verida_web_helpers._internal_.Provider.md#isprovider) - -## Constructors - -### constructor - -• **new Provider**() - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:153 - -## Properties - -### \_isProvider - -• `Readonly` **\_isProvider**: `boolean` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:152 - -## Methods - -### addListener - -▸ **addListener**(`eventName`, `listener`): [`Provider`](verida_web_helpers._internal_.Provider.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | [`EventType`](../modules/verida_web_helpers._internal_.md#eventtype) | -| `listener` | [`Listener`](../modules/verida_web_helpers._internal_.md#listener) | - -#### Returns - -[`Provider`](verida_web_helpers._internal_.Provider.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:149 - -___ - -### call - -▸ `Abstract` **call**(`transaction`, `blockTag?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transaction` | [`Deferrable`](../modules/verida_web_helpers._internal_.md#deferrable)<[`TransactionRequest`](../modules/verida_web_helpers._internal_.md#transactionrequest)\> | -| `blockTag?` | [`BlockTag`](../modules/verida_web_helpers._internal_.md#blocktag) \| `Promise`<[`BlockTag`](../modules/verida_web_helpers._internal_.md#blocktag)\> | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:133 - -___ - -### emit - -▸ `Abstract` **emit**(`eventName`, ...`args`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | [`EventType`](../modules/verida_web_helpers._internal_.md#eventtype) | -| `...args` | `any`[] | - -#### Returns - -`boolean` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:144 - -___ - -### estimateGas - -▸ `Abstract` **estimateGas**(`transaction`): `Promise`<[`BigNumber`](verida_web_helpers._internal_.BigNumber.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transaction` | [`Deferrable`](../modules/verida_web_helpers._internal_.md#deferrable)<[`TransactionRequest`](../modules/verida_web_helpers._internal_.md#transactionrequest)\> | - -#### Returns - -`Promise`<[`BigNumber`](verida_web_helpers._internal_.BigNumber.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:134 - -___ - -### getBalance - -▸ `Abstract` **getBalance**(`addressOrName`, `blockTag?`): `Promise`<[`BigNumber`](verida_web_helpers._internal_.BigNumber.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `addressOrName` | `string` \| `Promise`<`string`\> | -| `blockTag?` | [`BlockTag`](../modules/verida_web_helpers._internal_.md#blocktag) \| `Promise`<[`BlockTag`](../modules/verida_web_helpers._internal_.md#blocktag)\> | - -#### Returns - -`Promise`<[`BigNumber`](verida_web_helpers._internal_.BigNumber.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:128 - -___ - -### getBlock - -▸ `Abstract` **getBlock**(`blockHashOrBlockTag`): `Promise`<[`Block`](../interfaces/verida_web_helpers._internal_.Block.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `blockHashOrBlockTag` | [`BlockTag`](../modules/verida_web_helpers._internal_.md#blocktag) \| `Promise`<[`BlockTag`](../modules/verida_web_helpers._internal_.md#blocktag)\> | - -#### Returns - -`Promise`<[`Block`](../interfaces/verida_web_helpers._internal_.Block.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:135 - -___ - -### getBlockNumber - -▸ `Abstract` **getBlockNumber**(): `Promise`<`number`\> - -#### Returns - -`Promise`<`number`\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:125 - -___ - -### getBlockWithTransactions - -▸ `Abstract` **getBlockWithTransactions**(`blockHashOrBlockTag`): `Promise`<[`BlockWithTransactions`](../interfaces/verida_web_helpers._internal_.BlockWithTransactions.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `blockHashOrBlockTag` | [`BlockTag`](../modules/verida_web_helpers._internal_.md#blocktag) \| `Promise`<[`BlockTag`](../modules/verida_web_helpers._internal_.md#blocktag)\> | - -#### Returns - -`Promise`<[`BlockWithTransactions`](../interfaces/verida_web_helpers._internal_.BlockWithTransactions.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:136 - -___ - -### getCode - -▸ `Abstract` **getCode**(`addressOrName`, `blockTag?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `addressOrName` | `string` \| `Promise`<`string`\> | -| `blockTag?` | [`BlockTag`](../modules/verida_web_helpers._internal_.md#blocktag) \| `Promise`<[`BlockTag`](../modules/verida_web_helpers._internal_.md#blocktag)\> | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:130 - -___ - -### getFeeData - -▸ **getFeeData**(): `Promise`<[`FeeData`](../interfaces/verida_web_helpers._internal_.FeeData.md)\> - -#### Returns - -`Promise`<[`FeeData`](../interfaces/verida_web_helpers._internal_.FeeData.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:127 - -___ - -### getGasPrice - -▸ `Abstract` **getGasPrice**(): `Promise`<[`BigNumber`](verida_web_helpers._internal_.BigNumber.md)\> - -#### Returns - -`Promise`<[`BigNumber`](verida_web_helpers._internal_.BigNumber.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:126 - -___ - -### getLogs - -▸ `Abstract` **getLogs**(`filter`): `Promise`<[`Log`](../interfaces/verida_web_helpers._internal_.Log.md)[]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `filter` | [`Filter`](../interfaces/verida_web_helpers._internal_.Filter.md) | - -#### Returns - -`Promise`<[`Log`](../interfaces/verida_web_helpers._internal_.Log.md)[]\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:139 - -___ - -### getNetwork - -▸ `Abstract` **getNetwork**(): `Promise`<[`Network`](../modules/verida_web_helpers._internal_.md#network)\> - -#### Returns - -`Promise`<[`Network`](../modules/verida_web_helpers._internal_.md#network)\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:124 - -___ - -### getStorageAt - -▸ `Abstract` **getStorageAt**(`addressOrName`, `position`, `blockTag?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `addressOrName` | `string` \| `Promise`<`string`\> | -| `position` | [`BigNumberish`](../modules/verida_web_helpers._internal_.md#bignumberish) \| `Promise`<[`BigNumberish`](../modules/verida_web_helpers._internal_.md#bignumberish)\> | -| `blockTag?` | [`BlockTag`](../modules/verida_web_helpers._internal_.md#blocktag) \| `Promise`<[`BlockTag`](../modules/verida_web_helpers._internal_.md#blocktag)\> | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:131 - -___ - -### getTransaction - -▸ `Abstract` **getTransaction**(`transactionHash`): `Promise`<[`TransactionResponse`](../interfaces/verida_web_helpers._internal_.TransactionResponse.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transactionHash` | `string` | - -#### Returns - -`Promise`<[`TransactionResponse`](../interfaces/verida_web_helpers._internal_.TransactionResponse.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:137 - -___ - -### getTransactionCount - -▸ `Abstract` **getTransactionCount**(`addressOrName`, `blockTag?`): `Promise`<`number`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `addressOrName` | `string` \| `Promise`<`string`\> | -| `blockTag?` | [`BlockTag`](../modules/verida_web_helpers._internal_.md#blocktag) \| `Promise`<[`BlockTag`](../modules/verida_web_helpers._internal_.md#blocktag)\> | - -#### Returns - -`Promise`<`number`\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:129 - -___ - -### getTransactionReceipt - -▸ `Abstract` **getTransactionReceipt**(`transactionHash`): `Promise`<[`TransactionReceipt`](../interfaces/verida_web_helpers._internal_.TransactionReceipt.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transactionHash` | `string` | - -#### Returns - -`Promise`<[`TransactionReceipt`](../interfaces/verida_web_helpers._internal_.TransactionReceipt.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:138 - -___ - -### listenerCount - -▸ `Abstract` **listenerCount**(`eventName?`): `number` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName?` | [`EventType`](../modules/verida_web_helpers._internal_.md#eventtype) | - -#### Returns - -`number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:145 - -___ - -### listeners - -▸ `Abstract` **listeners**(`eventName?`): [`Listener`](../modules/verida_web_helpers._internal_.md#listener)[] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName?` | [`EventType`](../modules/verida_web_helpers._internal_.md#eventtype) | - -#### Returns - -[`Listener`](../modules/verida_web_helpers._internal_.md#listener)[] - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:146 - -___ - -### lookupAddress - -▸ `Abstract` **lookupAddress**(`address`): `Promise`<``null`` \| `string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `address` | `string` \| `Promise`<`string`\> | - -#### Returns - -`Promise`<``null`` \| `string`\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:141 - -___ - -### off - -▸ `Abstract` **off**(`eventName`, `listener?`): [`Provider`](verida_web_helpers._internal_.Provider.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | [`EventType`](../modules/verida_web_helpers._internal_.md#eventtype) | -| `listener?` | [`Listener`](../modules/verida_web_helpers._internal_.md#listener) | - -#### Returns - -[`Provider`](verida_web_helpers._internal_.Provider.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:147 - -___ - -### on - -▸ `Abstract` **on**(`eventName`, `listener`): [`Provider`](verida_web_helpers._internal_.Provider.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | [`EventType`](../modules/verida_web_helpers._internal_.md#eventtype) | -| `listener` | [`Listener`](../modules/verida_web_helpers._internal_.md#listener) | - -#### Returns - -[`Provider`](verida_web_helpers._internal_.Provider.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:142 - -___ - -### once - -▸ `Abstract` **once**(`eventName`, `listener`): [`Provider`](verida_web_helpers._internal_.Provider.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | [`EventType`](../modules/verida_web_helpers._internal_.md#eventtype) | -| `listener` | [`Listener`](../modules/verida_web_helpers._internal_.md#listener) | - -#### Returns - -[`Provider`](verida_web_helpers._internal_.Provider.md) - -#### Implementation of - -[OnceBlockable](../interfaces/verida_web_helpers._internal_.OnceBlockable.md).[once](../interfaces/verida_web_helpers._internal_.OnceBlockable.md#once) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:143 - -___ - -### removeAllListeners - -▸ `Abstract` **removeAllListeners**(`eventName?`): [`Provider`](verida_web_helpers._internal_.Provider.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName?` | [`EventType`](../modules/verida_web_helpers._internal_.md#eventtype) | - -#### Returns - -[`Provider`](verida_web_helpers._internal_.Provider.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:148 - -___ - -### removeListener - -▸ **removeListener**(`eventName`, `listener`): [`Provider`](verida_web_helpers._internal_.Provider.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | [`EventType`](../modules/verida_web_helpers._internal_.md#eventtype) | -| `listener` | [`Listener`](../modules/verida_web_helpers._internal_.md#listener) | - -#### Returns - -[`Provider`](verida_web_helpers._internal_.Provider.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:150 - -___ - -### resolveName - -▸ `Abstract` **resolveName**(`name`): `Promise`<``null`` \| `string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` \| `Promise`<`string`\> | - -#### Returns - -`Promise`<``null`` \| `string`\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:140 - -___ - -### sendTransaction - -▸ `Abstract` **sendTransaction**(`signedTransaction`): `Promise`<[`TransactionResponse`](../interfaces/verida_web_helpers._internal_.TransactionResponse.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `signedTransaction` | `string` \| `Promise`<`string`\> | - -#### Returns - -`Promise`<[`TransactionResponse`](../interfaces/verida_web_helpers._internal_.TransactionResponse.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:132 - -___ - -### waitForTransaction - -▸ `Abstract` **waitForTransaction**(`transactionHash`, `confirmations?`, `timeout?`): `Promise`<[`TransactionReceipt`](../interfaces/verida_web_helpers._internal_.TransactionReceipt.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transactionHash` | `string` | -| `confirmations?` | `number` | -| `timeout?` | `number` | - -#### Returns - -`Promise`<[`TransactionReceipt`](../interfaces/verida_web_helpers._internal_.TransactionReceipt.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:151 - -___ - -### isProvider - -▸ `Static` **isProvider**(`value`): value is Provider - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `any` | - -#### Returns - -value is Provider - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:154 diff --git a/docs/api/verida-js/classes/verida_web_helpers._internal_.Schema.md b/docs/api/verida-js/classes/verida_web_helpers._internal_.Schema.md deleted file mode 100644 index 99511cc..0000000 --- a/docs/api/verida-js/classes/verida_web_helpers._internal_.Schema.md +++ /dev/null @@ -1,401 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / Schema - -# Class: Schema - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).Schema - -## Implements - -- [`ISchema`](../interfaces/verida_web_helpers._internal_.ISchema.md) - -## Table of contents - -### Constructors - -- [constructor](verida_web_helpers._internal_.Schema.md#constructor) - -### Properties - -- [ajv](verida_web_helpers._internal_.Schema.md#ajv) -- [errors](verida_web_helpers._internal_.Schema.md#errors) -- [finalPath](verida_web_helpers._internal_.Schema.md#finalpath) -- [path](verida_web_helpers._internal_.Schema.md#path) -- [schemaJson](verida_web_helpers._internal_.Schema.md#schemajson) -- [specification](verida_web_helpers._internal_.Schema.md#specification) -- [validateFunction](verida_web_helpers._internal_.Schema.md#validatefunction) -- [schemaPaths](verida_web_helpers._internal_.Schema.md#schemapaths) -- [schemas](verida_web_helpers._internal_.Schema.md#schemas) - -### Methods - -- [getAppearance](verida_web_helpers._internal_.Schema.md#getappearance) -- [getPath](verida_web_helpers._internal_.Schema.md#getpath) -- [getSchemaJson](verida_web_helpers._internal_.Schema.md#getschemajson) -- [getSpecification](verida_web_helpers._internal_.Schema.md#getspecification) -- [validate](verida_web_helpers._internal_.Schema.md#validate) -- [getSchema](verida_web_helpers._internal_.Schema.md#getschema) -- [getSchemaPaths](verida_web_helpers._internal_.Schema.md#getschemapaths) -- [getVersionlessSchemaName](verida_web_helpers._internal_.Schema.md#getversionlessschemaname) -- [loadJson](verida_web_helpers._internal_.Schema.md#loadjson) -- [resolvePath](verida_web_helpers._internal_.Schema.md#resolvepath) -- [setSchemaPaths](verida_web_helpers._internal_.Schema.md#setschemapaths) - -## Constructors - -### constructor - -• **new Schema**(`path`, `options?`) - -An object representation of a JSON Schema. - -**Do not instantiate directly.** - -Access via {@link App#getSchema} - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `path` | `string` | Path to a schema in the form (http://..../schema.json, /schemas/name/schema.json, name/of/schema) | -| `options?` | `any` | - | - -#### Defined in - -packages/client-ts/dist/context/schema.d.ts:26 - -## Properties - -### ajv - -• `Protected` **ajv**: [`Ajv2020`](verida_web_helpers._internal_.Ajv2020.md) - -#### Defined in - -packages/client-ts/dist/context/schema.d.ts:10 - -___ - -### errors - -• **errors**: `string`[] - -#### Implementation of - -[ISchema](../interfaces/verida_web_helpers._internal_.ISchema.md).[errors](../interfaces/verida_web_helpers._internal_.ISchema.md#errors) - -#### Defined in - -packages/client-ts/dist/context/schema.d.ts:8 - -___ - -### finalPath - -• `Protected` `Optional` **finalPath**: `string` - -#### Defined in - -packages/client-ts/dist/context/schema.d.ts:12 - -___ - -### path - -• `Protected` **path**: `string` - -#### Defined in - -packages/client-ts/dist/context/schema.d.ts:9 - -___ - -### schemaJson - -• `Protected` `Optional` **schemaJson**: `object` - -#### Defined in - -packages/client-ts/dist/context/schema.d.ts:11 - -___ - -### specification - -• `Protected` `Optional` **specification**: `any` - -#### Defined in - -packages/client-ts/dist/context/schema.d.ts:13 - -___ - -### validateFunction - -• `Protected` `Optional` **validateFunction**: `any` - -#### Defined in - -packages/client-ts/dist/context/schema.d.ts:14 - -___ - -### schemaPaths - -▪ `Static` `Protected` `Optional` **schemaPaths**: [`Record`](../modules/verida_web_helpers._internal_.md#record)<`string`, `string`\> - -#### Defined in - -packages/client-ts/dist/context/schema.d.ts:15 - -___ - -### schemas - -▪ `Static` `Protected` **schemas**: `any` - -#### Defined in - -packages/client-ts/dist/context/schema.d.ts:16 - -## Methods - -### getAppearance - -▸ **getAppearance**(): `Promise`<`any`\> - -#### Returns - -`Promise`<`any`\> - -#### Implementation of - -[ISchema](../interfaces/verida_web_helpers._internal_.ISchema.md).[getAppearance](../interfaces/verida_web_helpers._internal_.ISchema.md#getappearance) - -#### Defined in - -packages/client-ts/dist/context/schema.d.ts:53 - -___ - -### getPath - -▸ `Protected` **getPath**(): `Promise`<`string`\> - -Get a rully resolveable path for a URL - -Handle shortened paths: - - `health/activity` -> `https://common.schemas.verida.io/health/activity/latest/schema.json` - - `https://common/schemas.verida.io/health/activity/latest` -> `https://common.schemas.verida.io/health/activity/latest/schema.json` - - `/health/activity/test.json` -> `https://common/schemas.verida.io/health/activity/test.json` - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -packages/client-ts/dist/context/schema.d.ts:62 - -___ - -### getSchemaJson - -▸ **getSchemaJson**(): `Promise`<`object`\> - -Fetch unresolved JSON schema - -#### Returns - -`Promise`<`object`\> - -#### Implementation of - -[ISchema](../interfaces/verida_web_helpers._internal_.ISchema.md).[getSchemaJson](../interfaces/verida_web_helpers._internal_.ISchema.md#getschemajson) - -#### Defined in - -packages/client-ts/dist/context/schema.d.ts:52 - -___ - -### getSpecification - -▸ **getSpecification**(): `Promise`<`any`\> - -**`todo:`** Deprecate in favour of `getProperties()` -Get an object that represents the JSON Schema. Fully resolved. -Warning: This can cause issues with very large schemas. - -**`example`** -let schemaDoc = await app.getSchema("social/contact"); -let spec = schemaDoc.getSpecification(); -console.log(spec); - -#### Returns - -`Promise`<`any`\> - -JSON object representing the defereferenced schema - -#### Implementation of - -[ISchema](../interfaces/verida_web_helpers._internal_.ISchema.md).[getSpecification](../interfaces/verida_web_helpers._internal_.ISchema.md#getspecification) - -#### Defined in - -packages/client-ts/dist/context/schema.d.ts:41 - -___ - -### validate - -▸ **validate**(`data`): `Promise`<`boolean`\> - -Validate a data object with this schema, using AJV - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `any` | - -#### Returns - -`Promise`<`boolean`\> - -True if the data validates against the schema. - -#### Implementation of - -[ISchema](../interfaces/verida_web_helpers._internal_.ISchema.md).[validate](../interfaces/verida_web_helpers._internal_.ISchema.md#validate) - -#### Defined in - -packages/client-ts/dist/context/schema.d.ts:48 - -___ - -### getSchema - -▸ `Static` **getSchema**(`schemaName`): `Promise`<[`Schema`](verida_web_helpers._internal_.Schema.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schemaName` | `string` | - -#### Returns - -`Promise`<[`Schema`](verida_web_helpers._internal_.Schema.md)\> - -#### Defined in - -packages/client-ts/dist/context/schema.d.ts:27 - -___ - -### getSchemaPaths - -▸ `Static` **getSchemaPaths**(): [`Record`](../modules/verida_web_helpers._internal_.md#record)<`string`, `string`\> - -#### Returns - -[`Record`](../modules/verida_web_helpers._internal_.md#record)<`string`, `string`\> - -#### Defined in - -packages/client-ts/dist/context/schema.d.ts:29 - -___ - -### getVersionlessSchemaName - -▸ `Static` **getVersionlessSchemaName**(`schemaName`): `string` - -Checks a version specified in schemaName - -SchemaName example :- https://core.schemas.verida.io/base/v0.1.0/schema.json -SchemaName format :- https://{protocol-name}/{name}/{v}{version}/name.json - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schemaName` | `string` | - -#### Returns - -`string` - -schemaName without the version - -#### Defined in - -packages/client-ts/dist/context/schema.d.ts:84 - -___ - -### loadJson - -▸ `Static` **loadJson**(`uri`): `Promise`<`object`\> - -Load JSON from a url that is fully resolved. - -Used by AJV. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `uri` | `string` | - -#### Returns - -`Promise`<`object`\> - -#### Defined in - -packages/client-ts/dist/context/schema.d.ts:75 - -___ - -### resolvePath - -▸ `Static` **resolvePath**(`uri`): `Promise`<`string`\> - -Force schema paths to be applied to URLs - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `uri` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -packages/client-ts/dist/context/schema.d.ts:67 - -___ - -### setSchemaPaths - -▸ `Static` **setSchemaPaths**(`schemaPaths`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schemaPaths` | [`Record`](../modules/verida_web_helpers._internal_.md#record)<`string`, `string`\> | - -#### Returns - -`void` - -#### Defined in - -packages/client-ts/dist/context/schema.d.ts:28 diff --git a/docs/api/verida-js/classes/verida_web_helpers._internal_.SchemaEnv.md b/docs/api/verida-js/classes/verida_web_helpers._internal_.SchemaEnv.md deleted file mode 100644 index 8b07dd8..0000000 --- a/docs/api/verida-js/classes/verida_web_helpers._internal_.SchemaEnv.md +++ /dev/null @@ -1,266 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / SchemaEnv - -# Class: SchemaEnv - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).SchemaEnv - -## Implements - -- [`SchemaEnvArgs`](../interfaces/verida_web_helpers._internal_.SchemaEnvArgs.md) - -## Table of contents - -### Constructors - -- [constructor](verida_web_helpers._internal_.SchemaEnv.md#constructor) - -### Properties - -- [$async](verida_web_helpers._internal_.SchemaEnv.md#$async) -- [baseId](verida_web_helpers._internal_.SchemaEnv.md#baseid) -- [dynamicAnchors](verida_web_helpers._internal_.SchemaEnv.md#dynamicanchors) -- [localRefs](verida_web_helpers._internal_.SchemaEnv.md#localrefs) -- [meta](verida_web_helpers._internal_.SchemaEnv.md#meta) -- [parse](verida_web_helpers._internal_.SchemaEnv.md#parse) -- [parseName](verida_web_helpers._internal_.SchemaEnv.md#parsename) -- [refs](verida_web_helpers._internal_.SchemaEnv.md#refs) -- [root](verida_web_helpers._internal_.SchemaEnv.md#root) -- [schema](verida_web_helpers._internal_.SchemaEnv.md#schema) -- [schemaId](verida_web_helpers._internal_.SchemaEnv.md#schemaid) -- [schemaPath](verida_web_helpers._internal_.SchemaEnv.md#schemapath) -- [serialize](verida_web_helpers._internal_.SchemaEnv.md#serialize) -- [serializeName](verida_web_helpers._internal_.SchemaEnv.md#serializename) -- [validate](verida_web_helpers._internal_.SchemaEnv.md#validate) -- [validateName](verida_web_helpers._internal_.SchemaEnv.md#validatename) - -## Constructors - -### constructor - -• **new SchemaEnv**(`env`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `env` | [`SchemaEnvArgs`](../interfaces/verida_web_helpers._internal_.SchemaEnvArgs.md) | - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:73 - -## Properties - -### $async - -• `Optional` `Readonly` **$async**: `boolean` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:62 - -___ - -### baseId - -• **baseId**: `string` - -#### Implementation of - -[SchemaEnvArgs](../interfaces/verida_web_helpers._internal_.SchemaEnvArgs.md).[baseId](../interfaces/verida_web_helpers._internal_.SchemaEnvArgs.md#baseid) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:58 - -___ - -### dynamicAnchors - -• `Readonly` **dynamicAnchors**: `Object` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:64 - -___ - -### localRefs - -• `Optional` **localRefs**: [`LocalRefs`](../modules/verida_web_helpers._internal_.md#localrefs) - -#### Implementation of - -[SchemaEnvArgs](../interfaces/verida_web_helpers._internal_.SchemaEnvArgs.md).[localRefs](../interfaces/verida_web_helpers._internal_.SchemaEnvArgs.md#localrefs) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:60 - -___ - -### meta - -• `Optional` `Readonly` **meta**: `boolean` - -#### Implementation of - -[SchemaEnvArgs](../interfaces/verida_web_helpers._internal_.SchemaEnvArgs.md).[meta](../interfaces/verida_web_helpers._internal_.SchemaEnvArgs.md#meta) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:61 - -___ - -### parse - -• `Optional` **parse**: (`data`: `string`) => `unknown` - -#### Type declaration - -▸ (`data`): `unknown` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `string` | - -##### Returns - -`unknown` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:71 - -___ - -### parseName - -• `Optional` **parseName**: [`ValueScopeName`](verida_web_helpers._internal_.ValueScopeName.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:72 - -___ - -### refs - -• `Readonly` **refs**: [`SchemaRefs`](../modules/verida_web_helpers._internal_.md#schemarefs) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:63 - -___ - -### root - -• `Readonly` **root**: [`SchemaEnv`](verida_web_helpers._internal_.SchemaEnv.md) - -#### Implementation of - -[SchemaEnvArgs](../interfaces/verida_web_helpers._internal_.SchemaEnvArgs.md).[root](../interfaces/verida_web_helpers._internal_.SchemaEnvArgs.md#root) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:57 - -___ - -### schema - -• `Readonly` **schema**: [`AnySchema`](../modules/verida_web_helpers._internal_.md#anyschema) - -#### Implementation of - -[SchemaEnvArgs](../interfaces/verida_web_helpers._internal_.SchemaEnvArgs.md).[schema](../interfaces/verida_web_helpers._internal_.SchemaEnvArgs.md#schema) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:55 - -___ - -### schemaId - -• `Optional` `Readonly` **schemaId**: ``"id"`` \| ``"$id"`` - -#### Implementation of - -[SchemaEnvArgs](../interfaces/verida_web_helpers._internal_.SchemaEnvArgs.md).[schemaId](../interfaces/verida_web_helpers._internal_.SchemaEnvArgs.md#schemaid) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:56 - -___ - -### schemaPath - -• `Optional` **schemaPath**: `string` - -#### Implementation of - -[SchemaEnvArgs](../interfaces/verida_web_helpers._internal_.SchemaEnvArgs.md).[schemaPath](../interfaces/verida_web_helpers._internal_.SchemaEnvArgs.md#schemapath) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:59 - -___ - -### serialize - -• `Optional` **serialize**: (`data`: `unknown`) => `string` - -#### Type declaration - -▸ (`data`): `string` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `unknown` | - -##### Returns - -`string` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:69 - -___ - -### serializeName - -• `Optional` **serializeName**: [`ValueScopeName`](verida_web_helpers._internal_.ValueScopeName.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:70 - -___ - -### validate - -• `Optional` **validate**: [`AnyValidateFunction`](../modules/verida_web_helpers._internal_.md#anyvalidatefunction)<`any`\> - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:67 - -___ - -### validateName - -• `Optional` **validateName**: [`ValueScopeName`](verida_web_helpers._internal_.ValueScopeName.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:68 diff --git a/docs/api/verida-js/classes/verida_web_helpers._internal_.Scope.md b/docs/api/verida-js/classes/verida_web_helpers._internal_.Scope.md deleted file mode 100644 index 2073571..0000000 --- a/docs/api/verida-js/classes/verida_web_helpers._internal_.Scope.md +++ /dev/null @@ -1,146 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / Scope - -# Class: Scope - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).Scope - -## Hierarchy - -- **`Scope`** - - ↳ [`ValueScope`](verida_web_helpers._internal_.ValueScope.md) - -## Table of contents - -### Constructors - -- [constructor](verida_web_helpers._internal_.Scope.md#constructor) - -### Properties - -- [\_nameGroup](verida_web_helpers._internal_.Scope.md#_namegroup) -- [\_names](verida_web_helpers._internal_.Scope.md#_names) -- [\_parent](verida_web_helpers._internal_.Scope.md#_parent) -- [\_prefixes](verida_web_helpers._internal_.Scope.md#_prefixes) - -### Methods - -- [\_newName](verida_web_helpers._internal_.Scope.md#_newname) -- [name](verida_web_helpers._internal_.Scope.md#name) -- [toName](verida_web_helpers._internal_.Scope.md#toname) - -## Constructors - -### constructor - -• **new Scope**(`__namedParameters?`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `__namedParameters?` | [`ScopeOptions`](../interfaces/verida_web_helpers._internal_.ScopeOptions.md) | - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/scope.d.ts:46 - -## Properties - -### \_nameGroup - -• `Private` **\_nameGroup**: `any` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/scope.d.ts:50 - -___ - -### \_names - -• `Protected` `Readonly` **\_names**: `Object` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/scope.d.ts:41 - -___ - -### \_parent - -• `Protected` `Optional` `Readonly` **\_parent**: [`Scope`](verida_web_helpers._internal_.Scope.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/scope.d.ts:45 - -___ - -### \_prefixes - -• `Protected` `Optional` `Readonly` **\_prefixes**: `Set`<`string`\> - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/scope.d.ts:44 - -## Methods - -### \_newName - -▸ `Protected` **_newName**(`prefix`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `prefix` | `string` | - -#### Returns - -`string` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/scope.d.ts:49 - -___ - -### name - -▸ **name**(`prefix`): [`Name`](verida_web_helpers._internal_.Name.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `prefix` | `string` | - -#### Returns - -[`Name`](verida_web_helpers._internal_.Name.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/scope.d.ts:48 - -___ - -### toName - -▸ **toName**(`nameOrPrefix`): [`Name`](verida_web_helpers._internal_.Name.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `nameOrPrefix` | `string` \| [`Name`](verida_web_helpers._internal_.Name.md) | - -#### Returns - -[`Name`](verida_web_helpers._internal_.Name.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/scope.d.ts:47 diff --git a/docs/api/verida-js/classes/verida_web_helpers._internal_.Signer.md b/docs/api/verida-js/classes/verida_web_helpers._internal_.Signer.md deleted file mode 100644 index 156d0ee..0000000 --- a/docs/api/verida-js/classes/verida_web_helpers._internal_.Signer.md +++ /dev/null @@ -1,383 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / Signer - -# Class: Signer - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).Signer - -## Table of contents - -### Constructors - -- [constructor](verida_web_helpers._internal_.Signer.md#constructor) - -### Properties - -- [\_isSigner](verida_web_helpers._internal_.Signer.md#_issigner) -- [provider](verida_web_helpers._internal_.Signer.md#provider) - -### Methods - -- [\_checkProvider](verida_web_helpers._internal_.Signer.md#_checkprovider) -- [call](verida_web_helpers._internal_.Signer.md#call) -- [checkTransaction](verida_web_helpers._internal_.Signer.md#checktransaction) -- [connect](verida_web_helpers._internal_.Signer.md#connect) -- [estimateGas](verida_web_helpers._internal_.Signer.md#estimategas) -- [getAddress](verida_web_helpers._internal_.Signer.md#getaddress) -- [getBalance](verida_web_helpers._internal_.Signer.md#getbalance) -- [getChainId](verida_web_helpers._internal_.Signer.md#getchainid) -- [getFeeData](verida_web_helpers._internal_.Signer.md#getfeedata) -- [getGasPrice](verida_web_helpers._internal_.Signer.md#getgasprice) -- [getTransactionCount](verida_web_helpers._internal_.Signer.md#gettransactioncount) -- [populateTransaction](verida_web_helpers._internal_.Signer.md#populatetransaction) -- [resolveName](verida_web_helpers._internal_.Signer.md#resolvename) -- [sendTransaction](verida_web_helpers._internal_.Signer.md#sendtransaction) -- [signMessage](verida_web_helpers._internal_.Signer.md#signmessage) -- [signTransaction](verida_web_helpers._internal_.Signer.md#signtransaction) -- [isSigner](verida_web_helpers._internal_.Signer.md#issigner) - -## Constructors - -### constructor - -• **new Signer**() - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:30 - -## Properties - -### \_isSigner - -• `Readonly` **\_isSigner**: `boolean` - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:29 - -___ - -### provider - -• `Optional` `Readonly` **provider**: [`Provider`](verida_web_helpers._internal_.Provider.md) - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:24 - -## Methods - -### \_checkProvider - -▸ **_checkProvider**(`operation?`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `operation?` | `string` | - -#### Returns - -`void` - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:42 - -___ - -### call - -▸ **call**(`transaction`, `blockTag?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transaction` | [`Deferrable`](../modules/verida_web_helpers._internal_.md#deferrable)<[`TransactionRequest`](../modules/verida_web_helpers._internal_.md#transactionrequest)\> | -| `blockTag?` | [`BlockTag`](../modules/verida_web_helpers._internal_.md#blocktag) | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:34 - -___ - -### checkTransaction - -▸ **checkTransaction**(`transaction`): [`Deferrable`](../modules/verida_web_helpers._internal_.md#deferrable)<[`TransactionRequest`](../modules/verida_web_helpers._internal_.md#transactionrequest)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transaction` | [`Deferrable`](../modules/verida_web_helpers._internal_.md#deferrable)<[`TransactionRequest`](../modules/verida_web_helpers._internal_.md#transactionrequest)\> | - -#### Returns - -[`Deferrable`](../modules/verida_web_helpers._internal_.md#deferrable)<[`TransactionRequest`](../modules/verida_web_helpers._internal_.md#transactionrequest)\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:40 - -___ - -### connect - -▸ `Abstract` **connect**(`provider`): [`Signer`](verida_web_helpers._internal_.Signer.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `provider` | [`Provider`](verida_web_helpers._internal_.Provider.md) | - -#### Returns - -[`Signer`](verida_web_helpers._internal_.Signer.md) - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:28 - -___ - -### estimateGas - -▸ **estimateGas**(`transaction`): `Promise`<[`BigNumber`](verida_web_helpers._internal_.BigNumber.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transaction` | [`Deferrable`](../modules/verida_web_helpers._internal_.md#deferrable)<[`TransactionRequest`](../modules/verida_web_helpers._internal_.md#transactionrequest)\> | - -#### Returns - -`Promise`<[`BigNumber`](verida_web_helpers._internal_.BigNumber.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:33 - -___ - -### getAddress - -▸ `Abstract` **getAddress**(): `Promise`<`string`\> - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:25 - -___ - -### getBalance - -▸ **getBalance**(`blockTag?`): `Promise`<[`BigNumber`](verida_web_helpers._internal_.BigNumber.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `blockTag?` | [`BlockTag`](../modules/verida_web_helpers._internal_.md#blocktag) | - -#### Returns - -`Promise`<[`BigNumber`](verida_web_helpers._internal_.BigNumber.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:31 - -___ - -### getChainId - -▸ **getChainId**(): `Promise`<`number`\> - -#### Returns - -`Promise`<`number`\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:36 - -___ - -### getFeeData - -▸ **getFeeData**(): `Promise`<[`FeeData`](../interfaces/verida_web_helpers._internal_.FeeData.md)\> - -#### Returns - -`Promise`<[`FeeData`](../interfaces/verida_web_helpers._internal_.FeeData.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:38 - -___ - -### getGasPrice - -▸ **getGasPrice**(): `Promise`<[`BigNumber`](verida_web_helpers._internal_.BigNumber.md)\> - -#### Returns - -`Promise`<[`BigNumber`](verida_web_helpers._internal_.BigNumber.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:37 - -___ - -### getTransactionCount - -▸ **getTransactionCount**(`blockTag?`): `Promise`<`number`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `blockTag?` | [`BlockTag`](../modules/verida_web_helpers._internal_.md#blocktag) | - -#### Returns - -`Promise`<`number`\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:32 - -___ - -### populateTransaction - -▸ **populateTransaction**(`transaction`): `Promise`<[`TransactionRequest`](../modules/verida_web_helpers._internal_.md#transactionrequest)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transaction` | [`Deferrable`](../modules/verida_web_helpers._internal_.md#deferrable)<[`TransactionRequest`](../modules/verida_web_helpers._internal_.md#transactionrequest)\> | - -#### Returns - -`Promise`<[`TransactionRequest`](../modules/verida_web_helpers._internal_.md#transactionrequest)\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:41 - -___ - -### resolveName - -▸ **resolveName**(`name`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:39 - -___ - -### sendTransaction - -▸ **sendTransaction**(`transaction`): `Promise`<[`TransactionResponse`](../interfaces/verida_web_helpers._internal_.TransactionResponse.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transaction` | [`Deferrable`](../modules/verida_web_helpers._internal_.md#deferrable)<[`TransactionRequest`](../modules/verida_web_helpers._internal_.md#transactionrequest)\> | - -#### Returns - -`Promise`<[`TransactionResponse`](../interfaces/verida_web_helpers._internal_.TransactionResponse.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:35 - -___ - -### signMessage - -▸ `Abstract` **signMessage**(`message`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `message` | `string` \| [`Bytes`](../modules/verida_web_helpers._internal_.md#bytes) | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:26 - -___ - -### signTransaction - -▸ `Abstract` **signTransaction**(`transaction`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transaction` | [`Deferrable`](../modules/verida_web_helpers._internal_.md#deferrable)<[`TransactionRequest`](../modules/verida_web_helpers._internal_.md#transactionrequest)\> | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:27 - -___ - -### isSigner - -▸ `Static` **isSigner**(`value`): value is Signer - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `any` | - -#### Returns - -value is Signer - -#### Defined in - -node_modules/@ethersproject/abstract-signer/lib/index.d.ts:43 diff --git a/docs/api/verida-js/classes/verida_web_helpers._internal_.ValueScope.md b/docs/api/verida-js/classes/verida_web_helpers._internal_.ValueScope.md deleted file mode 100644 index 437e89f..0000000 --- a/docs/api/verida-js/classes/verida_web_helpers._internal_.ValueScope.md +++ /dev/null @@ -1,311 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / ValueScope - -# Class: ValueScope - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).ValueScope - -## Hierarchy - -- [`Scope`](verida_web_helpers._internal_.Scope.md) - - ↳ **`ValueScope`** - -## Table of contents - -### Constructors - -- [constructor](verida_web_helpers._internal_.ValueScope.md#constructor) - -### Properties - -- [\_names](verida_web_helpers._internal_.ValueScope.md#_names) -- [\_parent](verida_web_helpers._internal_.ValueScope.md#_parent) -- [\_prefixes](verida_web_helpers._internal_.ValueScope.md#_prefixes) -- [\_reduceValues](verida_web_helpers._internal_.ValueScope.md#_reducevalues) -- [\_scope](verida_web_helpers._internal_.ValueScope.md#_scope) -- [\_values](verida_web_helpers._internal_.ValueScope.md#_values) -- [opts](verida_web_helpers._internal_.ValueScope.md#opts) - -### Methods - -- [\_newName](verida_web_helpers._internal_.ValueScope.md#_newname) -- [get](verida_web_helpers._internal_.ValueScope.md#get) -- [getValue](verida_web_helpers._internal_.ValueScope.md#getvalue) -- [name](verida_web_helpers._internal_.ValueScope.md#name) -- [scopeCode](verida_web_helpers._internal_.ValueScope.md#scopecode) -- [scopeRefs](verida_web_helpers._internal_.ValueScope.md#scoperefs) -- [toName](verida_web_helpers._internal_.ValueScope.md#toname) -- [value](verida_web_helpers._internal_.ValueScope.md#value) - -## Constructors - -### constructor - -• **new ValueScope**(`opts`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `opts` | [`ValueScopeOptions`](../interfaces/verida_web_helpers._internal_.ValueScopeOptions.md) | - -#### Overrides - -[Scope](verida_web_helpers._internal_.Scope.md).[constructor](verida_web_helpers._internal_.Scope.md#constructor) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/scope.d.ts:70 - -## Properties - -### \_names - -• `Protected` `Readonly` **\_names**: `Object` - -#### Inherited from - -[Scope](verida_web_helpers._internal_.Scope.md).[_names](verida_web_helpers._internal_.Scope.md#_names) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/scope.d.ts:41 - -___ - -### \_parent - -• `Protected` `Optional` `Readonly` **\_parent**: [`Scope`](verida_web_helpers._internal_.Scope.md) - -#### Inherited from - -[Scope](verida_web_helpers._internal_.Scope.md).[_parent](verida_web_helpers._internal_.Scope.md#_parent) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/scope.d.ts:45 - -___ - -### \_prefixes - -• `Protected` `Optional` `Readonly` **\_prefixes**: `Set`<`string`\> - -#### Inherited from - -[Scope](verida_web_helpers._internal_.Scope.md).[_prefixes](verida_web_helpers._internal_.Scope.md#_prefixes) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/scope.d.ts:44 - -___ - -### \_reduceValues - -• `Private` **\_reduceValues**: `any` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/scope.d.ts:77 - -___ - -### \_scope - -• `Protected` `Readonly` **\_scope**: [`ScopeStore`](../modules/verida_web_helpers._internal_.md#scopestore) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/scope.d.ts:68 - -___ - -### \_values - -• `Protected` `Readonly` **\_values**: [`ScopeValues`](../modules/verida_web_helpers._internal_.md#scopevalues) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/scope.d.ts:67 - -___ - -### opts - -• `Readonly` **opts**: [`VSOptions`](../interfaces/verida_web_helpers._internal_.VSOptions.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/scope.d.ts:69 - -## Methods - -### \_newName - -▸ `Protected` **_newName**(`prefix`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `prefix` | `string` | - -#### Returns - -`string` - -#### Inherited from - -[Scope](verida_web_helpers._internal_.Scope.md).[_newName](verida_web_helpers._internal_.Scope.md#_newname) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/scope.d.ts:49 - -___ - -### get - -▸ **get**(): [`ScopeStore`](../modules/verida_web_helpers._internal_.md#scopestore) - -#### Returns - -[`ScopeStore`](../modules/verida_web_helpers._internal_.md#scopestore) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/scope.d.ts:71 - -___ - -### getValue - -▸ **getValue**(`prefix`, `keyOrRef`): `undefined` \| [`ValueScopeName`](verida_web_helpers._internal_.ValueScopeName.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `prefix` | `string` | -| `keyOrRef` | `unknown` | - -#### Returns - -`undefined` \| [`ValueScopeName`](verida_web_helpers._internal_.ValueScopeName.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/scope.d.ts:74 - -___ - -### name - -▸ **name**(`prefix`): [`ValueScopeName`](verida_web_helpers._internal_.ValueScopeName.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `prefix` | `string` | - -#### Returns - -[`ValueScopeName`](verida_web_helpers._internal_.ValueScopeName.md) - -#### Overrides - -[Scope](verida_web_helpers._internal_.Scope.md).[name](verida_web_helpers._internal_.Scope.md#name) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/scope.d.ts:72 - -___ - -### scopeCode - -▸ **scopeCode**(`values?`, `usedValues?`, `getCode?`): [`Code`](../modules/verida_web_helpers._internal_.md#code) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `values?` | [`ScopeValues`](../modules/verida_web_helpers._internal_.md#scopevalues) \| [`ScopeValueSets`](../modules/verida_web_helpers._internal_.md#scopevaluesets) | -| `usedValues?` | [`UsedScopeValues`](../modules/verida_web_helpers._internal_.md#usedscopevalues) | -| `getCode?` | (`n`: [`ValueScopeName`](verida_web_helpers._internal_.ValueScopeName.md)) => `undefined` \| [`Code`](../modules/verida_web_helpers._internal_.md#code) | - -#### Returns - -[`Code`](../modules/verida_web_helpers._internal_.md#code) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/scope.d.ts:76 - -___ - -### scopeRefs - -▸ **scopeRefs**(`scopeName`, `values?`): [`Code`](../modules/verida_web_helpers._internal_.md#code) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `scopeName` | [`Name`](verida_web_helpers._internal_.Name.md) | -| `values?` | [`ScopeValues`](../modules/verida_web_helpers._internal_.md#scopevalues) \| [`ScopeValueSets`](../modules/verida_web_helpers._internal_.md#scopevaluesets) | - -#### Returns - -[`Code`](../modules/verida_web_helpers._internal_.md#code) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/scope.d.ts:75 - -___ - -### toName - -▸ **toName**(`nameOrPrefix`): [`Name`](verida_web_helpers._internal_.Name.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `nameOrPrefix` | `string` \| [`Name`](verida_web_helpers._internal_.Name.md) | - -#### Returns - -[`Name`](verida_web_helpers._internal_.Name.md) - -#### Inherited from - -[Scope](verida_web_helpers._internal_.Scope.md).[toName](verida_web_helpers._internal_.Scope.md#toname) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/scope.d.ts:47 - -___ - -### value - -▸ **value**(`nameOrPrefix`, `value`): [`ValueScopeName`](verida_web_helpers._internal_.ValueScopeName.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `nameOrPrefix` | `string` \| [`ValueScopeName`](verida_web_helpers._internal_.ValueScopeName.md) | -| `value` | [`NameValue`](../interfaces/verida_web_helpers._internal_.NameValue.md) | - -#### Returns - -[`ValueScopeName`](verida_web_helpers._internal_.ValueScopeName.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/scope.d.ts:73 diff --git a/docs/api/verida-js/classes/verida_web_helpers._internal_.ValueScopeName.md b/docs/api/verida-js/classes/verida_web_helpers._internal_.ValueScopeName.md deleted file mode 100644 index 7ddecac..0000000 --- a/docs/api/verida-js/classes/verida_web_helpers._internal_.ValueScopeName.md +++ /dev/null @@ -1,174 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / ValueScopeName - -# Class: ValueScopeName - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).ValueScopeName - -## Hierarchy - -- [`Name`](verida_web_helpers._internal_.Name.md) - - ↳ **`ValueScopeName`** - -## Table of contents - -### Constructors - -- [constructor](verida_web_helpers._internal_.ValueScopeName.md#constructor) - -### Properties - -- [prefix](verida_web_helpers._internal_.ValueScopeName.md#prefix) -- [scopePath](verida_web_helpers._internal_.ValueScopeName.md#scopepath) -- [str](verida_web_helpers._internal_.ValueScopeName.md#str) -- [value](verida_web_helpers._internal_.ValueScopeName.md#value) - -### Accessors - -- [names](verida_web_helpers._internal_.ValueScopeName.md#names) - -### Methods - -- [emptyStr](verida_web_helpers._internal_.ValueScopeName.md#emptystr) -- [setValue](verida_web_helpers._internal_.ValueScopeName.md#setvalue) -- [toString](verida_web_helpers._internal_.ValueScopeName.md#tostring) - -## Constructors - -### constructor - -• **new ValueScopeName**(`prefix`, `nameStr`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `prefix` | `string` | -| `nameStr` | `string` | - -#### Overrides - -[Name](verida_web_helpers._internal_.Name.md).[constructor](verida_web_helpers._internal_.Name.md#constructor) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/scope.d.ts:60 - -## Properties - -### prefix - -• `Readonly` **prefix**: `string` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/scope.d.ts:57 - -___ - -### scopePath - -• `Optional` **scopePath**: [`Code`](../modules/verida_web_helpers._internal_.md#code) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/scope.d.ts:59 - -___ - -### str - -• `Readonly` **str**: `string` - -#### Inherited from - -[Name](verida_web_helpers._internal_.Name.md).[str](verida_web_helpers._internal_.Name.md#str) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/code.d.ts:9 - -___ - -### value - -• `Optional` **value**: [`NameValue`](../interfaces/verida_web_helpers._internal_.NameValue.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/scope.d.ts:58 - -## Accessors - -### names - -• `get` **names**(): [`UsedNames`](../modules/verida_web_helpers._internal_.md#usednames) - -#### Returns - -[`UsedNames`](../modules/verida_web_helpers._internal_.md#usednames) - -#### Inherited from - -Name.names - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/code.d.ts:13 - -## Methods - -### emptyStr - -▸ **emptyStr**(): `boolean` - -#### Returns - -`boolean` - -#### Inherited from - -[Name](verida_web_helpers._internal_.Name.md).[emptyStr](verida_web_helpers._internal_.Name.md#emptystr) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/code.d.ts:12 - -___ - -### setValue - -▸ **setValue**(`value`, `__namedParameters`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | [`NameValue`](../interfaces/verida_web_helpers._internal_.NameValue.md) | -| `__namedParameters` | [`ScopePath`](../interfaces/verida_web_helpers._internal_.ScopePath.md) | - -#### Returns - -`void` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/scope.d.ts:61 - -___ - -### toString - -▸ **toString**(): `string` - -#### Returns - -`string` - -#### Inherited from - -[Name](verida_web_helpers._internal_.Name.md).[toString](verida_web_helpers._internal_.Name.md#tostring) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/code.d.ts:11 diff --git a/docs/api/verida-js/classes/verida_web_helpers._internal_.VaultAccount.md b/docs/api/verida-js/classes/verida_web_helpers._internal_.VaultAccount.md deleted file mode 100644 index 04cb70c..0000000 --- a/docs/api/verida-js/classes/verida_web_helpers._internal_.VaultAccount.md +++ /dev/null @@ -1,531 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / VaultAccount - -# Class: VaultAccount - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).VaultAccount - -An Authenticator that requests for authorization from the Vault - -## Hierarchy - -- [`default`](verida_web_helpers._internal_.default.md) - - ↳ **`VaultAccount`** - -## Table of contents - -### Constructors - -- [constructor](verida_web_helpers._internal_.VaultAccount.md#constructor) - -### Properties - -- [accountDid](verida_web_helpers._internal_.VaultAccount.md#accountdid) -- [config](verida_web_helpers._internal_.VaultAccount.md#config) -- [contextCache](verida_web_helpers._internal_.VaultAccount.md#contextcache) -- [getAxios](verida_web_helpers._internal_.VaultAccount.md#getaxios) -- [locateEndpointContextAuth](verida_web_helpers._internal_.VaultAccount.md#locateendpointcontextauth) - -### Methods - -- [addContext](verida_web_helpers._internal_.VaultAccount.md#addcontext) -- [connectContext](verida_web_helpers._internal_.VaultAccount.md#connectcontext) -- [contextAuthIsValid](verida_web_helpers._internal_.VaultAccount.md#contextauthisvalid) -- [createDidJwt](verida_web_helpers._internal_.VaultAccount.md#createdidjwt) -- [did](verida_web_helpers._internal_.VaultAccount.md#did) -- [disconnect](verida_web_helpers._internal_.VaultAccount.md#disconnect) -- [disconnectDevice](verida_web_helpers._internal_.VaultAccount.md#disconnectdevice) -- [getAuthContext](verida_web_helpers._internal_.VaultAccount.md#getauthcontext) -- [keyring](verida_web_helpers._internal_.VaultAccount.md#keyring) -- [linkStorage](verida_web_helpers._internal_.VaultAccount.md#linkstorage) -- [linkStorageContextService](verida_web_helpers._internal_.VaultAccount.md#linkstoragecontextservice) -- [loadFromSession](verida_web_helpers._internal_.VaultAccount.md#loadfromsession) -- [setAccountConfig](verida_web_helpers._internal_.VaultAccount.md#setaccountconfig) -- [setDid](verida_web_helpers._internal_.VaultAccount.md#setdid) -- [sign](verida_web_helpers._internal_.VaultAccount.md#sign) -- [storageConfig](verida_web_helpers._internal_.VaultAccount.md#storageconfig) -- [unlinkStorage](verida_web_helpers._internal_.VaultAccount.md#unlinkstorage) - -## Constructors - -### constructor - -• **new VaultAccount**(`config?`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config?` | [`AccountVaultConfig`](../interfaces/verida_web_helpers._internal_.AccountVaultConfig.md) | - -#### Overrides - -[default](verida_web_helpers._internal_.default.md).[constructor](verida_web_helpers._internal_.default.md#constructor) - -#### Defined in - -packages/account-web-vault/dist/vault-account.d.ts:12 - -## Properties - -### accountDid - -• `Private` `Optional` **accountDid**: `any` - -#### Defined in - -packages/account-web-vault/dist/vault-account.d.ts:10 - -___ - -### config - -• `Private` **config**: `any` - -#### Defined in - -packages/account-web-vault/dist/vault-account.d.ts:9 - -___ - -### contextCache - -• `Private` **contextCache**: `any` - -#### Defined in - -packages/account-web-vault/dist/vault-account.d.ts:11 - -___ - -### getAxios - -• `Private` **getAxios**: `any` - -#### Defined in - -packages/account-web-vault/dist/vault-account.d.ts:44 - -___ - -### locateEndpointContextAuth - -• `Private` **locateEndpointContextAuth**: `any` - -#### Defined in - -packages/account-web-vault/dist/vault-account.d.ts:42 - -## Methods - -### addContext - -▸ **addContext**(`contextName`, `contextConfig`, `keyring`, `contextAuths`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | -| `contextConfig` | [`SecureContextConfig`](../interfaces/verida_web_helpers._internal_.SecureContextConfig.md) | -| `keyring` | [`default`](verida_web_helpers._internal_.default-1.md) | -| `contextAuths` | [`VeridaDatabaseAuthContext`](../interfaces/verida_web_helpers._internal_.VeridaDatabaseAuthContext.md)[] | - -#### Returns - -`void` - -#### Defined in - -packages/account-web-vault/dist/vault-account.d.ts:24 - -___ - -### connectContext - -▸ **connectContext**(`contextName`, `ignoreSession?`): `Promise`<`boolean` \| [`SecureContextConfig`](../interfaces/verida_web_helpers._internal_.SecureContextConfig.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | -| `ignoreSession?` | `boolean` | - -#### Returns - -`Promise`<`boolean` \| [`SecureContextConfig`](../interfaces/verida_web_helpers._internal_.SecureContextConfig.md)\> - -#### Defined in - -packages/account-web-vault/dist/vault-account.d.ts:13 - -___ - -### contextAuthIsValid - -▸ **contextAuthIsValid**(`contextAuths`): `boolean` - -Verify we have valid JWT's and non-expired accessToken and refreshToken - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextAuths` | [`VeridaDatabaseAuthContext`](../interfaces/verida_web_helpers._internal_.VeridaDatabaseAuthContext.md)[] | - -#### Returns - -`boolean` - -#### Defined in - -packages/account-web-vault/dist/vault-account.d.ts:21 - -___ - -### createDidJwt - -▸ **createDidJwt**(`contextName`, `data`, `config?`): `Promise`<`string`\> - -Create a DID-JWT from a data object - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | -| `data` | `object` | -| `config?` | `any` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[default](verida_web_helpers._internal_.default.md).[createDidJwt](verida_web_helpers._internal_.default.md#createdidjwt) - -#### Defined in - -packages/account/dist/account.d.ts:42 - -___ - -### did - -▸ **did**(): `Promise`<`string`\> - -Get the DID of the current user - -#### Returns - -`Promise`<`string`\> - -#### Overrides - -[default](verida_web_helpers._internal_.default.md).[did](verida_web_helpers._internal_.default.md#did) - -#### Defined in - -packages/account-web-vault/dist/vault-account.d.ts:27 - -___ - -### disconnect - -▸ **disconnect**(`contextName?`): `Promise`<`void`\> - -An optional method that can be used to disconnect the current user. - -For example, in a web browser context, it would remove any stored signatures from local storage. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName?` | `string` | - -#### Returns - -`Promise`<`void`\> - -#### Overrides - -[default](verida_web_helpers._internal_.default.md).[disconnect](verida_web_helpers._internal_.default.md#disconnect) - -#### Defined in - -packages/account-web-vault/dist/vault-account.d.ts:41 - -___ - -### disconnectDevice - -▸ **disconnectDevice**(`contextName`, `deviceId?`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | -| `deviceId?` | `string` | - -#### Returns - -`Promise`<`boolean`\> - -#### Inherited from - -[default](verida_web_helpers._internal_.default.md).[disconnectDevice](verida_web_helpers._internal_.default.md#disconnectdevice) - -#### Defined in - -packages/account/dist/account.d.ts:50 - -___ - -### getAuthContext - -▸ **getAuthContext**(`contextName`, `contextConfig`, `authConfig?`, `authType?`): `Promise`<[`AuthContext`](../interfaces/verida_web_helpers._internal_.AuthContext.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | -| `contextConfig` | [`SecureContextConfig`](../interfaces/verida_web_helpers._internal_.SecureContextConfig.md) | -| `authConfig?` | [`AuthTypeConfig`](../interfaces/verida_web_helpers._internal_.AuthTypeConfig.md) | -| `authType?` | `string` | - -#### Returns - -`Promise`<[`AuthContext`](../interfaces/verida_web_helpers._internal_.AuthContext.md)\> - -#### Overrides - -[default](verida_web_helpers._internal_.default.md).[getAuthContext](verida_web_helpers._internal_.default.md#getauthcontext) - -#### Defined in - -packages/account-web-vault/dist/vault-account.d.ts:43 - -___ - -### keyring - -▸ **keyring**(`contextName`): `Promise`<[`default`](verida_web_helpers._internal_.default-1.md)\> - -Generate a keyring for this user for a given storage context. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | - -#### Returns - -`Promise`<[`default`](verida_web_helpers._internal_.default-1.md)\> - -#### Overrides - -[default](verida_web_helpers._internal_.default.md).[keyring](verida_web_helpers._internal_.default.md#keyring) - -#### Defined in - -packages/account-web-vault/dist/vault-account.d.ts:23 - -___ - -### linkStorage - -▸ **linkStorage**(`storageConfig`): `Promise`<`boolean`\> - -Link storage to this user - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `storageConfig` | [`SecureContextConfig`](../interfaces/verida_web_helpers._internal_.SecureContextConfig.md) | - -#### Returns - -`Promise`<`boolean`\> - -#### Overrides - -[default](verida_web_helpers._internal_.default.md).[linkStorage](verida_web_helpers._internal_.default.md#linkstorage) - -#### Defined in - -packages/account-web-vault/dist/vault-account.d.ts:34 - -___ - -### linkStorageContextService - -▸ **linkStorageContextService**(`contextName`, `endpointType`, `serverType`, `endpointUris`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | -| `endpointType` | `string` | -| `serverType` | `string` | -| `endpointUris` | `string`[] | - -#### Returns - -`Promise`<`boolean`\> - -#### Inherited from - -[default](verida_web_helpers._internal_.default.md).[linkStorageContextService](verida_web_helpers._internal_.default.md#linkstoragecontextservice) - -#### Defined in - -packages/account/dist/account.d.ts:36 - -___ - -### loadFromSession - -▸ **loadFromSession**(`contextName`): `Promise`<`undefined` \| [`SecureContextConfig`](../interfaces/verida_web_helpers._internal_.SecureContextConfig.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | - -#### Returns - -`Promise`<`undefined` \| [`SecureContextConfig`](../interfaces/verida_web_helpers._internal_.SecureContextConfig.md)\> - -#### Defined in - -packages/account-web-vault/dist/vault-account.d.ts:22 - -___ - -### setAccountConfig - -▸ **setAccountConfig**(`accountConfig`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `accountConfig` | [`AccountConfig`](../interfaces/verida_web_helpers._internal_.AccountConfig.md) | - -#### Returns - -`void` - -#### Overrides - -[default](verida_web_helpers._internal_.default.md).[setAccountConfig](verida_web_helpers._internal_.default.md#setaccountconfig) - -#### Defined in - -packages/account-web-vault/dist/vault-account.d.ts:14 - -___ - -### setDid - -▸ **setDid**(`did`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did` | `string` | - -#### Returns - -`void` - -#### Defined in - -packages/account-web-vault/dist/vault-account.d.ts:28 - -___ - -### sign - -▸ **sign**(`message`): `Promise`<`string`\> - -Sign a string as the current user - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `message` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Overrides - -[default](verida_web_helpers._internal_.default.md).[sign](verida_web_helpers._internal_.default.md#sign) - -#### Defined in - -packages/account-web-vault/dist/vault-account.d.ts:26 - -___ - -### storageConfig - -▸ **storageConfig**(`contextName`, `forceCreate?`): `Promise`<`undefined` \| [`SecureContextConfig`](../interfaces/verida_web_helpers._internal_.SecureContextConfig.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | -| `forceCreate?` | `boolean` | - -#### Returns - -`Promise`<`undefined` \| [`SecureContextConfig`](../interfaces/verida_web_helpers._internal_.SecureContextConfig.md)\> - -#### Overrides - -[default](verida_web_helpers._internal_.default.md).[storageConfig](verida_web_helpers._internal_.default.md#storageconfig) - -#### Defined in - -packages/account-web-vault/dist/vault-account.d.ts:25 - -___ - -### unlinkStorage - -▸ **unlinkStorage**(`contextName`): `Promise`<`boolean`\> - -Unlink storage for this user - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | - -#### Returns - -`Promise`<`boolean`\> - -#### Overrides - -[default](verida_web_helpers._internal_.default.md).[unlinkStorage](verida_web_helpers._internal_.default.md#unlinkstorage) - -#### Defined in - -packages/account-web-vault/dist/vault-account.d.ts:40 diff --git a/docs/api/verida-js/classes/verida_web_helpers._internal_._Code.md b/docs/api/verida-js/classes/verida_web_helpers._internal_._Code.md deleted file mode 100644 index 46b9584..0000000 --- a/docs/api/verida-js/classes/verida_web_helpers._internal_._Code.md +++ /dev/null @@ -1,155 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / \_Code - -# Class: \_Code - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md)._Code - -## Hierarchy - -- [`_CodeOrName`](verida_web_helpers._internal_._CodeOrName.md) - - ↳ **`_Code`** - -## Table of contents - -### Constructors - -- [constructor](verida_web_helpers._internal_._Code.md#constructor) - -### Properties - -- [\_items](verida_web_helpers._internal_._Code.md#_items) -- [\_names](verida_web_helpers._internal_._Code.md#_names) -- [\_str](verida_web_helpers._internal_._Code.md#_str) - -### Accessors - -- [names](verida_web_helpers._internal_._Code.md#names) -- [str](verida_web_helpers._internal_._Code.md#str) - -### Methods - -- [emptyStr](verida_web_helpers._internal_._Code.md#emptystr) -- [toString](verida_web_helpers._internal_._Code.md#tostring) - -## Constructors - -### constructor - -• **new _Code**(`code`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `code` | `string` \| readonly [`CodeItem`](../modules/verida_web_helpers._internal_.md#codeitem)[] | - -#### Overrides - -[_CodeOrName](verida_web_helpers._internal_._CodeOrName.md).[constructor](verida_web_helpers._internal_._CodeOrName.md#constructor) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/code.d.ts:19 - -## Properties - -### \_items - -• `Readonly` **\_items**: readonly [`CodeItem`](../modules/verida_web_helpers._internal_.md#codeitem)[] - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/code.d.ts:16 - -___ - -### \_names - -• `Private` `Optional` **\_names**: `any` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/code.d.ts:18 - -___ - -### \_str - -• `Private` `Optional` **\_str**: `any` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/code.d.ts:17 - -## Accessors - -### names - -• `get` **names**(): [`UsedNames`](../modules/verida_web_helpers._internal_.md#usednames) - -#### Returns - -[`UsedNames`](../modules/verida_web_helpers._internal_.md#usednames) - -#### Overrides - -\_CodeOrName.names - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/code.d.ts:23 - -___ - -### str - -• `get` **str**(): `string` - -#### Returns - -`string` - -#### Overrides - -\_CodeOrName.str - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/code.d.ts:22 - -## Methods - -### emptyStr - -▸ **emptyStr**(): `boolean` - -#### Returns - -`boolean` - -#### Overrides - -[_CodeOrName](verida_web_helpers._internal_._CodeOrName.md).[emptyStr](verida_web_helpers._internal_._CodeOrName.md#emptystr) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/code.d.ts:21 - -___ - -### toString - -▸ **toString**(): `string` - -#### Returns - -`string` - -#### Overrides - -[_CodeOrName](verida_web_helpers._internal_._CodeOrName.md).[toString](verida_web_helpers._internal_._CodeOrName.md#tostring) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/code.d.ts:20 diff --git a/docs/api/verida-js/classes/verida_web_helpers._internal_._CodeOrName.md b/docs/api/verida-js/classes/verida_web_helpers._internal_._CodeOrName.md deleted file mode 100644 index 5e99246..0000000 --- a/docs/api/verida-js/classes/verida_web_helpers._internal_._CodeOrName.md +++ /dev/null @@ -1,83 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / \_CodeOrName - -# Class: \_CodeOrName - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md)._CodeOrName - -## Hierarchy - -- **`_CodeOrName`** - - ↳ [`Name`](verida_web_helpers._internal_.Name.md) - - ↳ [`_Code`](verida_web_helpers._internal_._Code.md) - -## Table of contents - -### Constructors - -- [constructor](verida_web_helpers._internal_._CodeOrName.md#constructor) - -### Properties - -- [names](verida_web_helpers._internal_._CodeOrName.md#names) -- [str](verida_web_helpers._internal_._CodeOrName.md#str) - -### Methods - -- [emptyStr](verida_web_helpers._internal_._CodeOrName.md#emptystr) -- [toString](verida_web_helpers._internal_._CodeOrName.md#tostring) - -## Constructors - -### constructor - -• **new _CodeOrName**() - -## Properties - -### names - -• `Readonly` `Abstract` **names**: [`UsedNames`](../modules/verida_web_helpers._internal_.md#usednames) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/code.d.ts:3 - -___ - -### str - -• `Readonly` `Abstract` **str**: `string` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/code.d.ts:2 - -## Methods - -### emptyStr - -▸ `Abstract` **emptyStr**(): `boolean` - -#### Returns - -`boolean` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/code.d.ts:5 - -___ - -### toString - -▸ `Abstract` **toString**(): `string` - -#### Returns - -`string` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/code.d.ts:4 diff --git a/docs/api/verida-js/classes/verida_web_helpers._internal_.default-1.md b/docs/api/verida-js/classes/verida_web_helpers._internal_.default-1.md deleted file mode 100644 index 3e42e57..0000000 --- a/docs/api/verida-js/classes/verida_web_helpers._internal_.default-1.md +++ /dev/null @@ -1,423 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / default - -# Class: default - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).default - -Class that takes a signature (generated from a signed consent message) and generates a -collection of asymmetric keys, symmetric key and signing key for a given secure storage -context. - -## Implements - -- [`IKeyring`](../interfaces/verida_web_helpers._internal_.IKeyring.md) - -## Table of contents - -### Constructors - -- [constructor](verida_web_helpers._internal_.default-1.md#constructor) - -### Properties - -- [asymKeyPair](verida_web_helpers._internal_.default-1.md#asymkeypair) -- [buildKey](verida_web_helpers._internal_.default-1.md#buildkey) -- [seed](verida_web_helpers._internal_.default-1.md#seed) -- [signKeyPair](verida_web_helpers._internal_.default-1.md#signkeypair) -- [storageContextKeys](verida_web_helpers._internal_.default-1.md#storagecontextkeys) -- [symKey](verida_web_helpers._internal_.default-1.md#symkey) - -### Methods - -- [\_init](verida_web_helpers._internal_.default-1.md#_init) -- [asymDecrypt](verida_web_helpers._internal_.default-1.md#asymdecrypt) -- [asymEncrypt](verida_web_helpers._internal_.default-1.md#asymencrypt) -- [buildSharedKeyEnd](verida_web_helpers._internal_.default-1.md#buildsharedkeyend) -- [buildSharedKeyStart](verida_web_helpers._internal_.default-1.md#buildsharedkeystart) -- [getKeys](verida_web_helpers._internal_.default-1.md#getkeys) -- [getSeed](verida_web_helpers._internal_.default-1.md#getseed) -- [getStorageContextKey](verida_web_helpers._internal_.default-1.md#getstoragecontextkey) -- [publicKeys](verida_web_helpers._internal_.default-1.md#publickeys) -- [sign](verida_web_helpers._internal_.default-1.md#sign) -- [symDecrypt](verida_web_helpers._internal_.default-1.md#symdecrypt) -- [symEncrypt](verida_web_helpers._internal_.default-1.md#symencrypt) -- [verifySig](verida_web_helpers._internal_.default-1.md#verifysig) - -## Constructors - -### constructor - -• **new default**(`seed`) - -A string used as a seed for this keyring. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `seed` | `string` | - -#### Defined in - -packages/keyring/dist/keyring.d.ts:19 - -## Properties - -### asymKeyPair - -• `Optional` **asymKeyPair**: `any` - -#### Defined in - -packages/keyring/dist/keyring.d.ts:9 - -___ - -### buildKey - -• `Private` **buildKey**: `any` - -Helper function that generates a key of the appropriate type - -**`param`** - -**`param`** - -**`returns`** - -#### Defined in - -packages/keyring/dist/keyring.d.ts:29 - -___ - -### seed - -• `Private` **seed**: `any` - -#### Defined in - -packages/keyring/dist/keyring.d.ts:12 - -___ - -### signKeyPair - -• `Optional` **signKeyPair**: `any` - -#### Defined in - -packages/keyring/dist/keyring.d.ts:10 - -___ - -### storageContextKeys - -• `Private` **storageContextKeys**: `any` - -#### Defined in - -packages/keyring/dist/keyring.d.ts:13 - -___ - -### symKey - -• `Optional` **symKey**: `Uint8Array` - -#### Defined in - -packages/keyring/dist/keyring.d.ts:11 - -## Methods - -### \_init - -▸ **_init**(): `Promise`<`void`\> - -#### Returns - -`Promise`<`void`\> - -#### Implementation of - -[IKeyring](../interfaces/verida_web_helpers._internal_.IKeyring.md).[_init](../interfaces/verida_web_helpers._internal_.IKeyring.md#_init) - -#### Defined in - -packages/keyring/dist/keyring.d.ts:21 - -___ - -### asymDecrypt - -▸ **asymDecrypt**(`messageWithNonce`, `secretOrSharedKey`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `messageWithNonce` | `string` | -| `secretOrSharedKey` | `Uint8Array` | - -#### Returns - -`Promise`<`any`\> - -#### Implementation of - -[IKeyring](../interfaces/verida_web_helpers._internal_.IKeyring.md).[asymDecrypt](../interfaces/verida_web_helpers._internal_.IKeyring.md#asymdecrypt) - -#### Defined in - -packages/keyring/dist/keyring.d.ts:41 - -___ - -### asymEncrypt - -▸ **asymEncrypt**(`data`, `secretOrSharedKey`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `string` | -| `secretOrSharedKey` | `Uint8Array` | - -#### Returns - -`Promise`<`string`\> - -#### Implementation of - -[IKeyring](../interfaces/verida_web_helpers._internal_.IKeyring.md).[asymEncrypt](../interfaces/verida_web_helpers._internal_.IKeyring.md#asymencrypt) - -#### Defined in - -packages/keyring/dist/keyring.d.ts:40 - -___ - -### buildSharedKeyEnd - -▸ **buildSharedKeyEnd**(`publicKey`): `Promise`<`Uint8Array`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `publicKey` | `Uint8Array` | - -#### Returns - -`Promise`<`Uint8Array`\> - -#### Implementation of - -[IKeyring](../interfaces/verida_web_helpers._internal_.IKeyring.md).[buildSharedKeyEnd](../interfaces/verida_web_helpers._internal_.IKeyring.md#buildsharedkeyend) - -#### Defined in - -packages/keyring/dist/keyring.d.ts:43 - -___ - -### buildSharedKeyStart - -▸ **buildSharedKeyStart**(`privateKey`): `Promise`<`Uint8Array`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `privateKey` | `Uint8Array` | - -#### Returns - -`Promise`<`Uint8Array`\> - -#### Implementation of - -[IKeyring](../interfaces/verida_web_helpers._internal_.IKeyring.md).[buildSharedKeyStart](../interfaces/verida_web_helpers._internal_.IKeyring.md#buildsharedkeystart) - -#### Defined in - -packages/keyring/dist/keyring.d.ts:42 - -___ - -### getKeys - -▸ **getKeys**(): `Promise`<`any`\> - -#### Returns - -`Promise`<`any`\> - -#### Implementation of - -[IKeyring](../interfaces/verida_web_helpers._internal_.IKeyring.md).[getKeys](../interfaces/verida_web_helpers._internal_.IKeyring.md#getkeys) - -#### Defined in - -packages/keyring/dist/keyring.d.ts:20 - -___ - -### getSeed - -▸ **getSeed**(): `string` - -#### Returns - -`string` - -#### Implementation of - -[IKeyring](../interfaces/verida_web_helpers._internal_.IKeyring.md).[getSeed](../interfaces/verida_web_helpers._internal_.IKeyring.md#getseed) - -#### Defined in - -packages/keyring/dist/keyring.d.ts:44 - -___ - -### getStorageContextKey - -▸ **getStorageContextKey**(`databaseName`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `databaseName` | `string` | - -#### Returns - -`Promise`<`any`\> - -#### Implementation of - -[IKeyring](../interfaces/verida_web_helpers._internal_.IKeyring.md).[getStorageContextKey](../interfaces/verida_web_helpers._internal_.IKeyring.md#getstoragecontextkey) - -#### Defined in - -packages/keyring/dist/keyring.d.ts:45 - -___ - -### publicKeys - -▸ **publicKeys**(): `Promise`<[`KeyringPublicKeys`](../interfaces/verida_web_helpers._internal_.KeyringPublicKeys.md)\> - -Generate an object containing all the public keys for this Keyring - -#### Returns - -`Promise`<[`KeyringPublicKeys`](../interfaces/verida_web_helpers._internal_.KeyringPublicKeys.md)\> - -#### Implementation of - -[IKeyring](../interfaces/verida_web_helpers._internal_.IKeyring.md).[publicKeys](../interfaces/verida_web_helpers._internal_.IKeyring.md#publickeys) - -#### Defined in - -packages/keyring/dist/keyring.d.ts:35 - -___ - -### sign - -▸ **sign**(`data`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `any` | - -#### Returns - -`Promise`<`string`\> - -#### Implementation of - -[IKeyring](../interfaces/verida_web_helpers._internal_.IKeyring.md).[sign](../interfaces/verida_web_helpers._internal_.IKeyring.md#sign) - -#### Defined in - -packages/keyring/dist/keyring.d.ts:36 - -___ - -### symDecrypt - -▸ **symDecrypt**(`data`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `string` | - -#### Returns - -`Promise`<`any`\> - -#### Implementation of - -[IKeyring](../interfaces/verida_web_helpers._internal_.IKeyring.md).[symDecrypt](../interfaces/verida_web_helpers._internal_.IKeyring.md#symdecrypt) - -#### Defined in - -packages/keyring/dist/keyring.d.ts:39 - -___ - -### symEncrypt - -▸ **symEncrypt**(`data`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Implementation of - -[IKeyring](../interfaces/verida_web_helpers._internal_.IKeyring.md).[symEncrypt](../interfaces/verida_web_helpers._internal_.IKeyring.md#symencrypt) - -#### Defined in - -packages/keyring/dist/keyring.d.ts:38 - -___ - -### verifySig - -▸ **verifySig**(`data`, `sig`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `string` | -| `sig` | `string` | - -#### Returns - -`Promise`<`boolean`\> - -#### Implementation of - -[IKeyring](../interfaces/verida_web_helpers._internal_.IKeyring.md).[verifySig](../interfaces/verida_web_helpers._internal_.IKeyring.md#verifysig) - -#### Defined in - -packages/keyring/dist/keyring.d.ts:37 diff --git a/docs/api/verida-js/classes/verida_web_helpers._internal_.default-2.md b/docs/api/verida-js/classes/verida_web_helpers._internal_.default-2.md deleted file mode 100644 index 4e8026f..0000000 --- a/docs/api/verida-js/classes/verida_web_helpers._internal_.default-2.md +++ /dev/null @@ -1,515 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / default - -# Class: default - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).default - -## Implements - -- [`IDIDDocument`](../interfaces/verida_web_helpers._internal_.IDIDDocument.md) - -## Table of contents - -### Constructors - -- [constructor](verida_web_helpers._internal_.default-2.md#constructor) - -### Properties - -- [doc](verida_web_helpers._internal_.default-2.md#doc) -- [errors](verida_web_helpers._internal_.default-2.md#errors) -- [getProofData](verida_web_helpers._internal_.default-2.md#getproofdata) - -### Accessors - -- [id](verida_web_helpers._internal_.default-2.md#id) - -### Methods - -- [addContext](verida_web_helpers._internal_.default-2.md#addcontext) -- [addContextAsymKey](verida_web_helpers._internal_.default-2.md#addcontextasymkey) -- [addContextService](verida_web_helpers._internal_.default-2.md#addcontextservice) -- [addContextSignKey](verida_web_helpers._internal_.default-2.md#addcontextsignkey) -- [buildTimestamp](verida_web_helpers._internal_.default-2.md#buildtimestamp) -- [export](verida_web_helpers._internal_.default-2.md#export) -- [getErrors](verida_web_helpers._internal_.default-2.md#geterrors) -- [import](verida_web_helpers._internal_.default-2.md#import) -- [locateContextProof](verida_web_helpers._internal_.default-2.md#locatecontextproof) -- [locateServiceEndpoint](verida_web_helpers._internal_.default-2.md#locateserviceendpoint) -- [removeContext](verida_web_helpers._internal_.default-2.md#removecontext) -- [setAttributes](verida_web_helpers._internal_.default-2.md#setattributes) -- [signProof](verida_web_helpers._internal_.default-2.md#signproof) -- [verifyContextSignature](verida_web_helpers._internal_.default-2.md#verifycontextsignature) -- [verifyProof](verida_web_helpers._internal_.default-2.md#verifyproof) -- [verifySig](verida_web_helpers._internal_.default-2.md#verifysig) -- [generateContextHash](verida_web_helpers._internal_.default-2.md#generatecontexthash) - -## Constructors - -### constructor - -• **new default**(`doc`, `publicKeyHex?`) - -Force lower case DID as we can't guarantee the DID will always be provided with checksum - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `doc` | `string` \| [`VeridaDocInterface`](../interfaces/verida_web_helpers._internal_.VeridaDocInterface.md) | this value can be a DocInterface or DID. | -| `publicKeyHex?` | `string` | - | - -#### Defined in - -packages/did-document/dist/did-document.d.ts:11 - -## Properties - -### doc - -• `Private` **doc**: `any` - -#### Defined in - -packages/did-document/dist/did-document.d.ts:4 - -___ - -### errors - -• `Protected` **errors**: `string`[] - -#### Defined in - -packages/did-document/dist/did-document.d.ts:5 - -___ - -### getProofData - -• `Private` **getProofData**: `any` - -#### Defined in - -packages/did-document/dist/did-document.d.ts:37 - -## Accessors - -### id - -• `get` **id**(): `string` - -#### Returns - -`string` - -#### Implementation of - -IDIDDocument.id - -#### Defined in - -packages/did-document/dist/did-document.d.ts:12 - -## Methods - -### addContext - -▸ **addContext**(`contextName`, `keyring`, `privateKey`, `endpoints`): `Promise`<`void`\> - -Not used directly, used for testing - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `contextName` | `string` | string | -| `keyring` | [`IKeyring`](../interfaces/verida_web_helpers._internal_.IKeyring.md) | Keyring | -| `privateKey` | `string` | Private key of the DID that controls this DID Document | -| `endpoints` | [`SecureContextEndpoints`](../interfaces/verida_web_helpers._internal_.SecureContextEndpoints.md) | Endpoints | - -#### Returns - -`Promise`<`void`\> - -#### Implementation of - -[IDIDDocument](../interfaces/verida_web_helpers._internal_.IDIDDocument.md).[addContext](../interfaces/verida_web_helpers._internal_.IDIDDocument.md#addcontext) - -#### Defined in - -packages/did-document/dist/did-document.d.ts:22 - -___ - -### addContextAsymKey - -▸ **addContextAsymKey**(`contextHash`, `publicKeyHex`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextHash` | `string` | -| `publicKeyHex` | `string` | - -#### Returns - -`void` - -#### Implementation of - -[IDIDDocument](../interfaces/verida_web_helpers._internal_.IDIDDocument.md).[addContextAsymKey](../interfaces/verida_web_helpers._internal_.IDIDDocument.md#addcontextasymkey) - -#### Defined in - -packages/did-document/dist/did-document.d.ts:29 - -___ - -### addContextService - -▸ **addContextService**(`contextHash`, `endpointType`, `serviceType`, `endpointUris`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextHash` | `string` | -| `endpointType` | [`SecureContextEndpointType`](../enums/verida_web_helpers._internal_.SecureContextEndpointType.md) | -| `serviceType` | `string` | -| `endpointUris` | [`ServiceEndpoint`](../modules/verida_web_helpers._internal_.md#serviceendpoint)[] | - -#### Returns - -`void` - -#### Implementation of - -[IDIDDocument](../interfaces/verida_web_helpers._internal_.IDIDDocument.md).[addContextService](../interfaces/verida_web_helpers._internal_.IDIDDocument.md#addcontextservice) - -#### Defined in - -packages/did-document/dist/did-document.d.ts:27 - -___ - -### addContextSignKey - -▸ **addContextSignKey**(`contextHash`, `publicKeyHex`, `proof`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextHash` | `string` | -| `publicKeyHex` | `string` | -| `proof` | `string` | - -#### Returns - -`void` - -#### Implementation of - -[IDIDDocument](../interfaces/verida_web_helpers._internal_.IDIDDocument.md).[addContextSignKey](../interfaces/verida_web_helpers._internal_.IDIDDocument.md#addcontextsignkey) - -#### Defined in - -packages/did-document/dist/did-document.d.ts:28 - -___ - -### buildTimestamp - -▸ **buildTimestamp**(`date`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `date` | `Date` | - -#### Returns - -`string` - -#### Implementation of - -[IDIDDocument](../interfaces/verida_web_helpers._internal_.IDIDDocument.md).[buildTimestamp](../interfaces/verida_web_helpers._internal_.IDIDDocument.md#buildtimestamp) - -#### Defined in - -packages/did-document/dist/did-document.d.ts:38 - -___ - -### export - -▸ **export**(): [`VeridaDocInterface`](../interfaces/verida_web_helpers._internal_.VeridaDocInterface.md) - -#### Returns - -[`VeridaDocInterface`](../interfaces/verida_web_helpers._internal_.VeridaDocInterface.md) - -#### Implementation of - -[IDIDDocument](../interfaces/verida_web_helpers._internal_.IDIDDocument.md).[export](../interfaces/verida_web_helpers._internal_.IDIDDocument.md#export) - -#### Defined in - -packages/did-document/dist/did-document.d.ts:26 - -___ - -### getErrors - -▸ **getErrors**(): `string`[] - -#### Returns - -`string`[] - -#### Implementation of - -[IDIDDocument](../interfaces/verida_web_helpers._internal_.IDIDDocument.md).[getErrors](../interfaces/verida_web_helpers._internal_.IDIDDocument.md#geterrors) - -#### Defined in - -packages/did-document/dist/did-document.d.ts:13 - -___ - -### import - -▸ **import**(`doc`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `doc` | [`VeridaDocInterface`](../interfaces/verida_web_helpers._internal_.VeridaDocInterface.md) | - -#### Returns - -`void` - -#### Implementation of - -[IDIDDocument](../interfaces/verida_web_helpers._internal_.IDIDDocument.md).[import](../interfaces/verida_web_helpers._internal_.IDIDDocument.md#import) - -#### Defined in - -packages/did-document/dist/did-document.d.ts:25 - -___ - -### locateContextProof - -▸ **locateContextProof**(`contextName`): `undefined` \| `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | - -#### Returns - -`undefined` \| `string` - -#### Implementation of - -[IDIDDocument](../interfaces/verida_web_helpers._internal_.IDIDDocument.md).[locateContextProof](../interfaces/verida_web_helpers._internal_.IDIDDocument.md#locatecontextproof) - -#### Defined in - -packages/did-document/dist/did-document.d.ts:34 - -___ - -### locateServiceEndpoint - -▸ **locateServiceEndpoint**(`contextName`, `endpointType`): `undefined` \| [`Service`](../interfaces/verida_web_helpers._internal_.Service.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | -| `endpointType` | [`SecureContextEndpointType`](../enums/verida_web_helpers._internal_.SecureContextEndpointType.md) | - -#### Returns - -`undefined` \| [`Service`](../interfaces/verida_web_helpers._internal_.Service.md) - -#### Implementation of - -[IDIDDocument](../interfaces/verida_web_helpers._internal_.IDIDDocument.md).[locateServiceEndpoint](../interfaces/verida_web_helpers._internal_.IDIDDocument.md#locateserviceendpoint) - -#### Defined in - -packages/did-document/dist/did-document.d.ts:33 - -___ - -### removeContext - -▸ **removeContext**(`contextName`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | - -#### Returns - -`boolean` - -#### Implementation of - -[IDIDDocument](../interfaces/verida_web_helpers._internal_.IDIDDocument.md).[removeContext](../interfaces/verida_web_helpers._internal_.IDIDDocument.md#removecontext) - -#### Defined in - -packages/did-document/dist/did-document.d.ts:23 - -___ - -### setAttributes - -▸ **setAttributes**(`attributes`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `attributes` | [`Record`](../modules/verida_web_helpers._internal_.md#record)<`string`, `any`\> | - -#### Returns - -`void` - -#### Implementation of - -[IDIDDocument](../interfaces/verida_web_helpers._internal_.IDIDDocument.md).[setAttributes](../interfaces/verida_web_helpers._internal_.IDIDDocument.md#setattributes) - -#### Defined in - -packages/did-document/dist/did-document.d.ts:24 - -___ - -### signProof - -▸ **signProof**(`privateKey`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `privateKey` | `string` \| `Uint8Array` | - -#### Returns - -`void` - -#### Implementation of - -[IDIDDocument](../interfaces/verida_web_helpers._internal_.IDIDDocument.md).[signProof](../interfaces/verida_web_helpers._internal_.IDIDDocument.md#signproof) - -#### Defined in - -packages/did-document/dist/did-document.d.ts:35 - -___ - -### verifyContextSignature - -▸ **verifyContextSignature**(`data`, `contextName`, `signature`, `contextIsHash?`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `any` | -| `contextName` | `string` | -| `signature` | `string` | -| `contextIsHash?` | `boolean` | - -#### Returns - -`boolean` - -#### Implementation of - -[IDIDDocument](../interfaces/verida_web_helpers._internal_.IDIDDocument.md).[verifyContextSignature](../interfaces/verida_web_helpers._internal_.IDIDDocument.md#verifycontextsignature) - -#### Defined in - -packages/did-document/dist/did-document.d.ts:31 - -___ - -### verifyProof - -▸ **verifyProof**(): `boolean` - -#### Returns - -`boolean` - -#### Implementation of - -[IDIDDocument](../interfaces/verida_web_helpers._internal_.IDIDDocument.md).[verifyProof](../interfaces/verida_web_helpers._internal_.IDIDDocument.md#verifyproof) - -#### Defined in - -packages/did-document/dist/did-document.d.ts:36 - -___ - -### verifySig - -▸ **verifySig**(`data`, `signature`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `any` | -| `signature` | `string` | - -#### Returns - -`boolean` - -#### Implementation of - -[IDIDDocument](../interfaces/verida_web_helpers._internal_.IDIDDocument.md).[verifySig](../interfaces/verida_web_helpers._internal_.IDIDDocument.md#verifysig) - -#### Defined in - -packages/did-document/dist/did-document.d.ts:30 - -___ - -### generateContextHash - -▸ `Static` **generateContextHash**(`did`, `contextName`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did` | `string` | -| `contextName` | `string` | - -#### Returns - -`string` - -#### Defined in - -packages/did-document/dist/did-document.d.ts:32 diff --git a/docs/api/verida-js/classes/verida_web_helpers._internal_.default-3.md b/docs/api/verida-js/classes/verida_web_helpers._internal_.default-3.md deleted file mode 100644 index 3587da2..0000000 --- a/docs/api/verida-js/classes/verida_web_helpers._internal_.default-3.md +++ /dev/null @@ -1,948 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / default - -# Class: default - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).default - -## Hierarchy - -- **`default`** - - ↳ [`Ajv2020`](verida_web_helpers._internal_.Ajv2020.md) - -## Table of contents - -### Constructors - -- [constructor](verida_web_helpers._internal_.default-3.md#constructor) - -### Properties - -- [RULES](verida_web_helpers._internal_.default-3.md#rules) -- [\_cache](verida_web_helpers._internal_.default-3.md#_cache) -- [\_checkUnique](verida_web_helpers._internal_.default-3.md#_checkunique) -- [\_compilations](verida_web_helpers._internal_.default-3.md#_compilations) -- [\_compileMetaSchema](verida_web_helpers._internal_.default-3.md#_compilemetaschema) -- [\_compileSchemaEnv](verida_web_helpers._internal_.default-3.md#_compileschemaenv) -- [\_loading](verida_web_helpers._internal_.default-3.md#_loading) -- [\_metaOpts](verida_web_helpers._internal_.default-3.md#_metaopts) -- [\_removeAllSchemas](verida_web_helpers._internal_.default-3.md#_removeallschemas) -- [errors](verida_web_helpers._internal_.default-3.md#errors) -- [formats](verida_web_helpers._internal_.default-3.md#formats) -- [logger](verida_web_helpers._internal_.default-3.md#logger) -- [opts](verida_web_helpers._internal_.default-3.md#opts) -- [refs](verida_web_helpers._internal_.default-3.md#refs) -- [schemas](verida_web_helpers._internal_.default-3.md#schemas) -- [scope](verida_web_helpers._internal_.default-3.md#scope) -- [MissingRefError](verida_web_helpers._internal_.default-3.md#missingreferror) -- [ValidationError](verida_web_helpers._internal_.default-3.md#validationerror) - -### Methods - -- [$dataMetaSchema](verida_web_helpers._internal_.default-3.md#$datametaschema) -- [\_addDefaultMetaSchema](verida_web_helpers._internal_.default-3.md#_adddefaultmetaschema) -- [\_addSchema](verida_web_helpers._internal_.default-3.md#_addschema) -- [\_addVocabularies](verida_web_helpers._internal_.default-3.md#_addvocabularies) -- [addFormat](verida_web_helpers._internal_.default-3.md#addformat) -- [addKeyword](verida_web_helpers._internal_.default-3.md#addkeyword) -- [addMetaSchema](verida_web_helpers._internal_.default-3.md#addmetaschema) -- [addSchema](verida_web_helpers._internal_.default-3.md#addschema) -- [addVocabulary](verida_web_helpers._internal_.default-3.md#addvocabulary) -- [compile](verida_web_helpers._internal_.default-3.md#compile) -- [compileAsync](verida_web_helpers._internal_.default-3.md#compileasync) -- [defaultMeta](verida_web_helpers._internal_.default-3.md#defaultmeta) -- [errorsText](verida_web_helpers._internal_.default-3.md#errorstext) -- [getKeyword](verida_web_helpers._internal_.default-3.md#getkeyword) -- [getSchema](verida_web_helpers._internal_.default-3.md#getschema) -- [removeKeyword](verida_web_helpers._internal_.default-3.md#removekeyword) -- [removeSchema](verida_web_helpers._internal_.default-3.md#removeschema) -- [validate](verida_web_helpers._internal_.default-3.md#validate) -- [validateSchema](verida_web_helpers._internal_.default-3.md#validateschema) - -## Constructors - -### constructor - -• **new default**(`opts?`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `opts?` | [`Options`](../modules/verida_web_helpers._internal_.md#options) | - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:127 - -## Properties - -### RULES - -• `Readonly` **RULES**: [`ValidationRules`](../interfaces/verida_web_helpers._internal_.ValidationRules.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:120 - -___ - -### \_cache - -• `Private` `Readonly` **\_cache**: `any` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:123 - -___ - -### \_checkUnique - -• `Private` **\_checkUnique**: `any` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:166 - -___ - -### \_compilations - -• `Readonly` **\_compilations**: `Set`<[`SchemaEnv`](verida_web_helpers._internal_.SchemaEnv.md)\> - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:121 - -___ - -### \_compileMetaSchema - -• `Private` **\_compileMetaSchema**: `any` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:168 - -___ - -### \_compileSchemaEnv - -• `Private` **\_compileSchemaEnv**: `any` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:167 - -___ - -### \_loading - -• `Private` `Readonly` **\_loading**: `any` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:122 - -___ - -### \_metaOpts - -• `Private` `Readonly` **\_metaOpts**: `any` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:124 - -___ - -### \_removeAllSchemas - -• `Private` **\_removeAllSchemas**: `any` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:164 - -___ - -### errors - -• `Optional` **errors**: ``null`` \| [`ErrorObject`](../interfaces/verida_web_helpers._internal_.ErrorObject.md)<`string`, [`Record`](../modules/verida_web_helpers._internal_.md#record)<`string`, `any`\>, `unknown`\>[] - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:108 - -___ - -### formats - -• `Readonly` **formats**: `Object` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:117 - -___ - -### logger - -• **logger**: [`Logger`](../interfaces/verida_web_helpers._internal_.Logger.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:109 - -___ - -### opts - -• **opts**: [`InstanceOptions`](../modules/verida_web_helpers._internal_.md#instanceoptions) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:107 - -___ - -### refs - -• `Readonly` **refs**: `Object` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:114 - -___ - -### schemas - -• `Readonly` **schemas**: `Object` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:111 - -___ - -### scope - -• `Readonly` **scope**: [`ValueScope`](verida_web_helpers._internal_.ValueScope.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:110 - -___ - -### MissingRefError - -▪ `Static` **MissingRefError**: typeof [`default`](verida_web_helpers._internal_.default-5.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:126 - -___ - -### ValidationError - -▪ `Static` **ValidationError**: typeof [`default`](verida_web_helpers._internal_.default-4.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:125 - -## Methods - -### $dataMetaSchema - -▸ **$dataMetaSchema**(`metaSchema`, `keywordsJsonPointers`): [`AnySchemaObject`](../modules/verida_web_helpers._internal_.md#anyschemaobject) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `metaSchema` | [`AnySchemaObject`](../modules/verida_web_helpers._internal_.md#anyschemaobject) | -| `keywordsJsonPointers` | `string`[] | - -#### Returns - -[`AnySchemaObject`](../modules/verida_web_helpers._internal_.md#anyschemaobject) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:163 - -___ - -### \_addDefaultMetaSchema - -▸ **_addDefaultMetaSchema**(): `void` - -#### Returns - -`void` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:129 - -___ - -### \_addSchema - -▸ **_addSchema**(`schema`, `meta?`, `baseId?`, `validateSchema?`, `addSchema?`): [`SchemaEnv`](verida_web_helpers._internal_.SchemaEnv.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schema` | [`AnySchema`](../modules/verida_web_helpers._internal_.md#anyschema) | -| `meta?` | `boolean` | -| `baseId?` | `string` | -| `validateSchema?` | `boolean` \| ``"log"`` | -| `addSchema?` | `boolean` | - -#### Returns - -[`SchemaEnv`](verida_web_helpers._internal_.SchemaEnv.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:165 - -___ - -### \_addVocabularies - -▸ **_addVocabularies**(): `void` - -#### Returns - -`void` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:128 - -___ - -### addFormat - -▸ **addFormat**(`name`, `format`): [`default`](verida_web_helpers._internal_.default-3.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` | -| `format` | [`Format`](../modules/verida_web_helpers._internal_.md#format) | - -#### Returns - -[`default`](verida_web_helpers._internal_.default-3.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:160 - -___ - -### addKeyword - -▸ **addKeyword**(`kwdOrDef`, `def?`): [`default`](verida_web_helpers._internal_.default-3.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `kwdOrDef` | `string` \| [`KeywordDefinition`](../modules/verida_web_helpers._internal_.md#keyworddefinition) | -| `def?` | [`KeywordDefinition`](../modules/verida_web_helpers._internal_.md#keyworddefinition) | - -#### Returns - -[`default`](verida_web_helpers._internal_.default-3.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:157 - -___ - -### addMetaSchema - -▸ **addMetaSchema**(`schema`, `key?`, `_validateSchema?`): [`default`](verida_web_helpers._internal_.default-3.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schema` | [`AnySchemaObject`](../modules/verida_web_helpers._internal_.md#anyschemaobject) | -| `key?` | `string` | -| `_validateSchema?` | `boolean` \| ``"log"`` | - -#### Returns - -[`default`](verida_web_helpers._internal_.default-3.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:151 - -___ - -### addSchema - -▸ **addSchema**(`schema`, `key?`, `_meta?`, `_validateSchema?`): [`default`](verida_web_helpers._internal_.default-3.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schema` | [`AnySchema`](../modules/verida_web_helpers._internal_.md#anyschema) \| [`AnySchema`](../modules/verida_web_helpers._internal_.md#anyschema)[] | -| `key?` | `string` | -| `_meta?` | `boolean` | -| `_validateSchema?` | `boolean` \| ``"log"`` | - -#### Returns - -[`default`](verida_web_helpers._internal_.default-3.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:147 - -___ - -### addVocabulary - -▸ **addVocabulary**(`definitions`): [`default`](verida_web_helpers._internal_.default-3.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `definitions` | [`Vocabulary`](../modules/verida_web_helpers._internal_.md#vocabulary) | - -#### Returns - -[`default`](verida_web_helpers._internal_.default-3.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:156 - -___ - -### compile - -▸ **compile**<`T`\>(`schema`, `_meta?`): [`ValidateFunction`](../interfaces/verida_web_helpers._internal_.ValidateFunction.md)<`T`\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `unknown` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schema` | [`Schema`](../modules/verida_web_helpers._internal_.md#schema) \| [`UncheckedJSONSchemaType`](../modules/verida_web_helpers._internal_.md#uncheckedjsonschematype)<`T`, ``false``\> | -| `_meta?` | `boolean` | - -#### Returns - -[`ValidateFunction`](../interfaces/verida_web_helpers._internal_.ValidateFunction.md)<`T`\> - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:138 - -▸ **compile**<`T`\>(`schema`, `_meta?`): [`ValidateFunction`](../interfaces/verida_web_helpers._internal_.ValidateFunction.md)<`T`\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `unknown` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schema` | [`JTDSchemaType`](../modules/verida_web_helpers._internal_.md#jtdschematype)<`T`, [`Record`](../modules/verida_web_helpers._internal_.md#record)<`string`, `never`\>\> | -| `_meta?` | `boolean` | - -#### Returns - -[`ValidateFunction`](../interfaces/verida_web_helpers._internal_.ValidateFunction.md)<`T`\> - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:139 - -▸ **compile**<`N`, `T`\>(`schema`, `_meta?`): [`ValidateFunction`](../interfaces/verida_web_helpers._internal_.ValidateFunction.md)<[`JTDDataType`](../modules/verida_web_helpers._internal_.md#jtddatatype)<`T`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `N` | extends `never` | -| `T` | extends [`SomeJTDSchemaType`](../modules/verida_web_helpers._internal_.md#somejtdschematype) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schema` | `T` | -| `_meta?` | `boolean` | - -#### Returns - -[`ValidateFunction`](../interfaces/verida_web_helpers._internal_.ValidateFunction.md)<[`JTDDataType`](../modules/verida_web_helpers._internal_.md#jtddatatype)<`T`\>\> - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:140 - -▸ **compile**<`T`\>(`schema`, `_meta?`): [`AsyncValidateFunction`](../interfaces/verida_web_helpers._internal_.AsyncValidateFunction.md)<`T`\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `unknown` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schema` | [`AsyncSchema`](../interfaces/verida_web_helpers._internal_.AsyncSchema.md) | -| `_meta?` | `boolean` | - -#### Returns - -[`AsyncValidateFunction`](../interfaces/verida_web_helpers._internal_.AsyncValidateFunction.md)<`T`\> - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:141 - -▸ **compile**<`T`\>(`schema`, `_meta?`): [`AnyValidateFunction`](../modules/verida_web_helpers._internal_.md#anyvalidatefunction)<`T`\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `unknown` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schema` | [`AnySchema`](../modules/verida_web_helpers._internal_.md#anyschema) | -| `_meta?` | `boolean` | - -#### Returns - -[`AnyValidateFunction`](../modules/verida_web_helpers._internal_.md#anyvalidatefunction)<`T`\> - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:142 - -___ - -### compileAsync - -▸ **compileAsync**<`T`\>(`schema`, `_meta?`): `Promise`<[`ValidateFunction`](../interfaces/verida_web_helpers._internal_.ValidateFunction.md)<`T`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `unknown` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schema` | [`SchemaObject`](../interfaces/verida_web_helpers._internal_.SchemaObject.md) \| [`UncheckedJSONSchemaType`](../modules/verida_web_helpers._internal_.md#uncheckedjsonschematype)<`T`, ``false``\> | -| `_meta?` | `boolean` | - -#### Returns - -`Promise`<[`ValidateFunction`](../interfaces/verida_web_helpers._internal_.ValidateFunction.md)<`T`\>\> - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:143 - -▸ **compileAsync**<`T`\>(`schema`, `_meta?`): `Promise`<[`ValidateFunction`](../interfaces/verida_web_helpers._internal_.ValidateFunction.md)<`T`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `unknown` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schema` | [`JTDSchemaType`](../modules/verida_web_helpers._internal_.md#jtdschematype)<`T`, [`Record`](../modules/verida_web_helpers._internal_.md#record)<`string`, `never`\>\> | -| `_meta?` | `boolean` | - -#### Returns - -`Promise`<[`ValidateFunction`](../interfaces/verida_web_helpers._internal_.ValidateFunction.md)<`T`\>\> - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:144 - -▸ **compileAsync**<`T`\>(`schema`, `meta?`): `Promise`<[`AsyncValidateFunction`](../interfaces/verida_web_helpers._internal_.AsyncValidateFunction.md)<`T`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `unknown` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schema` | [`AsyncSchema`](../interfaces/verida_web_helpers._internal_.AsyncSchema.md) | -| `meta?` | `boolean` | - -#### Returns - -`Promise`<[`AsyncValidateFunction`](../interfaces/verida_web_helpers._internal_.AsyncValidateFunction.md)<`T`\>\> - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:145 - -▸ **compileAsync**<`T`\>(`schema`, `meta?`): `Promise`<[`AnyValidateFunction`](../modules/verida_web_helpers._internal_.md#anyvalidatefunction)<`T`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `unknown` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schema` | [`AnySchemaObject`](../modules/verida_web_helpers._internal_.md#anyschemaobject) | -| `meta?` | `boolean` | - -#### Returns - -`Promise`<[`AnyValidateFunction`](../modules/verida_web_helpers._internal_.md#anyvalidatefunction)<`T`\>\> - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:146 - -___ - -### defaultMeta - -▸ **defaultMeta**(): `undefined` \| `string` \| [`AnySchemaObject`](../modules/verida_web_helpers._internal_.md#anyschemaobject) - -#### Returns - -`undefined` \| `string` \| [`AnySchemaObject`](../modules/verida_web_helpers._internal_.md#anyschemaobject) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:130 - -___ - -### errorsText - -▸ **errorsText**(`errors?`, `__namedParameters?`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `errors?` | ``null`` \| [`ErrorObject`](../interfaces/verida_web_helpers._internal_.ErrorObject.md)<`string`, [`Record`](../modules/verida_web_helpers._internal_.md#record)<`string`, `any`\>, `unknown`\>[] | -| `__namedParameters?` | [`ErrorsTextOptions`](../interfaces/verida_web_helpers._internal_.ErrorsTextOptions.md) | - -#### Returns - -`string` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:161 - -___ - -### getKeyword - -▸ **getKeyword**(`keyword`): `boolean` \| [`AddedKeywordDefinition`](../modules/verida_web_helpers._internal_.md#addedkeyworddefinition) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `keyword` | `string` | - -#### Returns - -`boolean` \| [`AddedKeywordDefinition`](../modules/verida_web_helpers._internal_.md#addedkeyworddefinition) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:158 - -___ - -### getSchema - -▸ **getSchema**<`T`\>(`keyRef`): `undefined` \| [`AnyValidateFunction`](../modules/verida_web_helpers._internal_.md#anyvalidatefunction)<`T`\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `unknown` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `keyRef` | `string` | - -#### Returns - -`undefined` \| [`AnyValidateFunction`](../modules/verida_web_helpers._internal_.md#anyvalidatefunction)<`T`\> - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:154 - -___ - -### removeKeyword - -▸ **removeKeyword**(`keyword`): [`default`](verida_web_helpers._internal_.default-3.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `keyword` | `string` | - -#### Returns - -[`default`](verida_web_helpers._internal_.default-3.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:159 - -___ - -### removeSchema - -▸ **removeSchema**(`schemaKeyRef?`): [`default`](verida_web_helpers._internal_.default-3.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schemaKeyRef?` | `string` \| `RegExp` \| [`AnySchema`](../modules/verida_web_helpers._internal_.md#anyschema) | - -#### Returns - -[`default`](verida_web_helpers._internal_.default-3.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:155 - -___ - -### validate - -▸ **validate**(`schema`, `data`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schema` | `string` \| [`Schema`](../modules/verida_web_helpers._internal_.md#schema) | -| `data` | `unknown` | - -#### Returns - -`boolean` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:131 - -▸ **validate**(`schemaKeyRef`, `data`): `boolean` \| `Promise`<`unknown`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schemaKeyRef` | `string` \| [`AnySchema`](../modules/verida_web_helpers._internal_.md#anyschema) | -| `data` | `unknown` | - -#### Returns - -`boolean` \| `Promise`<`unknown`\> - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:132 - -▸ **validate**<`T`\>(`schema`, `data`): data is T - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schema` | `string` \| [`Schema`](../modules/verida_web_helpers._internal_.md#schema) \| [`UncheckedJSONSchemaType`](../modules/verida_web_helpers._internal_.md#uncheckedjsonschematype)<`T`, ``false``\> | -| `data` | `unknown` | - -#### Returns - -data is T - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:133 - -▸ **validate**<`T`\>(`schema`, `data`): data is T - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schema` | [`JTDSchemaType`](../modules/verida_web_helpers._internal_.md#jtdschematype)<`T`, [`Record`](../modules/verida_web_helpers._internal_.md#record)<`string`, `never`\>\> | -| `data` | `unknown` | - -#### Returns - -data is T - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:134 - -▸ **validate**<`N`, `T`\>(`schema`, `data`): data is JTDDataType - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `N` | extends `never` | -| `T` | extends [`SomeJTDSchemaType`](../modules/verida_web_helpers._internal_.md#somejtdschematype) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schema` | `T` | -| `data` | `unknown` | - -#### Returns - -data is JTDDataType - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:135 - -▸ **validate**<`T`\>(`schema`, `data`): `Promise`<`T`\> - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schema` | [`AsyncSchema`](../interfaces/verida_web_helpers._internal_.AsyncSchema.md) | -| `data` | `unknown` | - -#### Returns - -`Promise`<`T`\> - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:136 - -▸ **validate**<`T`\>(`schemaKeyRef`, `data`): data is T \| Promise - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schemaKeyRef` | `string` \| [`AnySchema`](../modules/verida_web_helpers._internal_.md#anyschema) | -| `data` | `unknown` | - -#### Returns - -data is T \| Promise - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:137 - -___ - -### validateSchema - -▸ **validateSchema**(`schema`, `throwOrLogError?`): `boolean` \| `Promise`<`unknown`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schema` | [`AnySchema`](../modules/verida_web_helpers._internal_.md#anyschema) | -| `throwOrLogError?` | `boolean` | - -#### Returns - -`boolean` \| `Promise`<`unknown`\> - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:153 diff --git a/docs/api/verida-js/classes/verida_web_helpers._internal_.default-4.md b/docs/api/verida-js/classes/verida_web_helpers._internal_.default-4.md deleted file mode 100644 index 7bc8b8f..0000000 --- a/docs/api/verida-js/classes/verida_web_helpers._internal_.default-4.md +++ /dev/null @@ -1,198 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / default - -# Class: default - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).default - -## Hierarchy - -- [`Error`](../modules/verida_web_helpers._internal_.md#error) - - ↳ **`default`** - -## Table of contents - -### Constructors - -- [constructor](verida_web_helpers._internal_.default-4.md#constructor) - -### Properties - -- [ajv](verida_web_helpers._internal_.default-4.md#ajv) -- [errors](verida_web_helpers._internal_.default-4.md#errors) -- [message](verida_web_helpers._internal_.default-4.md#message) -- [name](verida_web_helpers._internal_.default-4.md#name) -- [stack](verida_web_helpers._internal_.default-4.md#stack) -- [validation](verida_web_helpers._internal_.default-4.md#validation) -- [prepareStackTrace](verida_web_helpers._internal_.default-4.md#preparestacktrace) -- [stackTraceLimit](verida_web_helpers._internal_.default-4.md#stacktracelimit) - -### Methods - -- [captureStackTrace](verida_web_helpers._internal_.default-4.md#capturestacktrace) - -## Constructors - -### constructor - -• **new default**(`errors`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `errors` | [`Partial`](../modules/verida_web_helpers._internal_.md#partial)<[`ErrorObject`](../interfaces/verida_web_helpers._internal_.ErrorObject.md)<`string`, [`Record`](../modules/verida_web_helpers._internal_.md#record)<`string`, `any`\>, `unknown`\>\>[] | - -#### Overrides - -Error.constructor - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/runtime/validation_error.d.ts:6 - -## Properties - -### ajv - -• `Readonly` **ajv**: ``true`` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/runtime/validation_error.d.ts:4 - -___ - -### errors - -• `Readonly` **errors**: [`Partial`](../modules/verida_web_helpers._internal_.md#partial)<[`ErrorObject`](../interfaces/verida_web_helpers._internal_.ErrorObject.md)<`string`, [`Record`](../modules/verida_web_helpers._internal_.md#record)<`string`, `any`\>, `unknown`\>\>[] - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/runtime/validation_error.d.ts:3 - -___ - -### message - -• **message**: `string` - -#### Inherited from - -Error.message - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:974 - -___ - -### name - -• **name**: `string` - -#### Inherited from - -Error.name - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:973 - -___ - -### stack - -• `Optional` **stack**: `string` - -#### Inherited from - -Error.stack - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:975 - -___ - -### validation - -• `Readonly` **validation**: ``true`` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/runtime/validation_error.d.ts:5 - -___ - -### prepareStackTrace - -▪ `Static` `Optional` **prepareStackTrace**: (`err`: [`Error`](../modules/verida_web_helpers._internal_.md#error), `stackTraces`: [`CallSite`](../interfaces/verida_web_helpers._internal_.CallSite.md)[]) => `any` - -#### Type declaration - -▸ (`err`, `stackTraces`): `any` - -Optional override for formatting stack traces - -**`see`** https://v8.dev/docs/stack-trace-api#customizing-stack-traces - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `err` | [`Error`](../modules/verida_web_helpers._internal_.md#error) | -| `stackTraces` | [`CallSite`](../interfaces/verida_web_helpers._internal_.CallSite.md)[] | - -##### Returns - -`any` - -#### Inherited from - -Error.prepareStackTrace - -#### Defined in - -node_modules/@types/node/globals.d.ts:11 - -___ - -### stackTraceLimit - -▪ `Static` **stackTraceLimit**: `number` - -#### Inherited from - -Error.stackTraceLimit - -#### Defined in - -node_modules/@types/node/globals.d.ts:13 - -## Methods - -### captureStackTrace - -▸ `Static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` - -Create .stack property on a target object - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `targetObject` | `object` | -| `constructorOpt?` | `Function` | - -#### Returns - -`void` - -#### Inherited from - -Error.captureStackTrace - -#### Defined in - -node_modules/@types/node/globals.d.ts:4 diff --git a/docs/api/verida-js/classes/verida_web_helpers._internal_.default-5.md b/docs/api/verida-js/classes/verida_web_helpers._internal_.default-5.md deleted file mode 100644 index d02488b..0000000 --- a/docs/api/verida-js/classes/verida_web_helpers._internal_.default-5.md +++ /dev/null @@ -1,190 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / default - -# Class: default - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).default - -## Hierarchy - -- [`Error`](../modules/verida_web_helpers._internal_.md#error) - - ↳ **`default`** - -## Table of contents - -### Constructors - -- [constructor](verida_web_helpers._internal_.default-5.md#constructor) - -### Properties - -- [message](verida_web_helpers._internal_.default-5.md#message) -- [missingRef](verida_web_helpers._internal_.default-5.md#missingref) -- [missingSchema](verida_web_helpers._internal_.default-5.md#missingschema) -- [name](verida_web_helpers._internal_.default-5.md#name) -- [stack](verida_web_helpers._internal_.default-5.md#stack) -- [prepareStackTrace](verida_web_helpers._internal_.default-5.md#preparestacktrace) -- [stackTraceLimit](verida_web_helpers._internal_.default-5.md#stacktracelimit) - -### Methods - -- [captureStackTrace](verida_web_helpers._internal_.default-5.md#capturestacktrace) - -## Constructors - -### constructor - -• **new default**(`resolver`, `baseId`, `ref`, `msg?`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `resolver` | [`UriResolver`](../interfaces/verida_web_helpers._internal_.UriResolver.md) | -| `baseId` | `string` | -| `ref` | `string` | -| `msg?` | `string` | - -#### Overrides - -Error.constructor - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/ref_error.d.ts:5 - -## Properties - -### message - -• **message**: `string` - -#### Inherited from - -Error.message - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:974 - -___ - -### missingRef - -• `Readonly` **missingRef**: `string` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/ref_error.d.ts:3 - -___ - -### missingSchema - -• `Readonly` **missingSchema**: `string` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/ref_error.d.ts:4 - -___ - -### name - -• **name**: `string` - -#### Inherited from - -Error.name - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:973 - -___ - -### stack - -• `Optional` **stack**: `string` - -#### Inherited from - -Error.stack - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:975 - -___ - -### prepareStackTrace - -▪ `Static` `Optional` **prepareStackTrace**: (`err`: [`Error`](../modules/verida_web_helpers._internal_.md#error), `stackTraces`: [`CallSite`](../interfaces/verida_web_helpers._internal_.CallSite.md)[]) => `any` - -#### Type declaration - -▸ (`err`, `stackTraces`): `any` - -Optional override for formatting stack traces - -**`see`** https://v8.dev/docs/stack-trace-api#customizing-stack-traces - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `err` | [`Error`](../modules/verida_web_helpers._internal_.md#error) | -| `stackTraces` | [`CallSite`](../interfaces/verida_web_helpers._internal_.CallSite.md)[] | - -##### Returns - -`any` - -#### Inherited from - -Error.prepareStackTrace - -#### Defined in - -node_modules/@types/node/globals.d.ts:11 - -___ - -### stackTraceLimit - -▪ `Static` **stackTraceLimit**: `number` - -#### Inherited from - -Error.stackTraceLimit - -#### Defined in - -node_modules/@types/node/globals.d.ts:13 - -## Methods - -### captureStackTrace - -▸ `Static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` - -Create .stack property on a target object - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `targetObject` | `object` | -| `constructorOpt?` | `Function` | - -#### Returns - -`void` - -#### Inherited from - -Error.captureStackTrace - -#### Defined in - -node_modules/@types/node/globals.d.ts:4 diff --git a/docs/api/verida-js/classes/verida_web_helpers._internal_.default.md b/docs/api/verida-js/classes/verida_web_helpers._internal_.default.md deleted file mode 100644 index 9718272..0000000 --- a/docs/api/verida-js/classes/verida_web_helpers._internal_.default.md +++ /dev/null @@ -1,352 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / default - -# Class: default - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).default - -An Authenticator that automatically signs everything - -## Hierarchy - -- **`default`** - - ↳ [`VaultAccount`](verida_web_helpers._internal_.VaultAccount.md) - -## Implements - -- [`IAccount`](../interfaces/verida_web_helpers._internal_.IAccount.md) - -## Table of contents - -### Constructors - -- [constructor](verida_web_helpers._internal_.default.md#constructor) - -### Methods - -- [createDidJwt](verida_web_helpers._internal_.default.md#createdidjwt) -- [did](verida_web_helpers._internal_.default.md#did) -- [disconnect](verida_web_helpers._internal_.default.md#disconnect) -- [disconnectDevice](verida_web_helpers._internal_.default.md#disconnectdevice) -- [getAuthContext](verida_web_helpers._internal_.default.md#getauthcontext) -- [keyring](verida_web_helpers._internal_.default.md#keyring) -- [linkStorage](verida_web_helpers._internal_.default.md#linkstorage) -- [linkStorageContextService](verida_web_helpers._internal_.default.md#linkstoragecontextservice) -- [setAccountConfig](verida_web_helpers._internal_.default.md#setaccountconfig) -- [sign](verida_web_helpers._internal_.default.md#sign) -- [storageConfig](verida_web_helpers._internal_.default.md#storageconfig) -- [unlinkStorage](verida_web_helpers._internal_.default.md#unlinkstorage) - -## Constructors - -### constructor - -• **new default**() - -## Methods - -### createDidJwt - -▸ **createDidJwt**(`contextName`, `data`, `config?`): `Promise`<`string`\> - -Create a DID-JWT from a data object - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | -| `data` | `object` | -| `config?` | `any` | - -#### Returns - -`Promise`<`string`\> - -#### Implementation of - -[IAccount](../interfaces/verida_web_helpers._internal_.IAccount.md).[createDidJwt](../interfaces/verida_web_helpers._internal_.IAccount.md#createdidjwt) - -#### Defined in - -packages/account/dist/account.d.ts:42 - -___ - -### did - -▸ **did**(): `Promise`<`string`\> - -Get the DID of the current user - -#### Returns - -`Promise`<`string`\> - -#### Implementation of - -[IAccount](../interfaces/verida_web_helpers._internal_.IAccount.md).[did](../interfaces/verida_web_helpers._internal_.IAccount.md#did) - -#### Defined in - -packages/account/dist/account.d.ts:22 - -___ - -### disconnect - -▸ **disconnect**(`contextName?`): `Promise`<`void`\> - -An optional method that can be used to disconnect the current user. - -For example, in a web browser context, it would remove any stored signatures from local storage. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName?` | `string` | - -#### Returns - -`Promise`<`void`\> - -#### Implementation of - -[IAccount](../interfaces/verida_web_helpers._internal_.IAccount.md).[disconnect](../interfaces/verida_web_helpers._internal_.IAccount.md#disconnect) - -#### Defined in - -packages/account/dist/account.d.ts:48 - -___ - -### disconnectDevice - -▸ **disconnectDevice**(`contextName`, `deviceId?`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | -| `deviceId?` | `string` | - -#### Returns - -`Promise`<`boolean`\> - -#### Implementation of - -[IAccount](../interfaces/verida_web_helpers._internal_.IAccount.md).[disconnectDevice](../interfaces/verida_web_helpers._internal_.IAccount.md#disconnectdevice) - -#### Defined in - -packages/account/dist/account.d.ts:50 - -___ - -### getAuthContext - -▸ **getAuthContext**(`contextName`, `contextConfig`, `authConfig?`, `authType?`): `Promise`<[`AuthContext`](../interfaces/verida_web_helpers._internal_.AuthContext.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | -| `contextConfig` | [`SecureContextConfig`](../interfaces/verida_web_helpers._internal_.SecureContextConfig.md) | -| `authConfig?` | [`AuthTypeConfig`](../interfaces/verida_web_helpers._internal_.AuthTypeConfig.md) | -| `authType?` | `string` | - -#### Returns - -`Promise`<[`AuthContext`](../interfaces/verida_web_helpers._internal_.AuthContext.md)\> - -#### Implementation of - -[IAccount](../interfaces/verida_web_helpers._internal_.IAccount.md).[getAuthContext](../interfaces/verida_web_helpers._internal_.IAccount.md#getauthcontext) - -#### Defined in - -packages/account/dist/account.d.ts:49 - -___ - -### keyring - -▸ **keyring**(`contextName`): `Promise`<[`default`](verida_web_helpers._internal_.default-1.md)\> - -Generate a keyring for this user for a given storage context. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | - -#### Returns - -`Promise`<[`default`](verida_web_helpers._internal_.default-1.md)\> - -#### Implementation of - -[IAccount](../interfaces/verida_web_helpers._internal_.IAccount.md).[keyring](../interfaces/verida_web_helpers._internal_.IAccount.md#keyring) - -#### Defined in - -packages/account/dist/account.d.ts:12 - -___ - -### linkStorage - -▸ **linkStorage**(`storageConfig`): `Promise`<`boolean`\> - -Link storage to this user - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `storageConfig` | [`SecureContextConfig`](../interfaces/verida_web_helpers._internal_.SecureContextConfig.md) | - -#### Returns - -`Promise`<`boolean`\> - -#### Implementation of - -[IAccount](../interfaces/verida_web_helpers._internal_.IAccount.md).[linkStorage](../interfaces/verida_web_helpers._internal_.IAccount.md#linkstorage) - -#### Defined in - -packages/account/dist/account.d.ts:28 - -___ - -### linkStorageContextService - -▸ **linkStorageContextService**(`contextName`, `endpointType`, `serverType`, `endpointUris`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | -| `endpointType` | `string` | -| `serverType` | `string` | -| `endpointUris` | `string`[] | - -#### Returns - -`Promise`<`boolean`\> - -#### Implementation of - -[IAccount](../interfaces/verida_web_helpers._internal_.IAccount.md).[linkStorageContextService](../interfaces/verida_web_helpers._internal_.IAccount.md#linkstoragecontextservice) - -#### Defined in - -packages/account/dist/account.d.ts:36 - -___ - -### setAccountConfig - -▸ **setAccountConfig**(`accountConfig`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `accountConfig` | [`AccountConfig`](../interfaces/verida_web_helpers._internal_.AccountConfig.md) | - -#### Returns - -`void` - -#### Implementation of - -[IAccount](../interfaces/verida_web_helpers._internal_.IAccount.md).[setAccountConfig](../interfaces/verida_web_helpers._internal_.IAccount.md#setaccountconfig) - -#### Defined in - -packages/account/dist/account.d.ts:37 - -___ - -### sign - -▸ **sign**(`input`): `Promise`<`string`\> - -Sign a string as the current user - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `input` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Implementation of - -[IAccount](../interfaces/verida_web_helpers._internal_.IAccount.md).[sign](../interfaces/verida_web_helpers._internal_.IAccount.md#sign) - -#### Defined in - -packages/account/dist/account.d.ts:18 - -___ - -### storageConfig - -▸ **storageConfig**(`contextName`, `forceCreate?`): `Promise`<`undefined` \| [`SecureContextConfig`](../interfaces/verida_web_helpers._internal_.SecureContextConfig.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | -| `forceCreate?` | `boolean` | - -#### Returns - -`Promise`<`undefined` \| [`SecureContextConfig`](../interfaces/verida_web_helpers._internal_.SecureContextConfig.md)\> - -#### Implementation of - -[IAccount](../interfaces/verida_web_helpers._internal_.IAccount.md).[storageConfig](../interfaces/verida_web_helpers._internal_.IAccount.md#storageconfig) - -#### Defined in - -packages/account/dist/account.d.ts:35 - -___ - -### unlinkStorage - -▸ **unlinkStorage**(`contextName`): `Promise`<`boolean`\> - -Unlink storage for this user - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | - -#### Returns - -`Promise`<`boolean`\> - -#### Implementation of - -[IAccount](../interfaces/verida_web_helpers._internal_.IAccount.md).[unlinkStorage](../interfaces/verida_web_helpers._internal_.IAccount.md#unlinkstorage) - -#### Defined in - -packages/account/dist/account.d.ts:34 diff --git a/docs/api/verida-js/enums/verida_account.EnvironmentType.md b/docs/api/verida-js/enums/verida_account.EnvironmentType.md deleted file mode 100644 index 3658ce4..0000000 --- a/docs/api/verida-js/enums/verida_account.EnvironmentType.md +++ /dev/null @@ -1,43 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account](../modules/verida_account.md) / EnvironmentType - -# Enumeration: EnvironmentType - -[@verida/account](../modules/verida_account.md).EnvironmentType - -## Table of contents - -### Enumeration members - -- [LOCAL](verida_account.EnvironmentType.md#local) -- [MAINNET](verida_account.EnvironmentType.md#mainnet) -- [TESTNET](verida_account.EnvironmentType.md#testnet) - -## Enumeration members - -### LOCAL - -• **LOCAL** = `"local"` - -#### Defined in - -[packages/account/src/interfaces.ts:11](https://github.com/verida/verida-js/blob/c03b336/packages/account/src/interfaces.ts#L11) - -___ - -### MAINNET - -• **MAINNET** = `"mainnet"` - -#### Defined in - -[packages/account/src/interfaces.ts:13](https://github.com/verida/verida-js/blob/c03b336/packages/account/src/interfaces.ts#L13) - -___ - -### TESTNET - -• **TESTNET** = `"testnet"` - -#### Defined in - -[packages/account/src/interfaces.ts:12](https://github.com/verida/verida-js/blob/c03b336/packages/account/src/interfaces.ts#L12) diff --git a/docs/api/verida-js/enums/verida_account_node._internal_.EndpointType.md b/docs/api/verida-js/enums/verida_account_node._internal_.EndpointType.md deleted file mode 100644 index f3d6fd9..0000000 --- a/docs/api/verida-js/enums/verida_account_node._internal_.EndpointType.md +++ /dev/null @@ -1,54 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account-node](../modules/verida_account_node.md) / [](../modules/verida_account_node._internal_.md) / EndpointType - -# Enumeration: EndpointType - -[@verida/account-node](../modules/verida_account_node.md).[](../modules/verida_account_node._internal_.md).EndpointType - -## Table of contents - -### Enumeration members - -- [DATABASE](verida_account_node._internal_.EndpointType.md#database) -- [MESSAGING](verida_account_node._internal_.EndpointType.md#messaging) -- [NOTIFICATION](verida_account_node._internal_.EndpointType.md#notification) -- [STORAGE](verida_account_node._internal_.EndpointType.md#storage) - -## Enumeration members - -### DATABASE - -• **DATABASE** = `"database"` - -#### Defined in - -packages/did-document/dist/interfaces.d.ts:23 - -___ - -### MESSAGING - -• **MESSAGING** = `"messaging"` - -#### Defined in - -packages/did-document/dist/interfaces.d.ts:24 - -___ - -### NOTIFICATION - -• **NOTIFICATION** = `"notification"` - -#### Defined in - -packages/did-document/dist/interfaces.d.ts:26 - -___ - -### STORAGE - -• **STORAGE** = `"storage"` - -#### Defined in - -packages/did-document/dist/interfaces.d.ts:25 diff --git a/docs/api/verida-js/enums/verida_account_node._internal_.EnvironmentType.md b/docs/api/verida-js/enums/verida_account_node._internal_.EnvironmentType.md deleted file mode 100644 index 51ac1ad..0000000 --- a/docs/api/verida-js/enums/verida_account_node._internal_.EnvironmentType.md +++ /dev/null @@ -1,54 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account-node](../modules/verida_account_node.md) / [](../modules/verida_account_node._internal_.md) / EnvironmentType - -# Enumeration: EnvironmentType - -[@verida/account-node](../modules/verida_account_node.md).[](../modules/verida_account_node._internal_.md).EnvironmentType - -## Table of contents - -### Enumeration members - -- [DEVNET](verida_account_node._internal_.EnvironmentType.md#devnet) -- [LOCAL](verida_account_node._internal_.EnvironmentType.md#local) -- [MAINNET](verida_account_node._internal_.EnvironmentType.md#mainnet) -- [TESTNET](verida_account_node._internal_.EnvironmentType.md#testnet) - -## Enumeration members - -### DEVNET - -• **DEVNET** = `"devnet"` - -#### Defined in - -packages/types/dist/NetworkInterfaces.d.ts:6 - -___ - -### LOCAL - -• **LOCAL** = `"local"` - -#### Defined in - -packages/types/dist/NetworkInterfaces.d.ts:5 - -___ - -### MAINNET - -• **MAINNET** = `"mainnet"` - -#### Defined in - -packages/types/dist/NetworkInterfaces.d.ts:8 - -___ - -### TESTNET - -• **TESTNET** = `"testnet"` - -#### Defined in - -packages/types/dist/NetworkInterfaces.d.ts:7 diff --git a/docs/api/verida-js/enums/verida_account_node._internal_.SecureContextEndpointType.md b/docs/api/verida-js/enums/verida_account_node._internal_.SecureContextEndpointType.md deleted file mode 100644 index 96941b8..0000000 --- a/docs/api/verida-js/enums/verida_account_node._internal_.SecureContextEndpointType.md +++ /dev/null @@ -1,54 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account-node](../modules/verida_account_node.md) / [](../modules/verida_account_node._internal_.md) / SecureContextEndpointType - -# Enumeration: SecureContextEndpointType - -[@verida/account-node](../modules/verida_account_node.md).[](../modules/verida_account_node._internal_.md).SecureContextEndpointType - -## Table of contents - -### Enumeration members - -- [DATABASE](verida_account_node._internal_.SecureContextEndpointType.md#database) -- [MESSAGING](verida_account_node._internal_.SecureContextEndpointType.md#messaging) -- [NOTIFICATION](verida_account_node._internal_.SecureContextEndpointType.md#notification) -- [STORAGE](verida_account_node._internal_.SecureContextEndpointType.md#storage) - -## Enumeration members - -### DATABASE - -• **DATABASE** = `"database"` - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:14 - -___ - -### MESSAGING - -• **MESSAGING** = `"messaging"` - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:15 - -___ - -### NOTIFICATION - -• **NOTIFICATION** = `"notification"` - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:17 - -___ - -### STORAGE - -• **STORAGE** = `"storage"` - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:16 diff --git a/docs/api/verida-js/enums/verida_account_web_vault._internal_.EnvironmentType.md b/docs/api/verida-js/enums/verida_account_web_vault._internal_.EnvironmentType.md deleted file mode 100644 index 4eb8cba..0000000 --- a/docs/api/verida-js/enums/verida_account_web_vault._internal_.EnvironmentType.md +++ /dev/null @@ -1,54 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account-web-vault](../modules/verida_account_web_vault.md) / [](../modules/verida_account_web_vault._internal_.md) / EnvironmentType - -# Enumeration: EnvironmentType - -[@verida/account-web-vault](../modules/verida_account_web_vault.md).[](../modules/verida_account_web_vault._internal_.md).EnvironmentType - -## Table of contents - -### Enumeration members - -- [DEVNET](verida_account_web_vault._internal_.EnvironmentType.md#devnet) -- [LOCAL](verida_account_web_vault._internal_.EnvironmentType.md#local) -- [MAINNET](verida_account_web_vault._internal_.EnvironmentType.md#mainnet) -- [TESTNET](verida_account_web_vault._internal_.EnvironmentType.md#testnet) - -## Enumeration members - -### DEVNET - -• **DEVNET** = `"devnet"` - -#### Defined in - -packages/types/dist/NetworkInterfaces.d.ts:6 - -___ - -### LOCAL - -• **LOCAL** = `"local"` - -#### Defined in - -packages/types/dist/NetworkInterfaces.d.ts:5 - -___ - -### MAINNET - -• **MAINNET** = `"mainnet"` - -#### Defined in - -packages/types/dist/NetworkInterfaces.d.ts:8 - -___ - -### TESTNET - -• **TESTNET** = `"testnet"` - -#### Defined in - -packages/types/dist/NetworkInterfaces.d.ts:7 diff --git a/docs/api/verida-js/enums/verida_client_ts.ContextInterfaces.PermissionOptionsEnum.md b/docs/api/verida-js/enums/verida_client_ts.ContextInterfaces.PermissionOptionsEnum.md deleted file mode 100644 index 845af18..0000000 --- a/docs/api/verida-js/enums/verida_client_ts.ContextInterfaces.PermissionOptionsEnum.md +++ /dev/null @@ -1,43 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [ContextInterfaces](../modules/verida_client_ts.ContextInterfaces.md) / PermissionOptionsEnum - -# Enumeration: PermissionOptionsEnum - -[@verida/client-ts](../modules/verida_client_ts.md).[ContextInterfaces](../modules/verida_client_ts.ContextInterfaces.md).PermissionOptionsEnum - -## Table of contents - -### Enumeration members - -- [OWNER](verida_client_ts.ContextInterfaces.PermissionOptionsEnum.md#owner) -- [PUBLIC](verida_client_ts.ContextInterfaces.PermissionOptionsEnum.md#public) -- [USERS](verida_client_ts.ContextInterfaces.PermissionOptionsEnum.md#users) - -## Enumeration members - -### OWNER - -• **OWNER** = `"owner"` - -#### Defined in - -[packages/client-ts/src/context/interfaces.ts:107](https://github.com/verida/verida-js/blob/c03b336/packages/client-ts/src/context/interfaces.ts#L107) - -___ - -### PUBLIC - -• **PUBLIC** = `"public"` - -#### Defined in - -[packages/client-ts/src/context/interfaces.ts:108](https://github.com/verida/verida-js/blob/c03b336/packages/client-ts/src/context/interfaces.ts#L108) - -___ - -### USERS - -• **USERS** = `"users"` - -#### Defined in - -[packages/client-ts/src/context/interfaces.ts:109](https://github.com/verida/verida-js/blob/c03b336/packages/client-ts/src/context/interfaces.ts#L109) diff --git a/docs/api/verida-js/enums/verida_client_ts.EnvironmentType.md b/docs/api/verida-js/enums/verida_client_ts.EnvironmentType.md deleted file mode 100644 index aeca1d7..0000000 --- a/docs/api/verida-js/enums/verida_client_ts.EnvironmentType.md +++ /dev/null @@ -1,43 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / EnvironmentType - -# Enumeration: EnvironmentType - -[@verida/client-ts](../modules/verida_client_ts.md).EnvironmentType - -## Table of contents - -### Enumeration members - -- [LOCAL](verida_client_ts.EnvironmentType.md#local) -- [MAINNET](verida_client_ts.EnvironmentType.md#mainnet) -- [TESTNET](verida_client_ts.EnvironmentType.md#testnet) - -## Enumeration members - -### LOCAL - -• **LOCAL** = `"local"` - -#### Defined in - -packages/account/dist/interfaces.d.ts:9 - -___ - -### MAINNET - -• **MAINNET** = `"mainnet"` - -#### Defined in - -packages/account/dist/interfaces.d.ts:11 - -___ - -### TESTNET - -• **TESTNET** = `"testnet"` - -#### Defined in - -packages/account/dist/interfaces.d.ts:10 diff --git a/docs/api/verida-js/enums/verida_client_ts._internal_.ContextEngineType.md b/docs/api/verida-js/enums/verida_client_ts._internal_.ContextEngineType.md deleted file mode 100644 index eea5f82..0000000 --- a/docs/api/verida-js/enums/verida_client_ts._internal_.ContextEngineType.md +++ /dev/null @@ -1,43 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / ContextEngineType - -# Enumeration: ContextEngineType - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).ContextEngineType - -## Table of contents - -### Enumeration members - -- [Database](verida_client_ts._internal_.ContextEngineType.md#database) -- [Messsaging](verida_client_ts._internal_.ContextEngineType.md#messsaging) -- [Notification](verida_client_ts._internal_.ContextEngineType.md#notification) - -## Enumeration members - -### Database - -• **Database** = `"database"` - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:102 - -___ - -### Messsaging - -• **Messsaging** = `"messaging"` - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:104 - -___ - -### Notification - -• **Notification** = `"notification"` - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:103 diff --git a/docs/api/verida-js/enums/verida_client_ts._internal_.DatabasePermissionOptionsEnum.md b/docs/api/verida-js/enums/verida_client_ts._internal_.DatabasePermissionOptionsEnum.md deleted file mode 100644 index 4dd5b10..0000000 --- a/docs/api/verida-js/enums/verida_client_ts._internal_.DatabasePermissionOptionsEnum.md +++ /dev/null @@ -1,43 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / DatabasePermissionOptionsEnum - -# Enumeration: DatabasePermissionOptionsEnum - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).DatabasePermissionOptionsEnum - -## Table of contents - -### Enumeration members - -- [OWNER](verida_client_ts._internal_.DatabasePermissionOptionsEnum.md#owner) -- [PUBLIC](verida_client_ts._internal_.DatabasePermissionOptionsEnum.md#public) -- [USERS](verida_client_ts._internal_.DatabasePermissionOptionsEnum.md#users) - -## Enumeration members - -### OWNER - -• **OWNER** = `"owner"` - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:116 - -___ - -### PUBLIC - -• **PUBLIC** = `"public"` - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:117 - -___ - -### USERS - -• **USERS** = `"users"` - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:118 diff --git a/docs/api/verida-js/enums/verida_client_ts._internal_.EndpointType.md b/docs/api/verida-js/enums/verida_client_ts._internal_.EndpointType.md deleted file mode 100644 index 9ad986b..0000000 --- a/docs/api/verida-js/enums/verida_client_ts._internal_.EndpointType.md +++ /dev/null @@ -1,54 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / EndpointType - -# Enumeration: EndpointType - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).EndpointType - -## Table of contents - -### Enumeration members - -- [DATABASE](verida_client_ts._internal_.EndpointType.md#database) -- [MESSAGING](verida_client_ts._internal_.EndpointType.md#messaging) -- [NOTIFICATION](verida_client_ts._internal_.EndpointType.md#notification) -- [STORAGE](verida_client_ts._internal_.EndpointType.md#storage) - -## Enumeration members - -### DATABASE - -• **DATABASE** = `"database"` - -#### Defined in - -packages/did-document/dist/interfaces.d.ts:23 - -___ - -### MESSAGING - -• **MESSAGING** = `"messaging"` - -#### Defined in - -packages/did-document/dist/interfaces.d.ts:24 - -___ - -### NOTIFICATION - -• **NOTIFICATION** = `"notification"` - -#### Defined in - -packages/did-document/dist/interfaces.d.ts:26 - -___ - -### STORAGE - -• **STORAGE** = `"storage"` - -#### Defined in - -packages/did-document/dist/interfaces.d.ts:25 diff --git a/docs/api/verida-js/enums/verida_client_ts._internal_.EnvironmentType.md b/docs/api/verida-js/enums/verida_client_ts._internal_.EnvironmentType.md deleted file mode 100644 index cf38530..0000000 --- a/docs/api/verida-js/enums/verida_client_ts._internal_.EnvironmentType.md +++ /dev/null @@ -1,54 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / EnvironmentType - -# Enumeration: EnvironmentType - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).EnvironmentType - -## Table of contents - -### Enumeration members - -- [DEVNET](verida_client_ts._internal_.EnvironmentType.md#devnet) -- [LOCAL](verida_client_ts._internal_.EnvironmentType.md#local) -- [MAINNET](verida_client_ts._internal_.EnvironmentType.md#mainnet) -- [TESTNET](verida_client_ts._internal_.EnvironmentType.md#testnet) - -## Enumeration members - -### DEVNET - -• **DEVNET** = `"devnet"` - -#### Defined in - -packages/types/dist/NetworkInterfaces.d.ts:6 - -___ - -### LOCAL - -• **LOCAL** = `"local"` - -#### Defined in - -packages/types/dist/NetworkInterfaces.d.ts:5 - -___ - -### MAINNET - -• **MAINNET** = `"mainnet"` - -#### Defined in - -packages/types/dist/NetworkInterfaces.d.ts:8 - -___ - -### TESTNET - -• **TESTNET** = `"testnet"` - -#### Defined in - -packages/types/dist/NetworkInterfaces.d.ts:7 diff --git a/docs/api/verida-js/enums/verida_client_ts._internal_.SecureContextEndpointType.md b/docs/api/verida-js/enums/verida_client_ts._internal_.SecureContextEndpointType.md deleted file mode 100644 index 986ad22..0000000 --- a/docs/api/verida-js/enums/verida_client_ts._internal_.SecureContextEndpointType.md +++ /dev/null @@ -1,54 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / SecureContextEndpointType - -# Enumeration: SecureContextEndpointType - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).SecureContextEndpointType - -## Table of contents - -### Enumeration members - -- [DATABASE](verida_client_ts._internal_.SecureContextEndpointType.md#database) -- [MESSAGING](verida_client_ts._internal_.SecureContextEndpointType.md#messaging) -- [NOTIFICATION](verida_client_ts._internal_.SecureContextEndpointType.md#notification) -- [STORAGE](verida_client_ts._internal_.SecureContextEndpointType.md#storage) - -## Enumeration members - -### DATABASE - -• **DATABASE** = `"database"` - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:14 - -___ - -### MESSAGING - -• **MESSAGING** = `"messaging"` - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:15 - -___ - -### NOTIFICATION - -• **NOTIFICATION** = `"notification"` - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:17 - -___ - -### STORAGE - -• **STORAGE** = `"storage"` - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:16 diff --git a/docs/api/verida-js/enums/verida_client_ts._internal_.Type.md b/docs/api/verida-js/enums/verida_client_ts._internal_.Type.md deleted file mode 100644 index 0407090..0000000 --- a/docs/api/verida-js/enums/verida_client_ts._internal_.Type.md +++ /dev/null @@ -1,32 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / Type - -# Enumeration: Type - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).Type - -## Table of contents - -### Enumeration members - -- [Num](verida_client_ts._internal_.Type.md#num) -- [Str](verida_client_ts._internal_.Type.md#str) - -## Enumeration members - -### Num - -• **Num** = `0` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/util.d.ts:35 - -___ - -### Str - -• **Str** = `1` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/util.d.ts:36 diff --git a/docs/api/verida-js/enums/verida_client_ts._internal_.UsedValueState.md b/docs/api/verida-js/enums/verida_client_ts._internal_.UsedValueState.md deleted file mode 100644 index 1a6604c..0000000 --- a/docs/api/verida-js/enums/verida_client_ts._internal_.UsedValueState.md +++ /dev/null @@ -1,32 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / UsedValueState - -# Enumeration: UsedValueState - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).UsedValueState - -## Table of contents - -### Enumeration members - -- [Completed](verida_client_ts._internal_.UsedValueState.md#completed) -- [Started](verida_client_ts._internal_.UsedValueState.md#started) - -## Enumeration members - -### Completed - -• **Completed** = `1` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/scope.d.ts:30 - -___ - -### Started - -• **Started** = `0` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/scope.d.ts:29 diff --git a/docs/api/verida-js/enums/verida_did_client._internal_.EndpointType.md b/docs/api/verida-js/enums/verida_did_client._internal_.EndpointType.md deleted file mode 100644 index f0fc6fa..0000000 --- a/docs/api/verida-js/enums/verida_did_client._internal_.EndpointType.md +++ /dev/null @@ -1,54 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/did-client](../modules/verida_did_client.md) / [](../modules/verida_did_client._internal_.md) / EndpointType - -# Enumeration: EndpointType - -[@verida/did-client](../modules/verida_did_client.md).[](../modules/verida_did_client._internal_.md).EndpointType - -## Table of contents - -### Enumeration members - -- [DATABASE](verida_did_client._internal_.EndpointType.md#database) -- [MESSAGING](verida_did_client._internal_.EndpointType.md#messaging) -- [NOTIFICATION](verida_did_client._internal_.EndpointType.md#notification) -- [STORAGE](verida_did_client._internal_.EndpointType.md#storage) - -## Enumeration members - -### DATABASE - -• **DATABASE** = `"database"` - -#### Defined in - -packages/did-document/dist/interfaces.d.ts:23 - -___ - -### MESSAGING - -• **MESSAGING** = `"messaging"` - -#### Defined in - -packages/did-document/dist/interfaces.d.ts:24 - -___ - -### NOTIFICATION - -• **NOTIFICATION** = `"notification"` - -#### Defined in - -packages/did-document/dist/interfaces.d.ts:26 - -___ - -### STORAGE - -• **STORAGE** = `"storage"` - -#### Defined in - -packages/did-document/dist/interfaces.d.ts:25 diff --git a/docs/api/verida-js/enums/verida_did_client._internal_.EnvironmentType.md b/docs/api/verida-js/enums/verida_did_client._internal_.EnvironmentType.md deleted file mode 100644 index 612b92f..0000000 --- a/docs/api/verida-js/enums/verida_did_client._internal_.EnvironmentType.md +++ /dev/null @@ -1,54 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/did-client](../modules/verida_did_client.md) / [](../modules/verida_did_client._internal_.md) / EnvironmentType - -# Enumeration: EnvironmentType - -[@verida/did-client](../modules/verida_did_client.md).[](../modules/verida_did_client._internal_.md).EnvironmentType - -## Table of contents - -### Enumeration members - -- [DEVNET](verida_did_client._internal_.EnvironmentType.md#devnet) -- [LOCAL](verida_did_client._internal_.EnvironmentType.md#local) -- [MAINNET](verida_did_client._internal_.EnvironmentType.md#mainnet) -- [TESTNET](verida_did_client._internal_.EnvironmentType.md#testnet) - -## Enumeration members - -### DEVNET - -• **DEVNET** = `"devnet"` - -#### Defined in - -packages/types/dist/NetworkInterfaces.d.ts:6 - -___ - -### LOCAL - -• **LOCAL** = `"local"` - -#### Defined in - -packages/types/dist/NetworkInterfaces.d.ts:5 - -___ - -### MAINNET - -• **MAINNET** = `"mainnet"` - -#### Defined in - -packages/types/dist/NetworkInterfaces.d.ts:8 - -___ - -### TESTNET - -• **TESTNET** = `"testnet"` - -#### Defined in - -packages/types/dist/NetworkInterfaces.d.ts:7 diff --git a/docs/api/verida-js/enums/verida_did_client._internal_.SecureContextEndpointType.md b/docs/api/verida-js/enums/verida_did_client._internal_.SecureContextEndpointType.md deleted file mode 100644 index e3c6e7f..0000000 --- a/docs/api/verida-js/enums/verida_did_client._internal_.SecureContextEndpointType.md +++ /dev/null @@ -1,54 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/did-client](../modules/verida_did_client.md) / [](../modules/verida_did_client._internal_.md) / SecureContextEndpointType - -# Enumeration: SecureContextEndpointType - -[@verida/did-client](../modules/verida_did_client.md).[](../modules/verida_did_client._internal_.md).SecureContextEndpointType - -## Table of contents - -### Enumeration members - -- [DATABASE](verida_did_client._internal_.SecureContextEndpointType.md#database) -- [MESSAGING](verida_did_client._internal_.SecureContextEndpointType.md#messaging) -- [NOTIFICATION](verida_did_client._internal_.SecureContextEndpointType.md#notification) -- [STORAGE](verida_did_client._internal_.SecureContextEndpointType.md#storage) - -## Enumeration members - -### DATABASE - -• **DATABASE** = `"database"` - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:14 - -___ - -### MESSAGING - -• **MESSAGING** = `"messaging"` - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:15 - -___ - -### NOTIFICATION - -• **NOTIFICATION** = `"notification"` - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:17 - -___ - -### STORAGE - -• **STORAGE** = `"storage"` - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:16 diff --git a/docs/api/verida-js/enums/verida_did_document.Interfaces.EndpointType.md b/docs/api/verida-js/enums/verida_did_document.Interfaces.EndpointType.md deleted file mode 100644 index de8e3a8..0000000 --- a/docs/api/verida-js/enums/verida_did_document.Interfaces.EndpointType.md +++ /dev/null @@ -1,54 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/did-document](../modules/verida_did_document.md) / [Interfaces](../modules/verida_did_document.Interfaces.md) / EndpointType - -# Enumeration: EndpointType - -[@verida/did-document](../modules/verida_did_document.md).[Interfaces](../modules/verida_did_document.Interfaces.md).EndpointType - -## Table of contents - -### Enumeration members - -- [DATABASE](verida_did_document.Interfaces.EndpointType.md#database) -- [MESSAGING](verida_did_document.Interfaces.EndpointType.md#messaging) -- [NOTIFICATION](verida_did_document.Interfaces.EndpointType.md#notification) -- [STORAGE](verida_did_document.Interfaces.EndpointType.md#storage) - -## Enumeration members - -### DATABASE - -• **DATABASE** = `"database"` - -#### Defined in - -[packages/did-document/src/interfaces.ts:28](https://github.com/verida/verida-js/blob/c03b336/packages/did-document/src/interfaces.ts#L28) - -___ - -### MESSAGING - -• **MESSAGING** = `"messaging"` - -#### Defined in - -[packages/did-document/src/interfaces.ts:29](https://github.com/verida/verida-js/blob/c03b336/packages/did-document/src/interfaces.ts#L29) - -___ - -### NOTIFICATION - -• **NOTIFICATION** = `"notification"` - -#### Defined in - -[packages/did-document/src/interfaces.ts:31](https://github.com/verida/verida-js/blob/c03b336/packages/did-document/src/interfaces.ts#L31) - -___ - -### STORAGE - -• **STORAGE** = `"storage"` - -#### Defined in - -[packages/did-document/src/interfaces.ts:30](https://github.com/verida/verida-js/blob/c03b336/packages/did-document/src/interfaces.ts#L30) diff --git a/docs/api/verida-js/enums/verida_did_document._internal_.SecureContextEndpointType.md b/docs/api/verida-js/enums/verida_did_document._internal_.SecureContextEndpointType.md deleted file mode 100644 index 9eff8d5..0000000 --- a/docs/api/verida-js/enums/verida_did_document._internal_.SecureContextEndpointType.md +++ /dev/null @@ -1,54 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/did-document](../modules/verida_did_document.md) / [](../modules/verida_did_document._internal_.md) / SecureContextEndpointType - -# Enumeration: SecureContextEndpointType - -[@verida/did-document](../modules/verida_did_document.md).[](../modules/verida_did_document._internal_.md).SecureContextEndpointType - -## Table of contents - -### Enumeration members - -- [DATABASE](verida_did_document._internal_.SecureContextEndpointType.md#database) -- [MESSAGING](verida_did_document._internal_.SecureContextEndpointType.md#messaging) -- [NOTIFICATION](verida_did_document._internal_.SecureContextEndpointType.md#notification) -- [STORAGE](verida_did_document._internal_.SecureContextEndpointType.md#storage) - -## Enumeration members - -### DATABASE - -• **DATABASE** = `"database"` - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:14 - -___ - -### MESSAGING - -• **MESSAGING** = `"messaging"` - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:15 - -___ - -### NOTIFICATION - -• **NOTIFICATION** = `"notification"` - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:17 - -___ - -### STORAGE - -• **STORAGE** = `"storage"` - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:16 diff --git a/docs/api/verida-js/enums/verida_did_resolver._internal_.EnvironmentType.md b/docs/api/verida-js/enums/verida_did_resolver._internal_.EnvironmentType.md deleted file mode 100644 index d6fec51..0000000 --- a/docs/api/verida-js/enums/verida_did_resolver._internal_.EnvironmentType.md +++ /dev/null @@ -1,43 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/did-resolver](../modules/verida_did_resolver.md) / [](../modules/verida_did_resolver._internal_.md) / EnvironmentType - -# Enumeration: EnvironmentType - -[@verida/did-resolver](../modules/verida_did_resolver.md).[](../modules/verida_did_resolver._internal_.md).EnvironmentType - -## Table of contents - -### Enumeration members - -- [LOCAL](verida_did_resolver._internal_.EnvironmentType.md#local) -- [MAINNET](verida_did_resolver._internal_.EnvironmentType.md#mainnet) -- [TESTNET](verida_did_resolver._internal_.EnvironmentType.md#testnet) - -## Enumeration members - -### LOCAL - -• **LOCAL** = `"local"` - -#### Defined in - -[packages/did-resolver/src/interfaces.ts:2](https://github.com/verida/verida-js/blob/c03b336/packages/did-resolver/src/interfaces.ts#L2) - -___ - -### MAINNET - -• **MAINNET** = `"mainnet"` - -#### Defined in - -[packages/did-resolver/src/interfaces.ts:4](https://github.com/verida/verida-js/blob/c03b336/packages/did-resolver/src/interfaces.ts#L4) - -___ - -### TESTNET - -• **TESTNET** = `"testnet"` - -#### Defined in - -[packages/did-resolver/src/interfaces.ts:3](https://github.com/verida/verida-js/blob/c03b336/packages/did-resolver/src/interfaces.ts#L3) diff --git a/docs/api/verida-js/enums/verida_helpers._internal_.ContextEngineType.md b/docs/api/verida-js/enums/verida_helpers._internal_.ContextEngineType.md deleted file mode 100644 index 7bef270..0000000 --- a/docs/api/verida-js/enums/verida_helpers._internal_.ContextEngineType.md +++ /dev/null @@ -1,43 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/helpers](../modules/verida_helpers.md) / [](../modules/verida_helpers._internal_.md) / ContextEngineType - -# Enumeration: ContextEngineType - -[@verida/helpers](../modules/verida_helpers.md).[](../modules/verida_helpers._internal_.md).ContextEngineType - -## Table of contents - -### Enumeration members - -- [Database](verida_helpers._internal_.ContextEngineType.md#database) -- [Messsaging](verida_helpers._internal_.ContextEngineType.md#messsaging) -- [Notification](verida_helpers._internal_.ContextEngineType.md#notification) - -## Enumeration members - -### Database - -• **Database** = `"database"` - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:102 - -___ - -### Messsaging - -• **Messsaging** = `"messaging"` - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:104 - -___ - -### Notification - -• **Notification** = `"notification"` - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:103 diff --git a/docs/api/verida-js/enums/verida_helpers._internal_.DatabasePermissionOptionsEnum.md b/docs/api/verida-js/enums/verida_helpers._internal_.DatabasePermissionOptionsEnum.md deleted file mode 100644 index 710f45d..0000000 --- a/docs/api/verida-js/enums/verida_helpers._internal_.DatabasePermissionOptionsEnum.md +++ /dev/null @@ -1,43 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/helpers](../modules/verida_helpers.md) / [](../modules/verida_helpers._internal_.md) / DatabasePermissionOptionsEnum - -# Enumeration: DatabasePermissionOptionsEnum - -[@verida/helpers](../modules/verida_helpers.md).[](../modules/verida_helpers._internal_.md).DatabasePermissionOptionsEnum - -## Table of contents - -### Enumeration members - -- [OWNER](verida_helpers._internal_.DatabasePermissionOptionsEnum.md#owner) -- [PUBLIC](verida_helpers._internal_.DatabasePermissionOptionsEnum.md#public) -- [USERS](verida_helpers._internal_.DatabasePermissionOptionsEnum.md#users) - -## Enumeration members - -### OWNER - -• **OWNER** = `"owner"` - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:116 - -___ - -### PUBLIC - -• **PUBLIC** = `"public"` - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:117 - -___ - -### USERS - -• **USERS** = `"users"` - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:118 diff --git a/docs/api/verida-js/enums/verida_keyring._internal_.KeyringKeyType.md b/docs/api/verida-js/enums/verida_keyring._internal_.KeyringKeyType.md deleted file mode 100644 index 67c7ec0..0000000 --- a/docs/api/verida-js/enums/verida_keyring._internal_.KeyringKeyType.md +++ /dev/null @@ -1,43 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/keyring](../modules/verida_keyring.md) / [](../modules/verida_keyring._internal_.md) / KeyringKeyType - -# Enumeration: KeyringKeyType - -[@verida/keyring](../modules/verida_keyring.md).[](../modules/verida_keyring._internal_.md).KeyringKeyType - -## Table of contents - -### Enumeration members - -- [ASYM](verida_keyring._internal_.KeyringKeyType.md#asym) -- [SIGN](verida_keyring._internal_.KeyringKeyType.md#sign) -- [SYM](verida_keyring._internal_.KeyringKeyType.md#sym) - -## Enumeration members - -### ASYM - -• **ASYM** = `"asym"` - -#### Defined in - -packages/types/dist/IKeyring.d.ts:26 - -___ - -### SIGN - -• **SIGN** = `"sign"` - -#### Defined in - -packages/types/dist/IKeyring.d.ts:25 - -___ - -### SYM - -• **SYM** = `"sym"` - -#### Defined in - -packages/types/dist/IKeyring.d.ts:27 diff --git a/docs/api/verida-js/enums/verida_storage_link._internal_.EndpointType.md b/docs/api/verida-js/enums/verida_storage_link._internal_.EndpointType.md deleted file mode 100644 index 880878c..0000000 --- a/docs/api/verida-js/enums/verida_storage_link._internal_.EndpointType.md +++ /dev/null @@ -1,54 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/storage-link](../modules/verida_storage_link.md) / [](../modules/verida_storage_link._internal_.md) / EndpointType - -# Enumeration: EndpointType - -[@verida/storage-link](../modules/verida_storage_link.md).[](../modules/verida_storage_link._internal_.md).EndpointType - -## Table of contents - -### Enumeration members - -- [DATABASE](verida_storage_link._internal_.EndpointType.md#database) -- [MESSAGING](verida_storage_link._internal_.EndpointType.md#messaging) -- [NOTIFICATION](verida_storage_link._internal_.EndpointType.md#notification) -- [STORAGE](verida_storage_link._internal_.EndpointType.md#storage) - -## Enumeration members - -### DATABASE - -• **DATABASE** = `"database"` - -#### Defined in - -packages/did-document/dist/interfaces.d.ts:23 - -___ - -### MESSAGING - -• **MESSAGING** = `"messaging"` - -#### Defined in - -packages/did-document/dist/interfaces.d.ts:24 - -___ - -### NOTIFICATION - -• **NOTIFICATION** = `"notification"` - -#### Defined in - -packages/did-document/dist/interfaces.d.ts:26 - -___ - -### STORAGE - -• **STORAGE** = `"storage"` - -#### Defined in - -packages/did-document/dist/interfaces.d.ts:25 diff --git a/docs/api/verida-js/enums/verida_storage_link._internal_.EnvironmentType.md b/docs/api/verida-js/enums/verida_storage_link._internal_.EnvironmentType.md deleted file mode 100644 index a7a69ee..0000000 --- a/docs/api/verida-js/enums/verida_storage_link._internal_.EnvironmentType.md +++ /dev/null @@ -1,54 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/storage-link](../modules/verida_storage_link.md) / [](../modules/verida_storage_link._internal_.md) / EnvironmentType - -# Enumeration: EnvironmentType - -[@verida/storage-link](../modules/verida_storage_link.md).[](../modules/verida_storage_link._internal_.md).EnvironmentType - -## Table of contents - -### Enumeration members - -- [DEVNET](verida_storage_link._internal_.EnvironmentType.md#devnet) -- [LOCAL](verida_storage_link._internal_.EnvironmentType.md#local) -- [MAINNET](verida_storage_link._internal_.EnvironmentType.md#mainnet) -- [TESTNET](verida_storage_link._internal_.EnvironmentType.md#testnet) - -## Enumeration members - -### DEVNET - -• **DEVNET** = `"devnet"` - -#### Defined in - -packages/types/dist/NetworkInterfaces.d.ts:6 - -___ - -### LOCAL - -• **LOCAL** = `"local"` - -#### Defined in - -packages/types/dist/NetworkInterfaces.d.ts:5 - -___ - -### MAINNET - -• **MAINNET** = `"mainnet"` - -#### Defined in - -packages/types/dist/NetworkInterfaces.d.ts:8 - -___ - -### TESTNET - -• **TESTNET** = `"testnet"` - -#### Defined in - -packages/types/dist/NetworkInterfaces.d.ts:7 diff --git a/docs/api/verida-js/enums/verida_storage_link._internal_.SecureContextEndpointType.md b/docs/api/verida-js/enums/verida_storage_link._internal_.SecureContextEndpointType.md deleted file mode 100644 index 44f2472..0000000 --- a/docs/api/verida-js/enums/verida_storage_link._internal_.SecureContextEndpointType.md +++ /dev/null @@ -1,54 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/storage-link](../modules/verida_storage_link.md) / [](../modules/verida_storage_link._internal_.md) / SecureContextEndpointType - -# Enumeration: SecureContextEndpointType - -[@verida/storage-link](../modules/verida_storage_link.md).[](../modules/verida_storage_link._internal_.md).SecureContextEndpointType - -## Table of contents - -### Enumeration members - -- [DATABASE](verida_storage_link._internal_.SecureContextEndpointType.md#database) -- [MESSAGING](verida_storage_link._internal_.SecureContextEndpointType.md#messaging) -- [NOTIFICATION](verida_storage_link._internal_.SecureContextEndpointType.md#notification) -- [STORAGE](verida_storage_link._internal_.SecureContextEndpointType.md#storage) - -## Enumeration members - -### DATABASE - -• **DATABASE** = `"database"` - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:14 - -___ - -### MESSAGING - -• **MESSAGING** = `"messaging"` - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:15 - -___ - -### NOTIFICATION - -• **NOTIFICATION** = `"notification"` - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:17 - -___ - -### STORAGE - -• **STORAGE** = `"storage"` - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:16 diff --git a/docs/api/verida-js/enums/verida_types.ContextEngineType.md b/docs/api/verida-js/enums/verida_types.ContextEngineType.md deleted file mode 100644 index ba1102e..0000000 --- a/docs/api/verida-js/enums/verida_types.ContextEngineType.md +++ /dev/null @@ -1,43 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/types](../modules/verida_types.md) / ContextEngineType - -# Enumeration: ContextEngineType - -[@verida/types](../modules/verida_types.md).ContextEngineType - -## Table of contents - -### Enumeration members - -- [Database](verida_types.ContextEngineType.md#database) -- [Messsaging](verida_types.ContextEngineType.md#messsaging) -- [Notification](verida_types.ContextEngineType.md#notification) - -## Enumeration members - -### Database - -• **Database** = `"database"` - -#### Defined in - -[packages/types/src/ContextInterfaces.ts:124](https://github.com/verida/verida-js/blob/5040472/packages/types/src/ContextInterfaces.ts#L124) - -___ - -### Messsaging - -• **Messsaging** = `"messaging"` - -#### Defined in - -[packages/types/src/ContextInterfaces.ts:126](https://github.com/verida/verida-js/blob/5040472/packages/types/src/ContextInterfaces.ts#L126) - -___ - -### Notification - -• **Notification** = `"notification"` - -#### Defined in - -[packages/types/src/ContextInterfaces.ts:125](https://github.com/verida/verida-js/blob/5040472/packages/types/src/ContextInterfaces.ts#L125) diff --git a/docs/api/verida-js/enums/verida_types.DatabasePermissionOptionsEnum.md b/docs/api/verida-js/enums/verida_types.DatabasePermissionOptionsEnum.md deleted file mode 100644 index 6f7772f..0000000 --- a/docs/api/verida-js/enums/verida_types.DatabasePermissionOptionsEnum.md +++ /dev/null @@ -1,43 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/types](../modules/verida_types.md) / DatabasePermissionOptionsEnum - -# Enumeration: DatabasePermissionOptionsEnum - -[@verida/types](../modules/verida_types.md).DatabasePermissionOptionsEnum - -## Table of contents - -### Enumeration members - -- [OWNER](verida_types.DatabasePermissionOptionsEnum.md#owner) -- [PUBLIC](verida_types.DatabasePermissionOptionsEnum.md#public) -- [USERS](verida_types.DatabasePermissionOptionsEnum.md#users) - -## Enumeration members - -### OWNER - -• **OWNER** = `"owner"` - -#### Defined in - -[packages/types/src/ContextInterfaces.ts:140](https://github.com/verida/verida-js/blob/5040472/packages/types/src/ContextInterfaces.ts#L140) - -___ - -### PUBLIC - -• **PUBLIC** = `"public"` - -#### Defined in - -[packages/types/src/ContextInterfaces.ts:141](https://github.com/verida/verida-js/blob/5040472/packages/types/src/ContextInterfaces.ts#L141) - -___ - -### USERS - -• **USERS** = `"users"` - -#### Defined in - -[packages/types/src/ContextInterfaces.ts:142](https://github.com/verida/verida-js/blob/5040472/packages/types/src/ContextInterfaces.ts#L142) diff --git a/docs/api/verida-js/enums/verida_types.EnumStatus.md b/docs/api/verida-js/enums/verida_types.EnumStatus.md deleted file mode 100644 index b0d510f..0000000 --- a/docs/api/verida-js/enums/verida_types.EnumStatus.md +++ /dev/null @@ -1,46 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/types](../modules/verida_types.md) / EnumStatus - -# Enumeration: EnumStatus - -[@verida/types](../modules/verida_types.md).EnumStatus - -Status of StoargeNode and DataCenter -Used in `vda-node-manager` and `vda-node-client` packages - -## Table of contents - -### Enumeration members - -- [active](verida_types.EnumStatus.md#active) -- [removed](verida_types.EnumStatus.md#removed) -- [removing](verida_types.EnumStatus.md#removing) - -## Enumeration members - -### active - -• **active** = `2` - -#### Defined in - -[packages/types/src/IStorageNode.ts:9](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IStorageNode.ts#L9) - -___ - -### removed - -• **removed** = `0` - -#### Defined in - -[packages/types/src/IStorageNode.ts:7](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IStorageNode.ts#L7) - -___ - -### removing - -• **removing** = `1` - -#### Defined in - -[packages/types/src/IStorageNode.ts:8](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IStorageNode.ts#L8) diff --git a/docs/api/verida-js/enums/verida_types.EnvironmentType.md b/docs/api/verida-js/enums/verida_types.EnvironmentType.md deleted file mode 100644 index fca01c0..0000000 --- a/docs/api/verida-js/enums/verida_types.EnvironmentType.md +++ /dev/null @@ -1,54 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/types](../modules/verida_types.md) / EnvironmentType - -# Enumeration: EnvironmentType - -[@verida/types](../modules/verida_types.md).EnvironmentType - -## Table of contents - -### Enumeration members - -- [DEVNET](verida_types.EnvironmentType.md#devnet) -- [LOCAL](verida_types.EnvironmentType.md#local) -- [MAINNET](verida_types.EnvironmentType.md#mainnet) -- [TESTNET](verida_types.EnvironmentType.md#testnet) - -## Enumeration members - -### DEVNET - -• **DEVNET** = `"devnet"` - -#### Defined in - -[packages/types/src/NetworkInterfaces.ts:7](https://github.com/verida/verida-js/blob/5040472/packages/types/src/NetworkInterfaces.ts#L7) - -___ - -### LOCAL - -• **LOCAL** = `"local"` - -#### Defined in - -[packages/types/src/NetworkInterfaces.ts:6](https://github.com/verida/verida-js/blob/5040472/packages/types/src/NetworkInterfaces.ts#L6) - -___ - -### MAINNET - -• **MAINNET** = `"mainnet"` - -#### Defined in - -[packages/types/src/NetworkInterfaces.ts:9](https://github.com/verida/verida-js/blob/5040472/packages/types/src/NetworkInterfaces.ts#L9) - -___ - -### TESTNET - -• **TESTNET** = `"testnet"` - -#### Defined in - -[packages/types/src/NetworkInterfaces.ts:8](https://github.com/verida/verida-js/blob/5040472/packages/types/src/NetworkInterfaces.ts#L8) diff --git a/docs/api/verida-js/enums/verida_types.KeyringKeyType.md b/docs/api/verida-js/enums/verida_types.KeyringKeyType.md deleted file mode 100644 index 2f3edc1..0000000 --- a/docs/api/verida-js/enums/verida_types.KeyringKeyType.md +++ /dev/null @@ -1,43 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/types](../modules/verida_types.md) / KeyringKeyType - -# Enumeration: KeyringKeyType - -[@verida/types](../modules/verida_types.md).KeyringKeyType - -## Table of contents - -### Enumeration members - -- [ASYM](verida_types.KeyringKeyType.md#asym) -- [SIGN](verida_types.KeyringKeyType.md#sign) -- [SYM](verida_types.KeyringKeyType.md#sym) - -## Enumeration members - -### ASYM - -• **ASYM** = `"asym"` - -#### Defined in - -[packages/types/src/IKeyring.ts:41](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IKeyring.ts#L41) - -___ - -### SIGN - -• **SIGN** = `"sign"` - -#### Defined in - -[packages/types/src/IKeyring.ts:40](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IKeyring.ts#L40) - -___ - -### SYM - -• **SYM** = `"sym"` - -#### Defined in - -[packages/types/src/IKeyring.ts:42](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IKeyring.ts#L42) diff --git a/docs/api/verida-js/enums/verida_types.SecureContextEndpointType.md b/docs/api/verida-js/enums/verida_types.SecureContextEndpointType.md deleted file mode 100644 index 25ad5e6..0000000 --- a/docs/api/verida-js/enums/verida_types.SecureContextEndpointType.md +++ /dev/null @@ -1,54 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/types](../modules/verida_types.md) / SecureContextEndpointType - -# Enumeration: SecureContextEndpointType - -[@verida/types](../modules/verida_types.md).SecureContextEndpointType - -## Table of contents - -### Enumeration members - -- [DATABASE](verida_types.SecureContextEndpointType.md#database) -- [MESSAGING](verida_types.SecureContextEndpointType.md#messaging) -- [NOTIFICATION](verida_types.SecureContextEndpointType.md#notification) -- [STORAGE](verida_types.SecureContextEndpointType.md#storage) - -## Enumeration members - -### DATABASE - -• **DATABASE** = `"database"` - -#### Defined in - -[packages/types/src/DocumentInterfaces.ts:18](https://github.com/verida/verida-js/blob/5040472/packages/types/src/DocumentInterfaces.ts#L18) - -___ - -### MESSAGING - -• **MESSAGING** = `"messaging"` - -#### Defined in - -[packages/types/src/DocumentInterfaces.ts:19](https://github.com/verida/verida-js/blob/5040472/packages/types/src/DocumentInterfaces.ts#L19) - -___ - -### NOTIFICATION - -• **NOTIFICATION** = `"notification"` - -#### Defined in - -[packages/types/src/DocumentInterfaces.ts:21](https://github.com/verida/verida-js/blob/5040472/packages/types/src/DocumentInterfaces.ts#L21) - -___ - -### STORAGE - -• **STORAGE** = `"storage"` - -#### Defined in - -[packages/types/src/DocumentInterfaces.ts:20](https://github.com/verida/verida-js/blob/5040472/packages/types/src/DocumentInterfaces.ts#L20) diff --git a/docs/api/verida-js/enums/verida_types.VerificationMethodTypes.md b/docs/api/verida-js/enums/verida_types.VerificationMethodTypes.md deleted file mode 100644 index 8b36991..0000000 --- a/docs/api/verida-js/enums/verida_types.VerificationMethodTypes.md +++ /dev/null @@ -1,65 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/types](../modules/verida_types.md) / VerificationMethodTypes - -# Enumeration: VerificationMethodTypes - -[@verida/types](../modules/verida_types.md).VerificationMethodTypes - -## Table of contents - -### Enumeration members - -- [EcdsaSecp256k1RecoveryMethod2020](verida_types.VerificationMethodTypes.md#ecdsasecp256k1recoverymethod2020) -- [EcdsaSecp256k1VerificationKey2019](verida_types.VerificationMethodTypes.md#ecdsasecp256k1verificationkey2019) -- [Ed25519VerificationKey2018](verida_types.VerificationMethodTypes.md#ed25519verificationkey2018) -- [RSAVerificationKey2018](verida_types.VerificationMethodTypes.md#rsaverificationkey2018) -- [X25519KeyAgreementKey2019](verida_types.VerificationMethodTypes.md#x25519keyagreementkey2019) - -## Enumeration members - -### EcdsaSecp256k1RecoveryMethod2020 - -• **EcdsaSecp256k1RecoveryMethod2020** = `"EcdsaSecp256k1RecoveryMethod2020"` - -#### Defined in - -[packages/types/src/DocumentInterfaces.ts:32](https://github.com/verida/verida-js/blob/5040472/packages/types/src/DocumentInterfaces.ts#L32) - -___ - -### EcdsaSecp256k1VerificationKey2019 - -• **EcdsaSecp256k1VerificationKey2019** = `"EcdsaSecp256k1VerificationKey2019"` - -#### Defined in - -[packages/types/src/DocumentInterfaces.ts:31](https://github.com/verida/verida-js/blob/5040472/packages/types/src/DocumentInterfaces.ts#L31) - -___ - -### Ed25519VerificationKey2018 - -• **Ed25519VerificationKey2018** = `"Ed25519VerificationKey2018"` - -#### Defined in - -[packages/types/src/DocumentInterfaces.ts:33](https://github.com/verida/verida-js/blob/5040472/packages/types/src/DocumentInterfaces.ts#L33) - -___ - -### RSAVerificationKey2018 - -• **RSAVerificationKey2018** = `"RSAVerificationKey2018"` - -#### Defined in - -[packages/types/src/DocumentInterfaces.ts:34](https://github.com/verida/verida-js/blob/5040472/packages/types/src/DocumentInterfaces.ts#L34) - -___ - -### X25519KeyAgreementKey2019 - -• **X25519KeyAgreementKey2019** = `"X25519KeyAgreementKey2019"` - -#### Defined in - -[packages/types/src/DocumentInterfaces.ts:35](https://github.com/verida/verida-js/blob/5040472/packages/types/src/DocumentInterfaces.ts#L35) diff --git a/docs/api/verida-js/enums/verida_vda_did._internal_.SecureContextEndpointType.md b/docs/api/verida-js/enums/verida_vda_did._internal_.SecureContextEndpointType.md deleted file mode 100644 index 31c79af..0000000 --- a/docs/api/verida-js/enums/verida_vda_did._internal_.SecureContextEndpointType.md +++ /dev/null @@ -1,54 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-did](../modules/verida_vda_did.md) / [](../modules/verida_vda_did._internal_.md) / SecureContextEndpointType - -# Enumeration: SecureContextEndpointType - -[@verida/vda-did](../modules/verida_vda_did.md).[](../modules/verida_vda_did._internal_.md).SecureContextEndpointType - -## Table of contents - -### Enumeration members - -- [DATABASE](verida_vda_did._internal_.SecureContextEndpointType.md#database) -- [MESSAGING](verida_vda_did._internal_.SecureContextEndpointType.md#messaging) -- [NOTIFICATION](verida_vda_did._internal_.SecureContextEndpointType.md#notification) -- [STORAGE](verida_vda_did._internal_.SecureContextEndpointType.md#storage) - -## Enumeration members - -### DATABASE - -• **DATABASE** = `"database"` - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:14 - -___ - -### MESSAGING - -• **MESSAGING** = `"messaging"` - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:15 - -___ - -### NOTIFICATION - -• **NOTIFICATION** = `"notification"` - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:17 - -___ - -### STORAGE - -• **STORAGE** = `"storage"` - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:16 diff --git a/docs/api/verida-js/enums/verida_vda_did_resolver._internal_.EnvironmentType.md b/docs/api/verida-js/enums/verida_vda_did_resolver._internal_.EnvironmentType.md deleted file mode 100644 index 87c8889..0000000 --- a/docs/api/verida-js/enums/verida_vda_did_resolver._internal_.EnvironmentType.md +++ /dev/null @@ -1,54 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-did-resolver](../modules/verida_vda_did_resolver.md) / [](../modules/verida_vda_did_resolver._internal_.md) / EnvironmentType - -# Enumeration: EnvironmentType - -[@verida/vda-did-resolver](../modules/verida_vda_did_resolver.md).[](../modules/verida_vda_did_resolver._internal_.md).EnvironmentType - -## Table of contents - -### Enumeration members - -- [DEVNET](verida_vda_did_resolver._internal_.EnvironmentType.md#devnet) -- [LOCAL](verida_vda_did_resolver._internal_.EnvironmentType.md#local) -- [MAINNET](verida_vda_did_resolver._internal_.EnvironmentType.md#mainnet) -- [TESTNET](verida_vda_did_resolver._internal_.EnvironmentType.md#testnet) - -## Enumeration members - -### DEVNET - -• **DEVNET** = `"devnet"` - -#### Defined in - -packages/types/dist/NetworkInterfaces.d.ts:6 - -___ - -### LOCAL - -• **LOCAL** = `"local"` - -#### Defined in - -packages/types/dist/NetworkInterfaces.d.ts:5 - -___ - -### MAINNET - -• **MAINNET** = `"mainnet"` - -#### Defined in - -packages/types/dist/NetworkInterfaces.d.ts:8 - -___ - -### TESTNET - -• **TESTNET** = `"testnet"` - -#### Defined in - -packages/types/dist/NetworkInterfaces.d.ts:7 diff --git a/docs/api/verida-js/enums/verida_vda_name_client._internal_.EnvironmentType.md b/docs/api/verida-js/enums/verida_vda_name_client._internal_.EnvironmentType.md deleted file mode 100644 index 0863471..0000000 --- a/docs/api/verida-js/enums/verida_vda_name_client._internal_.EnvironmentType.md +++ /dev/null @@ -1,54 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-name-client](../modules/verida_vda_name_client.md) / [](../modules/verida_vda_name_client._internal_.md) / EnvironmentType - -# Enumeration: EnvironmentType - -[@verida/vda-name-client](../modules/verida_vda_name_client.md).[](../modules/verida_vda_name_client._internal_.md).EnvironmentType - -## Table of contents - -### Enumeration members - -- [DEVNET](verida_vda_name_client._internal_.EnvironmentType.md#devnet) -- [LOCAL](verida_vda_name_client._internal_.EnvironmentType.md#local) -- [MAINNET](verida_vda_name_client._internal_.EnvironmentType.md#mainnet) -- [TESTNET](verida_vda_name_client._internal_.EnvironmentType.md#testnet) - -## Enumeration members - -### DEVNET - -• **DEVNET** = `"devnet"` - -#### Defined in - -packages/types/dist/NetworkInterfaces.d.ts:6 - -___ - -### LOCAL - -• **LOCAL** = `"local"` - -#### Defined in - -packages/types/dist/NetworkInterfaces.d.ts:5 - -___ - -### MAINNET - -• **MAINNET** = `"mainnet"` - -#### Defined in - -packages/types/dist/NetworkInterfaces.d.ts:8 - -___ - -### TESTNET - -• **TESTNET** = `"testnet"` - -#### Defined in - -packages/types/dist/NetworkInterfaces.d.ts:7 diff --git a/docs/api/verida-js/enums/verida_vda_sbt_client._internal_.EnvironmentType.md b/docs/api/verida-js/enums/verida_vda_sbt_client._internal_.EnvironmentType.md deleted file mode 100644 index cbac17d..0000000 --- a/docs/api/verida-js/enums/verida_vda_sbt_client._internal_.EnvironmentType.md +++ /dev/null @@ -1,54 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-sbt-client](../modules/verida_vda_sbt_client.md) / [](../modules/verida_vda_sbt_client._internal_.md) / EnvironmentType - -# Enumeration: EnvironmentType - -[@verida/vda-sbt-client](../modules/verida_vda_sbt_client.md).[](../modules/verida_vda_sbt_client._internal_.md).EnvironmentType - -## Table of contents - -### Enumeration members - -- [DEVNET](verida_vda_sbt_client._internal_.EnvironmentType.md#devnet) -- [LOCAL](verida_vda_sbt_client._internal_.EnvironmentType.md#local) -- [MAINNET](verida_vda_sbt_client._internal_.EnvironmentType.md#mainnet) -- [TESTNET](verida_vda_sbt_client._internal_.EnvironmentType.md#testnet) - -## Enumeration members - -### DEVNET - -• **DEVNET** = `"devnet"` - -#### Defined in - -packages/types/dist/NetworkInterfaces.d.ts:6 - -___ - -### LOCAL - -• **LOCAL** = `"local"` - -#### Defined in - -packages/types/dist/NetworkInterfaces.d.ts:5 - -___ - -### MAINNET - -• **MAINNET** = `"mainnet"` - -#### Defined in - -packages/types/dist/NetworkInterfaces.d.ts:8 - -___ - -### TESTNET - -• **TESTNET** = `"testnet"` - -#### Defined in - -packages/types/dist/NetworkInterfaces.d.ts:7 diff --git a/docs/api/verida-js/enums/verida_verifiable_credentials._internal_.ContextEngineType.md b/docs/api/verida-js/enums/verida_verifiable_credentials._internal_.ContextEngineType.md deleted file mode 100644 index 432ebbf..0000000 --- a/docs/api/verida-js/enums/verida_verifiable_credentials._internal_.ContextEngineType.md +++ /dev/null @@ -1,43 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / ContextEngineType - -# Enumeration: ContextEngineType - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md).ContextEngineType - -## Table of contents - -### Enumeration members - -- [Database](verida_verifiable_credentials._internal_.ContextEngineType.md#database) -- [Messsaging](verida_verifiable_credentials._internal_.ContextEngineType.md#messsaging) -- [Notification](verida_verifiable_credentials._internal_.ContextEngineType.md#notification) - -## Enumeration members - -### Database - -• **Database** = `"database"` - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:102 - -___ - -### Messsaging - -• **Messsaging** = `"messaging"` - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:104 - -___ - -### Notification - -• **Notification** = `"notification"` - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:103 diff --git a/docs/api/verida-js/enums/verida_verifiable_credentials._internal_.DatabasePermissionOptionsEnum.md b/docs/api/verida-js/enums/verida_verifiable_credentials._internal_.DatabasePermissionOptionsEnum.md deleted file mode 100644 index aced6cf..0000000 --- a/docs/api/verida-js/enums/verida_verifiable_credentials._internal_.DatabasePermissionOptionsEnum.md +++ /dev/null @@ -1,43 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / DatabasePermissionOptionsEnum - -# Enumeration: DatabasePermissionOptionsEnum - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md).DatabasePermissionOptionsEnum - -## Table of contents - -### Enumeration members - -- [OWNER](verida_verifiable_credentials._internal_.DatabasePermissionOptionsEnum.md#owner) -- [PUBLIC](verida_verifiable_credentials._internal_.DatabasePermissionOptionsEnum.md#public) -- [USERS](verida_verifiable_credentials._internal_.DatabasePermissionOptionsEnum.md#users) - -## Enumeration members - -### OWNER - -• **OWNER** = `"owner"` - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:116 - -___ - -### PUBLIC - -• **PUBLIC** = `"public"` - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:117 - -___ - -### USERS - -• **USERS** = `"users"` - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:118 diff --git a/docs/api/verida-js/enums/verida_verifiable_credentials._internal_.EndpointType.md b/docs/api/verida-js/enums/verida_verifiable_credentials._internal_.EndpointType.md deleted file mode 100644 index 6fa6d1b..0000000 --- a/docs/api/verida-js/enums/verida_verifiable_credentials._internal_.EndpointType.md +++ /dev/null @@ -1,54 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / EndpointType - -# Enumeration: EndpointType - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md).EndpointType - -## Table of contents - -### Enumeration members - -- [DATABASE](verida_verifiable_credentials._internal_.EndpointType.md#database) -- [MESSAGING](verida_verifiable_credentials._internal_.EndpointType.md#messaging) -- [NOTIFICATION](verida_verifiable_credentials._internal_.EndpointType.md#notification) -- [STORAGE](verida_verifiable_credentials._internal_.EndpointType.md#storage) - -## Enumeration members - -### DATABASE - -• **DATABASE** = `"database"` - -#### Defined in - -packages/did-document/dist/interfaces.d.ts:23 - -___ - -### MESSAGING - -• **MESSAGING** = `"messaging"` - -#### Defined in - -packages/did-document/dist/interfaces.d.ts:24 - -___ - -### NOTIFICATION - -• **NOTIFICATION** = `"notification"` - -#### Defined in - -packages/did-document/dist/interfaces.d.ts:26 - -___ - -### STORAGE - -• **STORAGE** = `"storage"` - -#### Defined in - -packages/did-document/dist/interfaces.d.ts:25 diff --git a/docs/api/verida-js/enums/verida_verifiable_credentials._internal_.EnvironmentType.md b/docs/api/verida-js/enums/verida_verifiable_credentials._internal_.EnvironmentType.md deleted file mode 100644 index 51c8f05..0000000 --- a/docs/api/verida-js/enums/verida_verifiable_credentials._internal_.EnvironmentType.md +++ /dev/null @@ -1,43 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / EnvironmentType - -# Enumeration: EnvironmentType - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md).EnvironmentType - -## Table of contents - -### Enumeration members - -- [LOCAL](verida_verifiable_credentials._internal_.EnvironmentType.md#local) -- [MAINNET](verida_verifiable_credentials._internal_.EnvironmentType.md#mainnet) -- [TESTNET](verida_verifiable_credentials._internal_.EnvironmentType.md#testnet) - -## Enumeration members - -### LOCAL - -• **LOCAL** = `"local"` - -#### Defined in - -packages/account/dist/interfaces.d.ts:9 - -___ - -### MAINNET - -• **MAINNET** = `"mainnet"` - -#### Defined in - -packages/account/dist/interfaces.d.ts:11 - -___ - -### TESTNET - -• **TESTNET** = `"testnet"` - -#### Defined in - -packages/account/dist/interfaces.d.ts:10 diff --git a/docs/api/verida-js/enums/verida_verifiable_credentials._internal_.PermissionOptionsEnum.md b/docs/api/verida-js/enums/verida_verifiable_credentials._internal_.PermissionOptionsEnum.md deleted file mode 100644 index 328c685..0000000 --- a/docs/api/verida-js/enums/verida_verifiable_credentials._internal_.PermissionOptionsEnum.md +++ /dev/null @@ -1,43 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / PermissionOptionsEnum - -# Enumeration: PermissionOptionsEnum - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md).PermissionOptionsEnum - -## Table of contents - -### Enumeration members - -- [OWNER](verida_verifiable_credentials._internal_.PermissionOptionsEnum.md#owner) -- [PUBLIC](verida_verifiable_credentials._internal_.PermissionOptionsEnum.md#public) -- [USERS](verida_verifiable_credentials._internal_.PermissionOptionsEnum.md#users) - -## Enumeration members - -### OWNER - -• **OWNER** = `"owner"` - -#### Defined in - -packages/client-ts/dist/context/interfaces.d.ts:89 - -___ - -### PUBLIC - -• **PUBLIC** = `"public"` - -#### Defined in - -packages/client-ts/dist/context/interfaces.d.ts:90 - -___ - -### USERS - -• **USERS** = `"users"` - -#### Defined in - -packages/client-ts/dist/context/interfaces.d.ts:91 diff --git a/docs/api/verida-js/enums/verida_verifiable_credentials._internal_.Type.md b/docs/api/verida-js/enums/verida_verifiable_credentials._internal_.Type.md deleted file mode 100644 index a694a3e..0000000 --- a/docs/api/verida-js/enums/verida_verifiable_credentials._internal_.Type.md +++ /dev/null @@ -1,32 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / Type - -# Enumeration: Type - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md).Type - -## Table of contents - -### Enumeration members - -- [Num](verida_verifiable_credentials._internal_.Type.md#num) -- [Str](verida_verifiable_credentials._internal_.Type.md#str) - -## Enumeration members - -### Num - -• **Num** = `0` - -#### Defined in - -node_modules/ajv/dist/compile/util.d.ts:35 - -___ - -### Str - -• **Str** = `1` - -#### Defined in - -node_modules/ajv/dist/compile/util.d.ts:36 diff --git a/docs/api/verida-js/enums/verida_verifiable_credentials._internal_.UsedValueState.md b/docs/api/verida-js/enums/verida_verifiable_credentials._internal_.UsedValueState.md deleted file mode 100644 index dc44c1b..0000000 --- a/docs/api/verida-js/enums/verida_verifiable_credentials._internal_.UsedValueState.md +++ /dev/null @@ -1,32 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / UsedValueState - -# Enumeration: UsedValueState - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md).UsedValueState - -## Table of contents - -### Enumeration members - -- [Completed](verida_verifiable_credentials._internal_.UsedValueState.md#completed) -- [Started](verida_verifiable_credentials._internal_.UsedValueState.md#started) - -## Enumeration members - -### Completed - -• **Completed** = `1` - -#### Defined in - -node_modules/ajv/dist/compile/codegen/scope.d.ts:30 - -___ - -### Started - -• **Started** = `0` - -#### Defined in - -node_modules/ajv/dist/compile/codegen/scope.d.ts:29 diff --git a/docs/api/verida-js/enums/verida_web_helpers._internal_.ContextEngineType.md b/docs/api/verida-js/enums/verida_web_helpers._internal_.ContextEngineType.md deleted file mode 100644 index a0aca3d..0000000 --- a/docs/api/verida-js/enums/verida_web_helpers._internal_.ContextEngineType.md +++ /dev/null @@ -1,43 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / ContextEngineType - -# Enumeration: ContextEngineType - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).ContextEngineType - -## Table of contents - -### Enumeration members - -- [Database](verida_web_helpers._internal_.ContextEngineType.md#database) -- [Messsaging](verida_web_helpers._internal_.ContextEngineType.md#messsaging) -- [Notification](verida_web_helpers._internal_.ContextEngineType.md#notification) - -## Enumeration members - -### Database - -• **Database** = `"database"` - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:102 - -___ - -### Messsaging - -• **Messsaging** = `"messaging"` - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:104 - -___ - -### Notification - -• **Notification** = `"notification"` - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:103 diff --git a/docs/api/verida-js/enums/verida_web_helpers._internal_.DatabasePermissionOptionsEnum.md b/docs/api/verida-js/enums/verida_web_helpers._internal_.DatabasePermissionOptionsEnum.md deleted file mode 100644 index b0cdffd..0000000 --- a/docs/api/verida-js/enums/verida_web_helpers._internal_.DatabasePermissionOptionsEnum.md +++ /dev/null @@ -1,43 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / DatabasePermissionOptionsEnum - -# Enumeration: DatabasePermissionOptionsEnum - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).DatabasePermissionOptionsEnum - -## Table of contents - -### Enumeration members - -- [OWNER](verida_web_helpers._internal_.DatabasePermissionOptionsEnum.md#owner) -- [PUBLIC](verida_web_helpers._internal_.DatabasePermissionOptionsEnum.md#public) -- [USERS](verida_web_helpers._internal_.DatabasePermissionOptionsEnum.md#users) - -## Enumeration members - -### OWNER - -• **OWNER** = `"owner"` - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:116 - -___ - -### PUBLIC - -• **PUBLIC** = `"public"` - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:117 - -___ - -### USERS - -• **USERS** = `"users"` - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:118 diff --git a/docs/api/verida-js/enums/verida_web_helpers._internal_.EnvironmentType.md b/docs/api/verida-js/enums/verida_web_helpers._internal_.EnvironmentType.md deleted file mode 100644 index 78485f9..0000000 --- a/docs/api/verida-js/enums/verida_web_helpers._internal_.EnvironmentType.md +++ /dev/null @@ -1,54 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / EnvironmentType - -# Enumeration: EnvironmentType - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).EnvironmentType - -## Table of contents - -### Enumeration members - -- [DEVNET](verida_web_helpers._internal_.EnvironmentType.md#devnet) -- [LOCAL](verida_web_helpers._internal_.EnvironmentType.md#local) -- [MAINNET](verida_web_helpers._internal_.EnvironmentType.md#mainnet) -- [TESTNET](verida_web_helpers._internal_.EnvironmentType.md#testnet) - -## Enumeration members - -### DEVNET - -• **DEVNET** = `"devnet"` - -#### Defined in - -packages/types/dist/NetworkInterfaces.d.ts:6 - -___ - -### LOCAL - -• **LOCAL** = `"local"` - -#### Defined in - -packages/types/dist/NetworkInterfaces.d.ts:5 - -___ - -### MAINNET - -• **MAINNET** = `"mainnet"` - -#### Defined in - -packages/types/dist/NetworkInterfaces.d.ts:8 - -___ - -### TESTNET - -• **TESTNET** = `"testnet"` - -#### Defined in - -packages/types/dist/NetworkInterfaces.d.ts:7 diff --git a/docs/api/verida-js/enums/verida_web_helpers._internal_.SecureContextEndpointType.md b/docs/api/verida-js/enums/verida_web_helpers._internal_.SecureContextEndpointType.md deleted file mode 100644 index 0fdeae8..0000000 --- a/docs/api/verida-js/enums/verida_web_helpers._internal_.SecureContextEndpointType.md +++ /dev/null @@ -1,54 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / SecureContextEndpointType - -# Enumeration: SecureContextEndpointType - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).SecureContextEndpointType - -## Table of contents - -### Enumeration members - -- [DATABASE](verida_web_helpers._internal_.SecureContextEndpointType.md#database) -- [MESSAGING](verida_web_helpers._internal_.SecureContextEndpointType.md#messaging) -- [NOTIFICATION](verida_web_helpers._internal_.SecureContextEndpointType.md#notification) -- [STORAGE](verida_web_helpers._internal_.SecureContextEndpointType.md#storage) - -## Enumeration members - -### DATABASE - -• **DATABASE** = `"database"` - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:14 - -___ - -### MESSAGING - -• **MESSAGING** = `"messaging"` - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:15 - -___ - -### NOTIFICATION - -• **NOTIFICATION** = `"notification"` - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:17 - -___ - -### STORAGE - -• **STORAGE** = `"storage"` - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:16 diff --git a/docs/api/verida-js/enums/verida_web_helpers._internal_.Type.md b/docs/api/verida-js/enums/verida_web_helpers._internal_.Type.md deleted file mode 100644 index 9257d74..0000000 --- a/docs/api/verida-js/enums/verida_web_helpers._internal_.Type.md +++ /dev/null @@ -1,32 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / Type - -# Enumeration: Type - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).Type - -## Table of contents - -### Enumeration members - -- [Num](verida_web_helpers._internal_.Type.md#num) -- [Str](verida_web_helpers._internal_.Type.md#str) - -## Enumeration members - -### Num - -• **Num** = `0` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/util.d.ts:35 - -___ - -### Str - -• **Str** = `1` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/util.d.ts:36 diff --git a/docs/api/verida-js/enums/verida_web_helpers._internal_.UsedValueState.md b/docs/api/verida-js/enums/verida_web_helpers._internal_.UsedValueState.md deleted file mode 100644 index 5709ac3..0000000 --- a/docs/api/verida-js/enums/verida_web_helpers._internal_.UsedValueState.md +++ /dev/null @@ -1,32 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / UsedValueState - -# Enumeration: UsedValueState - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).UsedValueState - -## Table of contents - -### Enumeration members - -- [Completed](verida_web_helpers._internal_.UsedValueState.md#completed) -- [Started](verida_web_helpers._internal_.UsedValueState.md#started) - -## Enumeration members - -### Completed - -• **Completed** = `1` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/scope.d.ts:30 - -___ - -### Started - -• **Started** = `0` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/scope.d.ts:29 diff --git a/docs/api/verida-js/interfaces/verida_account.AccountConfig.md b/docs/api/verida-js/interfaces/verida_account.AccountConfig.md deleted file mode 100644 index 0e86e30..0000000 --- a/docs/api/verida-js/interfaces/verida_account.AccountConfig.md +++ /dev/null @@ -1,54 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account](../modules/verida_account.md) / AccountConfig - -# Interface: AccountConfig - -[@verida/account](../modules/verida_account.md).AccountConfig - -## Table of contents - -### Properties - -- [defaultDatabaseServer](verida_account.AccountConfig.md#defaultdatabaseserver) -- [defaultMessageServer](verida_account.AccountConfig.md#defaultmessageserver) -- [defaultNotificationServer](verida_account.AccountConfig.md#defaultnotificationserver) -- [defaultStorageServer](verida_account.AccountConfig.md#defaultstorageserver) - -## Properties - -### defaultDatabaseServer - -• **defaultDatabaseServer**: [`SecureContextEndpoint`](verida_account._internal_.SecureContextEndpoint.md) - -#### Defined in - -[packages/account/src/interfaces.ts:4](https://github.com/verida/verida-js/blob/c03b336/packages/account/src/interfaces.ts#L4) - -___ - -### defaultMessageServer - -• **defaultMessageServer**: [`SecureContextEndpoint`](verida_account._internal_.SecureContextEndpoint.md) - -#### Defined in - -[packages/account/src/interfaces.ts:5](https://github.com/verida/verida-js/blob/c03b336/packages/account/src/interfaces.ts#L5) - -___ - -### defaultNotificationServer - -• `Optional` **defaultNotificationServer**: [`SecureContextEndpoint`](verida_account._internal_.SecureContextEndpoint.md) - -#### Defined in - -[packages/account/src/interfaces.ts:7](https://github.com/verida/verida-js/blob/c03b336/packages/account/src/interfaces.ts#L7) - -___ - -### defaultStorageServer - -• `Optional` **defaultStorageServer**: [`SecureContextEndpoint`](verida_account._internal_.SecureContextEndpoint.md) - -#### Defined in - -[packages/account/src/interfaces.ts:6](https://github.com/verida/verida-js/blob/c03b336/packages/account/src/interfaces.ts#L6) diff --git a/docs/api/verida-js/interfaces/verida_account._internal_.AccountConfig.md b/docs/api/verida-js/interfaces/verida_account._internal_.AccountConfig.md deleted file mode 100644 index 0a1b594..0000000 --- a/docs/api/verida-js/interfaces/verida_account._internal_.AccountConfig.md +++ /dev/null @@ -1,54 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account](../modules/verida_account.md) / [](../modules/verida_account._internal_.md) / AccountConfig - -# Interface: AccountConfig - -[@verida/account](../modules/verida_account.md).[](../modules/verida_account._internal_.md).AccountConfig - -## Table of contents - -### Properties - -- [defaultDatabaseServer](verida_account._internal_.AccountConfig.md#defaultdatabaseserver) -- [defaultMessageServer](verida_account._internal_.AccountConfig.md#defaultmessageserver) -- [defaultNotificationServer](verida_account._internal_.AccountConfig.md#defaultnotificationserver) -- [defaultStorageServer](verida_account._internal_.AccountConfig.md#defaultstorageserver) - -## Properties - -### defaultDatabaseServer - -• **defaultDatabaseServer**: [`SecureContextEndpoint`](verida_account._internal_.SecureContextEndpoint.md) - -#### Defined in - -packages/types/dist/AccountInterfaces.d.ts:7 - -___ - -### defaultMessageServer - -• **defaultMessageServer**: [`SecureContextEndpoint`](verida_account._internal_.SecureContextEndpoint.md) - -#### Defined in - -packages/types/dist/AccountInterfaces.d.ts:8 - -___ - -### defaultNotificationServer - -• `Optional` **defaultNotificationServer**: [`SecureContextEndpoint`](verida_account._internal_.SecureContextEndpoint.md) - -#### Defined in - -packages/types/dist/AccountInterfaces.d.ts:10 - -___ - -### defaultStorageServer - -• `Optional` **defaultStorageServer**: [`SecureContextEndpoint`](verida_account._internal_.SecureContextEndpoint.md) - -#### Defined in - -packages/types/dist/AccountInterfaces.d.ts:9 diff --git a/docs/api/verida-js/interfaces/verida_account._internal_.AuthContext.md b/docs/api/verida-js/interfaces/verida_account._internal_.AuthContext.md deleted file mode 100644 index 545b535..0000000 --- a/docs/api/verida-js/interfaces/verida_account._internal_.AuthContext.md +++ /dev/null @@ -1,21 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account](../modules/verida_account.md) / [](../modules/verida_account._internal_.md) / AuthContext - -# Interface: AuthContext - -[@verida/account](../modules/verida_account.md).[](../modules/verida_account._internal_.md).AuthContext - -## Table of contents - -### Properties - -- [publicSigningKey](verida_account._internal_.AuthContext.md#publicsigningkey) - -## Properties - -### publicSigningKey - -• **publicSigningKey**: [`SecureContextPublicKey`](verida_account._internal_.SecureContextPublicKey.md) - -#### Defined in - -packages/types/dist/AccountInterfaces.d.ts:13 diff --git a/docs/api/verida-js/interfaces/verida_account._internal_.AuthTypeConfig.md b/docs/api/verida-js/interfaces/verida_account._internal_.AuthTypeConfig.md deleted file mode 100644 index f94b751..0000000 --- a/docs/api/verida-js/interfaces/verida_account._internal_.AuthTypeConfig.md +++ /dev/null @@ -1,21 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account](../modules/verida_account.md) / [](../modules/verida_account._internal_.md) / AuthTypeConfig - -# Interface: AuthTypeConfig - -[@verida/account](../modules/verida_account.md).[](../modules/verida_account._internal_.md).AuthTypeConfig - -## Table of contents - -### Properties - -- [force](verida_account._internal_.AuthTypeConfig.md#force) - -## Properties - -### force - -• `Optional` **force**: `boolean` - -#### Defined in - -packages/types/dist/AccountInterfaces.d.ts:16 diff --git a/docs/api/verida-js/interfaces/verida_account._internal_.IAccount.md b/docs/api/verida-js/interfaces/verida_account._internal_.IAccount.md deleted file mode 100644 index ee1c194..0000000 --- a/docs/api/verida-js/interfaces/verida_account._internal_.IAccount.md +++ /dev/null @@ -1,270 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account](../modules/verida_account.md) / [](../modules/verida_account._internal_.md) / IAccount - -# Interface: IAccount - -[@verida/account](../modules/verida_account.md).[](../modules/verida_account._internal_.md).IAccount - -## Implemented by - -- [`Account`](../classes/verida_account.Account.md) - -## Table of contents - -### Methods - -- [createDidJwt](verida_account._internal_.IAccount.md#createdidjwt) -- [did](verida_account._internal_.IAccount.md#did) -- [disconnect](verida_account._internal_.IAccount.md#disconnect) -- [disconnectDevice](verida_account._internal_.IAccount.md#disconnectdevice) -- [getAuthContext](verida_account._internal_.IAccount.md#getauthcontext) -- [keyring](verida_account._internal_.IAccount.md#keyring) -- [linkStorage](verida_account._internal_.IAccount.md#linkstorage) -- [linkStorageContextService](verida_account._internal_.IAccount.md#linkstoragecontextservice) -- [setAccountConfig](verida_account._internal_.IAccount.md#setaccountconfig) -- [sign](verida_account._internal_.IAccount.md#sign) -- [storageConfig](verida_account._internal_.IAccount.md#storageconfig) -- [unlinkStorage](verida_account._internal_.IAccount.md#unlinkstorage) - -## Methods - -### createDidJwt - -▸ **createDidJwt**(`contextName`, `data`, `config`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | -| `data` | `object` | -| `config` | `any` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -packages/types/dist/IAccount.d.ts:13 - -___ - -### did - -▸ **did**(): `Promise`<`string`\> - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -packages/types/dist/IAccount.d.ts:7 - -___ - -### disconnect - -▸ **disconnect**(`contextName?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName?` | `string` | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -packages/types/dist/IAccount.d.ts:14 - -___ - -### disconnectDevice - -▸ **disconnectDevice**(`contextName`, `deviceId`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | -| `deviceId` | `string` | - -#### Returns - -`Promise`<`boolean`\> - -#### Defined in - -packages/types/dist/IAccount.d.ts:16 - -___ - -### getAuthContext - -▸ **getAuthContext**(`contextName`, `contextConfig`, `authConfig?`, `authType?`): `Promise`<[`AuthContext`](verida_account._internal_.AuthContext.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | -| `contextConfig` | [`SecureContextConfig`](verida_account._internal_.SecureContextConfig.md) | -| `authConfig?` | [`AuthTypeConfig`](verida_account._internal_.AuthTypeConfig.md) | -| `authType?` | `string` | - -#### Returns - -`Promise`<[`AuthContext`](verida_account._internal_.AuthContext.md)\> - -#### Defined in - -packages/types/dist/IAccount.d.ts:15 - -___ - -### keyring - -▸ **keyring**(`contextName`): `Promise`<[`IKeyring`](verida_account._internal_.IKeyring.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | - -#### Returns - -`Promise`<[`IKeyring`](verida_account._internal_.IKeyring.md)\> - -#### Defined in - -packages/types/dist/IAccount.d.ts:5 - -___ - -### linkStorage - -▸ **linkStorage**(`storageConfig`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `storageConfig` | [`SecureContextConfig`](verida_account._internal_.SecureContextConfig.md) | - -#### Returns - -`Promise`<`boolean`\> - -#### Defined in - -packages/types/dist/IAccount.d.ts:8 - -___ - -### linkStorageContextService - -▸ **linkStorageContextService**(`contextName`, `endpointType`, `serverType`, `endpointUris`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | -| `endpointType` | `string` | -| `serverType` | `string` | -| `endpointUris` | `string`[] | - -#### Returns - -`Promise`<`boolean`\> - -#### Defined in - -packages/types/dist/IAccount.d.ts:11 - -___ - -### setAccountConfig - -▸ **setAccountConfig**(`accountConfig`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `accountConfig` | [`AccountConfig`](verida_account._internal_.AccountConfig.md) | - -#### Returns - -`void` - -#### Defined in - -packages/types/dist/IAccount.d.ts:12 - -___ - -### sign - -▸ **sign**(`input`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `input` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -packages/types/dist/IAccount.d.ts:6 - -___ - -### storageConfig - -▸ **storageConfig**(`contextName`, `forceCreate`): `Promise`<`undefined` \| [`SecureContextConfig`](verida_account._internal_.SecureContextConfig.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | -| `forceCreate` | `boolean` | - -#### Returns - -`Promise`<`undefined` \| [`SecureContextConfig`](verida_account._internal_.SecureContextConfig.md)\> - -#### Defined in - -packages/types/dist/IAccount.d.ts:10 - -___ - -### unlinkStorage - -▸ **unlinkStorage**(`contextName`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | - -#### Returns - -`Promise`<`boolean`\> - -#### Defined in - -packages/types/dist/IAccount.d.ts:9 diff --git a/docs/api/verida-js/interfaces/verida_account._internal_.IKeyring.md b/docs/api/verida-js/interfaces/verida_account._internal_.IKeyring.md deleted file mode 100644 index 0b750ba..0000000 --- a/docs/api/verida-js/interfaces/verida_account._internal_.IKeyring.md +++ /dev/null @@ -1,266 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account](../modules/verida_account.md) / [](../modules/verida_account._internal_.md) / IKeyring - -# Interface: IKeyring - -[@verida/account](../modules/verida_account.md).[](../modules/verida_account._internal_.md).IKeyring - -## Implemented by - -- [`default`](../classes/verida_account._internal_.default.md) - -## Table of contents - -### Methods - -- [\_init](verida_account._internal_.IKeyring.md#_init) -- [asymDecrypt](verida_account._internal_.IKeyring.md#asymdecrypt) -- [asymEncrypt](verida_account._internal_.IKeyring.md#asymencrypt) -- [buildSharedKeyEnd](verida_account._internal_.IKeyring.md#buildsharedkeyend) -- [buildSharedKeyStart](verida_account._internal_.IKeyring.md#buildsharedkeystart) -- [getKeys](verida_account._internal_.IKeyring.md#getkeys) -- [getSeed](verida_account._internal_.IKeyring.md#getseed) -- [getStorageContextKey](verida_account._internal_.IKeyring.md#getstoragecontextkey) -- [publicKeys](verida_account._internal_.IKeyring.md#publickeys) -- [sign](verida_account._internal_.IKeyring.md#sign) -- [symDecrypt](verida_account._internal_.IKeyring.md#symdecrypt) -- [symEncrypt](verida_account._internal_.IKeyring.md#symencrypt) -- [verifySig](verida_account._internal_.IKeyring.md#verifysig) - -## Methods - -### \_init - -▸ **_init**(): `Promise`<`void`\> - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:3 - -___ - -### asymDecrypt - -▸ **asymDecrypt**(`messageWithNonce`, `secretOrSharedKey`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `messageWithNonce` | `string` | -| `secretOrSharedKey` | `Uint8Array` | - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:10 - -___ - -### asymEncrypt - -▸ **asymEncrypt**(`data`, `secretOrSharedKey`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `string` | -| `secretOrSharedKey` | `Uint8Array` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:9 - -___ - -### buildSharedKeyEnd - -▸ **buildSharedKeyEnd**(`publicKey`): `Promise`<`Uint8Array`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `publicKey` | `Uint8Array` | - -#### Returns - -`Promise`<`Uint8Array`\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:12 - -___ - -### buildSharedKeyStart - -▸ **buildSharedKeyStart**(`privateKey`): `Promise`<`Uint8Array`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `privateKey` | `Uint8Array` | - -#### Returns - -`Promise`<`Uint8Array`\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:11 - -___ - -### getKeys - -▸ **getKeys**(): `Promise`<`any`\> - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:2 - -___ - -### getSeed - -▸ **getSeed**(): `string` - -#### Returns - -`string` - -#### Defined in - -packages/types/dist/IKeyring.d.ts:13 - -___ - -### getStorageContextKey - -▸ **getStorageContextKey**(`databaseName`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `databaseName` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:14 - -___ - -### publicKeys - -▸ **publicKeys**(): `Promise`<[`KeyringPublicKeys`](verida_account._internal_.KeyringPublicKeys.md)\> - -#### Returns - -`Promise`<[`KeyringPublicKeys`](verida_account._internal_.KeyringPublicKeys.md)\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:4 - -___ - -### sign - -▸ **sign**(`data`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `any` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:5 - -___ - -### symDecrypt - -▸ **symDecrypt**(`data`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `string` | - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:8 - -___ - -### symEncrypt - -▸ **symEncrypt**(`data`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:7 - -___ - -### verifySig - -▸ **verifySig**(`data`, `sig`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `string` | -| `sig` | `string` | - -#### Returns - -`Promise`<`boolean`\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:6 diff --git a/docs/api/verida-js/interfaces/verida_account._internal_.KeyringPublicKeys.md b/docs/api/verida-js/interfaces/verida_account._internal_.KeyringPublicKeys.md deleted file mode 100644 index 54cd2bb..0000000 --- a/docs/api/verida-js/interfaces/verida_account._internal_.KeyringPublicKeys.md +++ /dev/null @@ -1,76 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account](../modules/verida_account.md) / [](../modules/verida_account._internal_.md) / KeyringPublicKeys - -# Interface: KeyringPublicKeys - -[@verida/account](../modules/verida_account.md).[](../modules/verida_account._internal_.md).KeyringPublicKeys - -## Table of contents - -### Properties - -- [asymPublicKey](verida_account._internal_.KeyringPublicKeys.md#asympublickey) -- [asymPublicKeyBase58](verida_account._internal_.KeyringPublicKeys.md#asympublickeybase58) -- [asymPublicKeyHex](verida_account._internal_.KeyringPublicKeys.md#asympublickeyhex) -- [signPublicKey](verida_account._internal_.KeyringPublicKeys.md#signpublickey) -- [signPublicKeyBase58](verida_account._internal_.KeyringPublicKeys.md#signpublickeybase58) -- [signPublicKeyHex](verida_account._internal_.KeyringPublicKeys.md#signpublickeyhex) - -## Properties - -### asymPublicKey - -• **asymPublicKey**: `Uint8Array` - -#### Defined in - -packages/types/dist/IKeyring.d.ts:17 - -___ - -### asymPublicKeyBase58 - -• **asymPublicKeyBase58**: `string` - -#### Defined in - -packages/types/dist/IKeyring.d.ts:19 - -___ - -### asymPublicKeyHex - -• **asymPublicKeyHex**: `string` - -#### Defined in - -packages/types/dist/IKeyring.d.ts:18 - -___ - -### signPublicKey - -• **signPublicKey**: `Uint8Array` - -#### Defined in - -packages/types/dist/IKeyring.d.ts:20 - -___ - -### signPublicKeyBase58 - -• **signPublicKeyBase58**: `string` - -#### Defined in - -packages/types/dist/IKeyring.d.ts:22 - -___ - -### signPublicKeyHex - -• **signPublicKeyHex**: `string` - -#### Defined in - -packages/types/dist/IKeyring.d.ts:21 diff --git a/docs/api/verida-js/interfaces/verida_account._internal_.SecureContextConfig.md b/docs/api/verida-js/interfaces/verida_account._internal_.SecureContextConfig.md deleted file mode 100644 index 868a9b0..0000000 --- a/docs/api/verida-js/interfaces/verida_account._internal_.SecureContextConfig.md +++ /dev/null @@ -1,43 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account](../modules/verida_account.md) / [](../modules/verida_account._internal_.md) / SecureContextConfig - -# Interface: SecureContextConfig - -[@verida/account](../modules/verida_account.md).[](../modules/verida_account._internal_.md).SecureContextConfig - -## Table of contents - -### Properties - -- [id](verida_account._internal_.SecureContextConfig.md#id) -- [publicKeys](verida_account._internal_.SecureContextConfig.md#publickeys) -- [services](verida_account._internal_.SecureContextConfig.md#services) - -## Properties - -### id - -• **id**: `string` - -#### Defined in - -packages/types/dist/StorageLinkInterfaces.d.ts:17 - -___ - -### publicKeys - -• **publicKeys**: [`SecureStorageContextPublicKeys`](verida_account._internal_.SecureStorageContextPublicKeys.md) - -#### Defined in - -packages/types/dist/StorageLinkInterfaces.d.ts:18 - -___ - -### services - -• **services**: [`SecureContextServices`](verida_account._internal_.SecureContextServices.md) - -#### Defined in - -packages/types/dist/StorageLinkInterfaces.d.ts:19 diff --git a/docs/api/verida-js/interfaces/verida_account._internal_.SecureContextEndpoint.md b/docs/api/verida-js/interfaces/verida_account._internal_.SecureContextEndpoint.md deleted file mode 100644 index 276892c..0000000 --- a/docs/api/verida-js/interfaces/verida_account._internal_.SecureContextEndpoint.md +++ /dev/null @@ -1,43 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account](../modules/verida_account.md) / [](../modules/verida_account._internal_.md) / SecureContextEndpoint - -# Interface: SecureContextEndpoint - -[@verida/account](../modules/verida_account.md).[](../modules/verida_account._internal_.md).SecureContextEndpoint - -## Table of contents - -### Properties - -- [config](verida_account._internal_.SecureContextEndpoint.md#config) -- [endpointUri](verida_account._internal_.SecureContextEndpoint.md#endpointuri) -- [type](verida_account._internal_.SecureContextEndpoint.md#type) - -## Properties - -### config - -• `Optional` **config**: `object` - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:5 - -___ - -### endpointUri - -• **endpointUri**: [`ServiceEndpoint`](../modules/verida_account._internal_.md#serviceendpoint)[] - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:4 - -___ - -### type - -• **type**: `string` - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:3 diff --git a/docs/api/verida-js/interfaces/verida_account._internal_.SecureContextPublicKey.md b/docs/api/verida-js/interfaces/verida_account._internal_.SecureContextPublicKey.md deleted file mode 100644 index caa9077..0000000 --- a/docs/api/verida-js/interfaces/verida_account._internal_.SecureContextPublicKey.md +++ /dev/null @@ -1,32 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account](../modules/verida_account.md) / [](../modules/verida_account._internal_.md) / SecureContextPublicKey - -# Interface: SecureContextPublicKey - -[@verida/account](../modules/verida_account.md).[](../modules/verida_account._internal_.md).SecureContextPublicKey - -## Table of contents - -### Properties - -- [publicKeyHex](verida_account._internal_.SecureContextPublicKey.md#publickeyhex) -- [type](verida_account._internal_.SecureContextPublicKey.md#type) - -## Properties - -### publicKeyHex - -• **publicKeyHex**: `string` - -#### Defined in - -packages/types/dist/StorageLinkInterfaces.d.ts:4 - -___ - -### type - -• **type**: `string` - -#### Defined in - -packages/types/dist/StorageLinkInterfaces.d.ts:3 diff --git a/docs/api/verida-js/interfaces/verida_account._internal_.SecureContextServices.md b/docs/api/verida-js/interfaces/verida_account._internal_.SecureContextServices.md deleted file mode 100644 index 0afd60a..0000000 --- a/docs/api/verida-js/interfaces/verida_account._internal_.SecureContextServices.md +++ /dev/null @@ -1,54 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account](../modules/verida_account.md) / [](../modules/verida_account._internal_.md) / SecureContextServices - -# Interface: SecureContextServices - -[@verida/account](../modules/verida_account.md).[](../modules/verida_account._internal_.md).SecureContextServices - -## Table of contents - -### Properties - -- [databaseServer](verida_account._internal_.SecureContextServices.md#databaseserver) -- [messageServer](verida_account._internal_.SecureContextServices.md#messageserver) -- [notificationServer](verida_account._internal_.SecureContextServices.md#notificationserver) -- [storageServer](verida_account._internal_.SecureContextServices.md#storageserver) - -## Properties - -### databaseServer - -• **databaseServer**: [`SecureContextEndpoint`](verida_account._internal_.SecureContextEndpoint.md) - -#### Defined in - -packages/types/dist/StorageLinkInterfaces.d.ts:11 - -___ - -### messageServer - -• **messageServer**: [`SecureContextEndpoint`](verida_account._internal_.SecureContextEndpoint.md) - -#### Defined in - -packages/types/dist/StorageLinkInterfaces.d.ts:12 - -___ - -### notificationServer - -• `Optional` **notificationServer**: [`SecureContextEndpoint`](verida_account._internal_.SecureContextEndpoint.md) - -#### Defined in - -packages/types/dist/StorageLinkInterfaces.d.ts:14 - -___ - -### storageServer - -• `Optional` **storageServer**: [`SecureContextEndpoint`](verida_account._internal_.SecureContextEndpoint.md) - -#### Defined in - -packages/types/dist/StorageLinkInterfaces.d.ts:13 diff --git a/docs/api/verida-js/interfaces/verida_account._internal_.SecureStorageContextPublicKeys.md b/docs/api/verida-js/interfaces/verida_account._internal_.SecureStorageContextPublicKeys.md deleted file mode 100644 index aadab7b..0000000 --- a/docs/api/verida-js/interfaces/verida_account._internal_.SecureStorageContextPublicKeys.md +++ /dev/null @@ -1,32 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account](../modules/verida_account.md) / [](../modules/verida_account._internal_.md) / SecureStorageContextPublicKeys - -# Interface: SecureStorageContextPublicKeys - -[@verida/account](../modules/verida_account.md).[](../modules/verida_account._internal_.md).SecureStorageContextPublicKeys - -## Table of contents - -### Properties - -- [asymKey](verida_account._internal_.SecureStorageContextPublicKeys.md#asymkey) -- [signKey](verida_account._internal_.SecureStorageContextPublicKeys.md#signkey) - -## Properties - -### asymKey - -• **asymKey**: [`SecureContextPublicKey`](verida_account._internal_.SecureContextPublicKey.md) - -#### Defined in - -packages/types/dist/StorageLinkInterfaces.d.ts:7 - -___ - -### signKey - -• **signKey**: [`SecureContextPublicKey`](verida_account._internal_.SecureContextPublicKey.md) - -#### Defined in - -packages/types/dist/StorageLinkInterfaces.d.ts:8 diff --git a/docs/api/verida-js/interfaces/verida_account_node.NodeSelectorConfig.md b/docs/api/verida-js/interfaces/verida_account_node.NodeSelectorConfig.md deleted file mode 100644 index d8364fa..0000000 --- a/docs/api/verida-js/interfaces/verida_account_node.NodeSelectorConfig.md +++ /dev/null @@ -1,43 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account-node](../modules/verida_account_node.md) / NodeSelectorConfig - -# Interface: NodeSelectorConfig - -[@verida/account-node](../modules/verida_account_node.md).NodeSelectorConfig - -## Table of contents - -### Properties - -- [defaultTimeout](verida_account_node.NodeSelectorConfig.md#defaulttimeout) -- [network](verida_account_node.NodeSelectorConfig.md#network) -- [notificationEndpoints](verida_account_node.NodeSelectorConfig.md#notificationendpoints) - -## Properties - -### defaultTimeout - -• **defaultTimeout**: `number` - -#### Defined in - -[packages/account-node/src/nodeSelector.ts:32](https://github.com/verida/verida-js/blob/5040472/packages/account-node/src/nodeSelector.ts#L32) - -___ - -### network - -• **network**: [`EnvironmentType`](../enums/verida_account_node._internal_.EnvironmentType.md) - -#### Defined in - -[packages/account-node/src/nodeSelector.ts:30](https://github.com/verida/verida-js/blob/5040472/packages/account-node/src/nodeSelector.ts#L30) - -___ - -### notificationEndpoints - -• **notificationEndpoints**: `string`[] - -#### Defined in - -[packages/account-node/src/nodeSelector.ts:31](https://github.com/verida/verida-js/blob/5040472/packages/account-node/src/nodeSelector.ts#L31) diff --git a/docs/api/verida-js/interfaces/verida_account_node.NodeSelectorParams.md b/docs/api/verida-js/interfaces/verida_account_node.NodeSelectorParams.md deleted file mode 100644 index 87c009e..0000000 --- a/docs/api/verida-js/interfaces/verida_account_node.NodeSelectorParams.md +++ /dev/null @@ -1,43 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account-node](../modules/verida_account_node.md) / NodeSelectorParams - -# Interface: NodeSelectorParams - -[@verida/account-node](../modules/verida_account_node.md).NodeSelectorParams - -## Table of contents - -### Properties - -- [defaultTimeout](verida_account_node.NodeSelectorParams.md#defaulttimeout) -- [network](verida_account_node.NodeSelectorParams.md#network) -- [notificationEndpoints](verida_account_node.NodeSelectorParams.md#notificationendpoints) - -## Properties - -### defaultTimeout - -• `Optional` **defaultTimeout**: `number` - -#### Defined in - -[packages/account-node/src/nodeSelector.ts:26](https://github.com/verida/verida-js/blob/5040472/packages/account-node/src/nodeSelector.ts#L26) - -___ - -### network - -• `Optional` **network**: [`EnvironmentType`](../enums/verida_account_node._internal_.EnvironmentType.md) - -#### Defined in - -[packages/account-node/src/nodeSelector.ts:24](https://github.com/verida/verida-js/blob/5040472/packages/account-node/src/nodeSelector.ts#L24) - -___ - -### notificationEndpoints - -• `Optional` **notificationEndpoints**: [`ServiceEndpoint`](../modules/verida_account_node._internal_.md#serviceendpoint)[] - -#### Defined in - -[packages/account-node/src/nodeSelector.ts:25](https://github.com/verida/verida-js/blob/5040472/packages/account-node/src/nodeSelector.ts#L25) diff --git a/docs/api/verida-js/interfaces/verida_account_node.StorageNode.md b/docs/api/verida-js/interfaces/verida_account_node.StorageNode.md deleted file mode 100644 index 6adeac7..0000000 --- a/docs/api/verida-js/interfaces/verida_account_node.StorageNode.md +++ /dev/null @@ -1,98 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account-node](../modules/verida_account_node.md) / StorageNode - -# Interface: StorageNode - -[@verida/account-node](../modules/verida_account_node.md).StorageNode - -## Table of contents - -### Properties - -- [countryLocation](verida_account_node.StorageNode.md#countrylocation) -- [datacenter](verida_account_node.StorageNode.md#datacenter) -- [description](verida_account_node.StorageNode.md#description) -- [establishmentDate](verida_account_node.StorageNode.md#establishmentdate) -- [id](verida_account_node.StorageNode.md#id) -- [name](verida_account_node.StorageNode.md#name) -- [region](verida_account_node.StorageNode.md#region) -- [serviceEndpoint](verida_account_node.StorageNode.md#serviceendpoint) - -## Properties - -### countryLocation - -• **countryLocation**: `string` - -#### Defined in - -[packages/account-node/src/nodeSelector.ts:13](https://github.com/verida/verida-js/blob/5040472/packages/account-node/src/nodeSelector.ts#L13) - -___ - -### datacenter - -• **datacenter**: `string` - -#### Defined in - -[packages/account-node/src/nodeSelector.ts:10](https://github.com/verida/verida-js/blob/5040472/packages/account-node/src/nodeSelector.ts#L10) - -___ - -### description - -• **description**: `string` - -#### Defined in - -[packages/account-node/src/nodeSelector.ts:9](https://github.com/verida/verida-js/blob/5040472/packages/account-node/src/nodeSelector.ts#L9) - -___ - -### establishmentDate - -• **establishmentDate**: `string` - -#### Defined in - -[packages/account-node/src/nodeSelector.ts:12](https://github.com/verida/verida-js/blob/5040472/packages/account-node/src/nodeSelector.ts#L12) - -___ - -### id - -• **id**: `string` - -#### Defined in - -[packages/account-node/src/nodeSelector.ts:7](https://github.com/verida/verida-js/blob/5040472/packages/account-node/src/nodeSelector.ts#L7) - -___ - -### name - -• **name**: `string` - -#### Defined in - -[packages/account-node/src/nodeSelector.ts:8](https://github.com/verida/verida-js/blob/5040472/packages/account-node/src/nodeSelector.ts#L8) - -___ - -### region - -• **region**: `string` - -#### Defined in - -[packages/account-node/src/nodeSelector.ts:14](https://github.com/verida/verida-js/blob/5040472/packages/account-node/src/nodeSelector.ts#L14) - -___ - -### serviceEndpoint - -• **serviceEndpoint**: `string` - -#### Defined in - -[packages/account-node/src/nodeSelector.ts:11](https://github.com/verida/verida-js/blob/5040472/packages/account-node/src/nodeSelector.ts#L11) diff --git a/docs/api/verida-js/interfaces/verida_account_node._internal_.AbortSignal.md b/docs/api/verida-js/interfaces/verida_account_node._internal_.AbortSignal.md deleted file mode 100644 index dbabe0e..0000000 --- a/docs/api/verida-js/interfaces/verida_account_node._internal_.AbortSignal.md +++ /dev/null @@ -1,25 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account-node](../modules/verida_account_node.md) / [](../modules/verida_account_node._internal_.md) / AbortSignal - -# Interface: AbortSignal - -[@verida/account-node](../modules/verida_account_node.md).[](../modules/verida_account_node._internal_.md).AbortSignal - -A signal object that allows you to communicate with a DOM request (such as a Fetch) and abort it if required via an AbortController object. - -## Table of contents - -### Properties - -- [aborted](verida_account_node._internal_.AbortSignal.md#aborted) - -## Properties - -### aborted - -• `Readonly` **aborted**: `boolean` - -Returns true if this AbortSignal's AbortController has signaled to abort, and false otherwise. - -#### Defined in - -node_modules/@types/node/globals.d.ts:64 diff --git a/docs/api/verida-js/interfaces/verida_account_node._internal_.AccountConfig.md b/docs/api/verida-js/interfaces/verida_account_node._internal_.AccountConfig.md deleted file mode 100644 index ce25a45..0000000 --- a/docs/api/verida-js/interfaces/verida_account_node._internal_.AccountConfig.md +++ /dev/null @@ -1,54 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account-node](../modules/verida_account_node.md) / [](../modules/verida_account_node._internal_.md) / AccountConfig - -# Interface: AccountConfig - -[@verida/account-node](../modules/verida_account_node.md).[](../modules/verida_account_node._internal_.md).AccountConfig - -## Table of contents - -### Properties - -- [defaultDatabaseServer](verida_account_node._internal_.AccountConfig.md#defaultdatabaseserver) -- [defaultMessageServer](verida_account_node._internal_.AccountConfig.md#defaultmessageserver) -- [defaultNotificationServer](verida_account_node._internal_.AccountConfig.md#defaultnotificationserver) -- [defaultStorageServer](verida_account_node._internal_.AccountConfig.md#defaultstorageserver) - -## Properties - -### defaultDatabaseServer - -• **defaultDatabaseServer**: [`SecureContextEndpoint`](verida_account_node._internal_.SecureContextEndpoint.md) - -#### Defined in - -packages/types/dist/AccountInterfaces.d.ts:7 - -___ - -### defaultMessageServer - -• **defaultMessageServer**: [`SecureContextEndpoint`](verida_account_node._internal_.SecureContextEndpoint.md) - -#### Defined in - -packages/types/dist/AccountInterfaces.d.ts:8 - -___ - -### defaultNotificationServer - -• `Optional` **defaultNotificationServer**: [`SecureContextEndpoint`](verida_account_node._internal_.SecureContextEndpoint.md) - -#### Defined in - -packages/types/dist/AccountInterfaces.d.ts:10 - -___ - -### defaultStorageServer - -• `Optional` **defaultStorageServer**: [`SecureContextEndpoint`](verida_account_node._internal_.SecureContextEndpoint.md) - -#### Defined in - -packages/types/dist/AccountInterfaces.d.ts:9 diff --git a/docs/api/verida-js/interfaces/verida_account_node._internal_.AccountNodeConfig.md b/docs/api/verida-js/interfaces/verida_account_node._internal_.AccountNodeConfig.md deleted file mode 100644 index 7427dde..0000000 --- a/docs/api/verida-js/interfaces/verida_account_node._internal_.AccountNodeConfig.md +++ /dev/null @@ -1,65 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account-node](../modules/verida_account_node.md) / [](../modules/verida_account_node._internal_.md) / AccountNodeConfig - -# Interface: AccountNodeConfig - -[@verida/account-node](../modules/verida_account_node.md).[](../modules/verida_account_node._internal_.md).AccountNodeConfig - -## Table of contents - -### Properties - -- [countryCode](verida_account_node._internal_.AccountNodeConfig.md#countrycode) -- [didClientConfig](verida_account_node._internal_.AccountNodeConfig.md#didclientconfig) -- [environment](verida_account_node._internal_.AccountNodeConfig.md#environment) -- [options](verida_account_node._internal_.AccountNodeConfig.md#options) -- [privateKey](verida_account_node._internal_.AccountNodeConfig.md#privatekey) - -## Properties - -### countryCode - -• `Optional` **countryCode**: `string` - -#### Defined in - -packages/types/dist/AccountInterfaces.d.ts:37 - -___ - -### didClientConfig - -• **didClientConfig**: [`AccountNodeDIDClientConfig`](verida_account_node._internal_.AccountNodeDIDClientConfig.md) - -#### Defined in - -packages/types/dist/AccountInterfaces.d.ts:35 - -___ - -### environment - -• **environment**: [`EnvironmentType`](../enums/verida_account_node._internal_.EnvironmentType.md) - -#### Defined in - -packages/types/dist/AccountInterfaces.d.ts:34 - -___ - -### options - -• `Optional` **options**: `any` - -#### Defined in - -packages/types/dist/AccountInterfaces.d.ts:36 - -___ - -### privateKey - -• **privateKey**: `string` - -#### Defined in - -packages/types/dist/AccountInterfaces.d.ts:33 diff --git a/docs/api/verida-js/interfaces/verida_account_node._internal_.AccountNodeDIDClientConfig.md b/docs/api/verida-js/interfaces/verida_account_node._internal_.AccountNodeDIDClientConfig.md deleted file mode 100644 index afeaf8d..0000000 --- a/docs/api/verida-js/interfaces/verida_account_node._internal_.AccountNodeDIDClientConfig.md +++ /dev/null @@ -1,82 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account-node](../modules/verida_account_node.md) / [](../modules/verida_account_node._internal_.md) / AccountNodeDIDClientConfig - -# Interface: AccountNodeDIDClientConfig - -[@verida/account-node](../modules/verida_account_node.md).[](../modules/verida_account_node._internal_.md).AccountNodeDIDClientConfig - -Client configuration required for AccountNode that will support creating a DID -on chain, if required - -## Hierarchy - -- [`Omit`](../modules/verida_account_node._internal_.md#omit)<[`DIDClientConfig`](verida_account_node._internal_.DIDClientConfig.md), ``"network"``\> - - ↳ **`AccountNodeDIDClientConfig`** - -## Table of contents - -### Properties - -- [callType](verida_account_node._internal_.AccountNodeDIDClientConfig.md#calltype) -- [didEndpoints](verida_account_node._internal_.AccountNodeDIDClientConfig.md#didendpoints) -- [rpcUrl](verida_account_node._internal_.AccountNodeDIDClientConfig.md#rpcurl) -- [timeout](verida_account_node._internal_.AccountNodeDIDClientConfig.md#timeout) -- [web3Config](verida_account_node._internal_.AccountNodeDIDClientConfig.md#web3config) - -## Properties - -### callType - -• **callType**: [`Web3CallType`](../modules/verida_account_node._internal_.md#web3calltype) - -#### Defined in - -packages/types/dist/AccountInterfaces.d.ts:44 - -___ - -### didEndpoints - -• `Optional` **didEndpoints**: `string`[] - -#### Defined in - -packages/types/dist/AccountInterfaces.d.ts:46 - -___ - -### rpcUrl - -• `Optional` **rpcUrl**: `string` - -#### Inherited from - -Omit.rpcUrl - -#### Defined in - -packages/types/dist/NetworkInterfaces.d.ts:22 - -___ - -### timeout - -• `Optional` **timeout**: `number` - -#### Inherited from - -Omit.timeout - -#### Defined in - -packages/types/dist/NetworkInterfaces.d.ts:23 - -___ - -### web3Config - -• **web3Config**: [`Web3MetaTransactionConfig`](verida_account_node._internal_.Web3MetaTransactionConfig.md) \| [`Web3SelfTransactionConfig`](verida_account_node._internal_.Web3SelfTransactionConfig.md) - -#### Defined in - -packages/types/dist/AccountInterfaces.d.ts:45 diff --git a/docs/api/verida-js/interfaces/verida_account_node._internal_.ArrayLike.md b/docs/api/verida-js/interfaces/verida_account_node._internal_.ArrayLike.md deleted file mode 100644 index 5f3e053..0000000 --- a/docs/api/verida-js/interfaces/verida_account_node._internal_.ArrayLike.md +++ /dev/null @@ -1,31 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account-node](../modules/verida_account_node.md) / [](../modules/verida_account_node._internal_.md) / ArrayLike - -# Interface: ArrayLike - -[@verida/account-node](../modules/verida_account_node.md).[](../modules/verida_account_node._internal_.md).ArrayLike - -## Type parameters - -| Name | -| :------ | -| `T` | - -## Indexable - -▪ [n: `number`]: `T` - -## Table of contents - -### Properties - -- [length](verida_account_node._internal_.ArrayLike.md#length) - -## Properties - -### length - -• `Readonly` **length**: `number` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1464 diff --git a/docs/api/verida-js/interfaces/verida_account_node._internal_.AuthContext.md b/docs/api/verida-js/interfaces/verida_account_node._internal_.AuthContext.md deleted file mode 100644 index abc5b4a..0000000 --- a/docs/api/verida-js/interfaces/verida_account_node._internal_.AuthContext.md +++ /dev/null @@ -1,27 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account-node](../modules/verida_account_node.md) / [](../modules/verida_account_node._internal_.md) / AuthContext - -# Interface: AuthContext - -[@verida/account-node](../modules/verida_account_node.md).[](../modules/verida_account_node._internal_.md).AuthContext - -## Hierarchy - -- **`AuthContext`** - - ↳ [`VeridaDatabaseAuthContext`](verida_account_node._internal_.VeridaDatabaseAuthContext.md) - -## Table of contents - -### Properties - -- [publicSigningKey](verida_account_node._internal_.AuthContext.md#publicsigningkey) - -## Properties - -### publicSigningKey - -• **publicSigningKey**: [`SecureContextPublicKey`](verida_account_node._internal_.SecureContextPublicKey.md) - -#### Defined in - -packages/types/dist/AccountInterfaces.d.ts:13 diff --git a/docs/api/verida-js/interfaces/verida_account_node._internal_.AuthTypeConfig.md b/docs/api/verida-js/interfaces/verida_account_node._internal_.AuthTypeConfig.md deleted file mode 100644 index b538eb2..0000000 --- a/docs/api/verida-js/interfaces/verida_account_node._internal_.AuthTypeConfig.md +++ /dev/null @@ -1,27 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account-node](../modules/verida_account_node.md) / [](../modules/verida_account_node._internal_.md) / AuthTypeConfig - -# Interface: AuthTypeConfig - -[@verida/account-node](../modules/verida_account_node.md).[](../modules/verida_account_node._internal_.md).AuthTypeConfig - -## Hierarchy - -- **`AuthTypeConfig`** - - ↳ [`VeridaDatabaseAuthTypeConfig`](verida_account_node._internal_.VeridaDatabaseAuthTypeConfig.md) - -## Table of contents - -### Properties - -- [force](verida_account_node._internal_.AuthTypeConfig.md#force) - -## Properties - -### force - -• `Optional` **force**: `boolean` - -#### Defined in - -packages/types/dist/AccountInterfaces.d.ts:16 diff --git a/docs/api/verida-js/interfaces/verida_account_node._internal_.AxiosAdapter.md b/docs/api/verida-js/interfaces/verida_account_node._internal_.AxiosAdapter.md deleted file mode 100644 index 756a0a4..0000000 --- a/docs/api/verida-js/interfaces/verida_account_node._internal_.AxiosAdapter.md +++ /dev/null @@ -1,25 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account-node](../modules/verida_account_node.md) / [](../modules/verida_account_node._internal_.md) / AxiosAdapter - -# Interface: AxiosAdapter - -[@verida/account-node](../modules/verida_account_node.md).[](../modules/verida_account_node._internal_.md).AxiosAdapter - -## Callable - -### AxiosAdapter - -▸ **AxiosAdapter**(`config`): [`AxiosPromise`](verida_account_node._internal_.AxiosPromise.md)<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | [`AxiosRequestConfig`](verida_account_node._internal_.AxiosRequestConfig.md)<`any`\> | - -#### Returns - -[`AxiosPromise`](verida_account_node._internal_.AxiosPromise.md)<`any`\> - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:17 diff --git a/docs/api/verida-js/interfaces/verida_account_node._internal_.AxiosBasicCredentials.md b/docs/api/verida-js/interfaces/verida_account_node._internal_.AxiosBasicCredentials.md deleted file mode 100644 index 4d0d7a7..0000000 --- a/docs/api/verida-js/interfaces/verida_account_node._internal_.AxiosBasicCredentials.md +++ /dev/null @@ -1,32 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account-node](../modules/verida_account_node.md) / [](../modules/verida_account_node._internal_.md) / AxiosBasicCredentials - -# Interface: AxiosBasicCredentials - -[@verida/account-node](../modules/verida_account_node.md).[](../modules/verida_account_node._internal_.md).AxiosBasicCredentials - -## Table of contents - -### Properties - -- [password](verida_account_node._internal_.AxiosBasicCredentials.md#password) -- [username](verida_account_node._internal_.AxiosBasicCredentials.md#username) - -## Properties - -### password - -• **password**: `string` - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:22 - -___ - -### username - -• **username**: `string` - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:21 diff --git a/docs/api/verida-js/interfaces/verida_account_node._internal_.AxiosDefaults.md b/docs/api/verida-js/interfaces/verida_account_node._internal_.AxiosDefaults.md deleted file mode 100644 index 873f551..0000000 --- a/docs/api/verida-js/interfaces/verida_account_node._internal_.AxiosDefaults.md +++ /dev/null @@ -1,594 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account-node](../modules/verida_account_node.md) / [](../modules/verida_account_node._internal_.md) / AxiosDefaults - -# Interface: AxiosDefaults - -[@verida/account-node](../modules/verida_account_node.md).[](../modules/verida_account_node._internal_.md).AxiosDefaults - -## Type parameters - -| Name | Type | -| :------ | :------ | -| `D` | `any` | - -## Hierarchy - -- [`Omit`](../modules/verida_account_node._internal_.md#omit)<[`AxiosRequestConfig`](verida_account_node._internal_.AxiosRequestConfig.md)<`D`\>, ``"headers"``\> - - ↳ **`AxiosDefaults`** - -## Table of contents - -### Properties - -- [adapter](verida_account_node._internal_.AxiosDefaults.md#adapter) -- [auth](verida_account_node._internal_.AxiosDefaults.md#auth) -- [baseURL](verida_account_node._internal_.AxiosDefaults.md#baseurl) -- [cancelToken](verida_account_node._internal_.AxiosDefaults.md#canceltoken) -- [data](verida_account_node._internal_.AxiosDefaults.md#data) -- [decompress](verida_account_node._internal_.AxiosDefaults.md#decompress) -- [env](verida_account_node._internal_.AxiosDefaults.md#env) -- [headers](verida_account_node._internal_.AxiosDefaults.md#headers) -- [httpAgent](verida_account_node._internal_.AxiosDefaults.md#httpagent) -- [httpsAgent](verida_account_node._internal_.AxiosDefaults.md#httpsagent) -- [insecureHTTPParser](verida_account_node._internal_.AxiosDefaults.md#insecurehttpparser) -- [maxBodyLength](verida_account_node._internal_.AxiosDefaults.md#maxbodylength) -- [maxContentLength](verida_account_node._internal_.AxiosDefaults.md#maxcontentlength) -- [maxRedirects](verida_account_node._internal_.AxiosDefaults.md#maxredirects) -- [method](verida_account_node._internal_.AxiosDefaults.md#method) -- [params](verida_account_node._internal_.AxiosDefaults.md#params) -- [proxy](verida_account_node._internal_.AxiosDefaults.md#proxy) -- [responseEncoding](verida_account_node._internal_.AxiosDefaults.md#responseencoding) -- [responseType](verida_account_node._internal_.AxiosDefaults.md#responsetype) -- [signal](verida_account_node._internal_.AxiosDefaults.md#signal) -- [socketPath](verida_account_node._internal_.AxiosDefaults.md#socketpath) -- [timeout](verida_account_node._internal_.AxiosDefaults.md#timeout) -- [timeoutErrorMessage](verida_account_node._internal_.AxiosDefaults.md#timeouterrormessage) -- [transformRequest](verida_account_node._internal_.AxiosDefaults.md#transformrequest) -- [transformResponse](verida_account_node._internal_.AxiosDefaults.md#transformresponse) -- [transitional](verida_account_node._internal_.AxiosDefaults.md#transitional) -- [url](verida_account_node._internal_.AxiosDefaults.md#url) -- [validateStatus](verida_account_node._internal_.AxiosDefaults.md#validatestatus) -- [withCredentials](verida_account_node._internal_.AxiosDefaults.md#withcredentials) -- [xsrfCookieName](verida_account_node._internal_.AxiosDefaults.md#xsrfcookiename) -- [xsrfHeaderName](verida_account_node._internal_.AxiosDefaults.md#xsrfheadername) - -### Methods - -- [beforeRedirect](verida_account_node._internal_.AxiosDefaults.md#beforeredirect) -- [onDownloadProgress](verida_account_node._internal_.AxiosDefaults.md#ondownloadprogress) -- [onUploadProgress](verida_account_node._internal_.AxiosDefaults.md#onuploadprogress) -- [paramsSerializer](verida_account_node._internal_.AxiosDefaults.md#paramsserializer) - -## Properties - -### adapter - -• `Optional` **adapter**: [`AxiosAdapter`](verida_account_node._internal_.AxiosAdapter.md) - -#### Inherited from - -Omit.adapter - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:88 - -___ - -### auth - -• `Optional` **auth**: [`AxiosBasicCredentials`](verida_account_node._internal_.AxiosBasicCredentials.md) - -#### Inherited from - -Omit.auth - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:89 - -___ - -### baseURL - -• `Optional` **baseURL**: `string` - -#### Inherited from - -Omit.baseURL - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:78 - -___ - -### cancelToken - -• `Optional` **cancelToken**: [`CancelToken`](verida_account_node._internal_.CancelToken.md) - -#### Inherited from - -Omit.cancelToken - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:105 - -___ - -### data - -• `Optional` **data**: `D` - -#### Inherited from - -Omit.data - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:84 - -___ - -### decompress - -• `Optional` **decompress**: `boolean` - -#### Inherited from - -Omit.decompress - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:106 - -___ - -### env - -• `Optional` **env**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `FormData?` | (...`args`: `any`[]) => `object` | - -#### Inherited from - -Omit.env - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:110 - -___ - -### headers - -• **headers**: [`HeadersDefaults`](verida_account_node._internal_.HeadersDefaults.md) - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:130 - -___ - -### httpAgent - -• `Optional` **httpAgent**: `any` - -#### Inherited from - -Omit.httpAgent - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:102 - -___ - -### httpsAgent - -• `Optional` **httpsAgent**: `any` - -#### Inherited from - -Omit.httpsAgent - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:103 - -___ - -### insecureHTTPParser - -• `Optional` **insecureHTTPParser**: `boolean` - -#### Inherited from - -Omit.insecureHTTPParser - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:109 - -___ - -### maxBodyLength - -• `Optional` **maxBodyLength**: `number` - -#### Inherited from - -Omit.maxBodyLength - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:98 - -___ - -### maxContentLength - -• `Optional` **maxContentLength**: `number` - -#### Inherited from - -Omit.maxContentLength - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:96 - -___ - -### maxRedirects - -• `Optional` **maxRedirects**: `number` - -#### Inherited from - -Omit.maxRedirects - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:99 - -___ - -### method - -• `Optional` **method**: `string` - -#### Inherited from - -Omit.method - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:77 - -___ - -### params - -• `Optional` **params**: `any` - -#### Inherited from - -Omit.params - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:82 - -___ - -### proxy - -• `Optional` **proxy**: ``false`` \| [`AxiosProxyConfig`](verida_account_node._internal_.AxiosProxyConfig.md) - -#### Inherited from - -Omit.proxy - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:104 - -___ - -### responseEncoding - -• `Optional` **responseEncoding**: `string` - -#### Inherited from - -Omit.responseEncoding - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:91 - -___ - -### responseType - -• `Optional` **responseType**: [`ResponseType`](../modules/verida_account_node._internal_.md#responsetype) - -#### Inherited from - -Omit.responseType - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:90 - -___ - -### signal - -• `Optional` **signal**: [`AbortSignal`](../modules/verida_account_node._internal_.md#abortsignal) - -#### Inherited from - -Omit.signal - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:108 - -___ - -### socketPath - -• `Optional` **socketPath**: ``null`` \| `string` - -#### Inherited from - -Omit.socketPath - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:101 - -___ - -### timeout - -• `Optional` **timeout**: `number` - -#### Inherited from - -Omit.timeout - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:85 - -___ - -### timeoutErrorMessage - -• `Optional` **timeoutErrorMessage**: `string` - -#### Inherited from - -Omit.timeoutErrorMessage - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:86 - -___ - -### transformRequest - -• `Optional` **transformRequest**: [`AxiosRequestTransformer`](verida_account_node._internal_.AxiosRequestTransformer.md) \| [`AxiosRequestTransformer`](verida_account_node._internal_.AxiosRequestTransformer.md)[] - -#### Inherited from - -Omit.transformRequest - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:79 - -___ - -### transformResponse - -• `Optional` **transformResponse**: [`AxiosResponseTransformer`](verida_account_node._internal_.AxiosResponseTransformer.md) \| [`AxiosResponseTransformer`](verida_account_node._internal_.AxiosResponseTransformer.md)[] - -#### Inherited from - -Omit.transformResponse - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:80 - -___ - -### transitional - -• `Optional` **transitional**: [`TransitionalOptions`](verida_account_node._internal_.TransitionalOptions.md) - -#### Inherited from - -Omit.transitional - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:107 - -___ - -### url - -• `Optional` **url**: `string` - -#### Inherited from - -Omit.url - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:76 - -___ - -### validateStatus - -• `Optional` **validateStatus**: ``null`` \| (`status`: `number`) => `boolean` - -#### Inherited from - -Omit.validateStatus - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:97 - -___ - -### withCredentials - -• `Optional` **withCredentials**: `boolean` - -#### Inherited from - -Omit.withCredentials - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:87 - -___ - -### xsrfCookieName - -• `Optional` **xsrfCookieName**: `string` - -#### Inherited from - -Omit.xsrfCookieName - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:92 - -___ - -### xsrfHeaderName - -• `Optional` **xsrfHeaderName**: `string` - -#### Inherited from - -Omit.xsrfHeaderName - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:93 - -## Methods - -### beforeRedirect - -▸ `Optional` **beforeRedirect**(`options`, `responseDetails`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options` | [`Record`](../modules/verida_account_node._internal_.md#record)<`string`, `any`\> | -| `responseDetails` | `Object` | -| `responseDetails.headers` | [`Record`](../modules/verida_account_node._internal_.md#record)<`string`, `string`\> | - -#### Returns - -`void` - -#### Inherited from - -Omit.beforeRedirect - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:100 - -___ - -### onDownloadProgress - -▸ `Optional` **onDownloadProgress**(`progressEvent`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `progressEvent` | `any` | - -#### Returns - -`void` - -#### Inherited from - -Omit.onDownloadProgress - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:95 - -___ - -### onUploadProgress - -▸ `Optional` **onUploadProgress**(`progressEvent`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `progressEvent` | `any` | - -#### Returns - -`void` - -#### Inherited from - -Omit.onUploadProgress - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:94 - -___ - -### paramsSerializer - -▸ `Optional` **paramsSerializer**(`params`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `params` | `any` | - -#### Returns - -`string` - -#### Inherited from - -Omit.paramsSerializer - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:83 diff --git a/docs/api/verida-js/interfaces/verida_account_node._internal_.AxiosInstance.md b/docs/api/verida-js/interfaces/verida_account_node._internal_.AxiosInstance.md deleted file mode 100644 index 6d4f5f1..0000000 --- a/docs/api/verida-js/interfaces/verida_account_node._internal_.AxiosInstance.md +++ /dev/null @@ -1,499 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account-node](../modules/verida_account_node.md) / [](../modules/verida_account_node._internal_.md) / AxiosInstance - -# Interface: AxiosInstance - -[@verida/account-node](../modules/verida_account_node.md).[](../modules/verida_account_node._internal_.md).AxiosInstance - -## Hierarchy - -- [`Axios`](../classes/verida_account_node._internal_.Axios.md) - - ↳ **`AxiosInstance`** - -## Callable - -### AxiosInstance - -▸ **AxiosInstance**(`config`): [`AxiosPromise`](verida_account_node._internal_.AxiosPromise.md)<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | [`AxiosRequestConfig`](verida_account_node._internal_.AxiosRequestConfig.md)<`any`\> | - -#### Returns - -[`AxiosPromise`](verida_account_node._internal_.AxiosPromise.md)<`any`\> - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:236 - -### AxiosInstance - -▸ **AxiosInstance**(`url`, `config?`): [`AxiosPromise`](verida_account_node._internal_.AxiosPromise.md)<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `config?` | [`AxiosRequestConfig`](verida_account_node._internal_.AxiosRequestConfig.md)<`any`\> | - -#### Returns - -[`AxiosPromise`](verida_account_node._internal_.AxiosPromise.md)<`any`\> - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:237 - -## Table of contents - -### Properties - -- [defaults](verida_account_node._internal_.AxiosInstance.md#defaults) -- [interceptors](verida_account_node._internal_.AxiosInstance.md#interceptors) - -### Methods - -- [delete](verida_account_node._internal_.AxiosInstance.md#delete) -- [get](verida_account_node._internal_.AxiosInstance.md#get) -- [getUri](verida_account_node._internal_.AxiosInstance.md#geturi) -- [head](verida_account_node._internal_.AxiosInstance.md#head) -- [options](verida_account_node._internal_.AxiosInstance.md#options) -- [patch](verida_account_node._internal_.AxiosInstance.md#patch) -- [patchForm](verida_account_node._internal_.AxiosInstance.md#patchform) -- [post](verida_account_node._internal_.AxiosInstance.md#post) -- [postForm](verida_account_node._internal_.AxiosInstance.md#postform) -- [put](verida_account_node._internal_.AxiosInstance.md#put) -- [putForm](verida_account_node._internal_.AxiosInstance.md#putform) -- [request](verida_account_node._internal_.AxiosInstance.md#request) - -## Properties - -### defaults - -• **defaults**: [`AxiosDefaults`](verida_account_node._internal_.AxiosDefaults.md)<`any`\> - -#### Inherited from - -[Axios](../classes/verida_account_node._internal_.Axios.md).[defaults](../classes/verida_account_node._internal_.Axios.md#defaults) - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:216 - -___ - -### interceptors - -• **interceptors**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `request` | [`AxiosInterceptorManager`](verida_account_node._internal_.AxiosInterceptorManager.md)<[`AxiosRequestConfig`](verida_account_node._internal_.AxiosRequestConfig.md)<`any`\>\> | -| `response` | [`AxiosInterceptorManager`](verida_account_node._internal_.AxiosInterceptorManager.md)<[`AxiosResponse`](verida_account_node._internal_.AxiosResponse.md)<`any`, `any`\>\> | - -#### Inherited from - -[Axios](../classes/verida_account_node._internal_.Axios.md).[interceptors](../classes/verida_account_node._internal_.Axios.md#interceptors) - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:217 - -## Methods - -### delete - -▸ **delete**<`T`, `R`, `D`\>(`url`, `config?`): `Promise`<`R`\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `any` | -| `R` | [`AxiosResponse`](verida_account_node._internal_.AxiosResponse.md)<`T`, `any`\> | -| `D` | `any` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `config?` | [`AxiosRequestConfig`](verida_account_node._internal_.AxiosRequestConfig.md)<`D`\> | - -#### Returns - -`Promise`<`R`\> - -#### Inherited from - -[Axios](../classes/verida_account_node._internal_.Axios.md).[delete](../classes/verida_account_node._internal_.Axios.md#delete) - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:224 - -___ - -### get - -▸ **get**<`T`, `R`, `D`\>(`url`, `config?`): `Promise`<`R`\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `any` | -| `R` | [`AxiosResponse`](verida_account_node._internal_.AxiosResponse.md)<`T`, `any`\> | -| `D` | `any` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `config?` | [`AxiosRequestConfig`](verida_account_node._internal_.AxiosRequestConfig.md)<`D`\> | - -#### Returns - -`Promise`<`R`\> - -#### Inherited from - -[Axios](../classes/verida_account_node._internal_.Axios.md).[get](../classes/verida_account_node._internal_.Axios.md#get) - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:223 - -___ - -### getUri - -▸ **getUri**(`config?`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config?` | [`AxiosRequestConfig`](verida_account_node._internal_.AxiosRequestConfig.md)<`any`\> | - -#### Returns - -`string` - -#### Inherited from - -[Axios](../classes/verida_account_node._internal_.Axios.md).[getUri](../classes/verida_account_node._internal_.Axios.md#geturi) - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:221 - -___ - -### head - -▸ **head**<`T`, `R`, `D`\>(`url`, `config?`): `Promise`<`R`\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `any` | -| `R` | [`AxiosResponse`](verida_account_node._internal_.AxiosResponse.md)<`T`, `any`\> | -| `D` | `any` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `config?` | [`AxiosRequestConfig`](verida_account_node._internal_.AxiosRequestConfig.md)<`D`\> | - -#### Returns - -`Promise`<`R`\> - -#### Inherited from - -[Axios](../classes/verida_account_node._internal_.Axios.md).[head](../classes/verida_account_node._internal_.Axios.md#head) - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:225 - -___ - -### options - -▸ **options**<`T`, `R`, `D`\>(`url`, `config?`): `Promise`<`R`\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `any` | -| `R` | [`AxiosResponse`](verida_account_node._internal_.AxiosResponse.md)<`T`, `any`\> | -| `D` | `any` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `config?` | [`AxiosRequestConfig`](verida_account_node._internal_.AxiosRequestConfig.md)<`D`\> | - -#### Returns - -`Promise`<`R`\> - -#### Inherited from - -[Axios](../classes/verida_account_node._internal_.Axios.md).[options](../classes/verida_account_node._internal_.Axios.md#options) - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:226 - -___ - -### patch - -▸ **patch**<`T`, `R`, `D`\>(`url`, `data?`, `config?`): `Promise`<`R`\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `any` | -| `R` | [`AxiosResponse`](verida_account_node._internal_.AxiosResponse.md)<`T`, `any`\> | -| `D` | `any` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `data?` | `D` | -| `config?` | [`AxiosRequestConfig`](verida_account_node._internal_.AxiosRequestConfig.md)<`D`\> | - -#### Returns - -`Promise`<`R`\> - -#### Inherited from - -[Axios](../classes/verida_account_node._internal_.Axios.md).[patch](../classes/verida_account_node._internal_.Axios.md#patch) - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:229 - -___ - -### patchForm - -▸ **patchForm**<`T`, `R`, `D`\>(`url`, `data?`, `config?`): `Promise`<`R`\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `any` | -| `R` | [`AxiosResponse`](verida_account_node._internal_.AxiosResponse.md)<`T`, `any`\> | -| `D` | `any` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `data?` | `D` | -| `config?` | [`AxiosRequestConfig`](verida_account_node._internal_.AxiosRequestConfig.md)<`D`\> | - -#### Returns - -`Promise`<`R`\> - -#### Inherited from - -[Axios](../classes/verida_account_node._internal_.Axios.md).[patchForm](../classes/verida_account_node._internal_.Axios.md#patchform) - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:232 - -___ - -### post - -▸ **post**<`T`, `R`, `D`\>(`url`, `data?`, `config?`): `Promise`<`R`\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `any` | -| `R` | [`AxiosResponse`](verida_account_node._internal_.AxiosResponse.md)<`T`, `any`\> | -| `D` | `any` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `data?` | `D` | -| `config?` | [`AxiosRequestConfig`](verida_account_node._internal_.AxiosRequestConfig.md)<`D`\> | - -#### Returns - -`Promise`<`R`\> - -#### Inherited from - -[Axios](../classes/verida_account_node._internal_.Axios.md).[post](../classes/verida_account_node._internal_.Axios.md#post) - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:227 - -___ - -### postForm - -▸ **postForm**<`T`, `R`, `D`\>(`url`, `data?`, `config?`): `Promise`<`R`\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `any` | -| `R` | [`AxiosResponse`](verida_account_node._internal_.AxiosResponse.md)<`T`, `any`\> | -| `D` | `any` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `data?` | `D` | -| `config?` | [`AxiosRequestConfig`](verida_account_node._internal_.AxiosRequestConfig.md)<`D`\> | - -#### Returns - -`Promise`<`R`\> - -#### Inherited from - -[Axios](../classes/verida_account_node._internal_.Axios.md).[postForm](../classes/verida_account_node._internal_.Axios.md#postform) - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:230 - -___ - -### put - -▸ **put**<`T`, `R`, `D`\>(`url`, `data?`, `config?`): `Promise`<`R`\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `any` | -| `R` | [`AxiosResponse`](verida_account_node._internal_.AxiosResponse.md)<`T`, `any`\> | -| `D` | `any` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `data?` | `D` | -| `config?` | [`AxiosRequestConfig`](verida_account_node._internal_.AxiosRequestConfig.md)<`D`\> | - -#### Returns - -`Promise`<`R`\> - -#### Inherited from - -[Axios](../classes/verida_account_node._internal_.Axios.md).[put](../classes/verida_account_node._internal_.Axios.md#put) - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:228 - -___ - -### putForm - -▸ **putForm**<`T`, `R`, `D`\>(`url`, `data?`, `config?`): `Promise`<`R`\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `any` | -| `R` | [`AxiosResponse`](verida_account_node._internal_.AxiosResponse.md)<`T`, `any`\> | -| `D` | `any` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `data?` | `D` | -| `config?` | [`AxiosRequestConfig`](verida_account_node._internal_.AxiosRequestConfig.md)<`D`\> | - -#### Returns - -`Promise`<`R`\> - -#### Inherited from - -[Axios](../classes/verida_account_node._internal_.Axios.md).[putForm](../classes/verida_account_node._internal_.Axios.md#putform) - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:231 - -___ - -### request - -▸ **request**<`T`, `R`, `D`\>(`config`): `Promise`<`R`\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `any` | -| `R` | [`AxiosResponse`](verida_account_node._internal_.AxiosResponse.md)<`T`, `any`\> | -| `D` | `any` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | [`AxiosRequestConfig`](verida_account_node._internal_.AxiosRequestConfig.md)<`D`\> | - -#### Returns - -`Promise`<`R`\> - -#### Inherited from - -[Axios](../classes/verida_account_node._internal_.Axios.md).[request](../classes/verida_account_node._internal_.Axios.md#request) - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:222 diff --git a/docs/api/verida-js/interfaces/verida_account_node._internal_.AxiosInterceptorManager.md b/docs/api/verida-js/interfaces/verida_account_node._internal_.AxiosInterceptorManager.md deleted file mode 100644 index b47dbcc..0000000 --- a/docs/api/verida-js/interfaces/verida_account_node._internal_.AxiosInterceptorManager.md +++ /dev/null @@ -1,66 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account-node](../modules/verida_account_node.md) / [](../modules/verida_account_node._internal_.md) / AxiosInterceptorManager - -# Interface: AxiosInterceptorManager - -[@verida/account-node](../modules/verida_account_node.md).[](../modules/verida_account_node._internal_.md).AxiosInterceptorManager - -## Type parameters - -| Name | -| :------ | -| `V` | - -## Table of contents - -### Methods - -- [eject](verida_account_node._internal_.AxiosInterceptorManager.md#eject) -- [use](verida_account_node._internal_.AxiosInterceptorManager.md#use) - -## Methods - -### eject - -▸ **eject**(`id`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `id` | `number` | - -#### Returns - -`void` - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:211 - -___ - -### use - -▸ **use**<`T`\>(`onFulfilled?`, `onRejected?`, `options?`): `number` - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `V` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `onFulfilled?` | (`value`: `V`) => `T` \| `Promise`<`T`\> | -| `onRejected?` | (`error`: `any`) => `any` | -| `options?` | [`AxiosInterceptorOptions`](verida_account_node._internal_.AxiosInterceptorOptions.md) | - -#### Returns - -`number` - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:210 diff --git a/docs/api/verida-js/interfaces/verida_account_node._internal_.AxiosInterceptorOptions.md b/docs/api/verida-js/interfaces/verida_account_node._internal_.AxiosInterceptorOptions.md deleted file mode 100644 index 328c6d2..0000000 --- a/docs/api/verida-js/interfaces/verida_account_node._internal_.AxiosInterceptorOptions.md +++ /dev/null @@ -1,45 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account-node](../modules/verida_account_node.md) / [](../modules/verida_account_node._internal_.md) / AxiosInterceptorOptions - -# Interface: AxiosInterceptorOptions - -[@verida/account-node](../modules/verida_account_node.md).[](../modules/verida_account_node._internal_.md).AxiosInterceptorOptions - -## Table of contents - -### Properties - -- [synchronous](verida_account_node._internal_.AxiosInterceptorOptions.md#synchronous) - -### Methods - -- [runWhen](verida_account_node._internal_.AxiosInterceptorOptions.md#runwhen) - -## Properties - -### synchronous - -• `Optional` **synchronous**: `boolean` - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:205 - -## Methods - -### runWhen - -▸ `Optional` **runWhen**(`config`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | [`AxiosRequestConfig`](verida_account_node._internal_.AxiosRequestConfig.md)<`any`\> | - -#### Returns - -`boolean` - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:206 diff --git a/docs/api/verida-js/interfaces/verida_account_node._internal_.AxiosPromise.md b/docs/api/verida-js/interfaces/verida_account_node._internal_.AxiosPromise.md deleted file mode 100644 index 51e0c3f..0000000 --- a/docs/api/verida-js/interfaces/verida_account_node._internal_.AxiosPromise.md +++ /dev/null @@ -1,142 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account-node](../modules/verida_account_node.md) / [](../modules/verida_account_node._internal_.md) / AxiosPromise - -# Interface: AxiosPromise - -[@verida/account-node](../modules/verida_account_node.md).[](../modules/verida_account_node._internal_.md).AxiosPromise - -## Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `any` | - -## Hierarchy - -- `Promise`<[`AxiosResponse`](verida_account_node._internal_.AxiosResponse.md)<`T`\>\> - - ↳ **`AxiosPromise`** - -## Table of contents - -### Properties - -- [[toStringTag]](verida_account_node._internal_.AxiosPromise.md#[tostringtag]) - -### Methods - -- [catch](verida_account_node._internal_.AxiosPromise.md#catch) -- [finally](verida_account_node._internal_.AxiosPromise.md#finally) -- [then](verida_account_node._internal_.AxiosPromise.md#then) - -## Properties - -### [toStringTag] - -• `Readonly` **[toStringTag]**: `string` - -#### Inherited from - -Promise.\_\_@toStringTag@170 - -#### Defined in - -node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:174 - -## Methods - -### catch - -▸ **catch**<`TResult`\>(`onrejected?`): `Promise`<[`AxiosResponse`](verida_account_node._internal_.AxiosResponse.md)<`T`, `any`\> \| `TResult`\> - -Attaches a callback for only the rejection of the Promise. - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `TResult` | `never` | - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `onrejected?` | ``null`` \| (`reason`: `any`) => `TResult` \| [`PromiseLike`](verida_account_node._internal_.PromiseLike.md)<`TResult`\> | The callback to execute when the Promise is rejected. | - -#### Returns - -`Promise`<[`AxiosResponse`](verida_account_node._internal_.AxiosResponse.md)<`T`, `any`\> \| `TResult`\> - -A Promise for the completion of the callback. - -#### Inherited from - -Promise.catch - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1460 - -___ - -### finally - -▸ **finally**(`onfinally?`): `Promise`<[`AxiosResponse`](verida_account_node._internal_.AxiosResponse.md)<`T`, `any`\>\> - -Attaches a callback that is invoked when the Promise is settled (fulfilled or rejected). The -resolved value cannot be modified from the callback. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `onfinally?` | ``null`` \| () => `void` | The callback to execute when the Promise is settled (fulfilled or rejected). | - -#### Returns - -`Promise`<[`AxiosResponse`](verida_account_node._internal_.AxiosResponse.md)<`T`, `any`\>\> - -A Promise for the completion of the callback. - -#### Inherited from - -Promise.finally - -#### Defined in - -node_modules/typescript/lib/lib.es2018.promise.d.ts:31 - -___ - -### then - -▸ **then**<`TResult1`, `TResult2`\>(`onfulfilled?`, `onrejected?`): `Promise`<`TResult1` \| `TResult2`\> - -Attaches callbacks for the resolution and/or rejection of the Promise. - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `TResult1` | [`AxiosResponse`](verida_account_node._internal_.AxiosResponse.md)<`T`, `any`\> | -| `TResult2` | `never` | - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `onfulfilled?` | ``null`` \| (`value`: [`AxiosResponse`](verida_account_node._internal_.AxiosResponse.md)<`T`, `any`\>) => `TResult1` \| [`PromiseLike`](verida_account_node._internal_.PromiseLike.md)<`TResult1`\> | The callback to execute when the Promise is resolved. | -| `onrejected?` | ``null`` \| (`reason`: `any`) => `TResult2` \| [`PromiseLike`](verida_account_node._internal_.PromiseLike.md)<`TResult2`\> | The callback to execute when the Promise is rejected. | - -#### Returns - -`Promise`<`TResult1` \| `TResult2`\> - -A Promise for the completion of which ever callback is executed. - -#### Inherited from - -Promise.then - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1453 diff --git a/docs/api/verida-js/interfaces/verida_account_node._internal_.AxiosProxyConfig.md b/docs/api/verida-js/interfaces/verida_account_node._internal_.AxiosProxyConfig.md deleted file mode 100644 index 290747e..0000000 --- a/docs/api/verida-js/interfaces/verida_account_node._internal_.AxiosProxyConfig.md +++ /dev/null @@ -1,61 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account-node](../modules/verida_account_node.md) / [](../modules/verida_account_node._internal_.md) / AxiosProxyConfig - -# Interface: AxiosProxyConfig - -[@verida/account-node](../modules/verida_account_node.md).[](../modules/verida_account_node._internal_.md).AxiosProxyConfig - -## Table of contents - -### Properties - -- [auth](verida_account_node._internal_.AxiosProxyConfig.md#auth) -- [host](verida_account_node._internal_.AxiosProxyConfig.md#host) -- [port](verida_account_node._internal_.AxiosProxyConfig.md#port) -- [protocol](verida_account_node._internal_.AxiosProxyConfig.md#protocol) - -## Properties - -### auth - -• `Optional` **auth**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `password` | `string` | -| `username` | `string` | - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:28 - -___ - -### host - -• **host**: `string` - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:26 - -___ - -### port - -• **port**: `number` - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:27 - -___ - -### protocol - -• `Optional` **protocol**: `string` - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:32 diff --git a/docs/api/verida-js/interfaces/verida_account_node._internal_.AxiosRequestConfig.md b/docs/api/verida-js/interfaces/verida_account_node._internal_.AxiosRequestConfig.md deleted file mode 100644 index 7e3ad61..0000000 --- a/docs/api/verida-js/interfaces/verida_account_node._internal_.AxiosRequestConfig.md +++ /dev/null @@ -1,452 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account-node](../modules/verida_account_node.md) / [](../modules/verida_account_node._internal_.md) / AxiosRequestConfig - -# Interface: AxiosRequestConfig - -[@verida/account-node](../modules/verida_account_node.md).[](../modules/verida_account_node._internal_.md).AxiosRequestConfig - -## Type parameters - -| Name | Type | -| :------ | :------ | -| `D` | `any` | - -## Table of contents - -### Properties - -- [adapter](verida_account_node._internal_.AxiosRequestConfig.md#adapter) -- [auth](verida_account_node._internal_.AxiosRequestConfig.md#auth) -- [baseURL](verida_account_node._internal_.AxiosRequestConfig.md#baseurl) -- [cancelToken](verida_account_node._internal_.AxiosRequestConfig.md#canceltoken) -- [data](verida_account_node._internal_.AxiosRequestConfig.md#data) -- [decompress](verida_account_node._internal_.AxiosRequestConfig.md#decompress) -- [env](verida_account_node._internal_.AxiosRequestConfig.md#env) -- [headers](verida_account_node._internal_.AxiosRequestConfig.md#headers) -- [httpAgent](verida_account_node._internal_.AxiosRequestConfig.md#httpagent) -- [httpsAgent](verida_account_node._internal_.AxiosRequestConfig.md#httpsagent) -- [insecureHTTPParser](verida_account_node._internal_.AxiosRequestConfig.md#insecurehttpparser) -- [maxBodyLength](verida_account_node._internal_.AxiosRequestConfig.md#maxbodylength) -- [maxContentLength](verida_account_node._internal_.AxiosRequestConfig.md#maxcontentlength) -- [maxRedirects](verida_account_node._internal_.AxiosRequestConfig.md#maxredirects) -- [method](verida_account_node._internal_.AxiosRequestConfig.md#method) -- [params](verida_account_node._internal_.AxiosRequestConfig.md#params) -- [proxy](verida_account_node._internal_.AxiosRequestConfig.md#proxy) -- [responseEncoding](verida_account_node._internal_.AxiosRequestConfig.md#responseencoding) -- [responseType](verida_account_node._internal_.AxiosRequestConfig.md#responsetype) -- [signal](verida_account_node._internal_.AxiosRequestConfig.md#signal) -- [socketPath](verida_account_node._internal_.AxiosRequestConfig.md#socketpath) -- [timeout](verida_account_node._internal_.AxiosRequestConfig.md#timeout) -- [timeoutErrorMessage](verida_account_node._internal_.AxiosRequestConfig.md#timeouterrormessage) -- [transformRequest](verida_account_node._internal_.AxiosRequestConfig.md#transformrequest) -- [transformResponse](verida_account_node._internal_.AxiosRequestConfig.md#transformresponse) -- [transitional](verida_account_node._internal_.AxiosRequestConfig.md#transitional) -- [url](verida_account_node._internal_.AxiosRequestConfig.md#url) -- [validateStatus](verida_account_node._internal_.AxiosRequestConfig.md#validatestatus) -- [withCredentials](verida_account_node._internal_.AxiosRequestConfig.md#withcredentials) -- [xsrfCookieName](verida_account_node._internal_.AxiosRequestConfig.md#xsrfcookiename) -- [xsrfHeaderName](verida_account_node._internal_.AxiosRequestConfig.md#xsrfheadername) - -### Methods - -- [beforeRedirect](verida_account_node._internal_.AxiosRequestConfig.md#beforeredirect) -- [onDownloadProgress](verida_account_node._internal_.AxiosRequestConfig.md#ondownloadprogress) -- [onUploadProgress](verida_account_node._internal_.AxiosRequestConfig.md#onuploadprogress) -- [paramsSerializer](verida_account_node._internal_.AxiosRequestConfig.md#paramsserializer) - -## Properties - -### adapter - -• `Optional` **adapter**: [`AxiosAdapter`](verida_account_node._internal_.AxiosAdapter.md) - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:88 - -___ - -### auth - -• `Optional` **auth**: [`AxiosBasicCredentials`](verida_account_node._internal_.AxiosBasicCredentials.md) - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:89 - -___ - -### baseURL - -• `Optional` **baseURL**: `string` - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:78 - -___ - -### cancelToken - -• `Optional` **cancelToken**: [`CancelToken`](verida_account_node._internal_.CancelToken.md) - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:105 - -___ - -### data - -• `Optional` **data**: `D` - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:84 - -___ - -### decompress - -• `Optional` **decompress**: `boolean` - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:106 - -___ - -### env - -• `Optional` **env**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `FormData?` | (...`args`: `any`[]) => `object` | - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:110 - -___ - -### headers - -• `Optional` **headers**: [`AxiosRequestHeaders`](../modules/verida_account_node._internal_.md#axiosrequestheaders) - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:81 - -___ - -### httpAgent - -• `Optional` **httpAgent**: `any` - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:102 - -___ - -### httpsAgent - -• `Optional` **httpsAgent**: `any` - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:103 - -___ - -### insecureHTTPParser - -• `Optional` **insecureHTTPParser**: `boolean` - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:109 - -___ - -### maxBodyLength - -• `Optional` **maxBodyLength**: `number` - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:98 - -___ - -### maxContentLength - -• `Optional` **maxContentLength**: `number` - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:96 - -___ - -### maxRedirects - -• `Optional` **maxRedirects**: `number` - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:99 - -___ - -### method - -• `Optional` **method**: `string` - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:77 - -___ - -### params - -• `Optional` **params**: `any` - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:82 - -___ - -### proxy - -• `Optional` **proxy**: ``false`` \| [`AxiosProxyConfig`](verida_account_node._internal_.AxiosProxyConfig.md) - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:104 - -___ - -### responseEncoding - -• `Optional` **responseEncoding**: `string` - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:91 - -___ - -### responseType - -• `Optional` **responseType**: [`ResponseType`](../modules/verida_account_node._internal_.md#responsetype) - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:90 - -___ - -### signal - -• `Optional` **signal**: [`AbortSignal`](../modules/verida_account_node._internal_.md#abortsignal) - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:108 - -___ - -### socketPath - -• `Optional` **socketPath**: ``null`` \| `string` - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:101 - -___ - -### timeout - -• `Optional` **timeout**: `number` - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:85 - -___ - -### timeoutErrorMessage - -• `Optional` **timeoutErrorMessage**: `string` - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:86 - -___ - -### transformRequest - -• `Optional` **transformRequest**: [`AxiosRequestTransformer`](verida_account_node._internal_.AxiosRequestTransformer.md) \| [`AxiosRequestTransformer`](verida_account_node._internal_.AxiosRequestTransformer.md)[] - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:79 - -___ - -### transformResponse - -• `Optional` **transformResponse**: [`AxiosResponseTransformer`](verida_account_node._internal_.AxiosResponseTransformer.md) \| [`AxiosResponseTransformer`](verida_account_node._internal_.AxiosResponseTransformer.md)[] - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:80 - -___ - -### transitional - -• `Optional` **transitional**: [`TransitionalOptions`](verida_account_node._internal_.TransitionalOptions.md) - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:107 - -___ - -### url - -• `Optional` **url**: `string` - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:76 - -___ - -### validateStatus - -• `Optional` **validateStatus**: ``null`` \| (`status`: `number`) => `boolean` - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:97 - -___ - -### withCredentials - -• `Optional` **withCredentials**: `boolean` - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:87 - -___ - -### xsrfCookieName - -• `Optional` **xsrfCookieName**: `string` - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:92 - -___ - -### xsrfHeaderName - -• `Optional` **xsrfHeaderName**: `string` - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:93 - -## Methods - -### beforeRedirect - -▸ `Optional` **beforeRedirect**(`options`, `responseDetails`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options` | [`Record`](../modules/verida_account_node._internal_.md#record)<`string`, `any`\> | -| `responseDetails` | `Object` | -| `responseDetails.headers` | [`Record`](../modules/verida_account_node._internal_.md#record)<`string`, `string`\> | - -#### Returns - -`void` - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:100 - -___ - -### onDownloadProgress - -▸ `Optional` **onDownloadProgress**(`progressEvent`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `progressEvent` | `any` | - -#### Returns - -`void` - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:95 - -___ - -### onUploadProgress - -▸ `Optional` **onUploadProgress**(`progressEvent`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `progressEvent` | `any` | - -#### Returns - -`void` - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:94 - -___ - -### paramsSerializer - -▸ `Optional` **paramsSerializer**(`params`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `params` | `any` | - -#### Returns - -`string` - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:83 diff --git a/docs/api/verida-js/interfaces/verida_account_node._internal_.AxiosRequestTransformer.md b/docs/api/verida-js/interfaces/verida_account_node._internal_.AxiosRequestTransformer.md deleted file mode 100644 index 7a25c5a..0000000 --- a/docs/api/verida-js/interfaces/verida_account_node._internal_.AxiosRequestTransformer.md +++ /dev/null @@ -1,26 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account-node](../modules/verida_account_node.md) / [](../modules/verida_account_node._internal_.md) / AxiosRequestTransformer - -# Interface: AxiosRequestTransformer - -[@verida/account-node](../modules/verida_account_node.md).[](../modules/verida_account_node._internal_.md).AxiosRequestTransformer - -## Callable - -### AxiosRequestTransformer - -▸ **AxiosRequestTransformer**(`data`, `headers?`): `any` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `any` | -| `headers?` | [`AxiosRequestHeaders`](../modules/verida_account_node._internal_.md#axiosrequestheaders) | - -#### Returns - -`any` - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:9 diff --git a/docs/api/verida-js/interfaces/verida_account_node._internal_.AxiosResponse.md b/docs/api/verida-js/interfaces/verida_account_node._internal_.AxiosResponse.md deleted file mode 100644 index d0ab8d4..0000000 --- a/docs/api/verida-js/interfaces/verida_account_node._internal_.AxiosResponse.md +++ /dev/null @@ -1,83 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account-node](../modules/verida_account_node.md) / [](../modules/verida_account_node._internal_.md) / AxiosResponse - -# Interface: AxiosResponse - -[@verida/account-node](../modules/verida_account_node.md).[](../modules/verida_account_node._internal_.md).AxiosResponse - -## Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `any` | -| `D` | `any` | - -## Table of contents - -### Properties - -- [config](verida_account_node._internal_.AxiosResponse.md#config) -- [data](verida_account_node._internal_.AxiosResponse.md#data) -- [headers](verida_account_node._internal_.AxiosResponse.md#headers) -- [request](verida_account_node._internal_.AxiosResponse.md#request) -- [status](verida_account_node._internal_.AxiosResponse.md#status) -- [statusText](verida_account_node._internal_.AxiosResponse.md#statustext) - -## Properties - -### config - -• **config**: [`AxiosRequestConfig`](verida_account_node._internal_.AxiosRequestConfig.md)<`D`\> - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:138 - -___ - -### data - -• **data**: `T` - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:134 - -___ - -### headers - -• **headers**: [`AxiosResponseHeaders`](../modules/verida_account_node._internal_.md#axiosresponseheaders) - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:137 - -___ - -### request - -• `Optional` **request**: `any` - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:139 - -___ - -### status - -• **status**: `number` - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:135 - -___ - -### statusText - -• **statusText**: `string` - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:136 diff --git a/docs/api/verida-js/interfaces/verida_account_node._internal_.AxiosResponseTransformer.md b/docs/api/verida-js/interfaces/verida_account_node._internal_.AxiosResponseTransformer.md deleted file mode 100644 index b32ecb0..0000000 --- a/docs/api/verida-js/interfaces/verida_account_node._internal_.AxiosResponseTransformer.md +++ /dev/null @@ -1,26 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account-node](../modules/verida_account_node.md) / [](../modules/verida_account_node._internal_.md) / AxiosResponseTransformer - -# Interface: AxiosResponseTransformer - -[@verida/account-node](../modules/verida_account_node.md).[](../modules/verida_account_node._internal_.md).AxiosResponseTransformer - -## Callable - -### AxiosResponseTransformer - -▸ **AxiosResponseTransformer**(`data`, `headers?`): `any` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `any` | -| `headers?` | [`AxiosResponseHeaders`](../modules/verida_account_node._internal_.md#axiosresponseheaders) | - -#### Returns - -`any` - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:13 diff --git a/docs/api/verida-js/interfaces/verida_account_node._internal_.Block.md b/docs/api/verida-js/interfaces/verida_account_node._internal_.Block.md deleted file mode 100644 index 28002cf..0000000 --- a/docs/api/verida-js/interfaces/verida_account_node._internal_.Block.md +++ /dev/null @@ -1,207 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account-node](../modules/verida_account_node.md) / [](../modules/verida_account_node._internal_.md) / Block - -# Interface: Block - -[@verida/account-node](../modules/verida_account_node.md).[](../modules/verida_account_node._internal_.md).Block - -## Hierarchy - -- [`_Block`](verida_account_node._internal_._Block.md) - - ↳ **`Block`** - -## Table of contents - -### Properties - -- [\_difficulty](verida_account_node._internal_.Block.md#_difficulty) -- [baseFeePerGas](verida_account_node._internal_.Block.md#basefeepergas) -- [difficulty](verida_account_node._internal_.Block.md#difficulty) -- [extraData](verida_account_node._internal_.Block.md#extradata) -- [gasLimit](verida_account_node._internal_.Block.md#gaslimit) -- [gasUsed](verida_account_node._internal_.Block.md#gasused) -- [hash](verida_account_node._internal_.Block.md#hash) -- [miner](verida_account_node._internal_.Block.md#miner) -- [nonce](verida_account_node._internal_.Block.md#nonce) -- [number](verida_account_node._internal_.Block.md#number) -- [parentHash](verida_account_node._internal_.Block.md#parenthash) -- [timestamp](verida_account_node._internal_.Block.md#timestamp) -- [transactions](verida_account_node._internal_.Block.md#transactions) - -## Properties - -### \_difficulty - -• **\_difficulty**: [`BigNumber`](../classes/verida_account_node._internal_.BigNumber.md) - -#### Inherited from - -[_Block](verida_account_node._internal_._Block.md).[_difficulty](verida_account_node._internal_._Block.md#_difficulty) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:41 - -___ - -### baseFeePerGas - -• `Optional` **baseFeePerGas**: ``null`` \| [`BigNumber`](../classes/verida_account_node._internal_.BigNumber.md) - -#### Inherited from - -[_Block](verida_account_node._internal_._Block.md).[baseFeePerGas](verida_account_node._internal_._Block.md#basefeepergas) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:46 - -___ - -### difficulty - -• **difficulty**: `number` - -#### Inherited from - -[_Block](verida_account_node._internal_._Block.md).[difficulty](verida_account_node._internal_._Block.md#difficulty) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:40 - -___ - -### extraData - -• **extraData**: `string` - -#### Inherited from - -[_Block](verida_account_node._internal_._Block.md).[extraData](verida_account_node._internal_._Block.md#extradata) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:45 - -___ - -### gasLimit - -• **gasLimit**: [`BigNumber`](../classes/verida_account_node._internal_.BigNumber.md) - -#### Inherited from - -[_Block](verida_account_node._internal_._Block.md).[gasLimit](verida_account_node._internal_._Block.md#gaslimit) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:42 - -___ - -### gasUsed - -• **gasUsed**: [`BigNumber`](../classes/verida_account_node._internal_.BigNumber.md) - -#### Inherited from - -[_Block](verida_account_node._internal_._Block.md).[gasUsed](verida_account_node._internal_._Block.md#gasused) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:43 - -___ - -### hash - -• **hash**: `string` - -#### Inherited from - -[_Block](verida_account_node._internal_._Block.md).[hash](verida_account_node._internal_._Block.md#hash) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:35 - -___ - -### miner - -• **miner**: `string` - -#### Inherited from - -[_Block](verida_account_node._internal_._Block.md).[miner](verida_account_node._internal_._Block.md#miner) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:44 - -___ - -### nonce - -• **nonce**: `string` - -#### Inherited from - -[_Block](verida_account_node._internal_._Block.md).[nonce](verida_account_node._internal_._Block.md#nonce) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:39 - -___ - -### number - -• **number**: `number` - -#### Inherited from - -[_Block](verida_account_node._internal_._Block.md).[number](verida_account_node._internal_._Block.md#number) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:37 - -___ - -### parentHash - -• **parentHash**: `string` - -#### Inherited from - -[_Block](verida_account_node._internal_._Block.md).[parentHash](verida_account_node._internal_._Block.md#parenthash) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:36 - -___ - -### timestamp - -• **timestamp**: `number` - -#### Inherited from - -[_Block](verida_account_node._internal_._Block.md).[timestamp](verida_account_node._internal_._Block.md#timestamp) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:38 - -___ - -### transactions - -• **transactions**: `string`[] - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:49 diff --git a/docs/api/verida-js/interfaces/verida_account_node._internal_.BlockWithTransactions.md b/docs/api/verida-js/interfaces/verida_account_node._internal_.BlockWithTransactions.md deleted file mode 100644 index 2f21826..0000000 --- a/docs/api/verida-js/interfaces/verida_account_node._internal_.BlockWithTransactions.md +++ /dev/null @@ -1,207 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account-node](../modules/verida_account_node.md) / [](../modules/verida_account_node._internal_.md) / BlockWithTransactions - -# Interface: BlockWithTransactions - -[@verida/account-node](../modules/verida_account_node.md).[](../modules/verida_account_node._internal_.md).BlockWithTransactions - -## Hierarchy - -- [`_Block`](verida_account_node._internal_._Block.md) - - ↳ **`BlockWithTransactions`** - -## Table of contents - -### Properties - -- [\_difficulty](verida_account_node._internal_.BlockWithTransactions.md#_difficulty) -- [baseFeePerGas](verida_account_node._internal_.BlockWithTransactions.md#basefeepergas) -- [difficulty](verida_account_node._internal_.BlockWithTransactions.md#difficulty) -- [extraData](verida_account_node._internal_.BlockWithTransactions.md#extradata) -- [gasLimit](verida_account_node._internal_.BlockWithTransactions.md#gaslimit) -- [gasUsed](verida_account_node._internal_.BlockWithTransactions.md#gasused) -- [hash](verida_account_node._internal_.BlockWithTransactions.md#hash) -- [miner](verida_account_node._internal_.BlockWithTransactions.md#miner) -- [nonce](verida_account_node._internal_.BlockWithTransactions.md#nonce) -- [number](verida_account_node._internal_.BlockWithTransactions.md#number) -- [parentHash](verida_account_node._internal_.BlockWithTransactions.md#parenthash) -- [timestamp](verida_account_node._internal_.BlockWithTransactions.md#timestamp) -- [transactions](verida_account_node._internal_.BlockWithTransactions.md#transactions) - -## Properties - -### \_difficulty - -• **\_difficulty**: [`BigNumber`](../classes/verida_account_node._internal_.BigNumber.md) - -#### Inherited from - -[_Block](verida_account_node._internal_._Block.md).[_difficulty](verida_account_node._internal_._Block.md#_difficulty) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:41 - -___ - -### baseFeePerGas - -• `Optional` **baseFeePerGas**: ``null`` \| [`BigNumber`](../classes/verida_account_node._internal_.BigNumber.md) - -#### Inherited from - -[_Block](verida_account_node._internal_._Block.md).[baseFeePerGas](verida_account_node._internal_._Block.md#basefeepergas) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:46 - -___ - -### difficulty - -• **difficulty**: `number` - -#### Inherited from - -[_Block](verida_account_node._internal_._Block.md).[difficulty](verida_account_node._internal_._Block.md#difficulty) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:40 - -___ - -### extraData - -• **extraData**: `string` - -#### Inherited from - -[_Block](verida_account_node._internal_._Block.md).[extraData](verida_account_node._internal_._Block.md#extradata) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:45 - -___ - -### gasLimit - -• **gasLimit**: [`BigNumber`](../classes/verida_account_node._internal_.BigNumber.md) - -#### Inherited from - -[_Block](verida_account_node._internal_._Block.md).[gasLimit](verida_account_node._internal_._Block.md#gaslimit) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:42 - -___ - -### gasUsed - -• **gasUsed**: [`BigNumber`](../classes/verida_account_node._internal_.BigNumber.md) - -#### Inherited from - -[_Block](verida_account_node._internal_._Block.md).[gasUsed](verida_account_node._internal_._Block.md#gasused) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:43 - -___ - -### hash - -• **hash**: `string` - -#### Inherited from - -[_Block](verida_account_node._internal_._Block.md).[hash](verida_account_node._internal_._Block.md#hash) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:35 - -___ - -### miner - -• **miner**: `string` - -#### Inherited from - -[_Block](verida_account_node._internal_._Block.md).[miner](verida_account_node._internal_._Block.md#miner) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:44 - -___ - -### nonce - -• **nonce**: `string` - -#### Inherited from - -[_Block](verida_account_node._internal_._Block.md).[nonce](verida_account_node._internal_._Block.md#nonce) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:39 - -___ - -### number - -• **number**: `number` - -#### Inherited from - -[_Block](verida_account_node._internal_._Block.md).[number](verida_account_node._internal_._Block.md#number) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:37 - -___ - -### parentHash - -• **parentHash**: `string` - -#### Inherited from - -[_Block](verida_account_node._internal_._Block.md).[parentHash](verida_account_node._internal_._Block.md#parenthash) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:36 - -___ - -### timestamp - -• **timestamp**: `number` - -#### Inherited from - -[_Block](verida_account_node._internal_._Block.md).[timestamp](verida_account_node._internal_._Block.md#timestamp) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:38 - -___ - -### transactions - -• **transactions**: [`TransactionResponse`](verida_account_node._internal_.TransactionResponse.md)[] - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:52 diff --git a/docs/api/verida-js/interfaces/verida_account_node._internal_.Cancel.md b/docs/api/verida-js/interfaces/verida_account_node._internal_.Cancel.md deleted file mode 100644 index bbe55be..0000000 --- a/docs/api/verida-js/interfaces/verida_account_node._internal_.Cancel.md +++ /dev/null @@ -1,21 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account-node](../modules/verida_account_node.md) / [](../modules/verida_account_node._internal_.md) / Cancel - -# Interface: Cancel - -[@verida/account-node](../modules/verida_account_node.md).[](../modules/verida_account_node._internal_.md).Cancel - -## Table of contents - -### Properties - -- [message](verida_account_node._internal_.Cancel.md#message) - -## Properties - -### message - -• **message**: `undefined` \| `string` - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:181 diff --git a/docs/api/verida-js/interfaces/verida_account_node._internal_.CancelToken.md b/docs/api/verida-js/interfaces/verida_account_node._internal_.CancelToken.md deleted file mode 100644 index 67f29ef..0000000 --- a/docs/api/verida-js/interfaces/verida_account_node._internal_.CancelToken.md +++ /dev/null @@ -1,50 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account-node](../modules/verida_account_node.md) / [](../modules/verida_account_node._internal_.md) / CancelToken - -# Interface: CancelToken - -[@verida/account-node](../modules/verida_account_node.md).[](../modules/verida_account_node._internal_.md).CancelToken - -## Table of contents - -### Properties - -- [promise](verida_account_node._internal_.CancelToken.md#promise) -- [reason](verida_account_node._internal_.CancelToken.md#reason) - -### Methods - -- [throwIfRequested](verida_account_node._internal_.CancelToken.md#throwifrequested) - -## Properties - -### promise - -• **promise**: `Promise`<[`Cancel`](verida_account_node._internal_.Cancel.md)\> - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:194 - -___ - -### reason - -• `Optional` **reason**: [`Cancel`](verida_account_node._internal_.Cancel.md) - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:195 - -## Methods - -### throwIfRequested - -▸ **throwIfRequested**(): `void` - -#### Returns - -`void` - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:196 diff --git a/docs/api/verida-js/interfaces/verida_account_node._internal_.DIDClientConfig.md b/docs/api/verida-js/interfaces/verida_account_node._internal_.DIDClientConfig.md deleted file mode 100644 index 6e56f8d..0000000 --- a/docs/api/verida-js/interfaces/verida_account_node._internal_.DIDClientConfig.md +++ /dev/null @@ -1,43 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account-node](../modules/verida_account_node.md) / [](../modules/verida_account_node._internal_.md) / DIDClientConfig - -# Interface: DIDClientConfig - -[@verida/account-node](../modules/verida_account_node.md).[](../modules/verida_account_node._internal_.md).DIDClientConfig - -## Table of contents - -### Properties - -- [network](verida_account_node._internal_.DIDClientConfig.md#network) -- [rpcUrl](verida_account_node._internal_.DIDClientConfig.md#rpcurl) -- [timeout](verida_account_node._internal_.DIDClientConfig.md#timeout) - -## Properties - -### network - -• **network**: [`EnvironmentType`](../enums/verida_account_node._internal_.EnvironmentType.md) - -#### Defined in - -packages/types/dist/NetworkInterfaces.d.ts:21 - -___ - -### rpcUrl - -• `Optional` **rpcUrl**: `string` - -#### Defined in - -packages/types/dist/NetworkInterfaces.d.ts:22 - -___ - -### timeout - -• `Optional` **timeout**: `number` - -#### Defined in - -packages/types/dist/NetworkInterfaces.d.ts:23 diff --git a/docs/api/verida-js/interfaces/verida_account_node._internal_.DIDDocumentStruct.md b/docs/api/verida-js/interfaces/verida_account_node._internal_.DIDDocumentStruct.md deleted file mode 100644 index a3bc6a3..0000000 --- a/docs/api/verida-js/interfaces/verida_account_node._internal_.DIDDocumentStruct.md +++ /dev/null @@ -1,189 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account-node](../modules/verida_account_node.md) / [](../modules/verida_account_node._internal_.md) / DIDDocumentStruct - -# Interface: DIDDocumentStruct - -[@verida/account-node](../modules/verida_account_node.md).[](../modules/verida_account_node._internal_.md).DIDDocumentStruct - -## Hierarchy - -- [`DIDDocument`](../modules/verida_account_node._internal_.md#diddocument) - - ↳ **`DIDDocumentStruct`** - -## Table of contents - -### Properties - -- [@context](verida_account_node._internal_.DIDDocumentStruct.md#@context) -- [alsoKnownAs](verida_account_node._internal_.DIDDocumentStruct.md#alsoknownas) -- [assertionMethod](verida_account_node._internal_.DIDDocumentStruct.md#assertionmethod) -- [authentication](verida_account_node._internal_.DIDDocumentStruct.md#authentication) -- [capabilityDelegation](verida_account_node._internal_.DIDDocumentStruct.md#capabilitydelegation) -- [capabilityInvocation](verida_account_node._internal_.DIDDocumentStruct.md#capabilityinvocation) -- [controller](verida_account_node._internal_.DIDDocumentStruct.md#controller) -- [id](verida_account_node._internal_.DIDDocumentStruct.md#id) -- [keyAgreement](verida_account_node._internal_.DIDDocumentStruct.md#keyagreement) -- [proof](verida_account_node._internal_.DIDDocumentStruct.md#proof) -- [publicKey](verida_account_node._internal_.DIDDocumentStruct.md#publickey) -- [service](verida_account_node._internal_.DIDDocumentStruct.md#service) -- [verificationMethod](verida_account_node._internal_.DIDDocumentStruct.md#verificationmethod) - -## Properties - -### @context - -• `Optional` **@context**: `string` \| `string`[] - -#### Inherited from - -DD.@context - -#### Defined in - -packages/did-document/node_modules/did-resolver/lib/resolver.d.ts:26 - -___ - -### alsoKnownAs - -• `Optional` **alsoKnownAs**: `string`[] - -#### Inherited from - -DD.alsoKnownAs - -#### Defined in - -packages/did-document/node_modules/did-resolver/lib/resolver.d.ts:28 - -___ - -### assertionMethod - -• **assertionMethod**: `undefined` \| (`string` \| [`VerificationMethod`](verida_account_node._internal_.VerificationMethod.md))[] - -#### Inherited from - -DD.assertionMethod - -___ - -### authentication - -• **authentication**: `undefined` \| (`string` \| [`VerificationMethod`](verida_account_node._internal_.VerificationMethod.md))[] - -#### Inherited from - -DD.authentication - -___ - -### capabilityDelegation - -• **capabilityDelegation**: `undefined` \| (`string` \| [`VerificationMethod`](verida_account_node._internal_.VerificationMethod.md))[] - -#### Inherited from - -DD.capabilityDelegation - -___ - -### capabilityInvocation - -• **capabilityInvocation**: `undefined` \| (`string` \| [`VerificationMethod`](verida_account_node._internal_.VerificationMethod.md))[] - -#### Inherited from - -DD.capabilityInvocation - -___ - -### controller - -• `Optional` **controller**: `string` \| `string`[] - -#### Inherited from - -DD.controller - -#### Defined in - -packages/did-document/node_modules/did-resolver/lib/resolver.d.ts:29 - -___ - -### id - -• **id**: `string` - -#### Inherited from - -DD.id - -#### Defined in - -packages/did-document/node_modules/did-resolver/lib/resolver.d.ts:27 - -___ - -### keyAgreement - -• **keyAgreement**: `undefined` \| (`string` \| [`VerificationMethod`](verida_account_node._internal_.VerificationMethod.md))[] - -#### Inherited from - -DD.keyAgreement - -___ - -### proof - -• `Optional` **proof**: [`Proof`](verida_account_node._internal_.Proof.md) - -#### Defined in - -packages/did-document/dist/interfaces.d.ts:14 - -___ - -### publicKey - -• `Optional` **publicKey**: [`VerificationMethod`](verida_account_node._internal_.VerificationMethod.md)[] - -**`deprecated`** - -#### Inherited from - -DD.publicKey - -#### Defined in - -packages/did-document/node_modules/did-resolver/lib/resolver.d.ts:35 - -___ - -### service - -• `Optional` **service**: [`ServiceEndpoint`](verida_account_node._internal_.ServiceEndpoint.md)[] - -#### Inherited from - -DD.service - -#### Defined in - -packages/did-document/node_modules/did-resolver/lib/resolver.d.ts:31 - -___ - -### verificationMethod - -• `Optional` **verificationMethod**: [`VerificationMethod`](verida_account_node._internal_.VerificationMethod.md)[] - -#### Inherited from - -DD.verificationMethod - -#### Defined in - -packages/did-document/node_modules/did-resolver/lib/resolver.d.ts:30 diff --git a/docs/api/verida-js/interfaces/verida_account_node._internal_.Endpoints.md b/docs/api/verida-js/interfaces/verida_account_node._internal_.Endpoints.md deleted file mode 100644 index e3e4039..0000000 --- a/docs/api/verida-js/interfaces/verida_account_node._internal_.Endpoints.md +++ /dev/null @@ -1,54 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account-node](../modules/verida_account_node.md) / [](../modules/verida_account_node._internal_.md) / Endpoints - -# Interface: Endpoints - -[@verida/account-node](../modules/verida_account_node.md).[](../modules/verida_account_node._internal_.md).Endpoints - -## Table of contents - -### Properties - -- [database](verida_account_node._internal_.Endpoints.md#database) -- [messaging](verida_account_node._internal_.Endpoints.md#messaging) -- [notification](verida_account_node._internal_.Endpoints.md#notification) -- [storage](verida_account_node._internal_.Endpoints.md#storage) - -## Properties - -### database - -• **database**: [`SecureContextEndpoint`](verida_account_node._internal_.SecureContextEndpoint-1.md) - -#### Defined in - -packages/did-document/dist/interfaces.d.ts:17 - -___ - -### messaging - -• **messaging**: [`SecureContextEndpoint`](verida_account_node._internal_.SecureContextEndpoint-1.md) - -#### Defined in - -packages/did-document/dist/interfaces.d.ts:18 - -___ - -### notification - -• `Optional` **notification**: [`SecureContextEndpoint`](verida_account_node._internal_.SecureContextEndpoint-1.md) - -#### Defined in - -packages/did-document/dist/interfaces.d.ts:20 - -___ - -### storage - -• `Optional` **storage**: [`SecureContextEndpoint`](verida_account_node._internal_.SecureContextEndpoint-1.md) - -#### Defined in - -packages/did-document/dist/interfaces.d.ts:19 diff --git a/docs/api/verida-js/interfaces/verida_account_node._internal_.EventFilter.md b/docs/api/verida-js/interfaces/verida_account_node._internal_.EventFilter.md deleted file mode 100644 index b4df4fb..0000000 --- a/docs/api/verida-js/interfaces/verida_account_node._internal_.EventFilter.md +++ /dev/null @@ -1,38 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account-node](../modules/verida_account_node.md) / [](../modules/verida_account_node._internal_.md) / EventFilter - -# Interface: EventFilter - -[@verida/account-node](../modules/verida_account_node.md).[](../modules/verida_account_node._internal_.md).EventFilter - -## Hierarchy - -- **`EventFilter`** - - ↳ [`Filter`](verida_account_node._internal_.Filter.md) - -## Table of contents - -### Properties - -- [address](verida_account_node._internal_.EventFilter.md#address) -- [topics](verida_account_node._internal_.EventFilter.md#topics) - -## Properties - -### address - -• `Optional` **address**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:91 - -___ - -### topics - -• `Optional` **topics**: (``null`` \| `string` \| `string`[])[] - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:92 diff --git a/docs/api/verida-js/interfaces/verida_account_node._internal_.FeeData.md b/docs/api/verida-js/interfaces/verida_account_node._internal_.FeeData.md deleted file mode 100644 index c02367b..0000000 --- a/docs/api/verida-js/interfaces/verida_account_node._internal_.FeeData.md +++ /dev/null @@ -1,54 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account-node](../modules/verida_account_node.md) / [](../modules/verida_account_node._internal_.md) / FeeData - -# Interface: FeeData - -[@verida/account-node](../modules/verida_account_node.md).[](../modules/verida_account_node._internal_.md).FeeData - -## Table of contents - -### Properties - -- [gasPrice](verida_account_node._internal_.FeeData.md#gasprice) -- [lastBaseFeePerGas](verida_account_node._internal_.FeeData.md#lastbasefeepergas) -- [maxFeePerGas](verida_account_node._internal_.FeeData.md#maxfeepergas) -- [maxPriorityFeePerGas](verida_account_node._internal_.FeeData.md#maxpriorityfeepergas) - -## Properties - -### gasPrice - -• **gasPrice**: ``null`` \| [`BigNumber`](../classes/verida_account_node._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:88 - -___ - -### lastBaseFeePerGas - -• **lastBaseFeePerGas**: ``null`` \| [`BigNumber`](../classes/verida_account_node._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:85 - -___ - -### maxFeePerGas - -• **maxFeePerGas**: ``null`` \| [`BigNumber`](../classes/verida_account_node._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:86 - -___ - -### maxPriorityFeePerGas - -• **maxPriorityFeePerGas**: ``null`` \| [`BigNumber`](../classes/verida_account_node._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:87 diff --git a/docs/api/verida-js/interfaces/verida_account_node._internal_.Filter.md b/docs/api/verida-js/interfaces/verida_account_node._internal_.Filter.md deleted file mode 100644 index 55b00e5..0000000 --- a/docs/api/verida-js/interfaces/verida_account_node._internal_.Filter.md +++ /dev/null @@ -1,68 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account-node](../modules/verida_account_node.md) / [](../modules/verida_account_node._internal_.md) / Filter - -# Interface: Filter - -[@verida/account-node](../modules/verida_account_node.md).[](../modules/verida_account_node._internal_.md).Filter - -## Hierarchy - -- [`EventFilter`](verida_account_node._internal_.EventFilter.md) - - ↳ **`Filter`** - -## Table of contents - -### Properties - -- [address](verida_account_node._internal_.Filter.md#address) -- [fromBlock](verida_account_node._internal_.Filter.md#fromblock) -- [toBlock](verida_account_node._internal_.Filter.md#toblock) -- [topics](verida_account_node._internal_.Filter.md#topics) - -## Properties - -### address - -• `Optional` **address**: `string` - -#### Inherited from - -[EventFilter](verida_account_node._internal_.EventFilter.md).[address](verida_account_node._internal_.EventFilter.md#address) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:91 - -___ - -### fromBlock - -• `Optional` **fromBlock**: [`BlockTag`](../modules/verida_account_node._internal_.md#blocktag) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:95 - -___ - -### toBlock - -• `Optional` **toBlock**: [`BlockTag`](../modules/verida_account_node._internal_.md#blocktag) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:96 - -___ - -### topics - -• `Optional` **topics**: (``null`` \| `string` \| `string`[])[] - -#### Inherited from - -[EventFilter](verida_account_node._internal_.EventFilter.md).[topics](verida_account_node._internal_.EventFilter.md#topics) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:92 diff --git a/docs/api/verida-js/interfaces/verida_account_node._internal_.HeadersDefaults.md b/docs/api/verida-js/interfaces/verida_account_node._internal_.HeadersDefaults.md deleted file mode 100644 index f867583..0000000 --- a/docs/api/verida-js/interfaces/verida_account_node._internal_.HeadersDefaults.md +++ /dev/null @@ -1,131 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account-node](../modules/verida_account_node.md) / [](../modules/verida_account_node._internal_.md) / HeadersDefaults - -# Interface: HeadersDefaults - -[@verida/account-node](../modules/verida_account_node.md).[](../modules/verida_account_node._internal_.md).HeadersDefaults - -## Table of contents - -### Properties - -- [common](verida_account_node._internal_.HeadersDefaults.md#common) -- [delete](verida_account_node._internal_.HeadersDefaults.md#delete) -- [get](verida_account_node._internal_.HeadersDefaults.md#get) -- [head](verida_account_node._internal_.HeadersDefaults.md#head) -- [link](verida_account_node._internal_.HeadersDefaults.md#link) -- [options](verida_account_node._internal_.HeadersDefaults.md#options) -- [patch](verida_account_node._internal_.HeadersDefaults.md#patch) -- [post](verida_account_node._internal_.HeadersDefaults.md#post) -- [purge](verida_account_node._internal_.HeadersDefaults.md#purge) -- [put](verida_account_node._internal_.HeadersDefaults.md#put) -- [unlink](verida_account_node._internal_.HeadersDefaults.md#unlink) - -## Properties - -### common - -• **common**: [`AxiosRequestHeaders`](../modules/verida_account_node._internal_.md#axiosrequestheaders) - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:116 - -___ - -### delete - -• **delete**: [`AxiosRequestHeaders`](../modules/verida_account_node._internal_.md#axiosrequestheaders) - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:117 - -___ - -### get - -• **get**: [`AxiosRequestHeaders`](../modules/verida_account_node._internal_.md#axiosrequestheaders) - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:118 - -___ - -### head - -• **head**: [`AxiosRequestHeaders`](../modules/verida_account_node._internal_.md#axiosrequestheaders) - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:119 - -___ - -### link - -• `Optional` **link**: [`AxiosRequestHeaders`](../modules/verida_account_node._internal_.md#axiosrequestheaders) - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:125 - -___ - -### options - -• `Optional` **options**: [`AxiosRequestHeaders`](../modules/verida_account_node._internal_.md#axiosrequestheaders) - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:123 - -___ - -### patch - -• **patch**: [`AxiosRequestHeaders`](../modules/verida_account_node._internal_.md#axiosrequestheaders) - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:122 - -___ - -### post - -• **post**: [`AxiosRequestHeaders`](../modules/verida_account_node._internal_.md#axiosrequestheaders) - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:120 - -___ - -### purge - -• `Optional` **purge**: [`AxiosRequestHeaders`](../modules/verida_account_node._internal_.md#axiosrequestheaders) - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:124 - -___ - -### put - -• **put**: [`AxiosRequestHeaders`](../modules/verida_account_node._internal_.md#axiosrequestheaders) - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:121 - -___ - -### unlink - -• `Optional` **unlink**: [`AxiosRequestHeaders`](../modules/verida_account_node._internal_.md#axiosrequestheaders) - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:126 diff --git a/docs/api/verida-js/interfaces/verida_account_node._internal_.Hexable.md b/docs/api/verida-js/interfaces/verida_account_node._internal_.Hexable.md deleted file mode 100644 index e6a1980..0000000 --- a/docs/api/verida-js/interfaces/verida_account_node._internal_.Hexable.md +++ /dev/null @@ -1,29 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account-node](../modules/verida_account_node.md) / [](../modules/verida_account_node._internal_.md) / Hexable - -# Interface: Hexable - -[@verida/account-node](../modules/verida_account_node.md).[](../modules/verida_account_node._internal_.md).Hexable - -## Implemented by - -- [`BigNumber`](../classes/verida_account_node._internal_.BigNumber.md) - -## Table of contents - -### Methods - -- [toHexString](verida_account_node._internal_.Hexable.md#tohexstring) - -## Methods - -### toHexString - -▸ **toHexString**(): `string` - -#### Returns - -`string` - -#### Defined in - -node_modules/@ethersproject/bytes/lib/index.d.ts:8 diff --git a/docs/api/verida-js/interfaces/verida_account_node._internal_.IAccount.md b/docs/api/verida-js/interfaces/verida_account_node._internal_.IAccount.md deleted file mode 100644 index 4c19751..0000000 --- a/docs/api/verida-js/interfaces/verida_account_node._internal_.IAccount.md +++ /dev/null @@ -1,270 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account-node](../modules/verida_account_node.md) / [](../modules/verida_account_node._internal_.md) / IAccount - -# Interface: IAccount - -[@verida/account-node](../modules/verida_account_node.md).[](../modules/verida_account_node._internal_.md).IAccount - -## Implemented by - -- [`default`](../classes/verida_account_node._internal_.default.md) - -## Table of contents - -### Methods - -- [createDidJwt](verida_account_node._internal_.IAccount.md#createdidjwt) -- [did](verida_account_node._internal_.IAccount.md#did) -- [disconnect](verida_account_node._internal_.IAccount.md#disconnect) -- [disconnectDevice](verida_account_node._internal_.IAccount.md#disconnectdevice) -- [getAuthContext](verida_account_node._internal_.IAccount.md#getauthcontext) -- [keyring](verida_account_node._internal_.IAccount.md#keyring) -- [linkStorage](verida_account_node._internal_.IAccount.md#linkstorage) -- [linkStorageContextService](verida_account_node._internal_.IAccount.md#linkstoragecontextservice) -- [setAccountConfig](verida_account_node._internal_.IAccount.md#setaccountconfig) -- [sign](verida_account_node._internal_.IAccount.md#sign) -- [storageConfig](verida_account_node._internal_.IAccount.md#storageconfig) -- [unlinkStorage](verida_account_node._internal_.IAccount.md#unlinkstorage) - -## Methods - -### createDidJwt - -▸ **createDidJwt**(`contextName`, `data`, `config`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | -| `data` | `object` | -| `config` | `any` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -packages/types/dist/IAccount.d.ts:13 - -___ - -### did - -▸ **did**(): `Promise`<`string`\> - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -packages/types/dist/IAccount.d.ts:7 - -___ - -### disconnect - -▸ **disconnect**(`contextName?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName?` | `string` | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -packages/types/dist/IAccount.d.ts:14 - -___ - -### disconnectDevice - -▸ **disconnectDevice**(`contextName`, `deviceId`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | -| `deviceId` | `string` | - -#### Returns - -`Promise`<`boolean`\> - -#### Defined in - -packages/types/dist/IAccount.d.ts:16 - -___ - -### getAuthContext - -▸ **getAuthContext**(`contextName`, `contextConfig`, `authConfig?`, `authType?`): `Promise`<[`AuthContext`](verida_account_node._internal_.AuthContext.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | -| `contextConfig` | [`SecureContextConfig`](verida_account_node._internal_.SecureContextConfig.md) | -| `authConfig?` | [`AuthTypeConfig`](verida_account_node._internal_.AuthTypeConfig.md) | -| `authType?` | `string` | - -#### Returns - -`Promise`<[`AuthContext`](verida_account_node._internal_.AuthContext.md)\> - -#### Defined in - -packages/types/dist/IAccount.d.ts:15 - -___ - -### keyring - -▸ **keyring**(`contextName`): `Promise`<[`IKeyring`](verida_account_node._internal_.IKeyring.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | - -#### Returns - -`Promise`<[`IKeyring`](verida_account_node._internal_.IKeyring.md)\> - -#### Defined in - -packages/types/dist/IAccount.d.ts:5 - -___ - -### linkStorage - -▸ **linkStorage**(`storageConfig`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `storageConfig` | [`SecureContextConfig`](verida_account_node._internal_.SecureContextConfig.md) | - -#### Returns - -`Promise`<`boolean`\> - -#### Defined in - -packages/types/dist/IAccount.d.ts:8 - -___ - -### linkStorageContextService - -▸ **linkStorageContextService**(`contextName`, `endpointType`, `serverType`, `endpointUris`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | -| `endpointType` | `string` | -| `serverType` | `string` | -| `endpointUris` | `string`[] | - -#### Returns - -`Promise`<`boolean`\> - -#### Defined in - -packages/types/dist/IAccount.d.ts:11 - -___ - -### setAccountConfig - -▸ **setAccountConfig**(`accountConfig`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `accountConfig` | [`AccountConfig`](verida_account_node._internal_.AccountConfig.md) | - -#### Returns - -`void` - -#### Defined in - -packages/types/dist/IAccount.d.ts:12 - -___ - -### sign - -▸ **sign**(`input`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `input` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -packages/types/dist/IAccount.d.ts:6 - -___ - -### storageConfig - -▸ **storageConfig**(`contextName`, `forceCreate`): `Promise`<`undefined` \| [`SecureContextConfig`](verida_account_node._internal_.SecureContextConfig.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | -| `forceCreate` | `boolean` | - -#### Returns - -`Promise`<`undefined` \| [`SecureContextConfig`](verida_account_node._internal_.SecureContextConfig.md)\> - -#### Defined in - -packages/types/dist/IAccount.d.ts:10 - -___ - -### unlinkStorage - -▸ **unlinkStorage**(`contextName`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | - -#### Returns - -`Promise`<`boolean`\> - -#### Defined in - -packages/types/dist/IAccount.d.ts:9 diff --git a/docs/api/verida-js/interfaces/verida_account_node._internal_.IDIDClient.md b/docs/api/verida-js/interfaces/verida_account_node._internal_.IDIDClient.md deleted file mode 100644 index 91df2ba..0000000 --- a/docs/api/verida-js/interfaces/verida_account_node._internal_.IDIDClient.md +++ /dev/null @@ -1,155 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account-node](../modules/verida_account_node.md) / [](../modules/verida_account_node._internal_.md) / IDIDClient - -# Interface: IDIDClient - -[@verida/account-node](../modules/verida_account_node.md).[](../modules/verida_account_node._internal_.md).IDIDClient - -## Implemented by - -- [`DIDClient`](../classes/verida_account_node._internal_.DIDClient.md) - -## Table of contents - -### Methods - -- [authenticate](verida_account_node._internal_.IDIDClient.md#authenticate) -- [authenticated](verida_account_node._internal_.IDIDClient.md#authenticated) -- [get](verida_account_node._internal_.IDIDClient.md#get) -- [getDid](verida_account_node._internal_.IDIDClient.md#getdid) -- [getLastEndpointErrors](verida_account_node._internal_.IDIDClient.md#getlastendpointerrors) -- [getPublicKey](verida_account_node._internal_.IDIDClient.md#getpublickey) -- [getRpcUrl](verida_account_node._internal_.IDIDClient.md#getrpcurl) -- [save](verida_account_node._internal_.IDIDClient.md#save) - -## Methods - -### authenticate - -▸ **authenticate**(`veridaPrivateKey`, `callType`, `web3Config`, `defaultEndpoints`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `veridaPrivateKey` | `string` | -| `callType` | [`Web3CallType`](../modules/verida_account_node._internal_.md#web3calltype) | -| `web3Config` | [`Web3SelfTransactionConfigPart`](verida_account_node._internal_.Web3SelfTransactionConfigPart.md) \| [`Web3MetaTransactionConfig`](verida_account_node._internal_.Web3MetaTransactionConfig.md) | -| `defaultEndpoints` | `string`[] | - -#### Returns - -`void` - -#### Defined in - -packages/types/dist/IDIDClient.d.ts:4 - -___ - -### authenticated - -▸ **authenticated**(): `boolean` - -#### Returns - -`boolean` - -#### Defined in - -packages/types/dist/IDIDClient.d.ts:5 - -___ - -### get - -▸ **get**(`did`): `Promise`<[`IDIDDocument`](verida_account_node._internal_.IDIDDocument.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did` | `string` | - -#### Returns - -`Promise`<[`IDIDDocument`](verida_account_node._internal_.IDIDDocument.md)\> - -#### Defined in - -packages/types/dist/IDIDClient.d.ts:10 - -___ - -### getDid - -▸ **getDid**(): `undefined` \| `string` - -#### Returns - -`undefined` \| `string` - -#### Defined in - -packages/types/dist/IDIDClient.d.ts:6 - -___ - -### getLastEndpointErrors - -▸ **getLastEndpointErrors**(): [`VdaDidEndpointResponses`](../modules/verida_account_node._internal_.md#vdadidendpointresponses) - -#### Returns - -[`VdaDidEndpointResponses`](../modules/verida_account_node._internal_.md#vdadidendpointresponses) - -#### Defined in - -packages/types/dist/IDIDClient.d.ts:9 - -___ - -### getPublicKey - -▸ **getPublicKey**(): `undefined` \| `string` - -#### Returns - -`undefined` \| `string` - -#### Defined in - -packages/types/dist/IDIDClient.d.ts:7 - -___ - -### getRpcUrl - -▸ **getRpcUrl**(): `string` - -#### Returns - -`string` - -#### Defined in - -packages/types/dist/IDIDClient.d.ts:11 - -___ - -### save - -▸ **save**(`document`): `Promise`<[`VdaDidEndpointResponses`](../modules/verida_account_node._internal_.md#vdadidendpointresponses)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `document` | [`IDIDDocument`](verida_account_node._internal_.IDIDDocument.md) | - -#### Returns - -`Promise`<[`VdaDidEndpointResponses`](../modules/verida_account_node._internal_.md#vdadidendpointresponses)\> - -#### Defined in - -packages/types/dist/IDIDClient.d.ts:8 diff --git a/docs/api/verida-js/interfaces/verida_account_node._internal_.IDIDDocument.md b/docs/api/verida-js/interfaces/verida_account_node._internal_.IDIDDocument.md deleted file mode 100644 index 7ba73e7..0000000 --- a/docs/api/verida-js/interfaces/verida_account_node._internal_.IDIDDocument.md +++ /dev/null @@ -1,364 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account-node](../modules/verida_account_node.md) / [](../modules/verida_account_node._internal_.md) / IDIDDocument - -# Interface: IDIDDocument - -[@verida/account-node](../modules/verida_account_node.md).[](../modules/verida_account_node._internal_.md).IDIDDocument - -## Implemented by - -- [`default`](../classes/verida_account_node._internal_.default-3.md) - -## Table of contents - -### Accessors - -- [id](verida_account_node._internal_.IDIDDocument.md#id) - -### Methods - -- [addContext](verida_account_node._internal_.IDIDDocument.md#addcontext) -- [addContextAsymKey](verida_account_node._internal_.IDIDDocument.md#addcontextasymkey) -- [addContextService](verida_account_node._internal_.IDIDDocument.md#addcontextservice) -- [addContextSignKey](verida_account_node._internal_.IDIDDocument.md#addcontextsignkey) -- [buildTimestamp](verida_account_node._internal_.IDIDDocument.md#buildtimestamp) -- [export](verida_account_node._internal_.IDIDDocument.md#export) -- [getErrors](verida_account_node._internal_.IDIDDocument.md#geterrors) -- [import](verida_account_node._internal_.IDIDDocument.md#import) -- [locateContextProof](verida_account_node._internal_.IDIDDocument.md#locatecontextproof) -- [locateServiceEndpoint](verida_account_node._internal_.IDIDDocument.md#locateserviceendpoint) -- [removeContext](verida_account_node._internal_.IDIDDocument.md#removecontext) -- [setAttributes](verida_account_node._internal_.IDIDDocument.md#setattributes) -- [signProof](verida_account_node._internal_.IDIDDocument.md#signproof) -- [verifyContextSignature](verida_account_node._internal_.IDIDDocument.md#verifycontextsignature) -- [verifyProof](verida_account_node._internal_.IDIDDocument.md#verifyproof) -- [verifySig](verida_account_node._internal_.IDIDDocument.md#verifysig) - -## Accessors - -### id - -• `get` **id**(): `string` - -#### Returns - -`string` - -#### Defined in - -packages/types/dist/IDIDDocument.d.ts:5 - -## Methods - -### addContext - -▸ **addContext**(`contextName`, `keyring`, `privateKey`, `endpoints`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | -| `keyring` | [`IKeyring`](verida_account_node._internal_.IKeyring.md) | -| `privateKey` | `string` | -| `endpoints` | [`SecureContextEndpoints`](verida_account_node._internal_.SecureContextEndpoints.md) | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -packages/types/dist/IDIDDocument.d.ts:7 - -___ - -### addContextAsymKey - -▸ **addContextAsymKey**(`contextHash`, `publicKeyHex`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextHash` | `string` | -| `publicKeyHex` | `string` | - -#### Returns - -`void` - -#### Defined in - -packages/types/dist/IDIDDocument.d.ts:14 - -___ - -### addContextService - -▸ **addContextService**(`contextHash`, `endpointType`, `serviceType`, `endpointUris`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextHash` | `string` | -| `endpointType` | [`SecureContextEndpointType`](../enums/verida_account_node._internal_.SecureContextEndpointType.md) | -| `serviceType` | `string` | -| `endpointUris` | [`ServiceEndpoint`](../modules/verida_account_node._internal_.md#serviceendpoint)[] | - -#### Returns - -`void` - -#### Defined in - -packages/types/dist/IDIDDocument.d.ts:12 - -___ - -### addContextSignKey - -▸ **addContextSignKey**(`contextHash`, `publicKeyHex`, `proof`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextHash` | `string` | -| `publicKeyHex` | `string` | -| `proof` | `string` | - -#### Returns - -`void` - -#### Defined in - -packages/types/dist/IDIDDocument.d.ts:13 - -___ - -### buildTimestamp - -▸ **buildTimestamp**(`date`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `date` | `Date` | - -#### Returns - -`string` - -#### Defined in - -packages/types/dist/IDIDDocument.d.ts:21 - -___ - -### export - -▸ **export**(): [`VeridaDocInterface`](verida_account_node._internal_.VeridaDocInterface.md) - -#### Returns - -[`VeridaDocInterface`](verida_account_node._internal_.VeridaDocInterface.md) - -#### Defined in - -packages/types/dist/IDIDDocument.d.ts:11 - -___ - -### getErrors - -▸ **getErrors**(): `string`[] - -#### Returns - -`string`[] - -#### Defined in - -packages/types/dist/IDIDDocument.d.ts:6 - -___ - -### import - -▸ **import**(`doc`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `doc` | [`VeridaDocInterface`](verida_account_node._internal_.VeridaDocInterface.md) | - -#### Returns - -`void` - -#### Defined in - -packages/types/dist/IDIDDocument.d.ts:10 - -___ - -### locateContextProof - -▸ **locateContextProof**(`contextName`): `undefined` \| `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | - -#### Returns - -`undefined` \| `string` - -#### Defined in - -packages/types/dist/IDIDDocument.d.ts:18 - -___ - -### locateServiceEndpoint - -▸ **locateServiceEndpoint**(`contextName`, `endpointType`): `undefined` \| [`Service`](verida_account_node._internal_.Service.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | -| `endpointType` | [`SecureContextEndpointType`](../enums/verida_account_node._internal_.SecureContextEndpointType.md) | - -#### Returns - -`undefined` \| [`Service`](verida_account_node._internal_.Service.md) - -#### Defined in - -packages/types/dist/IDIDDocument.d.ts:17 - -___ - -### removeContext - -▸ **removeContext**(`contextName`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | - -#### Returns - -`boolean` - -#### Defined in - -packages/types/dist/IDIDDocument.d.ts:8 - -___ - -### setAttributes - -▸ **setAttributes**(`attributes`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `attributes` | [`Record`](../modules/verida_account_node._internal_.md#record)<`string`, `any`\> | - -#### Returns - -`void` - -#### Defined in - -packages/types/dist/IDIDDocument.d.ts:9 - -___ - -### signProof - -▸ **signProof**(`privateKey`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `privateKey` | `string` \| `Uint8Array` | - -#### Returns - -`void` - -#### Defined in - -packages/types/dist/IDIDDocument.d.ts:19 - -___ - -### verifyContextSignature - -▸ **verifyContextSignature**(`data`, `contextName`, `signature`, `contextIsHash`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `any` | -| `contextName` | `string` | -| `signature` | `string` | -| `contextIsHash` | `boolean` | - -#### Returns - -`boolean` - -#### Defined in - -packages/types/dist/IDIDDocument.d.ts:16 - -___ - -### verifyProof - -▸ **verifyProof**(): `boolean` - -#### Returns - -`boolean` - -#### Defined in - -packages/types/dist/IDIDDocument.d.ts:20 - -___ - -### verifySig - -▸ **verifySig**(`data`, `signature`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `any` | -| `signature` | `string` | - -#### Returns - -`boolean` - -#### Defined in - -packages/types/dist/IDIDDocument.d.ts:15 diff --git a/docs/api/verida-js/interfaces/verida_account_node._internal_.IKeyring.md b/docs/api/verida-js/interfaces/verida_account_node._internal_.IKeyring.md deleted file mode 100644 index 9aa225c..0000000 --- a/docs/api/verida-js/interfaces/verida_account_node._internal_.IKeyring.md +++ /dev/null @@ -1,266 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account-node](../modules/verida_account_node.md) / [](../modules/verida_account_node._internal_.md) / IKeyring - -# Interface: IKeyring - -[@verida/account-node](../modules/verida_account_node.md).[](../modules/verida_account_node._internal_.md).IKeyring - -## Implemented by - -- [`default`](../classes/verida_account_node._internal_.default-2.md) - -## Table of contents - -### Methods - -- [\_init](verida_account_node._internal_.IKeyring.md#_init) -- [asymDecrypt](verida_account_node._internal_.IKeyring.md#asymdecrypt) -- [asymEncrypt](verida_account_node._internal_.IKeyring.md#asymencrypt) -- [buildSharedKeyEnd](verida_account_node._internal_.IKeyring.md#buildsharedkeyend) -- [buildSharedKeyStart](verida_account_node._internal_.IKeyring.md#buildsharedkeystart) -- [getKeys](verida_account_node._internal_.IKeyring.md#getkeys) -- [getSeed](verida_account_node._internal_.IKeyring.md#getseed) -- [getStorageContextKey](verida_account_node._internal_.IKeyring.md#getstoragecontextkey) -- [publicKeys](verida_account_node._internal_.IKeyring.md#publickeys) -- [sign](verida_account_node._internal_.IKeyring.md#sign) -- [symDecrypt](verida_account_node._internal_.IKeyring.md#symdecrypt) -- [symEncrypt](verida_account_node._internal_.IKeyring.md#symencrypt) -- [verifySig](verida_account_node._internal_.IKeyring.md#verifysig) - -## Methods - -### \_init - -▸ **_init**(): `Promise`<`void`\> - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:3 - -___ - -### asymDecrypt - -▸ **asymDecrypt**(`messageWithNonce`, `secretOrSharedKey`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `messageWithNonce` | `string` | -| `secretOrSharedKey` | `Uint8Array` | - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:10 - -___ - -### asymEncrypt - -▸ **asymEncrypt**(`data`, `secretOrSharedKey`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `string` | -| `secretOrSharedKey` | `Uint8Array` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:9 - -___ - -### buildSharedKeyEnd - -▸ **buildSharedKeyEnd**(`publicKey`): `Promise`<`Uint8Array`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `publicKey` | `Uint8Array` | - -#### Returns - -`Promise`<`Uint8Array`\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:12 - -___ - -### buildSharedKeyStart - -▸ **buildSharedKeyStart**(`privateKey`): `Promise`<`Uint8Array`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `privateKey` | `Uint8Array` | - -#### Returns - -`Promise`<`Uint8Array`\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:11 - -___ - -### getKeys - -▸ **getKeys**(): `Promise`<`any`\> - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:2 - -___ - -### getSeed - -▸ **getSeed**(): `string` - -#### Returns - -`string` - -#### Defined in - -packages/types/dist/IKeyring.d.ts:13 - -___ - -### getStorageContextKey - -▸ **getStorageContextKey**(`databaseName`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `databaseName` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:14 - -___ - -### publicKeys - -▸ **publicKeys**(): `Promise`<[`KeyringPublicKeys`](verida_account_node._internal_.KeyringPublicKeys.md)\> - -#### Returns - -`Promise`<[`KeyringPublicKeys`](verida_account_node._internal_.KeyringPublicKeys.md)\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:4 - -___ - -### sign - -▸ **sign**(`data`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `any` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:5 - -___ - -### symDecrypt - -▸ **symDecrypt**(`data`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `string` | - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:8 - -___ - -### symEncrypt - -▸ **symEncrypt**(`data`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:7 - -___ - -### verifySig - -▸ **verifySig**(`data`, `sig`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `string` | -| `sig` | `string` | - -#### Returns - -`Promise`<`boolean`\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:6 diff --git a/docs/api/verida-js/interfaces/verida_account_node._internal_.JsonWebKey.md b/docs/api/verida-js/interfaces/verida_account_node._internal_.JsonWebKey.md deleted file mode 100644 index b80a823..0000000 --- a/docs/api/verida-js/interfaces/verida_account_node._internal_.JsonWebKey.md +++ /dev/null @@ -1,145 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account-node](../modules/verida_account_node.md) / [](../modules/verida_account_node._internal_.md) / JsonWebKey - -# Interface: JsonWebKey - -[@verida/account-node](../modules/verida_account_node.md).[](../modules/verida_account_node._internal_.md).JsonWebKey - -Encapsulates a JSON web key type that includes only the public properties that -can be used in DID documents. - -The private properties are intentionally omitted to discourage the use -(and accidental disclosure) of private keys in DID documents. - -**`see`** [RFC7517 JsonWebKey (JWK)](https://www.rfc-editor.org/rfc/rfc7517) - -## Hierarchy - -- [`Extensible`](../modules/verida_account_node._internal_.md#extensible) - - ↳ **`JsonWebKey`** - -## Table of contents - -### Properties - -- [alg](verida_account_node._internal_.JsonWebKey.md#alg) -- [crv](verida_account_node._internal_.JsonWebKey.md#crv) -- [e](verida_account_node._internal_.JsonWebKey.md#e) -- [ext](verida_account_node._internal_.JsonWebKey.md#ext) -- [key\_ops](verida_account_node._internal_.JsonWebKey.md#key_ops) -- [kid](verida_account_node._internal_.JsonWebKey.md#kid) -- [kty](verida_account_node._internal_.JsonWebKey.md#kty) -- [n](verida_account_node._internal_.JsonWebKey.md#n) -- [use](verida_account_node._internal_.JsonWebKey.md#use) -- [x](verida_account_node._internal_.JsonWebKey.md#x) -- [y](verida_account_node._internal_.JsonWebKey.md#y) - -## Properties - -### alg - -• `Optional` **alg**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:103 - -___ - -### crv - -• `Optional` **crv**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:104 - -___ - -### e - -• `Optional` **e**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:105 - -___ - -### ext - -• `Optional` **ext**: `boolean` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:106 - -___ - -### key\_ops - -• `Optional` **key\_ops**: `string`[] - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:107 - -___ - -### kid - -• `Optional` **kid**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:108 - -___ - -### kty - -• **kty**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:109 - -___ - -### n - -• `Optional` **n**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:110 - -___ - -### use - -• `Optional` **use**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:111 - -___ - -### x - -• `Optional` **x**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:112 - -___ - -### y - -• `Optional` **y**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:113 diff --git a/docs/api/verida-js/interfaces/verida_account_node._internal_.KeyringPublicKeys.md b/docs/api/verida-js/interfaces/verida_account_node._internal_.KeyringPublicKeys.md deleted file mode 100644 index 5871a58..0000000 --- a/docs/api/verida-js/interfaces/verida_account_node._internal_.KeyringPublicKeys.md +++ /dev/null @@ -1,76 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account-node](../modules/verida_account_node.md) / [](../modules/verida_account_node._internal_.md) / KeyringPublicKeys - -# Interface: KeyringPublicKeys - -[@verida/account-node](../modules/verida_account_node.md).[](../modules/verida_account_node._internal_.md).KeyringPublicKeys - -## Table of contents - -### Properties - -- [asymPublicKey](verida_account_node._internal_.KeyringPublicKeys.md#asympublickey) -- [asymPublicKeyBase58](verida_account_node._internal_.KeyringPublicKeys.md#asympublickeybase58) -- [asymPublicKeyHex](verida_account_node._internal_.KeyringPublicKeys.md#asympublickeyhex) -- [signPublicKey](verida_account_node._internal_.KeyringPublicKeys.md#signpublickey) -- [signPublicKeyBase58](verida_account_node._internal_.KeyringPublicKeys.md#signpublickeybase58) -- [signPublicKeyHex](verida_account_node._internal_.KeyringPublicKeys.md#signpublickeyhex) - -## Properties - -### asymPublicKey - -• **asymPublicKey**: `Uint8Array` - -#### Defined in - -packages/types/dist/IKeyring.d.ts:17 - -___ - -### asymPublicKeyBase58 - -• **asymPublicKeyBase58**: `string` - -#### Defined in - -packages/types/dist/IKeyring.d.ts:19 - -___ - -### asymPublicKeyHex - -• **asymPublicKeyHex**: `string` - -#### Defined in - -packages/types/dist/IKeyring.d.ts:18 - -___ - -### signPublicKey - -• **signPublicKey**: `Uint8Array` - -#### Defined in - -packages/types/dist/IKeyring.d.ts:20 - -___ - -### signPublicKeyBase58 - -• **signPublicKeyBase58**: `string` - -#### Defined in - -packages/types/dist/IKeyring.d.ts:22 - -___ - -### signPublicKeyHex - -• **signPublicKeyHex**: `string` - -#### Defined in - -packages/types/dist/IKeyring.d.ts:21 diff --git a/docs/api/verida-js/interfaces/verida_account_node._internal_.Log.md b/docs/api/verida-js/interfaces/verida_account_node._internal_.Log.md deleted file mode 100644 index c1e3032..0000000 --- a/docs/api/verida-js/interfaces/verida_account_node._internal_.Log.md +++ /dev/null @@ -1,109 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account-node](../modules/verida_account_node.md) / [](../modules/verida_account_node._internal_.md) / Log - -# Interface: Log - -[@verida/account-node](../modules/verida_account_node.md).[](../modules/verida_account_node._internal_.md).Log - -## Table of contents - -### Properties - -- [address](verida_account_node._internal_.Log.md#address) -- [blockHash](verida_account_node._internal_.Log.md#blockhash) -- [blockNumber](verida_account_node._internal_.Log.md#blocknumber) -- [data](verida_account_node._internal_.Log.md#data) -- [logIndex](verida_account_node._internal_.Log.md#logindex) -- [removed](verida_account_node._internal_.Log.md#removed) -- [topics](verida_account_node._internal_.Log.md#topics) -- [transactionHash](verida_account_node._internal_.Log.md#transactionhash) -- [transactionIndex](verida_account_node._internal_.Log.md#transactionindex) - -## Properties - -### address - -• **address**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:59 - -___ - -### blockHash - -• **blockHash**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:56 - -___ - -### blockNumber - -• **blockNumber**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:55 - -___ - -### data - -• **data**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:60 - -___ - -### logIndex - -• **logIndex**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:63 - -___ - -### removed - -• **removed**: `boolean` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:58 - -___ - -### topics - -• **topics**: `string`[] - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:61 - -___ - -### transactionHash - -• **transactionHash**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:62 - -___ - -### transactionIndex - -• **transactionIndex**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:57 diff --git a/docs/api/verida-js/interfaces/verida_account_node._internal_.NodeAccountConfig.md b/docs/api/verida-js/interfaces/verida_account_node._internal_.NodeAccountConfig.md deleted file mode 100644 index f115728..0000000 --- a/docs/api/verida-js/interfaces/verida_account_node._internal_.NodeAccountConfig.md +++ /dev/null @@ -1,54 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account-node](../modules/verida_account_node.md) / [](../modules/verida_account_node._internal_.md) / NodeAccountConfig - -# Interface: NodeAccountConfig - -[@verida/account-node](../modules/verida_account_node.md).[](../modules/verida_account_node._internal_.md).NodeAccountConfig - -## Table of contents - -### Properties - -- [didServerUrl](verida_account_node._internal_.NodeAccountConfig.md#didserverurl) -- [environment](verida_account_node._internal_.NodeAccountConfig.md#environment) -- [options](verida_account_node._internal_.NodeAccountConfig.md#options) -- [privateKey](verida_account_node._internal_.NodeAccountConfig.md#privatekey) - -## Properties - -### didServerUrl - -• `Optional` **didServerUrl**: `string` - -#### Defined in - -[packages/account-node/src/interfaces.ts:6](https://github.com/verida/verida-js/blob/c03b336/packages/account-node/src/interfaces.ts#L6) - -___ - -### environment - -• **environment**: [`EnvironmentType`](../enums/verida_account_node._internal_.EnvironmentType.md) - -#### Defined in - -[packages/account-node/src/interfaces.ts:5](https://github.com/verida/verida-js/blob/c03b336/packages/account-node/src/interfaces.ts#L5) - -___ - -### options - -• `Optional` **options**: `any` - -#### Defined in - -[packages/account-node/src/interfaces.ts:7](https://github.com/verida/verida-js/blob/c03b336/packages/account-node/src/interfaces.ts#L7) - -___ - -### privateKey - -• **privateKey**: `string` - -#### Defined in - -[packages/account-node/src/interfaces.ts:4](https://github.com/verida/verida-js/blob/c03b336/packages/account-node/src/interfaces.ts#L4) diff --git a/docs/api/verida-js/interfaces/verida_account_node._internal_.OnceBlockable.md b/docs/api/verida-js/interfaces/verida_account_node._internal_.OnceBlockable.md deleted file mode 100644 index 4af82b6..0000000 --- a/docs/api/verida-js/interfaces/verida_account_node._internal_.OnceBlockable.md +++ /dev/null @@ -1,36 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account-node](../modules/verida_account_node.md) / [](../modules/verida_account_node._internal_.md) / OnceBlockable - -# Interface: OnceBlockable - -[@verida/account-node](../modules/verida_account_node.md).[](../modules/verida_account_node._internal_.md).OnceBlockable - -## Implemented by - -- [`Provider`](../classes/verida_account_node._internal_.Provider.md) - -## Table of contents - -### Methods - -- [once](verida_account_node._internal_.OnceBlockable.md#once) - -## Methods - -### once - -▸ **once**(`eventName`, `handler`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | ``"block"`` | -| `handler` | () => `void` | - -#### Returns - -`void` - -#### Defined in - -node_modules/@ethersproject/web/lib/index.d.ts:19 diff --git a/docs/api/verida-js/interfaces/verida_account_node._internal_.PromiseLike.md b/docs/api/verida-js/interfaces/verida_account_node._internal_.PromiseLike.md deleted file mode 100644 index 394938d..0000000 --- a/docs/api/verida-js/interfaces/verida_account_node._internal_.PromiseLike.md +++ /dev/null @@ -1,49 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account-node](../modules/verida_account_node.md) / [](../modules/verida_account_node._internal_.md) / PromiseLike - -# Interface: PromiseLike - -[@verida/account-node](../modules/verida_account_node.md).[](../modules/verida_account_node._internal_.md).PromiseLike - -## Type parameters - -| Name | -| :------ | -| `T` | - -## Table of contents - -### Methods - -- [then](verida_account_node._internal_.PromiseLike.md#then) - -## Methods - -### then - -▸ **then**<`TResult1`, `TResult2`\>(`onfulfilled?`, `onrejected?`): [`PromiseLike`](verida_account_node._internal_.PromiseLike.md)<`TResult1` \| `TResult2`\> - -Attaches callbacks for the resolution and/or rejection of the Promise. - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `TResult1` | `T` | -| `TResult2` | `never` | - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `onfulfilled?` | ``null`` \| (`value`: `T`) => `TResult1` \| [`PromiseLike`](verida_account_node._internal_.PromiseLike.md)<`TResult1`\> | The callback to execute when the Promise is resolved. | -| `onrejected?` | ``null`` \| (`reason`: `any`) => `TResult2` \| [`PromiseLike`](verida_account_node._internal_.PromiseLike.md)<`TResult2`\> | The callback to execute when the Promise is rejected. | - -#### Returns - -[`PromiseLike`](verida_account_node._internal_.PromiseLike.md)<`TResult1` \| `TResult2`\> - -A Promise for the completion of which ever callback is executed. - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1440 diff --git a/docs/api/verida-js/interfaces/verida_account_node._internal_.Proof.md b/docs/api/verida-js/interfaces/verida_account_node._internal_.Proof.md deleted file mode 100644 index 4e6cfc4..0000000 --- a/docs/api/verida-js/interfaces/verida_account_node._internal_.Proof.md +++ /dev/null @@ -1,54 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account-node](../modules/verida_account_node.md) / [](../modules/verida_account_node._internal_.md) / Proof - -# Interface: Proof - -[@verida/account-node](../modules/verida_account_node.md).[](../modules/verida_account_node._internal_.md).Proof - -## Table of contents - -### Properties - -- [proofPurpose](verida_account_node._internal_.Proof.md#proofpurpose) -- [proofValue](verida_account_node._internal_.Proof.md#proofvalue) -- [type](verida_account_node._internal_.Proof.md#type) -- [verificationMethod](verida_account_node._internal_.Proof.md#verificationmethod) - -## Properties - -### proofPurpose - -• **proofPurpose**: ``"assertionMethod"`` - -#### Defined in - -packages/did-document/dist/interfaces.d.ts:10 - -___ - -### proofValue - -• **proofValue**: `string` - -#### Defined in - -packages/did-document/dist/interfaces.d.ts:11 - -___ - -### type - -• **type**: ``"EcdsaSecp256k1VerificationKey2019"`` - -#### Defined in - -packages/did-document/dist/interfaces.d.ts:8 - -___ - -### verificationMethod - -• **verificationMethod**: `string` - -#### Defined in - -packages/did-document/dist/interfaces.d.ts:9 diff --git a/docs/api/verida-js/interfaces/verida_account_node._internal_.ProofInterface.md b/docs/api/verida-js/interfaces/verida_account_node._internal_.ProofInterface.md deleted file mode 100644 index c206ae9..0000000 --- a/docs/api/verida-js/interfaces/verida_account_node._internal_.ProofInterface.md +++ /dev/null @@ -1,54 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account-node](../modules/verida_account_node.md) / [](../modules/verida_account_node._internal_.md) / ProofInterface - -# Interface: ProofInterface - -[@verida/account-node](../modules/verida_account_node.md).[](../modules/verida_account_node._internal_.md).ProofInterface - -## Table of contents - -### Properties - -- [proofPurpose](verida_account_node._internal_.ProofInterface.md#proofpurpose) -- [proofValue](verida_account_node._internal_.ProofInterface.md#proofvalue) -- [type](verida_account_node._internal_.ProofInterface.md#type) -- [verificationMethod](verida_account_node._internal_.ProofInterface.md#verificationmethod) - -## Properties - -### proofPurpose - -• **proofPurpose**: `string` - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:34 - -___ - -### proofValue - -• **proofValue**: `string` - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:35 - -___ - -### type - -• **type**: `string` - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:32 - -___ - -### verificationMethod - -• **verificationMethod**: `string` - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:33 diff --git a/docs/api/verida-js/interfaces/verida_account_node._internal_.SecureContextConfig.md b/docs/api/verida-js/interfaces/verida_account_node._internal_.SecureContextConfig.md deleted file mode 100644 index 11929f2..0000000 --- a/docs/api/verida-js/interfaces/verida_account_node._internal_.SecureContextConfig.md +++ /dev/null @@ -1,43 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account-node](../modules/verida_account_node.md) / [](../modules/verida_account_node._internal_.md) / SecureContextConfig - -# Interface: SecureContextConfig - -[@verida/account-node](../modules/verida_account_node.md).[](../modules/verida_account_node._internal_.md).SecureContextConfig - -## Table of contents - -### Properties - -- [id](verida_account_node._internal_.SecureContextConfig.md#id) -- [publicKeys](verida_account_node._internal_.SecureContextConfig.md#publickeys) -- [services](verida_account_node._internal_.SecureContextConfig.md#services) - -## Properties - -### id - -• **id**: `string` - -#### Defined in - -packages/types/dist/StorageLinkInterfaces.d.ts:17 - -___ - -### publicKeys - -• **publicKeys**: [`SecureStorageContextPublicKeys`](verida_account_node._internal_.SecureStorageContextPublicKeys.md) - -#### Defined in - -packages/types/dist/StorageLinkInterfaces.d.ts:18 - -___ - -### services - -• **services**: [`SecureContextServices`](verida_account_node._internal_.SecureContextServices.md) - -#### Defined in - -packages/types/dist/StorageLinkInterfaces.d.ts:19 diff --git a/docs/api/verida-js/interfaces/verida_account_node._internal_.SecureContextEndpoint-1.md b/docs/api/verida-js/interfaces/verida_account_node._internal_.SecureContextEndpoint-1.md deleted file mode 100644 index f370219..0000000 --- a/docs/api/verida-js/interfaces/verida_account_node._internal_.SecureContextEndpoint-1.md +++ /dev/null @@ -1,43 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account-node](../modules/verida_account_node.md) / [](../modules/verida_account_node._internal_.md) / SecureContextEndpoint - -# Interface: SecureContextEndpoint - -[@verida/account-node](../modules/verida_account_node.md).[](../modules/verida_account_node._internal_.md).SecureContextEndpoint - -## Table of contents - -### Properties - -- [config](verida_account_node._internal_.SecureContextEndpoint-1.md#config) -- [endpointUri](verida_account_node._internal_.SecureContextEndpoint-1.md#endpointuri) -- [type](verida_account_node._internal_.SecureContextEndpoint-1.md#type) - -## Properties - -### config - -• `Optional` **config**: `object` - -#### Defined in - -packages/did-document/dist/interfaces.d.ts:5 - -___ - -### endpointUri - -• **endpointUri**: `string` - -#### Defined in - -packages/did-document/dist/interfaces.d.ts:4 - -___ - -### type - -• **type**: `string` - -#### Defined in - -packages/did-document/dist/interfaces.d.ts:3 diff --git a/docs/api/verida-js/interfaces/verida_account_node._internal_.SecureContextEndpoint.md b/docs/api/verida-js/interfaces/verida_account_node._internal_.SecureContextEndpoint.md deleted file mode 100644 index f05a443..0000000 --- a/docs/api/verida-js/interfaces/verida_account_node._internal_.SecureContextEndpoint.md +++ /dev/null @@ -1,43 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account-node](../modules/verida_account_node.md) / [](../modules/verida_account_node._internal_.md) / SecureContextEndpoint - -# Interface: SecureContextEndpoint - -[@verida/account-node](../modules/verida_account_node.md).[](../modules/verida_account_node._internal_.md).SecureContextEndpoint - -## Table of contents - -### Properties - -- [config](verida_account_node._internal_.SecureContextEndpoint.md#config) -- [endpointUri](verida_account_node._internal_.SecureContextEndpoint.md#endpointuri) -- [type](verida_account_node._internal_.SecureContextEndpoint.md#type) - -## Properties - -### config - -• `Optional` **config**: `object` - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:5 - -___ - -### endpointUri - -• **endpointUri**: [`ServiceEndpoint`](../modules/verida_account_node._internal_.md#serviceendpoint)[] - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:4 - -___ - -### type - -• **type**: `string` - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:3 diff --git a/docs/api/verida-js/interfaces/verida_account_node._internal_.SecureContextEndpoints.md b/docs/api/verida-js/interfaces/verida_account_node._internal_.SecureContextEndpoints.md deleted file mode 100644 index a4d7b75..0000000 --- a/docs/api/verida-js/interfaces/verida_account_node._internal_.SecureContextEndpoints.md +++ /dev/null @@ -1,54 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account-node](../modules/verida_account_node.md) / [](../modules/verida_account_node._internal_.md) / SecureContextEndpoints - -# Interface: SecureContextEndpoints - -[@verida/account-node](../modules/verida_account_node.md).[](../modules/verida_account_node._internal_.md).SecureContextEndpoints - -## Table of contents - -### Properties - -- [database](verida_account_node._internal_.SecureContextEndpoints.md#database) -- [messaging](verida_account_node._internal_.SecureContextEndpoints.md#messaging) -- [notification](verida_account_node._internal_.SecureContextEndpoints.md#notification) -- [storage](verida_account_node._internal_.SecureContextEndpoints.md#storage) - -## Properties - -### database - -• **database**: [`SecureContextEndpoint`](verida_account_node._internal_.SecureContextEndpoint.md) - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:8 - -___ - -### messaging - -• **messaging**: [`SecureContextEndpoint`](verida_account_node._internal_.SecureContextEndpoint.md) - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:9 - -___ - -### notification - -• `Optional` **notification**: [`SecureContextEndpoint`](verida_account_node._internal_.SecureContextEndpoint.md) - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:11 - -___ - -### storage - -• `Optional` **storage**: [`SecureContextEndpoint`](verida_account_node._internal_.SecureContextEndpoint.md) - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:10 diff --git a/docs/api/verida-js/interfaces/verida_account_node._internal_.SecureContextPublicKey.md b/docs/api/verida-js/interfaces/verida_account_node._internal_.SecureContextPublicKey.md deleted file mode 100644 index ba9431d..0000000 --- a/docs/api/verida-js/interfaces/verida_account_node._internal_.SecureContextPublicKey.md +++ /dev/null @@ -1,32 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account-node](../modules/verida_account_node.md) / [](../modules/verida_account_node._internal_.md) / SecureContextPublicKey - -# Interface: SecureContextPublicKey - -[@verida/account-node](../modules/verida_account_node.md).[](../modules/verida_account_node._internal_.md).SecureContextPublicKey - -## Table of contents - -### Properties - -- [publicKeyHex](verida_account_node._internal_.SecureContextPublicKey.md#publickeyhex) -- [type](verida_account_node._internal_.SecureContextPublicKey.md#type) - -## Properties - -### publicKeyHex - -• **publicKeyHex**: `string` - -#### Defined in - -packages/types/dist/StorageLinkInterfaces.d.ts:4 - -___ - -### type - -• **type**: `string` - -#### Defined in - -packages/types/dist/StorageLinkInterfaces.d.ts:3 diff --git a/docs/api/verida-js/interfaces/verida_account_node._internal_.SecureContextServices.md b/docs/api/verida-js/interfaces/verida_account_node._internal_.SecureContextServices.md deleted file mode 100644 index 59c3417..0000000 --- a/docs/api/verida-js/interfaces/verida_account_node._internal_.SecureContextServices.md +++ /dev/null @@ -1,54 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account-node](../modules/verida_account_node.md) / [](../modules/verida_account_node._internal_.md) / SecureContextServices - -# Interface: SecureContextServices - -[@verida/account-node](../modules/verida_account_node.md).[](../modules/verida_account_node._internal_.md).SecureContextServices - -## Table of contents - -### Properties - -- [databaseServer](verida_account_node._internal_.SecureContextServices.md#databaseserver) -- [messageServer](verida_account_node._internal_.SecureContextServices.md#messageserver) -- [notificationServer](verida_account_node._internal_.SecureContextServices.md#notificationserver) -- [storageServer](verida_account_node._internal_.SecureContextServices.md#storageserver) - -## Properties - -### databaseServer - -• **databaseServer**: [`SecureContextEndpoint`](verida_account_node._internal_.SecureContextEndpoint.md) - -#### Defined in - -packages/types/dist/StorageLinkInterfaces.d.ts:11 - -___ - -### messageServer - -• **messageServer**: [`SecureContextEndpoint`](verida_account_node._internal_.SecureContextEndpoint.md) - -#### Defined in - -packages/types/dist/StorageLinkInterfaces.d.ts:12 - -___ - -### notificationServer - -• `Optional` **notificationServer**: [`SecureContextEndpoint`](verida_account_node._internal_.SecureContextEndpoint.md) - -#### Defined in - -packages/types/dist/StorageLinkInterfaces.d.ts:14 - -___ - -### storageServer - -• `Optional` **storageServer**: [`SecureContextEndpoint`](verida_account_node._internal_.SecureContextEndpoint.md) - -#### Defined in - -packages/types/dist/StorageLinkInterfaces.d.ts:13 diff --git a/docs/api/verida-js/interfaces/verida_account_node._internal_.SecureStorageContextPublicKeys.md b/docs/api/verida-js/interfaces/verida_account_node._internal_.SecureStorageContextPublicKeys.md deleted file mode 100644 index 92bf7f1..0000000 --- a/docs/api/verida-js/interfaces/verida_account_node._internal_.SecureStorageContextPublicKeys.md +++ /dev/null @@ -1,32 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account-node](../modules/verida_account_node.md) / [](../modules/verida_account_node._internal_.md) / SecureStorageContextPublicKeys - -# Interface: SecureStorageContextPublicKeys - -[@verida/account-node](../modules/verida_account_node.md).[](../modules/verida_account_node._internal_.md).SecureStorageContextPublicKeys - -## Table of contents - -### Properties - -- [asymKey](verida_account_node._internal_.SecureStorageContextPublicKeys.md#asymkey) -- [signKey](verida_account_node._internal_.SecureStorageContextPublicKeys.md#signkey) - -## Properties - -### asymKey - -• **asymKey**: [`SecureContextPublicKey`](verida_account_node._internal_.SecureContextPublicKey.md) - -#### Defined in - -packages/types/dist/StorageLinkInterfaces.d.ts:7 - -___ - -### signKey - -• **signKey**: [`SecureContextPublicKey`](verida_account_node._internal_.SecureContextPublicKey.md) - -#### Defined in - -packages/types/dist/StorageLinkInterfaces.d.ts:8 diff --git a/docs/api/verida-js/interfaces/verida_account_node._internal_.Service.md b/docs/api/verida-js/interfaces/verida_account_node._internal_.Service.md deleted file mode 100644 index 0e00189..0000000 --- a/docs/api/verida-js/interfaces/verida_account_node._internal_.Service.md +++ /dev/null @@ -1,53 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account-node](../modules/verida_account_node.md) / [](../modules/verida_account_node._internal_.md) / Service - -# Interface: Service - -[@verida/account-node](../modules/verida_account_node.md).[](../modules/verida_account_node._internal_.md).Service - -Represents a Service entry in a [DID document](https://www.w3.org/TR/did-core/#did-document-properties). - -**`see`** [https://www.w3.org/TR/did-core/#services](https://www.w3.org/TR/did-core/#services) - -**`see`** [https://www.w3.org/TR/did-core/#service-properties](https://www.w3.org/TR/did-core/#service-properties) - -## Indexable - -▪ [x: `string`]: `any` - -## Table of contents - -### Properties - -- [id](verida_account_node._internal_.Service.md#id) -- [serviceEndpoint](verida_account_node._internal_.Service.md#serviceendpoint) -- [type](verida_account_node._internal_.Service.md#type) - -## Properties - -### id - -• **id**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:81 - -___ - -### serviceEndpoint - -• **serviceEndpoint**: [`ServiceEndpoint`](../modules/verida_account_node._internal_.md#serviceendpoint) \| [`ServiceEndpoint`](../modules/verida_account_node._internal_.md#serviceendpoint)[] - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:83 - -___ - -### type - -• **type**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:82 diff --git a/docs/api/verida-js/interfaces/verida_account_node._internal_.ServiceEndpoint.md b/docs/api/verida-js/interfaces/verida_account_node._internal_.ServiceEndpoint.md deleted file mode 100644 index ca04675..0000000 --- a/docs/api/verida-js/interfaces/verida_account_node._internal_.ServiceEndpoint.md +++ /dev/null @@ -1,54 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account-node](../modules/verida_account_node.md) / [](../modules/verida_account_node._internal_.md) / ServiceEndpoint - -# Interface: ServiceEndpoint - -[@verida/account-node](../modules/verida_account_node.md).[](../modules/verida_account_node._internal_.md).ServiceEndpoint - -## Table of contents - -### Properties - -- [description](verida_account_node._internal_.ServiceEndpoint.md#description) -- [id](verida_account_node._internal_.ServiceEndpoint.md#id) -- [serviceEndpoint](verida_account_node._internal_.ServiceEndpoint.md#serviceendpoint) -- [type](verida_account_node._internal_.ServiceEndpoint.md#type) - -## Properties - -### description - -• `Optional` **description**: `string` - -#### Defined in - -packages/did-document/node_modules/did-resolver/lib/resolver.d.ts:43 - -___ - -### id - -• **id**: `string` - -#### Defined in - -packages/did-document/node_modules/did-resolver/lib/resolver.d.ts:40 - -___ - -### serviceEndpoint - -• **serviceEndpoint**: `string` - -#### Defined in - -packages/did-document/node_modules/did-resolver/lib/resolver.d.ts:42 - -___ - -### type - -• **type**: `string` - -#### Defined in - -packages/did-document/node_modules/did-resolver/lib/resolver.d.ts:41 diff --git a/docs/api/verida-js/interfaces/verida_account_node._internal_.Transaction.md b/docs/api/verida-js/interfaces/verida_account_node._internal_.Transaction.md deleted file mode 100644 index 8a2a5e1..0000000 --- a/docs/api/verida-js/interfaces/verida_account_node._internal_.Transaction.md +++ /dev/null @@ -1,192 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account-node](../modules/verida_account_node.md) / [](../modules/verida_account_node._internal_.md) / Transaction - -# Interface: Transaction - -[@verida/account-node](../modules/verida_account_node.md).[](../modules/verida_account_node._internal_.md).Transaction - -## Hierarchy - -- **`Transaction`** - - ↳ [`TransactionResponse`](verida_account_node._internal_.TransactionResponse.md) - -## Table of contents - -### Properties - -- [accessList](verida_account_node._internal_.Transaction.md#accesslist) -- [chainId](verida_account_node._internal_.Transaction.md#chainid) -- [data](verida_account_node._internal_.Transaction.md#data) -- [from](verida_account_node._internal_.Transaction.md#from) -- [gasLimit](verida_account_node._internal_.Transaction.md#gaslimit) -- [gasPrice](verida_account_node._internal_.Transaction.md#gasprice) -- [hash](verida_account_node._internal_.Transaction.md#hash) -- [maxFeePerGas](verida_account_node._internal_.Transaction.md#maxfeepergas) -- [maxPriorityFeePerGas](verida_account_node._internal_.Transaction.md#maxpriorityfeepergas) -- [nonce](verida_account_node._internal_.Transaction.md#nonce) -- [r](verida_account_node._internal_.Transaction.md#r) -- [s](verida_account_node._internal_.Transaction.md#s) -- [to](verida_account_node._internal_.Transaction.md#to) -- [type](verida_account_node._internal_.Transaction.md#type) -- [v](verida_account_node._internal_.Transaction.md#v) -- [value](verida_account_node._internal_.Transaction.md#value) - -## Properties - -### accessList - -• `Optional` **accessList**: [`AccessList`](../modules/verida_account_node._internal_.md#accesslist) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:40 - -___ - -### chainId - -• **chainId**: `number` - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:35 - -___ - -### data - -• **data**: `string` - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:33 - -___ - -### from - -• `Optional` **from**: `string` - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:29 - -___ - -### gasLimit - -• **gasLimit**: [`BigNumber`](../classes/verida_account_node._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:31 - -___ - -### gasPrice - -• `Optional` **gasPrice**: [`BigNumber`](../classes/verida_account_node._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:32 - -___ - -### hash - -• `Optional` **hash**: `string` - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:27 - -___ - -### maxFeePerGas - -• `Optional` **maxFeePerGas**: [`BigNumber`](../classes/verida_account_node._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:42 - -___ - -### maxPriorityFeePerGas - -• `Optional` **maxPriorityFeePerGas**: [`BigNumber`](../classes/verida_account_node._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:41 - -___ - -### nonce - -• **nonce**: `number` - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:30 - -___ - -### r - -• `Optional` **r**: `string` - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:36 - -___ - -### s - -• `Optional` **s**: `string` - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:37 - -___ - -### to - -• `Optional` **to**: `string` - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:28 - -___ - -### type - -• `Optional` **type**: ``null`` \| `number` - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:39 - -___ - -### v - -• `Optional` **v**: `number` - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:38 - -___ - -### value - -• **value**: [`BigNumber`](../classes/verida_account_node._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:34 diff --git a/docs/api/verida-js/interfaces/verida_account_node._internal_.TransactionReceipt.md b/docs/api/verida-js/interfaces/verida_account_node._internal_.TransactionReceipt.md deleted file mode 100644 index aed3756..0000000 --- a/docs/api/verida-js/interfaces/verida_account_node._internal_.TransactionReceipt.md +++ /dev/null @@ -1,197 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account-node](../modules/verida_account_node.md) / [](../modules/verida_account_node._internal_.md) / TransactionReceipt - -# Interface: TransactionReceipt - -[@verida/account-node](../modules/verida_account_node.md).[](../modules/verida_account_node._internal_.md).TransactionReceipt - -## Table of contents - -### Properties - -- [blockHash](verida_account_node._internal_.TransactionReceipt.md#blockhash) -- [blockNumber](verida_account_node._internal_.TransactionReceipt.md#blocknumber) -- [byzantium](verida_account_node._internal_.TransactionReceipt.md#byzantium) -- [confirmations](verida_account_node._internal_.TransactionReceipt.md#confirmations) -- [contractAddress](verida_account_node._internal_.TransactionReceipt.md#contractaddress) -- [cumulativeGasUsed](verida_account_node._internal_.TransactionReceipt.md#cumulativegasused) -- [effectiveGasPrice](verida_account_node._internal_.TransactionReceipt.md#effectivegasprice) -- [from](verida_account_node._internal_.TransactionReceipt.md#from) -- [gasUsed](verida_account_node._internal_.TransactionReceipt.md#gasused) -- [logs](verida_account_node._internal_.TransactionReceipt.md#logs) -- [logsBloom](verida_account_node._internal_.TransactionReceipt.md#logsbloom) -- [root](verida_account_node._internal_.TransactionReceipt.md#root) -- [status](verida_account_node._internal_.TransactionReceipt.md#status) -- [to](verida_account_node._internal_.TransactionReceipt.md#to) -- [transactionHash](verida_account_node._internal_.TransactionReceipt.md#transactionhash) -- [transactionIndex](verida_account_node._internal_.TransactionReceipt.md#transactionindex) -- [type](verida_account_node._internal_.TransactionReceipt.md#type) - -## Properties - -### blockHash - -• **blockHash**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:73 - -___ - -### blockNumber - -• **blockNumber**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:76 - -___ - -### byzantium - -• **byzantium**: `boolean` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:80 - -___ - -### confirmations - -• **confirmations**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:77 - -___ - -### contractAddress - -• **contractAddress**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:68 - -___ - -### cumulativeGasUsed - -• **cumulativeGasUsed**: [`BigNumber`](../classes/verida_account_node._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:78 - -___ - -### effectiveGasPrice - -• **effectiveGasPrice**: [`BigNumber`](../classes/verida_account_node._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:79 - -___ - -### from - -• **from**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:67 - -___ - -### gasUsed - -• **gasUsed**: [`BigNumber`](../classes/verida_account_node._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:71 - -___ - -### logs - -• **logs**: [`Log`](verida_account_node._internal_.Log.md)[] - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:75 - -___ - -### logsBloom - -• **logsBloom**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:72 - -___ - -### root - -• `Optional` **root**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:70 - -___ - -### status - -• `Optional` **status**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:82 - -___ - -### to - -• **to**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:66 - -___ - -### transactionHash - -• **transactionHash**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:74 - -___ - -### transactionIndex - -• **transactionIndex**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:69 - -___ - -### type - -• **type**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:81 diff --git a/docs/api/verida-js/interfaces/verida_account_node._internal_.TransactionResponse.md b/docs/api/verida-js/interfaces/verida_account_node._internal_.TransactionResponse.md deleted file mode 100644 index dee252a..0000000 --- a/docs/api/verida-js/interfaces/verida_account_node._internal_.TransactionResponse.md +++ /dev/null @@ -1,335 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account-node](../modules/verida_account_node.md) / [](../modules/verida_account_node._internal_.md) / TransactionResponse - -# Interface: TransactionResponse - -[@verida/account-node](../modules/verida_account_node.md).[](../modules/verida_account_node._internal_.md).TransactionResponse - -## Hierarchy - -- [`Transaction`](verida_account_node._internal_.Transaction.md) - - ↳ **`TransactionResponse`** - -## Table of contents - -### Properties - -- [accessList](verida_account_node._internal_.TransactionResponse.md#accesslist) -- [blockHash](verida_account_node._internal_.TransactionResponse.md#blockhash) -- [blockNumber](verida_account_node._internal_.TransactionResponse.md#blocknumber) -- [chainId](verida_account_node._internal_.TransactionResponse.md#chainid) -- [confirmations](verida_account_node._internal_.TransactionResponse.md#confirmations) -- [data](verida_account_node._internal_.TransactionResponse.md#data) -- [from](verida_account_node._internal_.TransactionResponse.md#from) -- [gasLimit](verida_account_node._internal_.TransactionResponse.md#gaslimit) -- [gasPrice](verida_account_node._internal_.TransactionResponse.md#gasprice) -- [hash](verida_account_node._internal_.TransactionResponse.md#hash) -- [maxFeePerGas](verida_account_node._internal_.TransactionResponse.md#maxfeepergas) -- [maxPriorityFeePerGas](verida_account_node._internal_.TransactionResponse.md#maxpriorityfeepergas) -- [nonce](verida_account_node._internal_.TransactionResponse.md#nonce) -- [r](verida_account_node._internal_.TransactionResponse.md#r) -- [raw](verida_account_node._internal_.TransactionResponse.md#raw) -- [s](verida_account_node._internal_.TransactionResponse.md#s) -- [timestamp](verida_account_node._internal_.TransactionResponse.md#timestamp) -- [to](verida_account_node._internal_.TransactionResponse.md#to) -- [type](verida_account_node._internal_.TransactionResponse.md#type) -- [v](verida_account_node._internal_.TransactionResponse.md#v) -- [value](verida_account_node._internal_.TransactionResponse.md#value) - -### Methods - -- [wait](verida_account_node._internal_.TransactionResponse.md#wait) - -## Properties - -### accessList - -• `Optional` **accessList**: [`AccessList`](../modules/verida_account_node._internal_.md#accesslist) - -#### Inherited from - -[Transaction](verida_account_node._internal_.Transaction.md).[accessList](verida_account_node._internal_.Transaction.md#accesslist) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:40 - -___ - -### blockHash - -• `Optional` **blockHash**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:26 - -___ - -### blockNumber - -• `Optional` **blockNumber**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:25 - -___ - -### chainId - -• **chainId**: `number` - -#### Inherited from - -[Transaction](verida_account_node._internal_.Transaction.md).[chainId](verida_account_node._internal_.Transaction.md#chainid) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:35 - -___ - -### confirmations - -• **confirmations**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:28 - -___ - -### data - -• **data**: `string` - -#### Inherited from - -[Transaction](verida_account_node._internal_.Transaction.md).[data](verida_account_node._internal_.Transaction.md#data) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:33 - -___ - -### from - -• **from**: `string` - -#### Overrides - -[Transaction](verida_account_node._internal_.Transaction.md).[from](verida_account_node._internal_.Transaction.md#from) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:29 - -___ - -### gasLimit - -• **gasLimit**: [`BigNumber`](../classes/verida_account_node._internal_.BigNumber.md) - -#### Inherited from - -[Transaction](verida_account_node._internal_.Transaction.md).[gasLimit](verida_account_node._internal_.Transaction.md#gaslimit) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:31 - -___ - -### gasPrice - -• `Optional` **gasPrice**: [`BigNumber`](../classes/verida_account_node._internal_.BigNumber.md) - -#### Inherited from - -[Transaction](verida_account_node._internal_.Transaction.md).[gasPrice](verida_account_node._internal_.Transaction.md#gasprice) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:32 - -___ - -### hash - -• **hash**: `string` - -#### Overrides - -[Transaction](verida_account_node._internal_.Transaction.md).[hash](verida_account_node._internal_.Transaction.md#hash) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:24 - -___ - -### maxFeePerGas - -• `Optional` **maxFeePerGas**: [`BigNumber`](../classes/verida_account_node._internal_.BigNumber.md) - -#### Inherited from - -[Transaction](verida_account_node._internal_.Transaction.md).[maxFeePerGas](verida_account_node._internal_.Transaction.md#maxfeepergas) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:42 - -___ - -### maxPriorityFeePerGas - -• `Optional` **maxPriorityFeePerGas**: [`BigNumber`](../classes/verida_account_node._internal_.BigNumber.md) - -#### Inherited from - -[Transaction](verida_account_node._internal_.Transaction.md).[maxPriorityFeePerGas](verida_account_node._internal_.Transaction.md#maxpriorityfeepergas) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:41 - -___ - -### nonce - -• **nonce**: `number` - -#### Inherited from - -[Transaction](verida_account_node._internal_.Transaction.md).[nonce](verida_account_node._internal_.Transaction.md#nonce) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:30 - -___ - -### r - -• `Optional` **r**: `string` - -#### Inherited from - -[Transaction](verida_account_node._internal_.Transaction.md).[r](verida_account_node._internal_.Transaction.md#r) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:36 - -___ - -### raw - -• `Optional` **raw**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:30 - -___ - -### s - -• `Optional` **s**: `string` - -#### Inherited from - -[Transaction](verida_account_node._internal_.Transaction.md).[s](verida_account_node._internal_.Transaction.md#s) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:37 - -___ - -### timestamp - -• `Optional` **timestamp**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:27 - -___ - -### to - -• `Optional` **to**: `string` - -#### Inherited from - -[Transaction](verida_account_node._internal_.Transaction.md).[to](verida_account_node._internal_.Transaction.md#to) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:28 - -___ - -### type - -• `Optional` **type**: ``null`` \| `number` - -#### Inherited from - -[Transaction](verida_account_node._internal_.Transaction.md).[type](verida_account_node._internal_.Transaction.md#type) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:39 - -___ - -### v - -• `Optional` **v**: `number` - -#### Inherited from - -[Transaction](verida_account_node._internal_.Transaction.md).[v](verida_account_node._internal_.Transaction.md#v) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:38 - -___ - -### value - -• **value**: [`BigNumber`](../classes/verida_account_node._internal_.BigNumber.md) - -#### Inherited from - -[Transaction](verida_account_node._internal_.Transaction.md).[value](verida_account_node._internal_.Transaction.md#value) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:34 - -## Methods - -### wait - -▸ **wait**(`confirmations?`): `Promise`<[`TransactionReceipt`](verida_account_node._internal_.TransactionReceipt.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `confirmations?` | `number` | - -#### Returns - -`Promise`<[`TransactionReceipt`](verida_account_node._internal_.TransactionReceipt.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:31 diff --git a/docs/api/verida-js/interfaces/verida_account_node._internal_.TransitionalOptions.md b/docs/api/verida-js/interfaces/verida_account_node._internal_.TransitionalOptions.md deleted file mode 100644 index 6b3de80..0000000 --- a/docs/api/verida-js/interfaces/verida_account_node._internal_.TransitionalOptions.md +++ /dev/null @@ -1,43 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account-node](../modules/verida_account_node.md) / [](../modules/verida_account_node._internal_.md) / TransitionalOptions - -# Interface: TransitionalOptions - -[@verida/account-node](../modules/verida_account_node.md).[](../modules/verida_account_node._internal_.md).TransitionalOptions - -## Table of contents - -### Properties - -- [clarifyTimeoutError](verida_account_node._internal_.TransitionalOptions.md#clarifytimeouterror) -- [forcedJSONParsing](verida_account_node._internal_.TransitionalOptions.md#forcedjsonparsing) -- [silentJSONParsing](verida_account_node._internal_.TransitionalOptions.md#silentjsonparsing) - -## Properties - -### clarifyTimeoutError - -• `Optional` **clarifyTimeoutError**: `boolean` - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:72 - -___ - -### forcedJSONParsing - -• `Optional` **forcedJSONParsing**: `boolean` - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:71 - -___ - -### silentJSONParsing - -• `Optional` **silentJSONParsing**: `boolean` - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:70 diff --git a/docs/api/verida-js/interfaces/verida_account_node._internal_.VdaDidEndpointResponse.md b/docs/api/verida-js/interfaces/verida_account_node._internal_.VdaDidEndpointResponse.md deleted file mode 100644 index cc476d1..0000000 --- a/docs/api/verida-js/interfaces/verida_account_node._internal_.VdaDidEndpointResponse.md +++ /dev/null @@ -1,32 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account-node](../modules/verida_account_node.md) / [](../modules/verida_account_node._internal_.md) / VdaDidEndpointResponse - -# Interface: VdaDidEndpointResponse - -[@verida/account-node](../modules/verida_account_node.md).[](../modules/verida_account_node._internal_.md).VdaDidEndpointResponse - -## Table of contents - -### Properties - -- [message](verida_account_node._internal_.VdaDidEndpointResponse.md#message) -- [status](verida_account_node._internal_.VdaDidEndpointResponse.md#status) - -## Properties - -### message - -• `Optional` **message**: `string` - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:111 - -___ - -### status - -• **status**: ``"success"`` \| ``"fail"`` - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:110 diff --git a/docs/api/verida-js/interfaces/verida_account_node._internal_.VeridaDatabaseAuthContext.md b/docs/api/verida-js/interfaces/verida_account_node._internal_.VeridaDatabaseAuthContext.md deleted file mode 100644 index c6cb539..0000000 --- a/docs/api/verida-js/interfaces/verida_account_node._internal_.VeridaDatabaseAuthContext.md +++ /dev/null @@ -1,75 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account-node](../modules/verida_account_node.md) / [](../modules/verida_account_node._internal_.md) / VeridaDatabaseAuthContext - -# Interface: VeridaDatabaseAuthContext - -[@verida/account-node](../modules/verida_account_node.md).[](../modules/verida_account_node._internal_.md).VeridaDatabaseAuthContext - -## Hierarchy - -- [`AuthContext`](verida_account_node._internal_.AuthContext.md) - - ↳ **`VeridaDatabaseAuthContext`** - -## Table of contents - -### Properties - -- [accessToken](verida_account_node._internal_.VeridaDatabaseAuthContext.md#accesstoken) -- [endpointUri](verida_account_node._internal_.VeridaDatabaseAuthContext.md#endpointuri) -- [host](verida_account_node._internal_.VeridaDatabaseAuthContext.md#host) -- [publicSigningKey](verida_account_node._internal_.VeridaDatabaseAuthContext.md#publicsigningkey) -- [refreshToken](verida_account_node._internal_.VeridaDatabaseAuthContext.md#refreshtoken) - -## Properties - -### accessToken - -• `Optional` **accessToken**: `string` - -#### Defined in - -packages/types/dist/AccountInterfaces.d.ts:20 - -___ - -### endpointUri - -• **endpointUri**: [`ServiceEndpoint`](../modules/verida_account_node._internal_.md#serviceendpoint) - -#### Defined in - -packages/types/dist/AccountInterfaces.d.ts:21 - -___ - -### host - -• **host**: `string` - -#### Defined in - -packages/types/dist/AccountInterfaces.d.ts:22 - -___ - -### publicSigningKey - -• **publicSigningKey**: [`SecureContextPublicKey`](verida_account_node._internal_.SecureContextPublicKey.md) - -#### Inherited from - -[AuthContext](verida_account_node._internal_.AuthContext.md).[publicSigningKey](verida_account_node._internal_.AuthContext.md#publicsigningkey) - -#### Defined in - -packages/types/dist/AccountInterfaces.d.ts:13 - -___ - -### refreshToken - -• `Optional` **refreshToken**: `string` - -#### Defined in - -packages/types/dist/AccountInterfaces.d.ts:19 diff --git a/docs/api/verida-js/interfaces/verida_account_node._internal_.VeridaDatabaseAuthTypeConfig.md b/docs/api/verida-js/interfaces/verida_account_node._internal_.VeridaDatabaseAuthTypeConfig.md deleted file mode 100644 index 10b7dc4..0000000 --- a/docs/api/verida-js/interfaces/verida_account_node._internal_.VeridaDatabaseAuthTypeConfig.md +++ /dev/null @@ -1,64 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account-node](../modules/verida_account_node.md) / [](../modules/verida_account_node._internal_.md) / VeridaDatabaseAuthTypeConfig - -# Interface: VeridaDatabaseAuthTypeConfig - -[@verida/account-node](../modules/verida_account_node.md).[](../modules/verida_account_node._internal_.md).VeridaDatabaseAuthTypeConfig - -## Hierarchy - -- [`AuthTypeConfig`](verida_account_node._internal_.AuthTypeConfig.md) - - ↳ **`VeridaDatabaseAuthTypeConfig`** - -## Table of contents - -### Properties - -- [deviceId](verida_account_node._internal_.VeridaDatabaseAuthTypeConfig.md#deviceid) -- [endpointUri](verida_account_node._internal_.VeridaDatabaseAuthTypeConfig.md#endpointuri) -- [force](verida_account_node._internal_.VeridaDatabaseAuthTypeConfig.md#force) -- [invalidAccessToken](verida_account_node._internal_.VeridaDatabaseAuthTypeConfig.md#invalidaccesstoken) - -## Properties - -### deviceId - -• `Optional` **deviceId**: `string` - -#### Defined in - -packages/types/dist/AccountInterfaces.d.ts:25 - -___ - -### endpointUri - -• `Optional` **endpointUri**: `string` - -#### Defined in - -packages/types/dist/AccountInterfaces.d.ts:26 - -___ - -### force - -• `Optional` **force**: `boolean` - -#### Inherited from - -[AuthTypeConfig](verida_account_node._internal_.AuthTypeConfig.md).[force](verida_account_node._internal_.AuthTypeConfig.md#force) - -#### Defined in - -packages/types/dist/AccountInterfaces.d.ts:16 - -___ - -### invalidAccessToken - -• `Optional` **invalidAccessToken**: `boolean` - -#### Defined in - -packages/types/dist/AccountInterfaces.d.ts:27 diff --git a/docs/api/verida-js/interfaces/verida_account_node._internal_.VeridaDocInterface.md b/docs/api/verida-js/interfaces/verida_account_node._internal_.VeridaDocInterface.md deleted file mode 100644 index 13d9784..0000000 --- a/docs/api/verida-js/interfaces/verida_account_node._internal_.VeridaDocInterface.md +++ /dev/null @@ -1,233 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account-node](../modules/verida_account_node.md) / [](../modules/verida_account_node._internal_.md) / VeridaDocInterface - -# Interface: VeridaDocInterface - -[@verida/account-node](../modules/verida_account_node.md).[](../modules/verida_account_node._internal_.md).VeridaDocInterface - -## Hierarchy - -- [`DIDDocument`](../modules/verida_account_node._internal_.md#diddocument) - - ↳ **`VeridaDocInterface`** - -## Table of contents - -### Properties - -- [@context](verida_account_node._internal_.VeridaDocInterface.md#@context) -- [alsoKnownAs](verida_account_node._internal_.VeridaDocInterface.md#alsoknownas) -- [assertionMethod](verida_account_node._internal_.VeridaDocInterface.md#assertionmethod) -- [authentication](verida_account_node._internal_.VeridaDocInterface.md#authentication) -- [capabilityDelegation](verida_account_node._internal_.VeridaDocInterface.md#capabilitydelegation) -- [capabilityInvocation](verida_account_node._internal_.VeridaDocInterface.md#capabilityinvocation) -- [controller](verida_account_node._internal_.VeridaDocInterface.md#controller) -- [created](verida_account_node._internal_.VeridaDocInterface.md#created) -- [deactivated](verida_account_node._internal_.VeridaDocInterface.md#deactivated) -- [id](verida_account_node._internal_.VeridaDocInterface.md#id) -- [keyAgreement](verida_account_node._internal_.VeridaDocInterface.md#keyagreement) -- [proof](verida_account_node._internal_.VeridaDocInterface.md#proof) -- [publicKey](verida_account_node._internal_.VeridaDocInterface.md#publickey) -- [service](verida_account_node._internal_.VeridaDocInterface.md#service) -- [updated](verida_account_node._internal_.VeridaDocInterface.md#updated) -- [verificationMethod](verida_account_node._internal_.VeridaDocInterface.md#verificationmethod) -- [versionId](verida_account_node._internal_.VeridaDocInterface.md#versionid) - -## Properties - -### @context - -• `Optional` **@context**: `string` \| `string`[] - -#### Inherited from - -DocInterface.@context - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:61 - -___ - -### alsoKnownAs - -• `Optional` **alsoKnownAs**: `string`[] - -#### Inherited from - -DocInterface.alsoKnownAs - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:63 - -___ - -### assertionMethod - -• **assertionMethod**: `undefined` \| (`string` \| [`VerificationMethod`](verida_account_node._internal_.VerificationMethod.md))[] - -#### Inherited from - -DocInterface.assertionMethod - -___ - -### authentication - -• **authentication**: `undefined` \| (`string` \| [`VerificationMethod`](verida_account_node._internal_.VerificationMethod.md))[] - -#### Inherited from - -DocInterface.authentication - -___ - -### capabilityDelegation - -• **capabilityDelegation**: `undefined` \| (`string` \| [`VerificationMethod`](verida_account_node._internal_.VerificationMethod.md))[] - -#### Inherited from - -DocInterface.capabilityDelegation - -___ - -### capabilityInvocation - -• **capabilityInvocation**: `undefined` \| (`string` \| [`VerificationMethod`](verida_account_node._internal_.VerificationMethod.md))[] - -#### Inherited from - -DocInterface.capabilityInvocation - -___ - -### controller - -• `Optional` **controller**: `string` \| `string`[] - -#### Inherited from - -DocInterface.controller - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:64 - -___ - -### created - -• `Optional` **created**: `string` - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:39 - -___ - -### deactivated - -• `Optional` **deactivated**: `string` - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:41 - -___ - -### id - -• **id**: `string` - -#### Inherited from - -DocInterface.id - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:62 - -___ - -### keyAgreement - -• **keyAgreement**: `undefined` \| (`string` \| [`VerificationMethod`](verida_account_node._internal_.VerificationMethod.md))[] - -#### Inherited from - -DocInterface.keyAgreement - -___ - -### proof - -• `Optional` **proof**: [`ProofInterface`](verida_account_node._internal_.ProofInterface.md) - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:42 - -___ - -### publicKey - -• `Optional` **publicKey**: [`VerificationMethod`](verida_account_node._internal_.VerificationMethod.md)[] - -**`deprecated`** - -#### Inherited from - -DocInterface.publicKey - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:70 - -___ - -### service - -• `Optional` **service**: [`Service`](verida_account_node._internal_.Service.md)[] - -#### Inherited from - -DocInterface.service - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:66 - -___ - -### updated - -• `Optional` **updated**: `string` - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:40 - -___ - -### verificationMethod - -• `Optional` **verificationMethod**: [`VerificationMethod`](verida_account_node._internal_.VerificationMethod.md)[] - -#### Inherited from - -DocInterface.verificationMethod - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:65 - -___ - -### versionId - -• **versionId**: `number` - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:38 diff --git a/docs/api/verida-js/interfaces/verida_account_node._internal_.VerificationMethod.md b/docs/api/verida-js/interfaces/verida_account_node._internal_.VerificationMethod.md deleted file mode 100644 index a4f2851..0000000 --- a/docs/api/verida-js/interfaces/verida_account_node._internal_.VerificationMethod.md +++ /dev/null @@ -1,129 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account-node](../modules/verida_account_node.md) / [](../modules/verida_account_node._internal_.md) / VerificationMethod - -# Interface: VerificationMethod - -[@verida/account-node](../modules/verida_account_node.md).[](../modules/verida_account_node._internal_.md).VerificationMethod - -Represents the properties of a Verification Method listed in a DID document. - -This data type includes public key representations that are no longer present in the spec but are still used by -several DID methods / resolvers and kept for backward compatibility. - -**`see`** [https://www.w3.org/TR/did-core/#verification-methods](https://www.w3.org/TR/did-core/#verification-methods) - -**`see`** [https://www.w3.org/TR/did-core/#verification-method-properties](https://www.w3.org/TR/did-core/#verification-method-properties) - -## Table of contents - -### Properties - -- [blockchainAccountId](verida_account_node._internal_.VerificationMethod.md#blockchainaccountid) -- [controller](verida_account_node._internal_.VerificationMethod.md#controller) -- [ethereumAddress](verida_account_node._internal_.VerificationMethod.md#ethereumaddress) -- [id](verida_account_node._internal_.VerificationMethod.md#id) -- [publicKeyBase58](verida_account_node._internal_.VerificationMethod.md#publickeybase58) -- [publicKeyBase64](verida_account_node._internal_.VerificationMethod.md#publickeybase64) -- [publicKeyHex](verida_account_node._internal_.VerificationMethod.md#publickeyhex) -- [publicKeyJwk](verida_account_node._internal_.VerificationMethod.md#publickeyjwk) -- [publicKeyMultibase](verida_account_node._internal_.VerificationMethod.md#publickeymultibase) -- [type](verida_account_node._internal_.VerificationMethod.md#type) - -## Properties - -### blockchainAccountId - -• `Optional` **blockchainAccountId**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:133 - -___ - -### controller - -• **controller**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:127 - -___ - -### ethereumAddress - -• `Optional` **ethereumAddress**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:134 - -___ - -### id - -• **id**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:125 - -___ - -### publicKeyBase58 - -• `Optional` **publicKeyBase58**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:128 - -___ - -### publicKeyBase64 - -• `Optional` **publicKeyBase64**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:129 - -___ - -### publicKeyHex - -• `Optional` **publicKeyHex**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:131 - -___ - -### publicKeyJwk - -• `Optional` **publicKeyJwk**: [`JsonWebKey`](verida_account_node._internal_.JsonWebKey.md) - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:130 - -___ - -### publicKeyMultibase - -• `Optional` **publicKeyMultibase**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:132 - -___ - -### type - -• **type**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:126 diff --git a/docs/api/verida-js/interfaces/verida_account_node._internal_.Web3GasConfiguration.md b/docs/api/verida-js/interfaces/verida_account_node._internal_.Web3GasConfiguration.md deleted file mode 100644 index e180c60..0000000 --- a/docs/api/verida-js/interfaces/verida_account_node._internal_.Web3GasConfiguration.md +++ /dev/null @@ -1,91 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account-node](../modules/verida_account_node.md) / [](../modules/verida_account_node._internal_.md) / Web3GasConfiguration - -# Interface: Web3GasConfiguration - -[@verida/account-node](../modules/verida_account_node.md).[](../modules/verida_account_node._internal_.md).Web3GasConfiguration - -Gas configuration - -eip1559Mode - optional - Once this parameter is set, all other parameters are not used. Gas information is pulled from network. - -maxFeePerGas - optional - Used for EIP1559 chains -maxPriorityFeePerGas - optional - Used for EIP1559 chains -gasLimit - optional - Used for non EIP1559 chains -gasPrice - optional - Used for non EIP1559 chains - -## Hierarchy - -- **`Web3GasConfiguration`** - - ↳ [`Web3SelfTransactionConfig`](verida_account_node._internal_.Web3SelfTransactionConfig.md) - -## Table of contents - -### Properties - -- [eip1559Mode](verida_account_node._internal_.Web3GasConfiguration.md#eip1559mode) -- [eip1559gasStationUrl](verida_account_node._internal_.Web3GasConfiguration.md#eip1559gasstationurl) -- [gasLimit](verida_account_node._internal_.Web3GasConfiguration.md#gaslimit) -- [gasPrice](verida_account_node._internal_.Web3GasConfiguration.md#gasprice) -- [maxFeePerGas](verida_account_node._internal_.Web3GasConfiguration.md#maxfeepergas) -- [maxPriorityFeePerGas](verida_account_node._internal_.Web3GasConfiguration.md#maxpriorityfeepergas) - -## Properties - -### eip1559Mode - -• `Optional` **eip1559Mode**: [`EIP1559GasMode`](../modules/verida_account_node._internal_.md#eip1559gasmode) - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:24 - -___ - -### eip1559gasStationUrl - -• `Optional` **eip1559gasStationUrl**: `string` - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:25 - -___ - -### gasLimit - -• `Optional` **gasLimit**: [`BigNumber`](../classes/verida_account_node._internal_.BigNumber.md) - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:28 - -___ - -### gasPrice - -• `Optional` **gasPrice**: [`BigNumber`](../classes/verida_account_node._internal_.BigNumber.md) - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:29 - -___ - -### maxFeePerGas - -• `Optional` **maxFeePerGas**: [`BigNumber`](../classes/verida_account_node._internal_.BigNumber.md) - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:26 - -___ - -### maxPriorityFeePerGas - -• `Optional` **maxPriorityFeePerGas**: [`BigNumber`](../classes/verida_account_node._internal_.BigNumber.md) - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:27 diff --git a/docs/api/verida-js/interfaces/verida_account_node._internal_.Web3GaslessPostConfig.md b/docs/api/verida-js/interfaces/verida_account_node._internal_.Web3GaslessPostConfig.md deleted file mode 100644 index 462cb07..0000000 --- a/docs/api/verida-js/interfaces/verida_account_node._internal_.Web3GaslessPostConfig.md +++ /dev/null @@ -1,37 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account-node](../modules/verida_account_node.md) / [](../modules/verida_account_node._internal_.md) / Web3GaslessPostConfig - -# Interface: Web3GaslessPostConfig - -[@verida/account-node](../modules/verida_account_node.md).[](../modules/verida_account_node._internal_.md).Web3GaslessPostConfig - -Configuration type for gasless post - -## Indexable - -▪ [key: `string`]: `any` - -## Table of contents - -### Properties - -- [headers](verida_account_node._internal_.Web3GaslessPostConfig.md#headers) - -## Properties - -### headers - -• **headers**: `Object` - -#### Index signature - -▪ [key: `string`]: `any` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `user-agent` | `string` | - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:64 diff --git a/docs/api/verida-js/interfaces/verida_account_node._internal_.Web3GaslessRequestConfig.md b/docs/api/verida-js/interfaces/verida_account_node._internal_.Web3GaslessRequestConfig.md deleted file mode 100644 index 9b24a36..0000000 --- a/docs/api/verida-js/interfaces/verida_account_node._internal_.Web3GaslessRequestConfig.md +++ /dev/null @@ -1,37 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account-node](../modules/verida_account_node.md) / [](../modules/verida_account_node._internal_.md) / Web3GaslessRequestConfig - -# Interface: Web3GaslessRequestConfig - -[@verida/account-node](../modules/verida_account_node.md).[](../modules/verida_account_node._internal_.md).Web3GaslessRequestConfig - -Configuration type for gasless request - -## Indexable - -▪ [key: `string`]: `any` - -## Table of contents - -### Properties - -- [headers](verida_account_node._internal_.Web3GaslessRequestConfig.md#headers) - -## Properties - -### headers - -• **headers**: `Object` - -#### Index signature - -▪ [key: `string`]: `any` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `context-name` | `string` | - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:56 diff --git a/docs/api/verida-js/interfaces/verida_account_node._internal_.Web3MetaTransactionConfig.md b/docs/api/verida-js/interfaces/verida_account_node._internal_.Web3MetaTransactionConfig.md deleted file mode 100644 index 68a405e..0000000 --- a/docs/api/verida-js/interfaces/verida_account_node._internal_.Web3MetaTransactionConfig.md +++ /dev/null @@ -1,45 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account-node](../modules/verida_account_node.md) / [](../modules/verida_account_node._internal_.md) / Web3MetaTransactionConfig - -# Interface: Web3MetaTransactionConfig - -[@verida/account-node](../modules/verida_account_node.md).[](../modules/verida_account_node._internal_.md).Web3MetaTransactionConfig - -Configuration type for gasless mode - -## Table of contents - -### Properties - -- [endpointUrl](verida_account_node._internal_.Web3MetaTransactionConfig.md#endpointurl) -- [postConfig](verida_account_node._internal_.Web3MetaTransactionConfig.md#postconfig) -- [serverConfig](verida_account_node._internal_.Web3MetaTransactionConfig.md#serverconfig) - -## Properties - -### endpointUrl - -• **endpointUrl**: `string` - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:51 - -___ - -### postConfig - -• **postConfig**: [`Web3GaslessPostConfig`](verida_account_node._internal_.Web3GaslessPostConfig.md) - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:50 - -___ - -### serverConfig - -• **serverConfig**: [`Web3GaslessRequestConfig`](verida_account_node._internal_.Web3GaslessRequestConfig.md) - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:49 diff --git a/docs/api/verida-js/interfaces/verida_account_node._internal_.Web3SelfTransactionConfig.md b/docs/api/verida-js/interfaces/verida_account_node._internal_.Web3SelfTransactionConfig.md deleted file mode 100644 index daa16c4..0000000 --- a/docs/api/verida-js/interfaces/verida_account_node._internal_.Web3SelfTransactionConfig.md +++ /dev/null @@ -1,179 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account-node](../modules/verida_account_node.md) / [](../modules/verida_account_node._internal_.md) / Web3SelfTransactionConfig - -# Interface: Web3SelfTransactionConfig - -[@verida/account-node](../modules/verida_account_node.md).[](../modules/verida_account_node._internal_.md).Web3SelfTransactionConfig - -Configuration type for Web3 mode - -signer - optional - a Signer that sign the blockchain transactions. If a 'signer' is not provided, then 'contract' with an attached signer need to be used to make transactions -provider - optional - a web3 provider. At least one of `signer`,`provider`, or `rpcUrl` is required -rpcUrl - optinal - a JSON-RPC URL that can be used to connect to an ethereum network. At least one of `signer`, `provider`, or `rpcUrl` is required -web3 - optional - Can use provider or web.currentProvider as a provider. - -## Hierarchy - -- [`Web3GasConfiguration`](verida_account_node._internal_.Web3GasConfiguration.md) - - ↳ **`Web3SelfTransactionConfig`** - -## Table of contents - -### Properties - -- [eip1559Mode](verida_account_node._internal_.Web3SelfTransactionConfig.md#eip1559mode) -- [eip1559gasStationUrl](verida_account_node._internal_.Web3SelfTransactionConfig.md#eip1559gasstationurl) -- [gasLimit](verida_account_node._internal_.Web3SelfTransactionConfig.md#gaslimit) -- [gasPrice](verida_account_node._internal_.Web3SelfTransactionConfig.md#gasprice) -- [maxFeePerGas](verida_account_node._internal_.Web3SelfTransactionConfig.md#maxfeepergas) -- [maxPriorityFeePerGas](verida_account_node._internal_.Web3SelfTransactionConfig.md#maxpriorityfeepergas) -- [methodDefaults](verida_account_node._internal_.Web3SelfTransactionConfig.md#methoddefaults) -- [privateKey](verida_account_node._internal_.Web3SelfTransactionConfig.md#privatekey) -- [provider](verida_account_node._internal_.Web3SelfTransactionConfig.md#provider) -- [rpcUrl](verida_account_node._internal_.Web3SelfTransactionConfig.md#rpcurl) -- [signer](verida_account_node._internal_.Web3SelfTransactionConfig.md#signer) -- [web3](verida_account_node._internal_.Web3SelfTransactionConfig.md#web3) - -## Properties - -### eip1559Mode - -• `Optional` **eip1559Mode**: [`EIP1559GasMode`](../modules/verida_account_node._internal_.md#eip1559gasmode) - -#### Inherited from - -[Web3GasConfiguration](verida_account_node._internal_.Web3GasConfiguration.md).[eip1559Mode](verida_account_node._internal_.Web3GasConfiguration.md#eip1559mode) - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:24 - -___ - -### eip1559gasStationUrl - -• `Optional` **eip1559gasStationUrl**: `string` - -#### Inherited from - -[Web3GasConfiguration](verida_account_node._internal_.Web3GasConfiguration.md).[eip1559gasStationUrl](verida_account_node._internal_.Web3GasConfiguration.md#eip1559gasstationurl) - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:25 - -___ - -### gasLimit - -• `Optional` **gasLimit**: [`BigNumber`](../classes/verida_account_node._internal_.BigNumber.md) - -#### Inherited from - -[Web3GasConfiguration](verida_account_node._internal_.Web3GasConfiguration.md).[gasLimit](verida_account_node._internal_.Web3GasConfiguration.md#gaslimit) - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:28 - -___ - -### gasPrice - -• `Optional` **gasPrice**: [`BigNumber`](../classes/verida_account_node._internal_.BigNumber.md) - -#### Inherited from - -[Web3GasConfiguration](verida_account_node._internal_.Web3GasConfiguration.md).[gasPrice](verida_account_node._internal_.Web3GasConfiguration.md#gasprice) - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:29 - -___ - -### maxFeePerGas - -• `Optional` **maxFeePerGas**: [`BigNumber`](../classes/verida_account_node._internal_.BigNumber.md) - -#### Inherited from - -[Web3GasConfiguration](verida_account_node._internal_.Web3GasConfiguration.md).[maxFeePerGas](verida_account_node._internal_.Web3GasConfiguration.md#maxfeepergas) - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:26 - -___ - -### maxPriorityFeePerGas - -• `Optional` **maxPriorityFeePerGas**: [`BigNumber`](../classes/verida_account_node._internal_.BigNumber.md) - -#### Inherited from - -[Web3GasConfiguration](verida_account_node._internal_.Web3GasConfiguration.md).[maxPriorityFeePerGas](verida_account_node._internal_.Web3GasConfiguration.md#maxpriorityfeepergas) - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:27 - -___ - -### methodDefaults - -• `Optional` **methodDefaults**: [`Record`](../modules/verida_account_node._internal_.md#record)<`string`, [`Web3GasConfiguration`](verida_account_node._internal_.Web3GasConfiguration.md)\> - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:45 - -___ - -### privateKey - -• `Optional` **privateKey**: `string` - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:41 - -___ - -### provider - -• `Optional` **provider**: [`Provider`](../classes/verida_account_node._internal_.Provider.md) - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:42 - -___ - -### rpcUrl - -• `Optional` **rpcUrl**: `string` - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:43 - -___ - -### signer - -• `Optional` **signer**: [`Signer`](../classes/verida_account_node._internal_.Signer.md) - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:40 - -___ - -### web3 - -• `Optional` **web3**: `any` - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:44 diff --git a/docs/api/verida-js/interfaces/verida_account_node._internal_.Web3SelfTransactionConfigPart.md b/docs/api/verida-js/interfaces/verida_account_node._internal_.Web3SelfTransactionConfigPart.md deleted file mode 100644 index b3b2929..0000000 --- a/docs/api/verida-js/interfaces/verida_account_node._internal_.Web3SelfTransactionConfigPart.md +++ /dev/null @@ -1,32 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account-node](../modules/verida_account_node.md) / [](../modules/verida_account_node._internal_.md) / Web3SelfTransactionConfigPart - -# Interface: Web3SelfTransactionConfigPart - -[@verida/account-node](../modules/verida_account_node.md).[](../modules/verida_account_node._internal_.md).Web3SelfTransactionConfigPart - -## Table of contents - -### Properties - -- [privateKey](verida_account_node._internal_.Web3SelfTransactionConfigPart.md#privatekey) -- [signer](verida_account_node._internal_.Web3SelfTransactionConfigPart.md#signer) - -## Properties - -### privateKey - -• `Optional` **privateKey**: `string` - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:116 - -___ - -### signer - -• `Optional` **signer**: [`Signer`](../classes/verida_account_node._internal_.Signer.md) - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:115 diff --git a/docs/api/verida-js/interfaces/verida_account_node._internal_._Block.md b/docs/api/verida-js/interfaces/verida_account_node._internal_._Block.md deleted file mode 100644 index b1137fb..0000000 --- a/docs/api/verida-js/interfaces/verida_account_node._internal_._Block.md +++ /dev/null @@ -1,150 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account-node](../modules/verida_account_node.md) / [](../modules/verida_account_node._internal_.md) / \_Block - -# Interface: \_Block - -[@verida/account-node](../modules/verida_account_node.md).[](../modules/verida_account_node._internal_.md)._Block - -## Hierarchy - -- **`_Block`** - - ↳ [`Block`](verida_account_node._internal_.Block.md) - - ↳ [`BlockWithTransactions`](verida_account_node._internal_.BlockWithTransactions.md) - -## Table of contents - -### Properties - -- [\_difficulty](verida_account_node._internal_._Block.md#_difficulty) -- [baseFeePerGas](verida_account_node._internal_._Block.md#basefeepergas) -- [difficulty](verida_account_node._internal_._Block.md#difficulty) -- [extraData](verida_account_node._internal_._Block.md#extradata) -- [gasLimit](verida_account_node._internal_._Block.md#gaslimit) -- [gasUsed](verida_account_node._internal_._Block.md#gasused) -- [hash](verida_account_node._internal_._Block.md#hash) -- [miner](verida_account_node._internal_._Block.md#miner) -- [nonce](verida_account_node._internal_._Block.md#nonce) -- [number](verida_account_node._internal_._Block.md#number) -- [parentHash](verida_account_node._internal_._Block.md#parenthash) -- [timestamp](verida_account_node._internal_._Block.md#timestamp) - -## Properties - -### \_difficulty - -• **\_difficulty**: [`BigNumber`](../classes/verida_account_node._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:41 - -___ - -### baseFeePerGas - -• `Optional` **baseFeePerGas**: ``null`` \| [`BigNumber`](../classes/verida_account_node._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:46 - -___ - -### difficulty - -• **difficulty**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:40 - -___ - -### extraData - -• **extraData**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:45 - -___ - -### gasLimit - -• **gasLimit**: [`BigNumber`](../classes/verida_account_node._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:42 - -___ - -### gasUsed - -• **gasUsed**: [`BigNumber`](../classes/verida_account_node._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:43 - -___ - -### hash - -• **hash**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:35 - -___ - -### miner - -• **miner**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:44 - -___ - -### nonce - -• **nonce**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:39 - -___ - -### number - -• **number**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:37 - -___ - -### parentHash - -• **parentHash**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:36 - -___ - -### timestamp - -• **timestamp**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:38 diff --git a/docs/api/verida-js/interfaces/verida_account_web_vault.VaultAccountConfig.md b/docs/api/verida-js/interfaces/verida_account_web_vault.VaultAccountConfig.md deleted file mode 100644 index c1e4229..0000000 --- a/docs/api/verida-js/interfaces/verida_account_web_vault.VaultAccountConfig.md +++ /dev/null @@ -1,115 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account-web-vault](../modules/verida_account_web_vault.md) / VaultAccountConfig - -# Interface: VaultAccountConfig - -[@verida/account-web-vault](../modules/verida_account_web_vault.md).VaultAccountConfig - -## Table of contents - -### Properties - -- [canvasId](verida_account_web_vault.VaultAccountConfig.md#canvasid) -- [deeplinkId](verida_account_web_vault.VaultAccountConfig.md#deeplinkid) -- [loginUri](verida_account_web_vault.VaultAccountConfig.md#loginuri) -- [request](verida_account_web_vault.VaultAccountConfig.md#request) -- [schemeUri](verida_account_web_vault.VaultAccountConfig.md#schemeuri) -- [serverUri](verida_account_web_vault.VaultAccountConfig.md#serveruri) - -### Methods - -- [callback](verida_account_web_vault.VaultAccountConfig.md#callback) -- [callbackRejected](verida_account_web_vault.VaultAccountConfig.md#callbackrejected) - -## Properties - -### canvasId - -• `Optional` **canvasId**: `string` - -#### Defined in - -[packages/account-web-vault/src/interfaces.ts:11](https://github.com/verida/verida-js/blob/c03b336/packages/account-web-vault/src/interfaces.ts#L11) - -___ - -### deeplinkId - -• `Optional` **deeplinkId**: `string` - -#### Defined in - -[packages/account-web-vault/src/interfaces.ts:13](https://github.com/verida/verida-js/blob/c03b336/packages/account-web-vault/src/interfaces.ts#L13) - -___ - -### loginUri - -• `Optional` **loginUri**: `string` - -#### Defined in - -[packages/account-web-vault/src/interfaces.ts:10](https://github.com/verida/verida-js/blob/c03b336/packages/account-web-vault/src/interfaces.ts#L10) - -___ - -### request - -• `Optional` **request**: [`VaultAccountRequest`](verida_account_web_vault._internal_.VaultAccountRequest.md) - -#### Defined in - -[packages/account-web-vault/src/interfaces.ts:14](https://github.com/verida/verida-js/blob/c03b336/packages/account-web-vault/src/interfaces.ts#L14) - -___ - -### schemeUri - -• `Optional` **schemeUri**: `string` - -#### Defined in - -[packages/account-web-vault/src/interfaces.ts:12](https://github.com/verida/verida-js/blob/c03b336/packages/account-web-vault/src/interfaces.ts#L12) - -___ - -### serverUri - -• `Optional` **serverUri**: `string` - -#### Defined in - -[packages/account-web-vault/src/interfaces.ts:9](https://github.com/verida/verida-js/blob/c03b336/packages/account-web-vault/src/interfaces.ts#L9) - -## Methods - -### callback - -▸ `Optional` **callback**(`response`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `response` | [`AuthResponse`](verida_account_web_vault._internal_.AuthResponse.md) | - -#### Returns - -`void` - -#### Defined in - -[packages/account-web-vault/src/interfaces.ts:15](https://github.com/verida/verida-js/blob/c03b336/packages/account-web-vault/src/interfaces.ts#L15) - -___ - -### callbackRejected - -▸ `Optional` **callbackRejected**(): `void` - -#### Returns - -`void` - -#### Defined in - -[packages/account-web-vault/src/interfaces.ts:16](https://github.com/verida/verida-js/blob/c03b336/packages/account-web-vault/src/interfaces.ts#L16) diff --git a/docs/api/verida-js/interfaces/verida_account_web_vault._internal_.AccountConfig.md b/docs/api/verida-js/interfaces/verida_account_web_vault._internal_.AccountConfig.md deleted file mode 100644 index 4ea8ee1..0000000 --- a/docs/api/verida-js/interfaces/verida_account_web_vault._internal_.AccountConfig.md +++ /dev/null @@ -1,54 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account-web-vault](../modules/verida_account_web_vault.md) / [](../modules/verida_account_web_vault._internal_.md) / AccountConfig - -# Interface: AccountConfig - -[@verida/account-web-vault](../modules/verida_account_web_vault.md).[](../modules/verida_account_web_vault._internal_.md).AccountConfig - -## Table of contents - -### Properties - -- [defaultDatabaseServer](verida_account_web_vault._internal_.AccountConfig.md#defaultdatabaseserver) -- [defaultMessageServer](verida_account_web_vault._internal_.AccountConfig.md#defaultmessageserver) -- [defaultNotificationServer](verida_account_web_vault._internal_.AccountConfig.md#defaultnotificationserver) -- [defaultStorageServer](verida_account_web_vault._internal_.AccountConfig.md#defaultstorageserver) - -## Properties - -### defaultDatabaseServer - -• **defaultDatabaseServer**: [`SecureContextEndpoint`](verida_account_web_vault._internal_.SecureContextEndpoint.md) - -#### Defined in - -packages/types/dist/AccountInterfaces.d.ts:7 - -___ - -### defaultMessageServer - -• **defaultMessageServer**: [`SecureContextEndpoint`](verida_account_web_vault._internal_.SecureContextEndpoint.md) - -#### Defined in - -packages/types/dist/AccountInterfaces.d.ts:8 - -___ - -### defaultNotificationServer - -• `Optional` **defaultNotificationServer**: [`SecureContextEndpoint`](verida_account_web_vault._internal_.SecureContextEndpoint.md) - -#### Defined in - -packages/types/dist/AccountInterfaces.d.ts:10 - -___ - -### defaultStorageServer - -• `Optional` **defaultStorageServer**: [`SecureContextEndpoint`](verida_account_web_vault._internal_.SecureContextEndpoint.md) - -#### Defined in - -packages/types/dist/AccountInterfaces.d.ts:9 diff --git a/docs/api/verida-js/interfaces/verida_account_web_vault._internal_.AccountVaultConfig.md b/docs/api/verida-js/interfaces/verida_account_web_vault._internal_.AccountVaultConfig.md deleted file mode 100644 index 14e007f..0000000 --- a/docs/api/verida-js/interfaces/verida_account_web_vault._internal_.AccountVaultConfig.md +++ /dev/null @@ -1,126 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account-web-vault](../modules/verida_account_web_vault.md) / [](../modules/verida_account_web_vault._internal_.md) / AccountVaultConfig - -# Interface: AccountVaultConfig - -[@verida/account-web-vault](../modules/verida_account_web_vault.md).[](../modules/verida_account_web_vault._internal_.md).AccountVaultConfig - -## Table of contents - -### Properties - -- [canvasId](verida_account_web_vault._internal_.AccountVaultConfig.md#canvasid) -- [deeplinkId](verida_account_web_vault._internal_.AccountVaultConfig.md#deeplinkid) -- [environment](verida_account_web_vault._internal_.AccountVaultConfig.md#environment) -- [loginUri](verida_account_web_vault._internal_.AccountVaultConfig.md#loginuri) -- [request](verida_account_web_vault._internal_.AccountVaultConfig.md#request) -- [schemeUri](verida_account_web_vault._internal_.AccountVaultConfig.md#schemeuri) -- [serverUri](verida_account_web_vault._internal_.AccountVaultConfig.md#serveruri) - -### Methods - -- [callback](verida_account_web_vault._internal_.AccountVaultConfig.md#callback) -- [callbackRejected](verida_account_web_vault._internal_.AccountVaultConfig.md#callbackrejected) - -## Properties - -### canvasId - -• `Optional` **canvasId**: `string` - -#### Defined in - -packages/types/dist/AccountInterfaces.d.ts:66 - -___ - -### deeplinkId - -• `Optional` **deeplinkId**: `string` - -#### Defined in - -packages/types/dist/AccountInterfaces.d.ts:68 - -___ - -### environment - -• `Optional` **environment**: [`EnvironmentType`](../enums/verida_account_web_vault._internal_.EnvironmentType.md) - -#### Defined in - -packages/types/dist/AccountInterfaces.d.ts:70 - -___ - -### loginUri - -• `Optional` **loginUri**: `string` - -#### Defined in - -packages/types/dist/AccountInterfaces.d.ts:65 - -___ - -### request - -• `Optional` **request**: [`AccountVaultRequest`](verida_account_web_vault._internal_.AccountVaultRequest.md) - -#### Defined in - -packages/types/dist/AccountInterfaces.d.ts:69 - -___ - -### schemeUri - -• `Optional` **schemeUri**: `string` - -#### Defined in - -packages/types/dist/AccountInterfaces.d.ts:67 - -___ - -### serverUri - -• `Optional` **serverUri**: `string` - -#### Defined in - -packages/types/dist/AccountInterfaces.d.ts:64 - -## Methods - -### callback - -▸ `Optional` **callback**(`response`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `response` | [`AuthResponse`](verida_account_web_vault._internal_.AuthResponse.md) | - -#### Returns - -`void` - -#### Defined in - -packages/types/dist/AccountInterfaces.d.ts:71 - -___ - -### callbackRejected - -▸ `Optional` **callbackRejected**(): `void` - -#### Returns - -`void` - -#### Defined in - -packages/types/dist/AccountInterfaces.d.ts:72 diff --git a/docs/api/verida-js/interfaces/verida_account_web_vault._internal_.AccountVaultRequest.md b/docs/api/verida-js/interfaces/verida_account_web_vault._internal_.AccountVaultRequest.md deleted file mode 100644 index d9e200f..0000000 --- a/docs/api/verida-js/interfaces/verida_account_web_vault._internal_.AccountVaultRequest.md +++ /dev/null @@ -1,62 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account-web-vault](../modules/verida_account_web_vault.md) / [](../modules/verida_account_web_vault._internal_.md) / AccountVaultRequest - -# Interface: AccountVaultRequest - -[@verida/account-web-vault](../modules/verida_account_web_vault.md).[](../modules/verida_account_web_vault._internal_.md).AccountVaultRequest - -## Table of contents - -### Properties - -- [logoUrl](verida_account_web_vault._internal_.AccountVaultRequest.md#logourl) -- [openUrl](verida_account_web_vault._internal_.AccountVaultRequest.md#openurl) -- [userAgent](verida_account_web_vault._internal_.AccountVaultRequest.md#useragent) -- [walletConnect](verida_account_web_vault._internal_.AccountVaultRequest.md#walletconnect) - -## Properties - -### logoUrl - -• `Optional` **logoUrl**: `string` - -#### Defined in - -packages/types/dist/AccountInterfaces.d.ts:54 - -___ - -### openUrl - -• `Optional` **openUrl**: `string` - -#### Defined in - -packages/types/dist/AccountInterfaces.d.ts:55 - -___ - -### userAgent - -• `Optional` **userAgent**: `string` - -#### Defined in - -packages/types/dist/AccountInterfaces.d.ts:61 - -___ - -### walletConnect - -• `Optional` **walletConnect**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `chainId` | `string` | -| `uri` | `string` | -| `version` | `number` | - -#### Defined in - -packages/types/dist/AccountInterfaces.d.ts:56 diff --git a/docs/api/verida-js/interfaces/verida_account_web_vault._internal_.AuthContext.md b/docs/api/verida-js/interfaces/verida_account_web_vault._internal_.AuthContext.md deleted file mode 100644 index 7b4ebad..0000000 --- a/docs/api/verida-js/interfaces/verida_account_web_vault._internal_.AuthContext.md +++ /dev/null @@ -1,27 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account-web-vault](../modules/verida_account_web_vault.md) / [](../modules/verida_account_web_vault._internal_.md) / AuthContext - -# Interface: AuthContext - -[@verida/account-web-vault](../modules/verida_account_web_vault.md).[](../modules/verida_account_web_vault._internal_.md).AuthContext - -## Hierarchy - -- **`AuthContext`** - - ↳ [`VeridaDatabaseAuthContext`](verida_account_web_vault._internal_.VeridaDatabaseAuthContext.md) - -## Table of contents - -### Properties - -- [publicSigningKey](verida_account_web_vault._internal_.AuthContext.md#publicsigningkey) - -## Properties - -### publicSigningKey - -• **publicSigningKey**: [`SecureContextPublicKey`](verida_account_web_vault._internal_.SecureContextPublicKey.md) - -#### Defined in - -packages/types/dist/AccountInterfaces.d.ts:13 diff --git a/docs/api/verida-js/interfaces/verida_account_web_vault._internal_.AuthResponse.md b/docs/api/verida-js/interfaces/verida_account_web_vault._internal_.AuthResponse.md deleted file mode 100644 index a3ee16b..0000000 --- a/docs/api/verida-js/interfaces/verida_account_web_vault._internal_.AuthResponse.md +++ /dev/null @@ -1,43 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account-web-vault](../modules/verida_account_web_vault.md) / [](../modules/verida_account_web_vault._internal_.md) / AuthResponse - -# Interface: AuthResponse - -[@verida/account-web-vault](../modules/verida_account_web_vault.md).[](../modules/verida_account_web_vault._internal_.md).AuthResponse - -## Table of contents - -### Properties - -- [message](verida_account_web_vault._internal_.AuthResponse.md#message) -- [success](verida_account_web_vault._internal_.AuthResponse.md#success) -- [type](verida_account_web_vault._internal_.AuthResponse.md#type) - -## Properties - -### message - -• **message**: `string` - -#### Defined in - -packages/types/dist/AccountInterfaces.d.ts:88 - -___ - -### success - -• **success**: `boolean` - -#### Defined in - -packages/types/dist/AccountInterfaces.d.ts:87 - -___ - -### type - -• **type**: `string` - -#### Defined in - -packages/types/dist/AccountInterfaces.d.ts:86 diff --git a/docs/api/verida-js/interfaces/verida_account_web_vault._internal_.AuthTypeConfig.md b/docs/api/verida-js/interfaces/verida_account_web_vault._internal_.AuthTypeConfig.md deleted file mode 100644 index 0d7d1de..0000000 --- a/docs/api/verida-js/interfaces/verida_account_web_vault._internal_.AuthTypeConfig.md +++ /dev/null @@ -1,21 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account-web-vault](../modules/verida_account_web_vault.md) / [](../modules/verida_account_web_vault._internal_.md) / AuthTypeConfig - -# Interface: AuthTypeConfig - -[@verida/account-web-vault](../modules/verida_account_web_vault.md).[](../modules/verida_account_web_vault._internal_.md).AuthTypeConfig - -## Table of contents - -### Properties - -- [force](verida_account_web_vault._internal_.AuthTypeConfig.md#force) - -## Properties - -### force - -• `Optional` **force**: `boolean` - -#### Defined in - -packages/types/dist/AccountInterfaces.d.ts:16 diff --git a/docs/api/verida-js/interfaces/verida_account_web_vault._internal_.AxiosAdapter.md b/docs/api/verida-js/interfaces/verida_account_web_vault._internal_.AxiosAdapter.md deleted file mode 100644 index 99c94c8..0000000 --- a/docs/api/verida-js/interfaces/verida_account_web_vault._internal_.AxiosAdapter.md +++ /dev/null @@ -1,25 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account-web-vault](../modules/verida_account_web_vault.md) / [](../modules/verida_account_web_vault._internal_.md) / AxiosAdapter - -# Interface: AxiosAdapter - -[@verida/account-web-vault](../modules/verida_account_web_vault.md).[](../modules/verida_account_web_vault._internal_.md).AxiosAdapter - -## Callable - -### AxiosAdapter - -▸ **AxiosAdapter**(`config`): [`AxiosPromise`](verida_account_web_vault._internal_.AxiosPromise.md)<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | [`AxiosRequestConfig`](verida_account_web_vault._internal_.AxiosRequestConfig.md)<`any`\> | - -#### Returns - -[`AxiosPromise`](verida_account_web_vault._internal_.AxiosPromise.md)<`any`\> - -#### Defined in - -node_modules/axios/index.d.ts:17 diff --git a/docs/api/verida-js/interfaces/verida_account_web_vault._internal_.AxiosBasicCredentials.md b/docs/api/verida-js/interfaces/verida_account_web_vault._internal_.AxiosBasicCredentials.md deleted file mode 100644 index dd5a528..0000000 --- a/docs/api/verida-js/interfaces/verida_account_web_vault._internal_.AxiosBasicCredentials.md +++ /dev/null @@ -1,32 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account-web-vault](../modules/verida_account_web_vault.md) / [](../modules/verida_account_web_vault._internal_.md) / AxiosBasicCredentials - -# Interface: AxiosBasicCredentials - -[@verida/account-web-vault](../modules/verida_account_web_vault.md).[](../modules/verida_account_web_vault._internal_.md).AxiosBasicCredentials - -## Table of contents - -### Properties - -- [password](verida_account_web_vault._internal_.AxiosBasicCredentials.md#password) -- [username](verida_account_web_vault._internal_.AxiosBasicCredentials.md#username) - -## Properties - -### password - -• **password**: `string` - -#### Defined in - -node_modules/axios/index.d.ts:22 - -___ - -### username - -• **username**: `string` - -#### Defined in - -node_modules/axios/index.d.ts:21 diff --git a/docs/api/verida-js/interfaces/verida_account_web_vault._internal_.AxiosDefaults.md b/docs/api/verida-js/interfaces/verida_account_web_vault._internal_.AxiosDefaults.md deleted file mode 100644 index 4fb41af..0000000 --- a/docs/api/verida-js/interfaces/verida_account_web_vault._internal_.AxiosDefaults.md +++ /dev/null @@ -1,594 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account-web-vault](../modules/verida_account_web_vault.md) / [](../modules/verida_account_web_vault._internal_.md) / AxiosDefaults - -# Interface: AxiosDefaults - -[@verida/account-web-vault](../modules/verida_account_web_vault.md).[](../modules/verida_account_web_vault._internal_.md).AxiosDefaults - -## Type parameters - -| Name | Type | -| :------ | :------ | -| `D` | `any` | - -## Hierarchy - -- [`Omit`](../modules/verida_account_web_vault._internal_.md#omit)<[`AxiosRequestConfig`](verida_account_web_vault._internal_.AxiosRequestConfig.md)<`D`\>, ``"headers"``\> - - ↳ **`AxiosDefaults`** - -## Table of contents - -### Properties - -- [adapter](verida_account_web_vault._internal_.AxiosDefaults.md#adapter) -- [auth](verida_account_web_vault._internal_.AxiosDefaults.md#auth) -- [baseURL](verida_account_web_vault._internal_.AxiosDefaults.md#baseurl) -- [cancelToken](verida_account_web_vault._internal_.AxiosDefaults.md#canceltoken) -- [data](verida_account_web_vault._internal_.AxiosDefaults.md#data) -- [decompress](verida_account_web_vault._internal_.AxiosDefaults.md#decompress) -- [env](verida_account_web_vault._internal_.AxiosDefaults.md#env) -- [headers](verida_account_web_vault._internal_.AxiosDefaults.md#headers) -- [httpAgent](verida_account_web_vault._internal_.AxiosDefaults.md#httpagent) -- [httpsAgent](verida_account_web_vault._internal_.AxiosDefaults.md#httpsagent) -- [insecureHTTPParser](verida_account_web_vault._internal_.AxiosDefaults.md#insecurehttpparser) -- [maxBodyLength](verida_account_web_vault._internal_.AxiosDefaults.md#maxbodylength) -- [maxContentLength](verida_account_web_vault._internal_.AxiosDefaults.md#maxcontentlength) -- [maxRedirects](verida_account_web_vault._internal_.AxiosDefaults.md#maxredirects) -- [method](verida_account_web_vault._internal_.AxiosDefaults.md#method) -- [params](verida_account_web_vault._internal_.AxiosDefaults.md#params) -- [proxy](verida_account_web_vault._internal_.AxiosDefaults.md#proxy) -- [responseEncoding](verida_account_web_vault._internal_.AxiosDefaults.md#responseencoding) -- [responseType](verida_account_web_vault._internal_.AxiosDefaults.md#responsetype) -- [signal](verida_account_web_vault._internal_.AxiosDefaults.md#signal) -- [socketPath](verida_account_web_vault._internal_.AxiosDefaults.md#socketpath) -- [timeout](verida_account_web_vault._internal_.AxiosDefaults.md#timeout) -- [timeoutErrorMessage](verida_account_web_vault._internal_.AxiosDefaults.md#timeouterrormessage) -- [transformRequest](verida_account_web_vault._internal_.AxiosDefaults.md#transformrequest) -- [transformResponse](verida_account_web_vault._internal_.AxiosDefaults.md#transformresponse) -- [transitional](verida_account_web_vault._internal_.AxiosDefaults.md#transitional) -- [url](verida_account_web_vault._internal_.AxiosDefaults.md#url) -- [validateStatus](verida_account_web_vault._internal_.AxiosDefaults.md#validatestatus) -- [withCredentials](verida_account_web_vault._internal_.AxiosDefaults.md#withcredentials) -- [xsrfCookieName](verida_account_web_vault._internal_.AxiosDefaults.md#xsrfcookiename) -- [xsrfHeaderName](verida_account_web_vault._internal_.AxiosDefaults.md#xsrfheadername) - -### Methods - -- [beforeRedirect](verida_account_web_vault._internal_.AxiosDefaults.md#beforeredirect) -- [onDownloadProgress](verida_account_web_vault._internal_.AxiosDefaults.md#ondownloadprogress) -- [onUploadProgress](verida_account_web_vault._internal_.AxiosDefaults.md#onuploadprogress) -- [paramsSerializer](verida_account_web_vault._internal_.AxiosDefaults.md#paramsserializer) - -## Properties - -### adapter - -• `Optional` **adapter**: [`AxiosAdapter`](verida_account_web_vault._internal_.AxiosAdapter.md) - -#### Inherited from - -Omit.adapter - -#### Defined in - -node_modules/axios/index.d.ts:88 - -___ - -### auth - -• `Optional` **auth**: [`AxiosBasicCredentials`](verida_account_web_vault._internal_.AxiosBasicCredentials.md) - -#### Inherited from - -Omit.auth - -#### Defined in - -node_modules/axios/index.d.ts:89 - -___ - -### baseURL - -• `Optional` **baseURL**: `string` - -#### Inherited from - -Omit.baseURL - -#### Defined in - -node_modules/axios/index.d.ts:78 - -___ - -### cancelToken - -• `Optional` **cancelToken**: [`CancelToken`](verida_account_web_vault._internal_.CancelToken.md) - -#### Inherited from - -Omit.cancelToken - -#### Defined in - -node_modules/axios/index.d.ts:105 - -___ - -### data - -• `Optional` **data**: `D` - -#### Inherited from - -Omit.data - -#### Defined in - -node_modules/axios/index.d.ts:84 - -___ - -### decompress - -• `Optional` **decompress**: `boolean` - -#### Inherited from - -Omit.decompress - -#### Defined in - -node_modules/axios/index.d.ts:106 - -___ - -### env - -• `Optional` **env**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `FormData?` | (...`args`: `any`[]) => `object` | - -#### Inherited from - -Omit.env - -#### Defined in - -node_modules/axios/index.d.ts:110 - -___ - -### headers - -• **headers**: [`HeadersDefaults`](verida_account_web_vault._internal_.HeadersDefaults.md) - -#### Defined in - -node_modules/axios/index.d.ts:130 - -___ - -### httpAgent - -• `Optional` **httpAgent**: `any` - -#### Inherited from - -Omit.httpAgent - -#### Defined in - -node_modules/axios/index.d.ts:102 - -___ - -### httpsAgent - -• `Optional` **httpsAgent**: `any` - -#### Inherited from - -Omit.httpsAgent - -#### Defined in - -node_modules/axios/index.d.ts:103 - -___ - -### insecureHTTPParser - -• `Optional` **insecureHTTPParser**: `boolean` - -#### Inherited from - -Omit.insecureHTTPParser - -#### Defined in - -node_modules/axios/index.d.ts:109 - -___ - -### maxBodyLength - -• `Optional` **maxBodyLength**: `number` - -#### Inherited from - -Omit.maxBodyLength - -#### Defined in - -node_modules/axios/index.d.ts:98 - -___ - -### maxContentLength - -• `Optional` **maxContentLength**: `number` - -#### Inherited from - -Omit.maxContentLength - -#### Defined in - -node_modules/axios/index.d.ts:96 - -___ - -### maxRedirects - -• `Optional` **maxRedirects**: `number` - -#### Inherited from - -Omit.maxRedirects - -#### Defined in - -node_modules/axios/index.d.ts:99 - -___ - -### method - -• `Optional` **method**: `string` - -#### Inherited from - -Omit.method - -#### Defined in - -node_modules/axios/index.d.ts:77 - -___ - -### params - -• `Optional` **params**: `any` - -#### Inherited from - -Omit.params - -#### Defined in - -node_modules/axios/index.d.ts:82 - -___ - -### proxy - -• `Optional` **proxy**: ``false`` \| [`AxiosProxyConfig`](verida_account_web_vault._internal_.AxiosProxyConfig.md) - -#### Inherited from - -Omit.proxy - -#### Defined in - -node_modules/axios/index.d.ts:104 - -___ - -### responseEncoding - -• `Optional` **responseEncoding**: `string` - -#### Inherited from - -Omit.responseEncoding - -#### Defined in - -node_modules/axios/index.d.ts:91 - -___ - -### responseType - -• `Optional` **responseType**: [`ResponseType`](../modules/verida_account_web_vault._internal_.md#responsetype) - -#### Inherited from - -Omit.responseType - -#### Defined in - -node_modules/axios/index.d.ts:90 - -___ - -### signal - -• `Optional` **signal**: `AbortSignal` - -#### Inherited from - -Omit.signal - -#### Defined in - -node_modules/axios/index.d.ts:108 - -___ - -### socketPath - -• `Optional` **socketPath**: ``null`` \| `string` - -#### Inherited from - -Omit.socketPath - -#### Defined in - -node_modules/axios/index.d.ts:101 - -___ - -### timeout - -• `Optional` **timeout**: `number` - -#### Inherited from - -Omit.timeout - -#### Defined in - -node_modules/axios/index.d.ts:85 - -___ - -### timeoutErrorMessage - -• `Optional` **timeoutErrorMessage**: `string` - -#### Inherited from - -Omit.timeoutErrorMessage - -#### Defined in - -node_modules/axios/index.d.ts:86 - -___ - -### transformRequest - -• `Optional` **transformRequest**: [`AxiosRequestTransformer`](verida_account_web_vault._internal_.AxiosRequestTransformer.md) \| [`AxiosRequestTransformer`](verida_account_web_vault._internal_.AxiosRequestTransformer.md)[] - -#### Inherited from - -Omit.transformRequest - -#### Defined in - -node_modules/axios/index.d.ts:79 - -___ - -### transformResponse - -• `Optional` **transformResponse**: [`AxiosResponseTransformer`](verida_account_web_vault._internal_.AxiosResponseTransformer.md) \| [`AxiosResponseTransformer`](verida_account_web_vault._internal_.AxiosResponseTransformer.md)[] - -#### Inherited from - -Omit.transformResponse - -#### Defined in - -node_modules/axios/index.d.ts:80 - -___ - -### transitional - -• `Optional` **transitional**: [`TransitionalOptions`](verida_account_web_vault._internal_.TransitionalOptions.md) - -#### Inherited from - -Omit.transitional - -#### Defined in - -node_modules/axios/index.d.ts:107 - -___ - -### url - -• `Optional` **url**: `string` - -#### Inherited from - -Omit.url - -#### Defined in - -node_modules/axios/index.d.ts:76 - -___ - -### validateStatus - -• `Optional` **validateStatus**: ``null`` \| (`status`: `number`) => `boolean` - -#### Inherited from - -Omit.validateStatus - -#### Defined in - -node_modules/axios/index.d.ts:97 - -___ - -### withCredentials - -• `Optional` **withCredentials**: `boolean` - -#### Inherited from - -Omit.withCredentials - -#### Defined in - -node_modules/axios/index.d.ts:87 - -___ - -### xsrfCookieName - -• `Optional` **xsrfCookieName**: `string` - -#### Inherited from - -Omit.xsrfCookieName - -#### Defined in - -node_modules/axios/index.d.ts:92 - -___ - -### xsrfHeaderName - -• `Optional` **xsrfHeaderName**: `string` - -#### Inherited from - -Omit.xsrfHeaderName - -#### Defined in - -node_modules/axios/index.d.ts:93 - -## Methods - -### beforeRedirect - -▸ `Optional` **beforeRedirect**(`options`, `responseDetails`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options` | [`Record`](../modules/verida_account_web_vault._internal_.md#record)<`string`, `any`\> | -| `responseDetails` | `Object` | -| `responseDetails.headers` | [`Record`](../modules/verida_account_web_vault._internal_.md#record)<`string`, `string`\> | - -#### Returns - -`void` - -#### Inherited from - -Omit.beforeRedirect - -#### Defined in - -node_modules/axios/index.d.ts:100 - -___ - -### onDownloadProgress - -▸ `Optional` **onDownloadProgress**(`progressEvent`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `progressEvent` | `any` | - -#### Returns - -`void` - -#### Inherited from - -Omit.onDownloadProgress - -#### Defined in - -node_modules/axios/index.d.ts:95 - -___ - -### onUploadProgress - -▸ `Optional` **onUploadProgress**(`progressEvent`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `progressEvent` | `any` | - -#### Returns - -`void` - -#### Inherited from - -Omit.onUploadProgress - -#### Defined in - -node_modules/axios/index.d.ts:94 - -___ - -### paramsSerializer - -▸ `Optional` **paramsSerializer**(`params`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `params` | `any` | - -#### Returns - -`string` - -#### Inherited from - -Omit.paramsSerializer - -#### Defined in - -node_modules/axios/index.d.ts:83 diff --git a/docs/api/verida-js/interfaces/verida_account_web_vault._internal_.AxiosInstance.md b/docs/api/verida-js/interfaces/verida_account_web_vault._internal_.AxiosInstance.md deleted file mode 100644 index b6227af..0000000 --- a/docs/api/verida-js/interfaces/verida_account_web_vault._internal_.AxiosInstance.md +++ /dev/null @@ -1,499 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account-web-vault](../modules/verida_account_web_vault.md) / [](../modules/verida_account_web_vault._internal_.md) / AxiosInstance - -# Interface: AxiosInstance - -[@verida/account-web-vault](../modules/verida_account_web_vault.md).[](../modules/verida_account_web_vault._internal_.md).AxiosInstance - -## Hierarchy - -- [`Axios`](../classes/verida_account_web_vault._internal_.Axios.md) - - ↳ **`AxiosInstance`** - -## Callable - -### AxiosInstance - -▸ **AxiosInstance**(`config`): [`AxiosPromise`](verida_account_web_vault._internal_.AxiosPromise.md)<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | [`AxiosRequestConfig`](verida_account_web_vault._internal_.AxiosRequestConfig.md)<`any`\> | - -#### Returns - -[`AxiosPromise`](verida_account_web_vault._internal_.AxiosPromise.md)<`any`\> - -#### Defined in - -node_modules/axios/index.d.ts:236 - -### AxiosInstance - -▸ **AxiosInstance**(`url`, `config?`): [`AxiosPromise`](verida_account_web_vault._internal_.AxiosPromise.md)<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `config?` | [`AxiosRequestConfig`](verida_account_web_vault._internal_.AxiosRequestConfig.md)<`any`\> | - -#### Returns - -[`AxiosPromise`](verida_account_web_vault._internal_.AxiosPromise.md)<`any`\> - -#### Defined in - -node_modules/axios/index.d.ts:237 - -## Table of contents - -### Properties - -- [defaults](verida_account_web_vault._internal_.AxiosInstance.md#defaults) -- [interceptors](verida_account_web_vault._internal_.AxiosInstance.md#interceptors) - -### Methods - -- [delete](verida_account_web_vault._internal_.AxiosInstance.md#delete) -- [get](verida_account_web_vault._internal_.AxiosInstance.md#get) -- [getUri](verida_account_web_vault._internal_.AxiosInstance.md#geturi) -- [head](verida_account_web_vault._internal_.AxiosInstance.md#head) -- [options](verida_account_web_vault._internal_.AxiosInstance.md#options) -- [patch](verida_account_web_vault._internal_.AxiosInstance.md#patch) -- [patchForm](verida_account_web_vault._internal_.AxiosInstance.md#patchform) -- [post](verida_account_web_vault._internal_.AxiosInstance.md#post) -- [postForm](verida_account_web_vault._internal_.AxiosInstance.md#postform) -- [put](verida_account_web_vault._internal_.AxiosInstance.md#put) -- [putForm](verida_account_web_vault._internal_.AxiosInstance.md#putform) -- [request](verida_account_web_vault._internal_.AxiosInstance.md#request) - -## Properties - -### defaults - -• **defaults**: [`AxiosDefaults`](verida_account_web_vault._internal_.AxiosDefaults.md)<`any`\> - -#### Inherited from - -[Axios](../classes/verida_account_web_vault._internal_.Axios.md).[defaults](../classes/verida_account_web_vault._internal_.Axios.md#defaults) - -#### Defined in - -node_modules/axios/index.d.ts:216 - -___ - -### interceptors - -• **interceptors**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `request` | [`AxiosInterceptorManager`](verida_account_web_vault._internal_.AxiosInterceptorManager.md)<[`AxiosRequestConfig`](verida_account_web_vault._internal_.AxiosRequestConfig.md)<`any`\>\> | -| `response` | [`AxiosInterceptorManager`](verida_account_web_vault._internal_.AxiosInterceptorManager.md)<[`AxiosResponse`](verida_account_web_vault._internal_.AxiosResponse.md)<`any`, `any`\>\> | - -#### Inherited from - -[Axios](../classes/verida_account_web_vault._internal_.Axios.md).[interceptors](../classes/verida_account_web_vault._internal_.Axios.md#interceptors) - -#### Defined in - -node_modules/axios/index.d.ts:217 - -## Methods - -### delete - -▸ **delete**<`T`, `R`, `D`\>(`url`, `config?`): `Promise`<`R`\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `any` | -| `R` | [`AxiosResponse`](verida_account_web_vault._internal_.AxiosResponse.md)<`T`, `any`\> | -| `D` | `any` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `config?` | [`AxiosRequestConfig`](verida_account_web_vault._internal_.AxiosRequestConfig.md)<`D`\> | - -#### Returns - -`Promise`<`R`\> - -#### Inherited from - -[Axios](../classes/verida_account_web_vault._internal_.Axios.md).[delete](../classes/verida_account_web_vault._internal_.Axios.md#delete) - -#### Defined in - -node_modules/axios/index.d.ts:224 - -___ - -### get - -▸ **get**<`T`, `R`, `D`\>(`url`, `config?`): `Promise`<`R`\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `any` | -| `R` | [`AxiosResponse`](verida_account_web_vault._internal_.AxiosResponse.md)<`T`, `any`\> | -| `D` | `any` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `config?` | [`AxiosRequestConfig`](verida_account_web_vault._internal_.AxiosRequestConfig.md)<`D`\> | - -#### Returns - -`Promise`<`R`\> - -#### Inherited from - -[Axios](../classes/verida_account_web_vault._internal_.Axios.md).[get](../classes/verida_account_web_vault._internal_.Axios.md#get) - -#### Defined in - -node_modules/axios/index.d.ts:223 - -___ - -### getUri - -▸ **getUri**(`config?`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config?` | [`AxiosRequestConfig`](verida_account_web_vault._internal_.AxiosRequestConfig.md)<`any`\> | - -#### Returns - -`string` - -#### Inherited from - -[Axios](../classes/verida_account_web_vault._internal_.Axios.md).[getUri](../classes/verida_account_web_vault._internal_.Axios.md#geturi) - -#### Defined in - -node_modules/axios/index.d.ts:221 - -___ - -### head - -▸ **head**<`T`, `R`, `D`\>(`url`, `config?`): `Promise`<`R`\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `any` | -| `R` | [`AxiosResponse`](verida_account_web_vault._internal_.AxiosResponse.md)<`T`, `any`\> | -| `D` | `any` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `config?` | [`AxiosRequestConfig`](verida_account_web_vault._internal_.AxiosRequestConfig.md)<`D`\> | - -#### Returns - -`Promise`<`R`\> - -#### Inherited from - -[Axios](../classes/verida_account_web_vault._internal_.Axios.md).[head](../classes/verida_account_web_vault._internal_.Axios.md#head) - -#### Defined in - -node_modules/axios/index.d.ts:225 - -___ - -### options - -▸ **options**<`T`, `R`, `D`\>(`url`, `config?`): `Promise`<`R`\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `any` | -| `R` | [`AxiosResponse`](verida_account_web_vault._internal_.AxiosResponse.md)<`T`, `any`\> | -| `D` | `any` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `config?` | [`AxiosRequestConfig`](verida_account_web_vault._internal_.AxiosRequestConfig.md)<`D`\> | - -#### Returns - -`Promise`<`R`\> - -#### Inherited from - -[Axios](../classes/verida_account_web_vault._internal_.Axios.md).[options](../classes/verida_account_web_vault._internal_.Axios.md#options) - -#### Defined in - -node_modules/axios/index.d.ts:226 - -___ - -### patch - -▸ **patch**<`T`, `R`, `D`\>(`url`, `data?`, `config?`): `Promise`<`R`\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `any` | -| `R` | [`AxiosResponse`](verida_account_web_vault._internal_.AxiosResponse.md)<`T`, `any`\> | -| `D` | `any` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `data?` | `D` | -| `config?` | [`AxiosRequestConfig`](verida_account_web_vault._internal_.AxiosRequestConfig.md)<`D`\> | - -#### Returns - -`Promise`<`R`\> - -#### Inherited from - -[Axios](../classes/verida_account_web_vault._internal_.Axios.md).[patch](../classes/verida_account_web_vault._internal_.Axios.md#patch) - -#### Defined in - -node_modules/axios/index.d.ts:229 - -___ - -### patchForm - -▸ **patchForm**<`T`, `R`, `D`\>(`url`, `data?`, `config?`): `Promise`<`R`\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `any` | -| `R` | [`AxiosResponse`](verida_account_web_vault._internal_.AxiosResponse.md)<`T`, `any`\> | -| `D` | `any` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `data?` | `D` | -| `config?` | [`AxiosRequestConfig`](verida_account_web_vault._internal_.AxiosRequestConfig.md)<`D`\> | - -#### Returns - -`Promise`<`R`\> - -#### Inherited from - -[Axios](../classes/verida_account_web_vault._internal_.Axios.md).[patchForm](../classes/verida_account_web_vault._internal_.Axios.md#patchform) - -#### Defined in - -node_modules/axios/index.d.ts:232 - -___ - -### post - -▸ **post**<`T`, `R`, `D`\>(`url`, `data?`, `config?`): `Promise`<`R`\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `any` | -| `R` | [`AxiosResponse`](verida_account_web_vault._internal_.AxiosResponse.md)<`T`, `any`\> | -| `D` | `any` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `data?` | `D` | -| `config?` | [`AxiosRequestConfig`](verida_account_web_vault._internal_.AxiosRequestConfig.md)<`D`\> | - -#### Returns - -`Promise`<`R`\> - -#### Inherited from - -[Axios](../classes/verida_account_web_vault._internal_.Axios.md).[post](../classes/verida_account_web_vault._internal_.Axios.md#post) - -#### Defined in - -node_modules/axios/index.d.ts:227 - -___ - -### postForm - -▸ **postForm**<`T`, `R`, `D`\>(`url`, `data?`, `config?`): `Promise`<`R`\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `any` | -| `R` | [`AxiosResponse`](verida_account_web_vault._internal_.AxiosResponse.md)<`T`, `any`\> | -| `D` | `any` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `data?` | `D` | -| `config?` | [`AxiosRequestConfig`](verida_account_web_vault._internal_.AxiosRequestConfig.md)<`D`\> | - -#### Returns - -`Promise`<`R`\> - -#### Inherited from - -[Axios](../classes/verida_account_web_vault._internal_.Axios.md).[postForm](../classes/verida_account_web_vault._internal_.Axios.md#postform) - -#### Defined in - -node_modules/axios/index.d.ts:230 - -___ - -### put - -▸ **put**<`T`, `R`, `D`\>(`url`, `data?`, `config?`): `Promise`<`R`\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `any` | -| `R` | [`AxiosResponse`](verida_account_web_vault._internal_.AxiosResponse.md)<`T`, `any`\> | -| `D` | `any` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `data?` | `D` | -| `config?` | [`AxiosRequestConfig`](verida_account_web_vault._internal_.AxiosRequestConfig.md)<`D`\> | - -#### Returns - -`Promise`<`R`\> - -#### Inherited from - -[Axios](../classes/verida_account_web_vault._internal_.Axios.md).[put](../classes/verida_account_web_vault._internal_.Axios.md#put) - -#### Defined in - -node_modules/axios/index.d.ts:228 - -___ - -### putForm - -▸ **putForm**<`T`, `R`, `D`\>(`url`, `data?`, `config?`): `Promise`<`R`\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `any` | -| `R` | [`AxiosResponse`](verida_account_web_vault._internal_.AxiosResponse.md)<`T`, `any`\> | -| `D` | `any` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `data?` | `D` | -| `config?` | [`AxiosRequestConfig`](verida_account_web_vault._internal_.AxiosRequestConfig.md)<`D`\> | - -#### Returns - -`Promise`<`R`\> - -#### Inherited from - -[Axios](../classes/verida_account_web_vault._internal_.Axios.md).[putForm](../classes/verida_account_web_vault._internal_.Axios.md#putform) - -#### Defined in - -node_modules/axios/index.d.ts:231 - -___ - -### request - -▸ **request**<`T`, `R`, `D`\>(`config`): `Promise`<`R`\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `any` | -| `R` | [`AxiosResponse`](verida_account_web_vault._internal_.AxiosResponse.md)<`T`, `any`\> | -| `D` | `any` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | [`AxiosRequestConfig`](verida_account_web_vault._internal_.AxiosRequestConfig.md)<`D`\> | - -#### Returns - -`Promise`<`R`\> - -#### Inherited from - -[Axios](../classes/verida_account_web_vault._internal_.Axios.md).[request](../classes/verida_account_web_vault._internal_.Axios.md#request) - -#### Defined in - -node_modules/axios/index.d.ts:222 diff --git a/docs/api/verida-js/interfaces/verida_account_web_vault._internal_.AxiosInterceptorManager.md b/docs/api/verida-js/interfaces/verida_account_web_vault._internal_.AxiosInterceptorManager.md deleted file mode 100644 index d5c1f8b..0000000 --- a/docs/api/verida-js/interfaces/verida_account_web_vault._internal_.AxiosInterceptorManager.md +++ /dev/null @@ -1,66 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account-web-vault](../modules/verida_account_web_vault.md) / [](../modules/verida_account_web_vault._internal_.md) / AxiosInterceptorManager - -# Interface: AxiosInterceptorManager - -[@verida/account-web-vault](../modules/verida_account_web_vault.md).[](../modules/verida_account_web_vault._internal_.md).AxiosInterceptorManager - -## Type parameters - -| Name | -| :------ | -| `V` | - -## Table of contents - -### Methods - -- [eject](verida_account_web_vault._internal_.AxiosInterceptorManager.md#eject) -- [use](verida_account_web_vault._internal_.AxiosInterceptorManager.md#use) - -## Methods - -### eject - -▸ **eject**(`id`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `id` | `number` | - -#### Returns - -`void` - -#### Defined in - -node_modules/axios/index.d.ts:211 - -___ - -### use - -▸ **use**<`T`\>(`onFulfilled?`, `onRejected?`, `options?`): `number` - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `V` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `onFulfilled?` | (`value`: `V`) => `T` \| `Promise`<`T`\> | -| `onRejected?` | (`error`: `any`) => `any` | -| `options?` | [`AxiosInterceptorOptions`](verida_account_web_vault._internal_.AxiosInterceptorOptions.md) | - -#### Returns - -`number` - -#### Defined in - -node_modules/axios/index.d.ts:210 diff --git a/docs/api/verida-js/interfaces/verida_account_web_vault._internal_.AxiosInterceptorOptions.md b/docs/api/verida-js/interfaces/verida_account_web_vault._internal_.AxiosInterceptorOptions.md deleted file mode 100644 index 193b43f..0000000 --- a/docs/api/verida-js/interfaces/verida_account_web_vault._internal_.AxiosInterceptorOptions.md +++ /dev/null @@ -1,45 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account-web-vault](../modules/verida_account_web_vault.md) / [](../modules/verida_account_web_vault._internal_.md) / AxiosInterceptorOptions - -# Interface: AxiosInterceptorOptions - -[@verida/account-web-vault](../modules/verida_account_web_vault.md).[](../modules/verida_account_web_vault._internal_.md).AxiosInterceptorOptions - -## Table of contents - -### Properties - -- [synchronous](verida_account_web_vault._internal_.AxiosInterceptorOptions.md#synchronous) - -### Methods - -- [runWhen](verida_account_web_vault._internal_.AxiosInterceptorOptions.md#runwhen) - -## Properties - -### synchronous - -• `Optional` **synchronous**: `boolean` - -#### Defined in - -node_modules/axios/index.d.ts:205 - -## Methods - -### runWhen - -▸ `Optional` **runWhen**(`config`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | [`AxiosRequestConfig`](verida_account_web_vault._internal_.AxiosRequestConfig.md)<`any`\> | - -#### Returns - -`boolean` - -#### Defined in - -node_modules/axios/index.d.ts:206 diff --git a/docs/api/verida-js/interfaces/verida_account_web_vault._internal_.AxiosPromise.md b/docs/api/verida-js/interfaces/verida_account_web_vault._internal_.AxiosPromise.md deleted file mode 100644 index de49ddf..0000000 --- a/docs/api/verida-js/interfaces/verida_account_web_vault._internal_.AxiosPromise.md +++ /dev/null @@ -1,142 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account-web-vault](../modules/verida_account_web_vault.md) / [](../modules/verida_account_web_vault._internal_.md) / AxiosPromise - -# Interface: AxiosPromise - -[@verida/account-web-vault](../modules/verida_account_web_vault.md).[](../modules/verida_account_web_vault._internal_.md).AxiosPromise - -## Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `any` | - -## Hierarchy - -- `Promise`<[`AxiosResponse`](verida_account_web_vault._internal_.AxiosResponse.md)<`T`\>\> - - ↳ **`AxiosPromise`** - -## Table of contents - -### Properties - -- [[toStringTag]](verida_account_web_vault._internal_.AxiosPromise.md#[tostringtag]) - -### Methods - -- [catch](verida_account_web_vault._internal_.AxiosPromise.md#catch) -- [finally](verida_account_web_vault._internal_.AxiosPromise.md#finally) -- [then](verida_account_web_vault._internal_.AxiosPromise.md#then) - -## Properties - -### [toStringTag] - -• `Readonly` **[toStringTag]**: `string` - -#### Inherited from - -Promise.\_\_@toStringTag@928 - -#### Defined in - -node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:174 - -## Methods - -### catch - -▸ **catch**<`TResult`\>(`onrejected?`): `Promise`<[`AxiosResponse`](verida_account_web_vault._internal_.AxiosResponse.md)<`T`, `any`\> \| `TResult`\> - -Attaches a callback for only the rejection of the Promise. - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `TResult` | `never` | - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `onrejected?` | ``null`` \| (`reason`: `any`) => `TResult` \| [`PromiseLike`](verida_account_web_vault._internal_.PromiseLike.md)<`TResult`\> | The callback to execute when the Promise is rejected. | - -#### Returns - -`Promise`<[`AxiosResponse`](verida_account_web_vault._internal_.AxiosResponse.md)<`T`, `any`\> \| `TResult`\> - -A Promise for the completion of the callback. - -#### Inherited from - -Promise.catch - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1460 - -___ - -### finally - -▸ **finally**(`onfinally?`): `Promise`<[`AxiosResponse`](verida_account_web_vault._internal_.AxiosResponse.md)<`T`, `any`\>\> - -Attaches a callback that is invoked when the Promise is settled (fulfilled or rejected). The -resolved value cannot be modified from the callback. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `onfinally?` | ``null`` \| () => `void` | The callback to execute when the Promise is settled (fulfilled or rejected). | - -#### Returns - -`Promise`<[`AxiosResponse`](verida_account_web_vault._internal_.AxiosResponse.md)<`T`, `any`\>\> - -A Promise for the completion of the callback. - -#### Inherited from - -Promise.finally - -#### Defined in - -node_modules/typescript/lib/lib.es2018.promise.d.ts:31 - -___ - -### then - -▸ **then**<`TResult1`, `TResult2`\>(`onfulfilled?`, `onrejected?`): `Promise`<`TResult1` \| `TResult2`\> - -Attaches callbacks for the resolution and/or rejection of the Promise. - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `TResult1` | [`AxiosResponse`](verida_account_web_vault._internal_.AxiosResponse.md)<`T`, `any`\> | -| `TResult2` | `never` | - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `onfulfilled?` | ``null`` \| (`value`: [`AxiosResponse`](verida_account_web_vault._internal_.AxiosResponse.md)<`T`, `any`\>) => `TResult1` \| [`PromiseLike`](verida_account_web_vault._internal_.PromiseLike.md)<`TResult1`\> | The callback to execute when the Promise is resolved. | -| `onrejected?` | ``null`` \| (`reason`: `any`) => `TResult2` \| [`PromiseLike`](verida_account_web_vault._internal_.PromiseLike.md)<`TResult2`\> | The callback to execute when the Promise is rejected. | - -#### Returns - -`Promise`<`TResult1` \| `TResult2`\> - -A Promise for the completion of which ever callback is executed. - -#### Inherited from - -Promise.then - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1453 diff --git a/docs/api/verida-js/interfaces/verida_account_web_vault._internal_.AxiosProxyConfig.md b/docs/api/verida-js/interfaces/verida_account_web_vault._internal_.AxiosProxyConfig.md deleted file mode 100644 index 324bdc2..0000000 --- a/docs/api/verida-js/interfaces/verida_account_web_vault._internal_.AxiosProxyConfig.md +++ /dev/null @@ -1,61 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account-web-vault](../modules/verida_account_web_vault.md) / [](../modules/verida_account_web_vault._internal_.md) / AxiosProxyConfig - -# Interface: AxiosProxyConfig - -[@verida/account-web-vault](../modules/verida_account_web_vault.md).[](../modules/verida_account_web_vault._internal_.md).AxiosProxyConfig - -## Table of contents - -### Properties - -- [auth](verida_account_web_vault._internal_.AxiosProxyConfig.md#auth) -- [host](verida_account_web_vault._internal_.AxiosProxyConfig.md#host) -- [port](verida_account_web_vault._internal_.AxiosProxyConfig.md#port) -- [protocol](verida_account_web_vault._internal_.AxiosProxyConfig.md#protocol) - -## Properties - -### auth - -• `Optional` **auth**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `password` | `string` | -| `username` | `string` | - -#### Defined in - -node_modules/axios/index.d.ts:28 - -___ - -### host - -• **host**: `string` - -#### Defined in - -node_modules/axios/index.d.ts:26 - -___ - -### port - -• **port**: `number` - -#### Defined in - -node_modules/axios/index.d.ts:27 - -___ - -### protocol - -• `Optional` **protocol**: `string` - -#### Defined in - -node_modules/axios/index.d.ts:32 diff --git a/docs/api/verida-js/interfaces/verida_account_web_vault._internal_.AxiosRequestConfig.md b/docs/api/verida-js/interfaces/verida_account_web_vault._internal_.AxiosRequestConfig.md deleted file mode 100644 index fa96698..0000000 --- a/docs/api/verida-js/interfaces/verida_account_web_vault._internal_.AxiosRequestConfig.md +++ /dev/null @@ -1,452 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account-web-vault](../modules/verida_account_web_vault.md) / [](../modules/verida_account_web_vault._internal_.md) / AxiosRequestConfig - -# Interface: AxiosRequestConfig - -[@verida/account-web-vault](../modules/verida_account_web_vault.md).[](../modules/verida_account_web_vault._internal_.md).AxiosRequestConfig - -## Type parameters - -| Name | Type | -| :------ | :------ | -| `D` | `any` | - -## Table of contents - -### Properties - -- [adapter](verida_account_web_vault._internal_.AxiosRequestConfig.md#adapter) -- [auth](verida_account_web_vault._internal_.AxiosRequestConfig.md#auth) -- [baseURL](verida_account_web_vault._internal_.AxiosRequestConfig.md#baseurl) -- [cancelToken](verida_account_web_vault._internal_.AxiosRequestConfig.md#canceltoken) -- [data](verida_account_web_vault._internal_.AxiosRequestConfig.md#data) -- [decompress](verida_account_web_vault._internal_.AxiosRequestConfig.md#decompress) -- [env](verida_account_web_vault._internal_.AxiosRequestConfig.md#env) -- [headers](verida_account_web_vault._internal_.AxiosRequestConfig.md#headers) -- [httpAgent](verida_account_web_vault._internal_.AxiosRequestConfig.md#httpagent) -- [httpsAgent](verida_account_web_vault._internal_.AxiosRequestConfig.md#httpsagent) -- [insecureHTTPParser](verida_account_web_vault._internal_.AxiosRequestConfig.md#insecurehttpparser) -- [maxBodyLength](verida_account_web_vault._internal_.AxiosRequestConfig.md#maxbodylength) -- [maxContentLength](verida_account_web_vault._internal_.AxiosRequestConfig.md#maxcontentlength) -- [maxRedirects](verida_account_web_vault._internal_.AxiosRequestConfig.md#maxredirects) -- [method](verida_account_web_vault._internal_.AxiosRequestConfig.md#method) -- [params](verida_account_web_vault._internal_.AxiosRequestConfig.md#params) -- [proxy](verida_account_web_vault._internal_.AxiosRequestConfig.md#proxy) -- [responseEncoding](verida_account_web_vault._internal_.AxiosRequestConfig.md#responseencoding) -- [responseType](verida_account_web_vault._internal_.AxiosRequestConfig.md#responsetype) -- [signal](verida_account_web_vault._internal_.AxiosRequestConfig.md#signal) -- [socketPath](verida_account_web_vault._internal_.AxiosRequestConfig.md#socketpath) -- [timeout](verida_account_web_vault._internal_.AxiosRequestConfig.md#timeout) -- [timeoutErrorMessage](verida_account_web_vault._internal_.AxiosRequestConfig.md#timeouterrormessage) -- [transformRequest](verida_account_web_vault._internal_.AxiosRequestConfig.md#transformrequest) -- [transformResponse](verida_account_web_vault._internal_.AxiosRequestConfig.md#transformresponse) -- [transitional](verida_account_web_vault._internal_.AxiosRequestConfig.md#transitional) -- [url](verida_account_web_vault._internal_.AxiosRequestConfig.md#url) -- [validateStatus](verida_account_web_vault._internal_.AxiosRequestConfig.md#validatestatus) -- [withCredentials](verida_account_web_vault._internal_.AxiosRequestConfig.md#withcredentials) -- [xsrfCookieName](verida_account_web_vault._internal_.AxiosRequestConfig.md#xsrfcookiename) -- [xsrfHeaderName](verida_account_web_vault._internal_.AxiosRequestConfig.md#xsrfheadername) - -### Methods - -- [beforeRedirect](verida_account_web_vault._internal_.AxiosRequestConfig.md#beforeredirect) -- [onDownloadProgress](verida_account_web_vault._internal_.AxiosRequestConfig.md#ondownloadprogress) -- [onUploadProgress](verida_account_web_vault._internal_.AxiosRequestConfig.md#onuploadprogress) -- [paramsSerializer](verida_account_web_vault._internal_.AxiosRequestConfig.md#paramsserializer) - -## Properties - -### adapter - -• `Optional` **adapter**: [`AxiosAdapter`](verida_account_web_vault._internal_.AxiosAdapter.md) - -#### Defined in - -node_modules/axios/index.d.ts:88 - -___ - -### auth - -• `Optional` **auth**: [`AxiosBasicCredentials`](verida_account_web_vault._internal_.AxiosBasicCredentials.md) - -#### Defined in - -node_modules/axios/index.d.ts:89 - -___ - -### baseURL - -• `Optional` **baseURL**: `string` - -#### Defined in - -node_modules/axios/index.d.ts:78 - -___ - -### cancelToken - -• `Optional` **cancelToken**: [`CancelToken`](verida_account_web_vault._internal_.CancelToken.md) - -#### Defined in - -node_modules/axios/index.d.ts:105 - -___ - -### data - -• `Optional` **data**: `D` - -#### Defined in - -node_modules/axios/index.d.ts:84 - -___ - -### decompress - -• `Optional` **decompress**: `boolean` - -#### Defined in - -node_modules/axios/index.d.ts:106 - -___ - -### env - -• `Optional` **env**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `FormData?` | (...`args`: `any`[]) => `object` | - -#### Defined in - -node_modules/axios/index.d.ts:110 - -___ - -### headers - -• `Optional` **headers**: [`AxiosRequestHeaders`](../modules/verida_account_web_vault._internal_.md#axiosrequestheaders) - -#### Defined in - -node_modules/axios/index.d.ts:81 - -___ - -### httpAgent - -• `Optional` **httpAgent**: `any` - -#### Defined in - -node_modules/axios/index.d.ts:102 - -___ - -### httpsAgent - -• `Optional` **httpsAgent**: `any` - -#### Defined in - -node_modules/axios/index.d.ts:103 - -___ - -### insecureHTTPParser - -• `Optional` **insecureHTTPParser**: `boolean` - -#### Defined in - -node_modules/axios/index.d.ts:109 - -___ - -### maxBodyLength - -• `Optional` **maxBodyLength**: `number` - -#### Defined in - -node_modules/axios/index.d.ts:98 - -___ - -### maxContentLength - -• `Optional` **maxContentLength**: `number` - -#### Defined in - -node_modules/axios/index.d.ts:96 - -___ - -### maxRedirects - -• `Optional` **maxRedirects**: `number` - -#### Defined in - -node_modules/axios/index.d.ts:99 - -___ - -### method - -• `Optional` **method**: `string` - -#### Defined in - -node_modules/axios/index.d.ts:77 - -___ - -### params - -• `Optional` **params**: `any` - -#### Defined in - -node_modules/axios/index.d.ts:82 - -___ - -### proxy - -• `Optional` **proxy**: ``false`` \| [`AxiosProxyConfig`](verida_account_web_vault._internal_.AxiosProxyConfig.md) - -#### Defined in - -node_modules/axios/index.d.ts:104 - -___ - -### responseEncoding - -• `Optional` **responseEncoding**: `string` - -#### Defined in - -node_modules/axios/index.d.ts:91 - -___ - -### responseType - -• `Optional` **responseType**: [`ResponseType`](../modules/verida_account_web_vault._internal_.md#responsetype) - -#### Defined in - -node_modules/axios/index.d.ts:90 - -___ - -### signal - -• `Optional` **signal**: `AbortSignal` - -#### Defined in - -node_modules/axios/index.d.ts:108 - -___ - -### socketPath - -• `Optional` **socketPath**: ``null`` \| `string` - -#### Defined in - -node_modules/axios/index.d.ts:101 - -___ - -### timeout - -• `Optional` **timeout**: `number` - -#### Defined in - -node_modules/axios/index.d.ts:85 - -___ - -### timeoutErrorMessage - -• `Optional` **timeoutErrorMessage**: `string` - -#### Defined in - -node_modules/axios/index.d.ts:86 - -___ - -### transformRequest - -• `Optional` **transformRequest**: [`AxiosRequestTransformer`](verida_account_web_vault._internal_.AxiosRequestTransformer.md) \| [`AxiosRequestTransformer`](verida_account_web_vault._internal_.AxiosRequestTransformer.md)[] - -#### Defined in - -node_modules/axios/index.d.ts:79 - -___ - -### transformResponse - -• `Optional` **transformResponse**: [`AxiosResponseTransformer`](verida_account_web_vault._internal_.AxiosResponseTransformer.md) \| [`AxiosResponseTransformer`](verida_account_web_vault._internal_.AxiosResponseTransformer.md)[] - -#### Defined in - -node_modules/axios/index.d.ts:80 - -___ - -### transitional - -• `Optional` **transitional**: [`TransitionalOptions`](verida_account_web_vault._internal_.TransitionalOptions.md) - -#### Defined in - -node_modules/axios/index.d.ts:107 - -___ - -### url - -• `Optional` **url**: `string` - -#### Defined in - -node_modules/axios/index.d.ts:76 - -___ - -### validateStatus - -• `Optional` **validateStatus**: ``null`` \| (`status`: `number`) => `boolean` - -#### Defined in - -node_modules/axios/index.d.ts:97 - -___ - -### withCredentials - -• `Optional` **withCredentials**: `boolean` - -#### Defined in - -node_modules/axios/index.d.ts:87 - -___ - -### xsrfCookieName - -• `Optional` **xsrfCookieName**: `string` - -#### Defined in - -node_modules/axios/index.d.ts:92 - -___ - -### xsrfHeaderName - -• `Optional` **xsrfHeaderName**: `string` - -#### Defined in - -node_modules/axios/index.d.ts:93 - -## Methods - -### beforeRedirect - -▸ `Optional` **beforeRedirect**(`options`, `responseDetails`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options` | [`Record`](../modules/verida_account_web_vault._internal_.md#record)<`string`, `any`\> | -| `responseDetails` | `Object` | -| `responseDetails.headers` | [`Record`](../modules/verida_account_web_vault._internal_.md#record)<`string`, `string`\> | - -#### Returns - -`void` - -#### Defined in - -node_modules/axios/index.d.ts:100 - -___ - -### onDownloadProgress - -▸ `Optional` **onDownloadProgress**(`progressEvent`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `progressEvent` | `any` | - -#### Returns - -`void` - -#### Defined in - -node_modules/axios/index.d.ts:95 - -___ - -### onUploadProgress - -▸ `Optional` **onUploadProgress**(`progressEvent`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `progressEvent` | `any` | - -#### Returns - -`void` - -#### Defined in - -node_modules/axios/index.d.ts:94 - -___ - -### paramsSerializer - -▸ `Optional` **paramsSerializer**(`params`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `params` | `any` | - -#### Returns - -`string` - -#### Defined in - -node_modules/axios/index.d.ts:83 diff --git a/docs/api/verida-js/interfaces/verida_account_web_vault._internal_.AxiosRequestTransformer.md b/docs/api/verida-js/interfaces/verida_account_web_vault._internal_.AxiosRequestTransformer.md deleted file mode 100644 index 97d868b..0000000 --- a/docs/api/verida-js/interfaces/verida_account_web_vault._internal_.AxiosRequestTransformer.md +++ /dev/null @@ -1,26 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account-web-vault](../modules/verida_account_web_vault.md) / [](../modules/verida_account_web_vault._internal_.md) / AxiosRequestTransformer - -# Interface: AxiosRequestTransformer - -[@verida/account-web-vault](../modules/verida_account_web_vault.md).[](../modules/verida_account_web_vault._internal_.md).AxiosRequestTransformer - -## Callable - -### AxiosRequestTransformer - -▸ **AxiosRequestTransformer**(`data`, `headers?`): `any` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `any` | -| `headers?` | [`AxiosRequestHeaders`](../modules/verida_account_web_vault._internal_.md#axiosrequestheaders) | - -#### Returns - -`any` - -#### Defined in - -node_modules/axios/index.d.ts:9 diff --git a/docs/api/verida-js/interfaces/verida_account_web_vault._internal_.AxiosResponse.md b/docs/api/verida-js/interfaces/verida_account_web_vault._internal_.AxiosResponse.md deleted file mode 100644 index c53d006..0000000 --- a/docs/api/verida-js/interfaces/verida_account_web_vault._internal_.AxiosResponse.md +++ /dev/null @@ -1,83 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account-web-vault](../modules/verida_account_web_vault.md) / [](../modules/verida_account_web_vault._internal_.md) / AxiosResponse - -# Interface: AxiosResponse - -[@verida/account-web-vault](../modules/verida_account_web_vault.md).[](../modules/verida_account_web_vault._internal_.md).AxiosResponse - -## Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `any` | -| `D` | `any` | - -## Table of contents - -### Properties - -- [config](verida_account_web_vault._internal_.AxiosResponse.md#config) -- [data](verida_account_web_vault._internal_.AxiosResponse.md#data) -- [headers](verida_account_web_vault._internal_.AxiosResponse.md#headers) -- [request](verida_account_web_vault._internal_.AxiosResponse.md#request) -- [status](verida_account_web_vault._internal_.AxiosResponse.md#status) -- [statusText](verida_account_web_vault._internal_.AxiosResponse.md#statustext) - -## Properties - -### config - -• **config**: [`AxiosRequestConfig`](verida_account_web_vault._internal_.AxiosRequestConfig.md)<`D`\> - -#### Defined in - -node_modules/axios/index.d.ts:138 - -___ - -### data - -• **data**: `T` - -#### Defined in - -node_modules/axios/index.d.ts:134 - -___ - -### headers - -• **headers**: [`AxiosResponseHeaders`](../modules/verida_account_web_vault._internal_.md#axiosresponseheaders) - -#### Defined in - -node_modules/axios/index.d.ts:137 - -___ - -### request - -• `Optional` **request**: `any` - -#### Defined in - -node_modules/axios/index.d.ts:139 - -___ - -### status - -• **status**: `number` - -#### Defined in - -node_modules/axios/index.d.ts:135 - -___ - -### statusText - -• **statusText**: `string` - -#### Defined in - -node_modules/axios/index.d.ts:136 diff --git a/docs/api/verida-js/interfaces/verida_account_web_vault._internal_.AxiosResponseTransformer.md b/docs/api/verida-js/interfaces/verida_account_web_vault._internal_.AxiosResponseTransformer.md deleted file mode 100644 index 4ab45e6..0000000 --- a/docs/api/verida-js/interfaces/verida_account_web_vault._internal_.AxiosResponseTransformer.md +++ /dev/null @@ -1,26 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account-web-vault](../modules/verida_account_web_vault.md) / [](../modules/verida_account_web_vault._internal_.md) / AxiosResponseTransformer - -# Interface: AxiosResponseTransformer - -[@verida/account-web-vault](../modules/verida_account_web_vault.md).[](../modules/verida_account_web_vault._internal_.md).AxiosResponseTransformer - -## Callable - -### AxiosResponseTransformer - -▸ **AxiosResponseTransformer**(`data`, `headers?`): `any` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `any` | -| `headers?` | [`AxiosResponseHeaders`](../modules/verida_account_web_vault._internal_.md#axiosresponseheaders) | - -#### Returns - -`any` - -#### Defined in - -node_modules/axios/index.d.ts:13 diff --git a/docs/api/verida-js/interfaces/verida_account_web_vault._internal_.Cancel.md b/docs/api/verida-js/interfaces/verida_account_web_vault._internal_.Cancel.md deleted file mode 100644 index c6e0bbf..0000000 --- a/docs/api/verida-js/interfaces/verida_account_web_vault._internal_.Cancel.md +++ /dev/null @@ -1,21 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account-web-vault](../modules/verida_account_web_vault.md) / [](../modules/verida_account_web_vault._internal_.md) / Cancel - -# Interface: Cancel - -[@verida/account-web-vault](../modules/verida_account_web_vault.md).[](../modules/verida_account_web_vault._internal_.md).Cancel - -## Table of contents - -### Properties - -- [message](verida_account_web_vault._internal_.Cancel.md#message) - -## Properties - -### message - -• **message**: `undefined` \| `string` - -#### Defined in - -node_modules/axios/index.d.ts:181 diff --git a/docs/api/verida-js/interfaces/verida_account_web_vault._internal_.CancelToken.md b/docs/api/verida-js/interfaces/verida_account_web_vault._internal_.CancelToken.md deleted file mode 100644 index 45f98c6..0000000 --- a/docs/api/verida-js/interfaces/verida_account_web_vault._internal_.CancelToken.md +++ /dev/null @@ -1,50 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account-web-vault](../modules/verida_account_web_vault.md) / [](../modules/verida_account_web_vault._internal_.md) / CancelToken - -# Interface: CancelToken - -[@verida/account-web-vault](../modules/verida_account_web_vault.md).[](../modules/verida_account_web_vault._internal_.md).CancelToken - -## Table of contents - -### Properties - -- [promise](verida_account_web_vault._internal_.CancelToken.md#promise) -- [reason](verida_account_web_vault._internal_.CancelToken.md#reason) - -### Methods - -- [throwIfRequested](verida_account_web_vault._internal_.CancelToken.md#throwifrequested) - -## Properties - -### promise - -• **promise**: `Promise`<[`Cancel`](verida_account_web_vault._internal_.Cancel.md)\> - -#### Defined in - -node_modules/axios/index.d.ts:194 - -___ - -### reason - -• `Optional` **reason**: [`Cancel`](verida_account_web_vault._internal_.Cancel.md) - -#### Defined in - -node_modules/axios/index.d.ts:195 - -## Methods - -### throwIfRequested - -▸ **throwIfRequested**(): `void` - -#### Returns - -`void` - -#### Defined in - -node_modules/axios/index.d.ts:196 diff --git a/docs/api/verida-js/interfaces/verida_account_web_vault._internal_.HeadersDefaults.md b/docs/api/verida-js/interfaces/verida_account_web_vault._internal_.HeadersDefaults.md deleted file mode 100644 index 6b1e2a9..0000000 --- a/docs/api/verida-js/interfaces/verida_account_web_vault._internal_.HeadersDefaults.md +++ /dev/null @@ -1,131 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account-web-vault](../modules/verida_account_web_vault.md) / [](../modules/verida_account_web_vault._internal_.md) / HeadersDefaults - -# Interface: HeadersDefaults - -[@verida/account-web-vault](../modules/verida_account_web_vault.md).[](../modules/verida_account_web_vault._internal_.md).HeadersDefaults - -## Table of contents - -### Properties - -- [common](verida_account_web_vault._internal_.HeadersDefaults.md#common) -- [delete](verida_account_web_vault._internal_.HeadersDefaults.md#delete) -- [get](verida_account_web_vault._internal_.HeadersDefaults.md#get) -- [head](verida_account_web_vault._internal_.HeadersDefaults.md#head) -- [link](verida_account_web_vault._internal_.HeadersDefaults.md#link) -- [options](verida_account_web_vault._internal_.HeadersDefaults.md#options) -- [patch](verida_account_web_vault._internal_.HeadersDefaults.md#patch) -- [post](verida_account_web_vault._internal_.HeadersDefaults.md#post) -- [purge](verida_account_web_vault._internal_.HeadersDefaults.md#purge) -- [put](verida_account_web_vault._internal_.HeadersDefaults.md#put) -- [unlink](verida_account_web_vault._internal_.HeadersDefaults.md#unlink) - -## Properties - -### common - -• **common**: [`AxiosRequestHeaders`](../modules/verida_account_web_vault._internal_.md#axiosrequestheaders) - -#### Defined in - -node_modules/axios/index.d.ts:116 - -___ - -### delete - -• **delete**: [`AxiosRequestHeaders`](../modules/verida_account_web_vault._internal_.md#axiosrequestheaders) - -#### Defined in - -node_modules/axios/index.d.ts:117 - -___ - -### get - -• **get**: [`AxiosRequestHeaders`](../modules/verida_account_web_vault._internal_.md#axiosrequestheaders) - -#### Defined in - -node_modules/axios/index.d.ts:118 - -___ - -### head - -• **head**: [`AxiosRequestHeaders`](../modules/verida_account_web_vault._internal_.md#axiosrequestheaders) - -#### Defined in - -node_modules/axios/index.d.ts:119 - -___ - -### link - -• `Optional` **link**: [`AxiosRequestHeaders`](../modules/verida_account_web_vault._internal_.md#axiosrequestheaders) - -#### Defined in - -node_modules/axios/index.d.ts:125 - -___ - -### options - -• `Optional` **options**: [`AxiosRequestHeaders`](../modules/verida_account_web_vault._internal_.md#axiosrequestheaders) - -#### Defined in - -node_modules/axios/index.d.ts:123 - -___ - -### patch - -• **patch**: [`AxiosRequestHeaders`](../modules/verida_account_web_vault._internal_.md#axiosrequestheaders) - -#### Defined in - -node_modules/axios/index.d.ts:122 - -___ - -### post - -• **post**: [`AxiosRequestHeaders`](../modules/verida_account_web_vault._internal_.md#axiosrequestheaders) - -#### Defined in - -node_modules/axios/index.d.ts:120 - -___ - -### purge - -• `Optional` **purge**: [`AxiosRequestHeaders`](../modules/verida_account_web_vault._internal_.md#axiosrequestheaders) - -#### Defined in - -node_modules/axios/index.d.ts:124 - -___ - -### put - -• **put**: [`AxiosRequestHeaders`](../modules/verida_account_web_vault._internal_.md#axiosrequestheaders) - -#### Defined in - -node_modules/axios/index.d.ts:121 - -___ - -### unlink - -• `Optional` **unlink**: [`AxiosRequestHeaders`](../modules/verida_account_web_vault._internal_.md#axiosrequestheaders) - -#### Defined in - -node_modules/axios/index.d.ts:126 diff --git a/docs/api/verida-js/interfaces/verida_account_web_vault._internal_.IAccount.md b/docs/api/verida-js/interfaces/verida_account_web_vault._internal_.IAccount.md deleted file mode 100644 index 538e3f5..0000000 --- a/docs/api/verida-js/interfaces/verida_account_web_vault._internal_.IAccount.md +++ /dev/null @@ -1,270 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account-web-vault](../modules/verida_account_web_vault.md) / [](../modules/verida_account_web_vault._internal_.md) / IAccount - -# Interface: IAccount - -[@verida/account-web-vault](../modules/verida_account_web_vault.md).[](../modules/verida_account_web_vault._internal_.md).IAccount - -## Implemented by - -- [`default`](../classes/verida_account_web_vault._internal_.default.md) - -## Table of contents - -### Methods - -- [createDidJwt](verida_account_web_vault._internal_.IAccount.md#createdidjwt) -- [did](verida_account_web_vault._internal_.IAccount.md#did) -- [disconnect](verida_account_web_vault._internal_.IAccount.md#disconnect) -- [disconnectDevice](verida_account_web_vault._internal_.IAccount.md#disconnectdevice) -- [getAuthContext](verida_account_web_vault._internal_.IAccount.md#getauthcontext) -- [keyring](verida_account_web_vault._internal_.IAccount.md#keyring) -- [linkStorage](verida_account_web_vault._internal_.IAccount.md#linkstorage) -- [linkStorageContextService](verida_account_web_vault._internal_.IAccount.md#linkstoragecontextservice) -- [setAccountConfig](verida_account_web_vault._internal_.IAccount.md#setaccountconfig) -- [sign](verida_account_web_vault._internal_.IAccount.md#sign) -- [storageConfig](verida_account_web_vault._internal_.IAccount.md#storageconfig) -- [unlinkStorage](verida_account_web_vault._internal_.IAccount.md#unlinkstorage) - -## Methods - -### createDidJwt - -▸ **createDidJwt**(`contextName`, `data`, `config`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | -| `data` | `object` | -| `config` | `any` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -packages/types/dist/IAccount.d.ts:13 - -___ - -### did - -▸ **did**(): `Promise`<`string`\> - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -packages/types/dist/IAccount.d.ts:7 - -___ - -### disconnect - -▸ **disconnect**(`contextName?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName?` | `string` | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -packages/types/dist/IAccount.d.ts:14 - -___ - -### disconnectDevice - -▸ **disconnectDevice**(`contextName`, `deviceId`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | -| `deviceId` | `string` | - -#### Returns - -`Promise`<`boolean`\> - -#### Defined in - -packages/types/dist/IAccount.d.ts:16 - -___ - -### getAuthContext - -▸ **getAuthContext**(`contextName`, `contextConfig`, `authConfig?`, `authType?`): `Promise`<[`AuthContext`](verida_account_web_vault._internal_.AuthContext.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | -| `contextConfig` | [`SecureContextConfig`](verida_account_web_vault._internal_.SecureContextConfig.md) | -| `authConfig?` | [`AuthTypeConfig`](verida_account_web_vault._internal_.AuthTypeConfig.md) | -| `authType?` | `string` | - -#### Returns - -`Promise`<[`AuthContext`](verida_account_web_vault._internal_.AuthContext.md)\> - -#### Defined in - -packages/types/dist/IAccount.d.ts:15 - -___ - -### keyring - -▸ **keyring**(`contextName`): `Promise`<[`IKeyring`](verida_account_web_vault._internal_.IKeyring.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | - -#### Returns - -`Promise`<[`IKeyring`](verida_account_web_vault._internal_.IKeyring.md)\> - -#### Defined in - -packages/types/dist/IAccount.d.ts:5 - -___ - -### linkStorage - -▸ **linkStorage**(`storageConfig`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `storageConfig` | [`SecureContextConfig`](verida_account_web_vault._internal_.SecureContextConfig.md) | - -#### Returns - -`Promise`<`boolean`\> - -#### Defined in - -packages/types/dist/IAccount.d.ts:8 - -___ - -### linkStorageContextService - -▸ **linkStorageContextService**(`contextName`, `endpointType`, `serverType`, `endpointUris`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | -| `endpointType` | `string` | -| `serverType` | `string` | -| `endpointUris` | `string`[] | - -#### Returns - -`Promise`<`boolean`\> - -#### Defined in - -packages/types/dist/IAccount.d.ts:11 - -___ - -### setAccountConfig - -▸ **setAccountConfig**(`accountConfig`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `accountConfig` | [`AccountConfig`](verida_account_web_vault._internal_.AccountConfig.md) | - -#### Returns - -`void` - -#### Defined in - -packages/types/dist/IAccount.d.ts:12 - -___ - -### sign - -▸ **sign**(`input`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `input` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -packages/types/dist/IAccount.d.ts:6 - -___ - -### storageConfig - -▸ **storageConfig**(`contextName`, `forceCreate`): `Promise`<`undefined` \| [`SecureContextConfig`](verida_account_web_vault._internal_.SecureContextConfig.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | -| `forceCreate` | `boolean` | - -#### Returns - -`Promise`<`undefined` \| [`SecureContextConfig`](verida_account_web_vault._internal_.SecureContextConfig.md)\> - -#### Defined in - -packages/types/dist/IAccount.d.ts:10 - -___ - -### unlinkStorage - -▸ **unlinkStorage**(`contextName`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | - -#### Returns - -`Promise`<`boolean`\> - -#### Defined in - -packages/types/dist/IAccount.d.ts:9 diff --git a/docs/api/verida-js/interfaces/verida_account_web_vault._internal_.IKeyring.md b/docs/api/verida-js/interfaces/verida_account_web_vault._internal_.IKeyring.md deleted file mode 100644 index 653535a..0000000 --- a/docs/api/verida-js/interfaces/verida_account_web_vault._internal_.IKeyring.md +++ /dev/null @@ -1,266 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account-web-vault](../modules/verida_account_web_vault.md) / [](../modules/verida_account_web_vault._internal_.md) / IKeyring - -# Interface: IKeyring - -[@verida/account-web-vault](../modules/verida_account_web_vault.md).[](../modules/verida_account_web_vault._internal_.md).IKeyring - -## Implemented by - -- [`default`](../classes/verida_account_web_vault._internal_.default-1.md) - -## Table of contents - -### Methods - -- [\_init](verida_account_web_vault._internal_.IKeyring.md#_init) -- [asymDecrypt](verida_account_web_vault._internal_.IKeyring.md#asymdecrypt) -- [asymEncrypt](verida_account_web_vault._internal_.IKeyring.md#asymencrypt) -- [buildSharedKeyEnd](verida_account_web_vault._internal_.IKeyring.md#buildsharedkeyend) -- [buildSharedKeyStart](verida_account_web_vault._internal_.IKeyring.md#buildsharedkeystart) -- [getKeys](verida_account_web_vault._internal_.IKeyring.md#getkeys) -- [getSeed](verida_account_web_vault._internal_.IKeyring.md#getseed) -- [getStorageContextKey](verida_account_web_vault._internal_.IKeyring.md#getstoragecontextkey) -- [publicKeys](verida_account_web_vault._internal_.IKeyring.md#publickeys) -- [sign](verida_account_web_vault._internal_.IKeyring.md#sign) -- [symDecrypt](verida_account_web_vault._internal_.IKeyring.md#symdecrypt) -- [symEncrypt](verida_account_web_vault._internal_.IKeyring.md#symencrypt) -- [verifySig](verida_account_web_vault._internal_.IKeyring.md#verifysig) - -## Methods - -### \_init - -▸ **_init**(): `Promise`<`void`\> - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:3 - -___ - -### asymDecrypt - -▸ **asymDecrypt**(`messageWithNonce`, `secretOrSharedKey`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `messageWithNonce` | `string` | -| `secretOrSharedKey` | `Uint8Array` | - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:10 - -___ - -### asymEncrypt - -▸ **asymEncrypt**(`data`, `secretOrSharedKey`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `string` | -| `secretOrSharedKey` | `Uint8Array` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:9 - -___ - -### buildSharedKeyEnd - -▸ **buildSharedKeyEnd**(`publicKey`): `Promise`<`Uint8Array`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `publicKey` | `Uint8Array` | - -#### Returns - -`Promise`<`Uint8Array`\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:12 - -___ - -### buildSharedKeyStart - -▸ **buildSharedKeyStart**(`privateKey`): `Promise`<`Uint8Array`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `privateKey` | `Uint8Array` | - -#### Returns - -`Promise`<`Uint8Array`\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:11 - -___ - -### getKeys - -▸ **getKeys**(): `Promise`<`any`\> - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:2 - -___ - -### getSeed - -▸ **getSeed**(): `string` - -#### Returns - -`string` - -#### Defined in - -packages/types/dist/IKeyring.d.ts:13 - -___ - -### getStorageContextKey - -▸ **getStorageContextKey**(`databaseName`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `databaseName` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:14 - -___ - -### publicKeys - -▸ **publicKeys**(): `Promise`<[`KeyringPublicKeys`](verida_account_web_vault._internal_.KeyringPublicKeys.md)\> - -#### Returns - -`Promise`<[`KeyringPublicKeys`](verida_account_web_vault._internal_.KeyringPublicKeys.md)\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:4 - -___ - -### sign - -▸ **sign**(`data`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `any` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:5 - -___ - -### symDecrypt - -▸ **symDecrypt**(`data`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `string` | - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:8 - -___ - -### symEncrypt - -▸ **symEncrypt**(`data`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:7 - -___ - -### verifySig - -▸ **verifySig**(`data`, `sig`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `string` | -| `sig` | `string` | - -#### Returns - -`Promise`<`boolean`\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:6 diff --git a/docs/api/verida-js/interfaces/verida_account_web_vault._internal_.KeyringPublicKeys.md b/docs/api/verida-js/interfaces/verida_account_web_vault._internal_.KeyringPublicKeys.md deleted file mode 100644 index 13a575c..0000000 --- a/docs/api/verida-js/interfaces/verida_account_web_vault._internal_.KeyringPublicKeys.md +++ /dev/null @@ -1,76 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account-web-vault](../modules/verida_account_web_vault.md) / [](../modules/verida_account_web_vault._internal_.md) / KeyringPublicKeys - -# Interface: KeyringPublicKeys - -[@verida/account-web-vault](../modules/verida_account_web_vault.md).[](../modules/verida_account_web_vault._internal_.md).KeyringPublicKeys - -## Table of contents - -### Properties - -- [asymPublicKey](verida_account_web_vault._internal_.KeyringPublicKeys.md#asympublickey) -- [asymPublicKeyBase58](verida_account_web_vault._internal_.KeyringPublicKeys.md#asympublickeybase58) -- [asymPublicKeyHex](verida_account_web_vault._internal_.KeyringPublicKeys.md#asympublickeyhex) -- [signPublicKey](verida_account_web_vault._internal_.KeyringPublicKeys.md#signpublickey) -- [signPublicKeyBase58](verida_account_web_vault._internal_.KeyringPublicKeys.md#signpublickeybase58) -- [signPublicKeyHex](verida_account_web_vault._internal_.KeyringPublicKeys.md#signpublickeyhex) - -## Properties - -### asymPublicKey - -• **asymPublicKey**: `Uint8Array` - -#### Defined in - -packages/types/dist/IKeyring.d.ts:17 - -___ - -### asymPublicKeyBase58 - -• **asymPublicKeyBase58**: `string` - -#### Defined in - -packages/types/dist/IKeyring.d.ts:19 - -___ - -### asymPublicKeyHex - -• **asymPublicKeyHex**: `string` - -#### Defined in - -packages/types/dist/IKeyring.d.ts:18 - -___ - -### signPublicKey - -• **signPublicKey**: `Uint8Array` - -#### Defined in - -packages/types/dist/IKeyring.d.ts:20 - -___ - -### signPublicKeyBase58 - -• **signPublicKeyBase58**: `string` - -#### Defined in - -packages/types/dist/IKeyring.d.ts:22 - -___ - -### signPublicKeyHex - -• **signPublicKeyHex**: `string` - -#### Defined in - -packages/types/dist/IKeyring.d.ts:21 diff --git a/docs/api/verida-js/interfaces/verida_account_web_vault._internal_.PromiseLike.md b/docs/api/verida-js/interfaces/verida_account_web_vault._internal_.PromiseLike.md deleted file mode 100644 index 642a02c..0000000 --- a/docs/api/verida-js/interfaces/verida_account_web_vault._internal_.PromiseLike.md +++ /dev/null @@ -1,49 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account-web-vault](../modules/verida_account_web_vault.md) / [](../modules/verida_account_web_vault._internal_.md) / PromiseLike - -# Interface: PromiseLike - -[@verida/account-web-vault](../modules/verida_account_web_vault.md).[](../modules/verida_account_web_vault._internal_.md).PromiseLike - -## Type parameters - -| Name | -| :------ | -| `T` | - -## Table of contents - -### Methods - -- [then](verida_account_web_vault._internal_.PromiseLike.md#then) - -## Methods - -### then - -▸ **then**<`TResult1`, `TResult2`\>(`onfulfilled?`, `onrejected?`): [`PromiseLike`](verida_account_web_vault._internal_.PromiseLike.md)<`TResult1` \| `TResult2`\> - -Attaches callbacks for the resolution and/or rejection of the Promise. - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `TResult1` | `T` | -| `TResult2` | `never` | - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `onfulfilled?` | ``null`` \| (`value`: `T`) => `TResult1` \| [`PromiseLike`](verida_account_web_vault._internal_.PromiseLike.md)<`TResult1`\> | The callback to execute when the Promise is resolved. | -| `onrejected?` | ``null`` \| (`reason`: `any`) => `TResult2` \| [`PromiseLike`](verida_account_web_vault._internal_.PromiseLike.md)<`TResult2`\> | The callback to execute when the Promise is rejected. | - -#### Returns - -[`PromiseLike`](verida_account_web_vault._internal_.PromiseLike.md)<`TResult1` \| `TResult2`\> - -A Promise for the completion of which ever callback is executed. - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1440 diff --git a/docs/api/verida-js/interfaces/verida_account_web_vault._internal_.SecureContextConfig.md b/docs/api/verida-js/interfaces/verida_account_web_vault._internal_.SecureContextConfig.md deleted file mode 100644 index 207dd69..0000000 --- a/docs/api/verida-js/interfaces/verida_account_web_vault._internal_.SecureContextConfig.md +++ /dev/null @@ -1,43 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account-web-vault](../modules/verida_account_web_vault.md) / [](../modules/verida_account_web_vault._internal_.md) / SecureContextConfig - -# Interface: SecureContextConfig - -[@verida/account-web-vault](../modules/verida_account_web_vault.md).[](../modules/verida_account_web_vault._internal_.md).SecureContextConfig - -## Table of contents - -### Properties - -- [id](verida_account_web_vault._internal_.SecureContextConfig.md#id) -- [publicKeys](verida_account_web_vault._internal_.SecureContextConfig.md#publickeys) -- [services](verida_account_web_vault._internal_.SecureContextConfig.md#services) - -## Properties - -### id - -• **id**: `string` - -#### Defined in - -packages/types/dist/StorageLinkInterfaces.d.ts:17 - -___ - -### publicKeys - -• **publicKeys**: [`SecureStorageContextPublicKeys`](verida_account_web_vault._internal_.SecureStorageContextPublicKeys.md) - -#### Defined in - -packages/types/dist/StorageLinkInterfaces.d.ts:18 - -___ - -### services - -• **services**: [`SecureContextServices`](verida_account_web_vault._internal_.SecureContextServices.md) - -#### Defined in - -packages/types/dist/StorageLinkInterfaces.d.ts:19 diff --git a/docs/api/verida-js/interfaces/verida_account_web_vault._internal_.SecureContextEndpoint.md b/docs/api/verida-js/interfaces/verida_account_web_vault._internal_.SecureContextEndpoint.md deleted file mode 100644 index 1a69bfe..0000000 --- a/docs/api/verida-js/interfaces/verida_account_web_vault._internal_.SecureContextEndpoint.md +++ /dev/null @@ -1,43 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account-web-vault](../modules/verida_account_web_vault.md) / [](../modules/verida_account_web_vault._internal_.md) / SecureContextEndpoint - -# Interface: SecureContextEndpoint - -[@verida/account-web-vault](../modules/verida_account_web_vault.md).[](../modules/verida_account_web_vault._internal_.md).SecureContextEndpoint - -## Table of contents - -### Properties - -- [config](verida_account_web_vault._internal_.SecureContextEndpoint.md#config) -- [endpointUri](verida_account_web_vault._internal_.SecureContextEndpoint.md#endpointuri) -- [type](verida_account_web_vault._internal_.SecureContextEndpoint.md#type) - -## Properties - -### config - -• `Optional` **config**: `object` - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:5 - -___ - -### endpointUri - -• **endpointUri**: [`ServiceEndpoint`](../modules/verida_account_web_vault._internal_.md#serviceendpoint)[] - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:4 - -___ - -### type - -• **type**: `string` - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:3 diff --git a/docs/api/verida-js/interfaces/verida_account_web_vault._internal_.SecureContextPublicKey.md b/docs/api/verida-js/interfaces/verida_account_web_vault._internal_.SecureContextPublicKey.md deleted file mode 100644 index 34df193..0000000 --- a/docs/api/verida-js/interfaces/verida_account_web_vault._internal_.SecureContextPublicKey.md +++ /dev/null @@ -1,32 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account-web-vault](../modules/verida_account_web_vault.md) / [](../modules/verida_account_web_vault._internal_.md) / SecureContextPublicKey - -# Interface: SecureContextPublicKey - -[@verida/account-web-vault](../modules/verida_account_web_vault.md).[](../modules/verida_account_web_vault._internal_.md).SecureContextPublicKey - -## Table of contents - -### Properties - -- [publicKeyHex](verida_account_web_vault._internal_.SecureContextPublicKey.md#publickeyhex) -- [type](verida_account_web_vault._internal_.SecureContextPublicKey.md#type) - -## Properties - -### publicKeyHex - -• **publicKeyHex**: `string` - -#### Defined in - -packages/types/dist/StorageLinkInterfaces.d.ts:4 - -___ - -### type - -• **type**: `string` - -#### Defined in - -packages/types/dist/StorageLinkInterfaces.d.ts:3 diff --git a/docs/api/verida-js/interfaces/verida_account_web_vault._internal_.SecureContextServices.md b/docs/api/verida-js/interfaces/verida_account_web_vault._internal_.SecureContextServices.md deleted file mode 100644 index a2d2b19..0000000 --- a/docs/api/verida-js/interfaces/verida_account_web_vault._internal_.SecureContextServices.md +++ /dev/null @@ -1,54 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account-web-vault](../modules/verida_account_web_vault.md) / [](../modules/verida_account_web_vault._internal_.md) / SecureContextServices - -# Interface: SecureContextServices - -[@verida/account-web-vault](../modules/verida_account_web_vault.md).[](../modules/verida_account_web_vault._internal_.md).SecureContextServices - -## Table of contents - -### Properties - -- [databaseServer](verida_account_web_vault._internal_.SecureContextServices.md#databaseserver) -- [messageServer](verida_account_web_vault._internal_.SecureContextServices.md#messageserver) -- [notificationServer](verida_account_web_vault._internal_.SecureContextServices.md#notificationserver) -- [storageServer](verida_account_web_vault._internal_.SecureContextServices.md#storageserver) - -## Properties - -### databaseServer - -• **databaseServer**: [`SecureContextEndpoint`](verida_account_web_vault._internal_.SecureContextEndpoint.md) - -#### Defined in - -packages/types/dist/StorageLinkInterfaces.d.ts:11 - -___ - -### messageServer - -• **messageServer**: [`SecureContextEndpoint`](verida_account_web_vault._internal_.SecureContextEndpoint.md) - -#### Defined in - -packages/types/dist/StorageLinkInterfaces.d.ts:12 - -___ - -### notificationServer - -• `Optional` **notificationServer**: [`SecureContextEndpoint`](verida_account_web_vault._internal_.SecureContextEndpoint.md) - -#### Defined in - -packages/types/dist/StorageLinkInterfaces.d.ts:14 - -___ - -### storageServer - -• `Optional` **storageServer**: [`SecureContextEndpoint`](verida_account_web_vault._internal_.SecureContextEndpoint.md) - -#### Defined in - -packages/types/dist/StorageLinkInterfaces.d.ts:13 diff --git a/docs/api/verida-js/interfaces/verida_account_web_vault._internal_.SecureStorageContextPublicKeys.md b/docs/api/verida-js/interfaces/verida_account_web_vault._internal_.SecureStorageContextPublicKeys.md deleted file mode 100644 index a022a98..0000000 --- a/docs/api/verida-js/interfaces/verida_account_web_vault._internal_.SecureStorageContextPublicKeys.md +++ /dev/null @@ -1,32 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account-web-vault](../modules/verida_account_web_vault.md) / [](../modules/verida_account_web_vault._internal_.md) / SecureStorageContextPublicKeys - -# Interface: SecureStorageContextPublicKeys - -[@verida/account-web-vault](../modules/verida_account_web_vault.md).[](../modules/verida_account_web_vault._internal_.md).SecureStorageContextPublicKeys - -## Table of contents - -### Properties - -- [asymKey](verida_account_web_vault._internal_.SecureStorageContextPublicKeys.md#asymkey) -- [signKey](verida_account_web_vault._internal_.SecureStorageContextPublicKeys.md#signkey) - -## Properties - -### asymKey - -• **asymKey**: [`SecureContextPublicKey`](verida_account_web_vault._internal_.SecureContextPublicKey.md) - -#### Defined in - -packages/types/dist/StorageLinkInterfaces.d.ts:7 - -___ - -### signKey - -• **signKey**: [`SecureContextPublicKey`](verida_account_web_vault._internal_.SecureContextPublicKey.md) - -#### Defined in - -packages/types/dist/StorageLinkInterfaces.d.ts:8 diff --git a/docs/api/verida-js/interfaces/verida_account_web_vault._internal_.TransitionalOptions.md b/docs/api/verida-js/interfaces/verida_account_web_vault._internal_.TransitionalOptions.md deleted file mode 100644 index 27a8a0e..0000000 --- a/docs/api/verida-js/interfaces/verida_account_web_vault._internal_.TransitionalOptions.md +++ /dev/null @@ -1,43 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account-web-vault](../modules/verida_account_web_vault.md) / [](../modules/verida_account_web_vault._internal_.md) / TransitionalOptions - -# Interface: TransitionalOptions - -[@verida/account-web-vault](../modules/verida_account_web_vault.md).[](../modules/verida_account_web_vault._internal_.md).TransitionalOptions - -## Table of contents - -### Properties - -- [clarifyTimeoutError](verida_account_web_vault._internal_.TransitionalOptions.md#clarifytimeouterror) -- [forcedJSONParsing](verida_account_web_vault._internal_.TransitionalOptions.md#forcedjsonparsing) -- [silentJSONParsing](verida_account_web_vault._internal_.TransitionalOptions.md#silentjsonparsing) - -## Properties - -### clarifyTimeoutError - -• `Optional` **clarifyTimeoutError**: `boolean` - -#### Defined in - -node_modules/axios/index.d.ts:72 - -___ - -### forcedJSONParsing - -• `Optional` **forcedJSONParsing**: `boolean` - -#### Defined in - -node_modules/axios/index.d.ts:71 - -___ - -### silentJSONParsing - -• `Optional` **silentJSONParsing**: `boolean` - -#### Defined in - -node_modules/axios/index.d.ts:70 diff --git a/docs/api/verida-js/interfaces/verida_account_web_vault._internal_.VaultAccountRequest.md b/docs/api/verida-js/interfaces/verida_account_web_vault._internal_.VaultAccountRequest.md deleted file mode 100644 index 40911d5..0000000 --- a/docs/api/verida-js/interfaces/verida_account_web_vault._internal_.VaultAccountRequest.md +++ /dev/null @@ -1,32 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account-web-vault](../modules/verida_account_web_vault.md) / [](../modules/verida_account_web_vault._internal_.md) / VaultAccountRequest - -# Interface: VaultAccountRequest - -[@verida/account-web-vault](../modules/verida_account_web_vault.md).[](../modules/verida_account_web_vault._internal_.md).VaultAccountRequest - -## Table of contents - -### Properties - -- [logoUrl](verida_account_web_vault._internal_.VaultAccountRequest.md#logourl) -- [openUrl](verida_account_web_vault._internal_.VaultAccountRequest.md#openurl) - -## Properties - -### logoUrl - -• `Optional` **logoUrl**: `string` - -#### Defined in - -[packages/account-web-vault/src/interfaces.ts:4](https://github.com/verida/verida-js/blob/c03b336/packages/account-web-vault/src/interfaces.ts#L4) - -___ - -### openUrl - -• `Optional` **openUrl**: `string` - -#### Defined in - -[packages/account-web-vault/src/interfaces.ts:5](https://github.com/verida/verida-js/blob/c03b336/packages/account-web-vault/src/interfaces.ts#L5) diff --git a/docs/api/verida-js/interfaces/verida_account_web_vault._internal_.VeridaDatabaseAuthContext.md b/docs/api/verida-js/interfaces/verida_account_web_vault._internal_.VeridaDatabaseAuthContext.md deleted file mode 100644 index 7b5d7db..0000000 --- a/docs/api/verida-js/interfaces/verida_account_web_vault._internal_.VeridaDatabaseAuthContext.md +++ /dev/null @@ -1,75 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account-web-vault](../modules/verida_account_web_vault.md) / [](../modules/verida_account_web_vault._internal_.md) / VeridaDatabaseAuthContext - -# Interface: VeridaDatabaseAuthContext - -[@verida/account-web-vault](../modules/verida_account_web_vault.md).[](../modules/verida_account_web_vault._internal_.md).VeridaDatabaseAuthContext - -## Hierarchy - -- [`AuthContext`](verida_account_web_vault._internal_.AuthContext.md) - - ↳ **`VeridaDatabaseAuthContext`** - -## Table of contents - -### Properties - -- [accessToken](verida_account_web_vault._internal_.VeridaDatabaseAuthContext.md#accesstoken) -- [endpointUri](verida_account_web_vault._internal_.VeridaDatabaseAuthContext.md#endpointuri) -- [host](verida_account_web_vault._internal_.VeridaDatabaseAuthContext.md#host) -- [publicSigningKey](verida_account_web_vault._internal_.VeridaDatabaseAuthContext.md#publicsigningkey) -- [refreshToken](verida_account_web_vault._internal_.VeridaDatabaseAuthContext.md#refreshtoken) - -## Properties - -### accessToken - -• `Optional` **accessToken**: `string` - -#### Defined in - -packages/types/dist/AccountInterfaces.d.ts:20 - -___ - -### endpointUri - -• **endpointUri**: [`ServiceEndpoint`](../modules/verida_account_web_vault._internal_.md#serviceendpoint) - -#### Defined in - -packages/types/dist/AccountInterfaces.d.ts:21 - -___ - -### host - -• **host**: `string` - -#### Defined in - -packages/types/dist/AccountInterfaces.d.ts:22 - -___ - -### publicSigningKey - -• **publicSigningKey**: [`SecureContextPublicKey`](verida_account_web_vault._internal_.SecureContextPublicKey.md) - -#### Inherited from - -[AuthContext](verida_account_web_vault._internal_.AuthContext.md).[publicSigningKey](verida_account_web_vault._internal_.AuthContext.md#publicsigningkey) - -#### Defined in - -packages/types/dist/AccountInterfaces.d.ts:13 - -___ - -### refreshToken - -• `Optional` **refreshToken**: `string` - -#### Defined in - -packages/types/dist/AccountInterfaces.d.ts:19 diff --git a/docs/api/verida-js/interfaces/verida_client_ts.ContextInterfaces.DatabaseOpenConfig.md b/docs/api/verida-js/interfaces/verida_client_ts.ContextInterfaces.DatabaseOpenConfig.md deleted file mode 100644 index c096c53..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts.ContextInterfaces.DatabaseOpenConfig.md +++ /dev/null @@ -1,148 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [ContextInterfaces](../modules/verida_client_ts.ContextInterfaces.md) / DatabaseOpenConfig - -# Interface: DatabaseOpenConfig - -[@verida/client-ts](../modules/verida_client_ts.md).[ContextInterfaces](../modules/verida_client_ts.ContextInterfaces.md).DatabaseOpenConfig - -Interface for any DatabaseOpenConfig - -## Table of contents - -### Properties - -- [contextName](verida_client_ts.ContextInterfaces.DatabaseOpenConfig.md#contextname) -- [createContext](verida_client_ts.ContextInterfaces.DatabaseOpenConfig.md#createcontext) -- [did](verida_client_ts.ContextInterfaces.DatabaseOpenConfig.md#did) -- [dsn](verida_client_ts.ContextInterfaces.DatabaseOpenConfig.md#dsn) -- [encryptionKey](verida_client_ts.ContextInterfaces.DatabaseOpenConfig.md#encryptionkey) -- [isOwner](verida_client_ts.ContextInterfaces.DatabaseOpenConfig.md#isowner) -- [permissions](verida_client_ts.ContextInterfaces.DatabaseOpenConfig.md#permissions) -- [readOnly](verida_client_ts.ContextInterfaces.DatabaseOpenConfig.md#readonly) -- [saveDatabase](verida_client_ts.ContextInterfaces.DatabaseOpenConfig.md#savedatabase) -- [signingContext](verida_client_ts.ContextInterfaces.DatabaseOpenConfig.md#signingcontext) - -## Properties - -### contextName - -• `Optional` **contextName**: `string` - -Optionally specify an external context to open - -#### Defined in - -[packages/client-ts/src/context/interfaces.ts:56](https://github.com/verida/verida-js/blob/c03b336/packages/client-ts/src/context/interfaces.ts#L56) - -___ - -### createContext - -• `Optional` **createContext**: `boolean` - -Create an application context if it doesn't already exist for the connected account. - -#### Defined in - -[packages/client-ts/src/context/interfaces.ts:51](https://github.com/verida/verida-js/blob/c03b336/packages/client-ts/src/context/interfaces.ts#L51) - -___ - -### did - -• `Optional` **did**: `string` - -Specify the DID that owns the database. - -This ensures the Verida client connects to the correct database server hosting the data for the specified `did`. - -#### Defined in - -[packages/client-ts/src/context/interfaces.ts:17](https://github.com/verida/verida-js/blob/c03b336/packages/client-ts/src/context/interfaces.ts#L17) - -___ - -### dsn - -• `Optional` **dsn**: `string` - -Specify a specific database connection string to use when opening the database. - -#### Defined in - -[packages/client-ts/src/context/interfaces.ts:22](https://github.com/verida/verida-js/blob/c03b336/packages/client-ts/src/context/interfaces.ts#L22) - -___ - -### encryptionKey - -• `Optional` **encryptionKey**: `Buffer` - -An optional encryption key to use for encyrpting / decrypting data. - -This encryption key will not apply if the database is marked as `public`. - -#### Defined in - -[packages/client-ts/src/context/interfaces.ts:46](https://github.com/verida/verida-js/blob/c03b336/packages/client-ts/src/context/interfaces.ts#L46) - -___ - -### isOwner - -• `Optional` **isOwner**: `boolean` - -Boolean indicating if it's expected the current connected account is the owner of this database. - -#### Defined in - -[packages/client-ts/src/context/interfaces.ts:39](https://github.com/verida/verida-js/blob/c03b336/packages/client-ts/src/context/interfaces.ts#L39) - -___ - -### permissions - -• `Optional` **permissions**: [`PermissionsConfig`](verida_client_ts.ContextInterfaces.PermissionsConfig.md) - -Specify the permissions to use when opening this database. - -#### Defined in - -[packages/client-ts/src/context/interfaces.ts:10](https://github.com/verida/verida-js/blob/c03b336/packages/client-ts/src/context/interfaces.ts#L10) - -___ - -### readOnly - -• `Optional` **readOnly**: `boolean` - -Open the database in read-only mode. - -This is useful when opening a database owned by an external `did` where the current authenticated account has no write access. - -#### Defined in - -[packages/client-ts/src/context/interfaces.ts:34](https://github.com/verida/verida-js/blob/c03b336/packages/client-ts/src/context/interfaces.ts#L34) - -___ - -### saveDatabase - -• `Optional` **saveDatabase**: `boolean` - -Save this database into the user's master list of opened databases. - -#### Defined in - -[packages/client-ts/src/context/interfaces.ts:27](https://github.com/verida/verida-js/blob/c03b336/packages/client-ts/src/context/interfaces.ts#L27) - -___ - -### signingContext - -• `Optional` **signingContext**: [`Context`](../classes/verida_client_ts.Context.md) - -Optionally specify the context used to sign data - -#### Defined in - -[packages/client-ts/src/context/interfaces.ts:61](https://github.com/verida/verida-js/blob/c03b336/packages/client-ts/src/context/interfaces.ts#L61) diff --git a/docs/api/verida-js/interfaces/verida_client_ts.ContextInterfaces.DatastoreOpenConfig.md b/docs/api/verida-js/interfaces/verida_client_ts.ContextInterfaces.DatastoreOpenConfig.md deleted file mode 100644 index e6b9a70..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts.ContextInterfaces.DatastoreOpenConfig.md +++ /dev/null @@ -1,111 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [ContextInterfaces](../modules/verida_client_ts.ContextInterfaces.md) / DatastoreOpenConfig - -# Interface: DatastoreOpenConfig - -[@verida/client-ts](../modules/verida_client_ts.md).[ContextInterfaces](../modules/verida_client_ts.ContextInterfaces.md).DatastoreOpenConfig - -Interface for any DatastoreOpenConfig - -## Table of contents - -### Properties - -- [contextName](verida_client_ts.ContextInterfaces.DatastoreOpenConfig.md#contextname) -- [createContext](verida_client_ts.ContextInterfaces.DatastoreOpenConfig.md#createcontext) -- [databaseName](verida_client_ts.ContextInterfaces.DatastoreOpenConfig.md#databasename) -- [did](verida_client_ts.ContextInterfaces.DatastoreOpenConfig.md#did) -- [encryptionKey](verida_client_ts.ContextInterfaces.DatastoreOpenConfig.md#encryptionkey) -- [external](verida_client_ts.ContextInterfaces.DatastoreOpenConfig.md#external) -- [permissions](verida_client_ts.ContextInterfaces.DatastoreOpenConfig.md#permissions) -- [readOnly](verida_client_ts.ContextInterfaces.DatastoreOpenConfig.md#readonly) -- [saveDatabase](verida_client_ts.ContextInterfaces.DatastoreOpenConfig.md#savedatabase) - -## Properties - -### contextName - -• `Optional` **contextName**: `string` - -#### Defined in - -[packages/client-ts/src/context/interfaces.ts:79](https://github.com/verida/verida-js/blob/c03b336/packages/client-ts/src/context/interfaces.ts#L79) - -___ - -### createContext - -• `Optional` **createContext**: `boolean` - -#### Defined in - -[packages/client-ts/src/context/interfaces.ts:77](https://github.com/verida/verida-js/blob/c03b336/packages/client-ts/src/context/interfaces.ts#L77) - -___ - -### databaseName - -• `Optional` **databaseName**: `string` - -#### Defined in - -[packages/client-ts/src/context/interfaces.ts:76](https://github.com/verida/verida-js/blob/c03b336/packages/client-ts/src/context/interfaces.ts#L76) - -___ - -### did - -• `Optional` **did**: `string` - -#### Defined in - -[packages/client-ts/src/context/interfaces.ts:72](https://github.com/verida/verida-js/blob/c03b336/packages/client-ts/src/context/interfaces.ts#L72) - -___ - -### encryptionKey - -• `Optional` **encryptionKey**: `string` - -#### Defined in - -[packages/client-ts/src/context/interfaces.ts:75](https://github.com/verida/verida-js/blob/c03b336/packages/client-ts/src/context/interfaces.ts#L75) - -___ - -### external - -• `Optional` **external**: `boolean` - -#### Defined in - -[packages/client-ts/src/context/interfaces.ts:78](https://github.com/verida/verida-js/blob/c03b336/packages/client-ts/src/context/interfaces.ts#L78) - -___ - -### permissions - -• `Optional` **permissions**: [`PermissionsConfig`](verida_client_ts.ContextInterfaces.PermissionsConfig.md) - -#### Defined in - -[packages/client-ts/src/context/interfaces.ts:71](https://github.com/verida/verida-js/blob/c03b336/packages/client-ts/src/context/interfaces.ts#L71) - -___ - -### readOnly - -• `Optional` **readOnly**: `boolean` - -#### Defined in - -[packages/client-ts/src/context/interfaces.ts:74](https://github.com/verida/verida-js/blob/c03b336/packages/client-ts/src/context/interfaces.ts#L74) - -___ - -### saveDatabase - -• `Optional` **saveDatabase**: `boolean` - -#### Defined in - -[packages/client-ts/src/context/interfaces.ts:73](https://github.com/verida/verida-js/blob/c03b336/packages/client-ts/src/context/interfaces.ts#L73) diff --git a/docs/api/verida-js/interfaces/verida_client_ts.ContextInterfaces.MessageSendConfig.md b/docs/api/verida-js/interfaces/verida_client_ts.ContextInterfaces.MessageSendConfig.md deleted file mode 100644 index 29fff4f..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts.ContextInterfaces.MessageSendConfig.md +++ /dev/null @@ -1,56 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [ContextInterfaces](../modules/verida_client_ts.ContextInterfaces.md) / MessageSendConfig - -# Interface: MessageSendConfig - -[@verida/client-ts](../modules/verida_client_ts.md).[ContextInterfaces](../modules/verida_client_ts.ContextInterfaces.md).MessageSendConfig - -Interface for any MessageSendConfig - -## Table of contents - -### Properties - -- [did](verida_client_ts.ContextInterfaces.MessageSendConfig.md#did) -- [expiry](verida_client_ts.ContextInterfaces.MessageSendConfig.md#expiry) -- [openUrl](verida_client_ts.ContextInterfaces.MessageSendConfig.md#openurl) -- [recipientContextName](verida_client_ts.ContextInterfaces.MessageSendConfig.md#recipientcontextname) - -## Properties - -### did - -• **did**: `string` - -#### Defined in - -[packages/client-ts/src/context/interfaces.ts:116](https://github.com/verida/verida-js/blob/c03b336/packages/client-ts/src/context/interfaces.ts#L116) - -___ - -### expiry - -• `Optional` **expiry**: [`Number`](../modules/verida_client_ts._internal_.md#number) - -#### Defined in - -[packages/client-ts/src/context/interfaces.ts:117](https://github.com/verida/verida-js/blob/c03b336/packages/client-ts/src/context/interfaces.ts#L117) - -___ - -### openUrl - -• `Optional` **openUrl**: `string` - -#### Defined in - -[packages/client-ts/src/context/interfaces.ts:119](https://github.com/verida/verida-js/blob/c03b336/packages/client-ts/src/context/interfaces.ts#L119) - -___ - -### recipientContextName - -• `Optional` **recipientContextName**: `string` - -#### Defined in - -[packages/client-ts/src/context/interfaces.ts:118](https://github.com/verida/verida-js/blob/c03b336/packages/client-ts/src/context/interfaces.ts#L118) diff --git a/docs/api/verida-js/interfaces/verida_client_ts.ContextInterfaces.MessagesConfig.md b/docs/api/verida-js/interfaces/verida_client_ts.ContextInterfaces.MessagesConfig.md deleted file mode 100644 index 3a70ef9..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts.ContextInterfaces.MessagesConfig.md +++ /dev/null @@ -1,23 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [ContextInterfaces](../modules/verida_client_ts.ContextInterfaces.md) / MessagesConfig - -# Interface: MessagesConfig - -[@verida/client-ts](../modules/verida_client_ts.md).[ContextInterfaces](../modules/verida_client_ts.ContextInterfaces.md).MessagesConfig - -Interface for any MessagesConfig - -## Table of contents - -### Properties - -- [maxItems](verida_client_ts.ContextInterfaces.MessagesConfig.md#maxitems) - -## Properties - -### maxItems - -• `Optional` **maxItems**: [`Number`](../modules/verida_client_ts._internal_.md#number) - -#### Defined in - -[packages/client-ts/src/context/interfaces.ts:86](https://github.com/verida/verida-js/blob/c03b336/packages/client-ts/src/context/interfaces.ts#L86) diff --git a/docs/api/verida-js/interfaces/verida_client_ts.ContextInterfaces.PermissionsConfig.md b/docs/api/verida-js/interfaces/verida_client_ts.ContextInterfaces.PermissionsConfig.md deleted file mode 100644 index 6f99d18..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts.ContextInterfaces.PermissionsConfig.md +++ /dev/null @@ -1,56 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [ContextInterfaces](../modules/verida_client_ts.ContextInterfaces.md) / PermissionsConfig - -# Interface: PermissionsConfig - -[@verida/client-ts](../modules/verida_client_ts.md).[ContextInterfaces](../modules/verida_client_ts.ContextInterfaces.md).PermissionsConfig - -Interface for any PermissionsConfig - -## Table of contents - -### Properties - -- [read](verida_client_ts.ContextInterfaces.PermissionsConfig.md#read) -- [readList](verida_client_ts.ContextInterfaces.PermissionsConfig.md#readlist) -- [write](verida_client_ts.ContextInterfaces.PermissionsConfig.md#write) -- [writeList](verida_client_ts.ContextInterfaces.PermissionsConfig.md#writelist) - -## Properties - -### read - -• **read**: [`PermissionOptionsEnum`](../enums/verida_client_ts.ContextInterfaces.PermissionOptionsEnum.md) - -#### Defined in - -[packages/client-ts/src/context/interfaces.ts:100](https://github.com/verida/verida-js/blob/c03b336/packages/client-ts/src/context/interfaces.ts#L100) - -___ - -### readList - -• `Optional` **readList**: `string`[] - -#### Defined in - -[packages/client-ts/src/context/interfaces.ts:102](https://github.com/verida/verida-js/blob/c03b336/packages/client-ts/src/context/interfaces.ts#L102) - -___ - -### write - -• **write**: [`PermissionOptionsEnum`](../enums/verida_client_ts.ContextInterfaces.PermissionOptionsEnum.md) - -#### Defined in - -[packages/client-ts/src/context/interfaces.ts:101](https://github.com/verida/verida-js/blob/c03b336/packages/client-ts/src/context/interfaces.ts#L101) - -___ - -### writeList - -• `Optional` **writeList**: `string`[] - -#### Defined in - -[packages/client-ts/src/context/interfaces.ts:103](https://github.com/verida/verida-js/blob/c03b336/packages/client-ts/src/context/interfaces.ts#L103) diff --git a/docs/api/verida-js/interfaces/verida_client_ts.ContextInterfaces.StorageEngineTypes.md b/docs/api/verida-js/interfaces/verida_client_ts.ContextInterfaces.StorageEngineTypes.md deleted file mode 100644 index 17c91f9..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts.ContextInterfaces.StorageEngineTypes.md +++ /dev/null @@ -1,11 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [ContextInterfaces](../modules/verida_client_ts.ContextInterfaces.md) / StorageEngineTypes - -# Interface: StorageEngineTypes - -[@verida/client-ts](../modules/verida_client_ts.md).[ContextInterfaces](../modules/verida_client_ts.ContextInterfaces.md).StorageEngineTypes - -Interface for any StorageEngineTypes - -## Indexable - -▪ [key: `string`]: `any` diff --git a/docs/api/verida-js/interfaces/verida_client_ts.Database.md b/docs/api/verida-js/interfaces/verida_client_ts.Database.md deleted file mode 100644 index 8d7b247..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts.Database.md +++ /dev/null @@ -1,219 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / Database - -# Interface: Database - -[@verida/client-ts](../modules/verida_client_ts.md).Database - -Interface for any database returned from a storage engine - -## Table of contents - -### Methods - -- [changes](verida_client_ts.Database.md#changes) -- [delete](verida_client_ts.Database.md#delete) -- [deleteAll](verida_client_ts.Database.md#deleteall) -- [get](verida_client_ts.Database.md#get) -- [getDb](verida_client_ts.Database.md#getdb) -- [getMany](verida_client_ts.Database.md#getmany) -- [info](verida_client_ts.Database.md#info) -- [init](verida_client_ts.Database.md#init) -- [registryEntry](verida_client_ts.Database.md#registryentry) -- [save](verida_client_ts.Database.md#save) -- [updateUsers](verida_client_ts.Database.md#updateusers) - -## Methods - -### changes - -▸ **changes**(`cb`, `options`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `cb` | `Function` | -| `options` | `any` | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -[packages/client-ts/src/context/database.ts:13](https://github.com/verida/verida-js/blob/c03b336/packages/client-ts/src/context/database.ts#L13) - -___ - -### delete - -▸ **delete**(`doc`, `options`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `doc` | `any` | -| `options` | `any` | - -#### Returns - -`Promise`<`boolean`\> - -#### Defined in - -[packages/client-ts/src/context/database.ts:11](https://github.com/verida/verida-js/blob/c03b336/packages/client-ts/src/context/database.ts#L11) - -___ - -### deleteAll - -▸ **deleteAll**(): `Promise`<`void`\> - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -[packages/client-ts/src/context/database.ts:12](https://github.com/verida/verida-js/blob/c03b336/packages/client-ts/src/context/database.ts#L12) - -___ - -### get - -▸ **get**(`docId`, `options`): `Promise`<`undefined` \| `object`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `docId` | `any` | -| `options` | `any` | - -#### Returns - -`Promise`<`undefined` \| `object`\> - -#### Defined in - -[packages/client-ts/src/context/database.ts:10](https://github.com/verida/verida-js/blob/c03b336/packages/client-ts/src/context/database.ts#L10) - -___ - -### getDb - -▸ **getDb**(): `Promise`<`any`\> - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -[packages/client-ts/src/context/database.ts:15](https://github.com/verida/verida-js/blob/c03b336/packages/client-ts/src/context/database.ts#L15) - -___ - -### getMany - -▸ **getMany**(`filter`, `options`): `Promise`<`undefined` \| `object`[]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `filter` | `any` | -| `options` | `any` | - -#### Returns - -`Promise`<`undefined` \| `object`[]\> - -#### Defined in - -[packages/client-ts/src/context/database.ts:9](https://github.com/verida/verida-js/blob/c03b336/packages/client-ts/src/context/database.ts#L9) - -___ - -### info - -▸ **info**(): `Promise`<`any`\> - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -[packages/client-ts/src/context/database.ts:17](https://github.com/verida/verida-js/blob/c03b336/packages/client-ts/src/context/database.ts#L17) - -___ - -### init - -▸ **init**(): `Promise`<`void`\> - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -[packages/client-ts/src/context/database.ts:16](https://github.com/verida/verida-js/blob/c03b336/packages/client-ts/src/context/database.ts#L16) - -___ - -### registryEntry - -▸ **registryEntry**(): `Promise`<[`DbRegistryEntry`](verida_client_ts._internal_.DbRegistryEntry.md)\> - -#### Returns - -`Promise`<[`DbRegistryEntry`](verida_client_ts._internal_.DbRegistryEntry.md)\> - -#### Defined in - -[packages/client-ts/src/context/database.ts:18](https://github.com/verida/verida-js/blob/c03b336/packages/client-ts/src/context/database.ts#L18) - -___ - -### save - -▸ **save**(`data`, `options`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `any` | -| `options` | `any` | - -#### Returns - -`Promise`<`boolean`\> - -#### Defined in - -[packages/client-ts/src/context/database.ts:8](https://github.com/verida/verida-js/blob/c03b336/packages/client-ts/src/context/database.ts#L8) - -___ - -### updateUsers - -▸ **updateUsers**(`readList`, `writeList`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `readList` | `string`[] | -| `writeList` | `string`[] | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -[packages/client-ts/src/context/database.ts:14](https://github.com/verida/verida-js/blob/c03b336/packages/client-ts/src/context/database.ts#L14) diff --git a/docs/api/verida-js/interfaces/verida_client_ts.DbRegistry.DbRegistryEntry.md b/docs/api/verida-js/interfaces/verida_client_ts.DbRegistry.DbRegistryEntry.md deleted file mode 100644 index 4bdf68e..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts.DbRegistry.DbRegistryEntry.md +++ /dev/null @@ -1,89 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [DbRegistry](../modules/verida_client_ts.DbRegistry.md) / DbRegistryEntry - -# Interface: DbRegistryEntry - -[@verida/client-ts](../modules/verida_client_ts.md).[DbRegistry](../modules/verida_client_ts.DbRegistry.md).DbRegistryEntry - -Interface for DbRegistryEntry - -## Table of contents - -### Properties - -- [contextName](verida_client_ts.DbRegistry.DbRegistryEntry.md#contextname) -- [dbHash](verida_client_ts.DbRegistry.DbRegistryEntry.md#dbhash) -- [dbName](verida_client_ts.DbRegistry.DbRegistryEntry.md#dbname) -- [did](verida_client_ts.DbRegistry.DbRegistryEntry.md#did) -- [encryptionKey](verida_client_ts.DbRegistry.DbRegistryEntry.md#encryptionkey) -- [endpointType](verida_client_ts.DbRegistry.DbRegistryEntry.md#endpointtype) -- [permissions](verida_client_ts.DbRegistry.DbRegistryEntry.md#permissions) - -## Properties - -### contextName - -• **contextName**: `string` - -#### Defined in - -[packages/client-ts/src/context/db-registry.ts:24](https://github.com/verida/verida-js/blob/fa48d0d/packages/client-ts/src/context/db-registry.ts#L24) - -___ - -### dbHash - -• **dbHash**: `string` - -#### Defined in - -[packages/client-ts/src/context/db-registry.ts:20](https://github.com/verida/verida-js/blob/fa48d0d/packages/client-ts/src/context/db-registry.ts#L20) - -___ - -### dbName - -• **dbName**: `string` - -#### Defined in - -[packages/client-ts/src/context/db-registry.ts:21](https://github.com/verida/verida-js/blob/fa48d0d/packages/client-ts/src/context/db-registry.ts#L21) - -___ - -### did - -• **did**: `string` - -#### Defined in - -[packages/client-ts/src/context/db-registry.ts:23](https://github.com/verida/verida-js/blob/fa48d0d/packages/client-ts/src/context/db-registry.ts#L23) - -___ - -### encryptionKey - -• `Optional` **encryptionKey**: [`DbRegistryEntryEncryptionKey`](verida_client_ts.DbRegistry.DbRegistryEntryEncryptionKey.md) - -#### Defined in - -[packages/client-ts/src/context/db-registry.ts:26](https://github.com/verida/verida-js/blob/fa48d0d/packages/client-ts/src/context/db-registry.ts#L26) - -___ - -### endpointType - -• **endpointType**: `string` - -#### Defined in - -[packages/client-ts/src/context/db-registry.ts:22](https://github.com/verida/verida-js/blob/fa48d0d/packages/client-ts/src/context/db-registry.ts#L22) - -___ - -### permissions - -• **permissions**: [`PermissionsConfig`](verida_client_ts.ContextInterfaces.PermissionsConfig.md) - -#### Defined in - -[packages/client-ts/src/context/db-registry.ts:25](https://github.com/verida/verida-js/blob/fa48d0d/packages/client-ts/src/context/db-registry.ts#L25) diff --git a/docs/api/verida-js/interfaces/verida_client_ts.DbRegistry.DbRegistryEntryEncryptionKey.md b/docs/api/verida-js/interfaces/verida_client_ts.DbRegistry.DbRegistryEntryEncryptionKey.md deleted file mode 100644 index 5711886..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts.DbRegistry.DbRegistryEntryEncryptionKey.md +++ /dev/null @@ -1,34 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [DbRegistry](../modules/verida_client_ts.DbRegistry.md) / DbRegistryEntryEncryptionKey - -# Interface: DbRegistryEntryEncryptionKey - -[@verida/client-ts](../modules/verida_client_ts.md).[DbRegistry](../modules/verida_client_ts.DbRegistry.md).DbRegistryEntryEncryptionKey - -Interface for DbRegistryEntryEncryptionKey - -## Table of contents - -### Properties - -- [key](verida_client_ts.DbRegistry.DbRegistryEntryEncryptionKey.md#key) -- [type](verida_client_ts.DbRegistry.DbRegistryEntryEncryptionKey.md#type) - -## Properties - -### key - -• **key**: `string` - -#### Defined in - -[packages/client-ts/src/context/db-registry.ts:12](https://github.com/verida/verida-js/blob/fa48d0d/packages/client-ts/src/context/db-registry.ts#L12) - -___ - -### type - -• **type**: `string` - -#### Defined in - -[packages/client-ts/src/context/db-registry.ts:13](https://github.com/verida/verida-js/blob/fa48d0d/packages/client-ts/src/context/db-registry.ts#L13) diff --git a/docs/api/verida-js/interfaces/verida_client_ts.Messaging.md b/docs/api/verida-js/interfaces/verida_client_ts.Messaging.md deleted file mode 100644 index 26cb951..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts.Messaging.md +++ /dev/null @@ -1,184 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / Messaging - -# Interface: Messaging - -[@verida/client-ts](../modules/verida_client_ts.md).Messaging - -Interface Messaging - -## Table of contents - -### Methods - -- [connectAccount](verida_client_ts.Messaging.md#connectaccount) -- [getInbox](verida_client_ts.Messaging.md#getinbox) -- [getMessages](verida_client_ts.Messaging.md#getmessages) -- [init](verida_client_ts.Messaging.md#init) -- [offMessage](verida_client_ts.Messaging.md#offmessage) -- [onMessage](verida_client_ts.Messaging.md#onmessage) -- [send](verida_client_ts.Messaging.md#send) - -## Methods - -### connectAccount - -▸ **connectAccount**(`account`): `Promise`<`void`\> - -Connect an account to this messaging instance. - -Used internally. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `account` | [`default`](../classes/verida_client_ts._internal_.default-1.md) | Account | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -[packages/client-ts/src/context/messaging.ts:78](https://github.com/verida/verida-js/blob/c03b336/packages/client-ts/src/context/messaging.ts#L78) - -___ - -### getInbox - -▸ **getInbox**(): `Promise`<`any`\> - -Get the underlying inbox instance specific for the message storage type. - -#### Returns - -`Promise`<`any`\> - -any Currently returns a `Datastore` instance. - -#### Defined in - -[packages/client-ts/src/context/messaging.ts:69](https://github.com/verida/verida-js/blob/c03b336/packages/client-ts/src/context/messaging.ts#L69) - -___ - -### getMessages - -▸ **getMessages**(`filter?`, `options?`): `Promise`<`any`\> - -Get messages from this inbox. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `filter?` | `object` | object An optional datastore filter | -| `options?` | `any` | object An optional list of datastore options | - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -[packages/client-ts/src/context/messaging.ts:62](https://github.com/verida/verida-js/blob/c03b336/packages/client-ts/src/context/messaging.ts#L62) - -___ - -### init - -▸ **init**(): `Promise`<`void`\> - -Initialize messaging for the connected user - -(ie; create an empty database or anything else required to start receiving messages) - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -[packages/client-ts/src/context/messaging.ts:13](https://github.com/verida/verida-js/blob/c03b336/packages/client-ts/src/context/messaging.ts#L13) - -___ - -### offMessage - -▸ **offMessage**(`callback`): `Promise`<`void`\> - -Unregister a callback to fire when a new message is received - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `callback` | `any` | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -[packages/client-ts/src/context/messaging.ts:54](https://github.com/verida/verida-js/blob/c03b336/packages/client-ts/src/context/messaging.ts#L54) - -___ - -### onMessage - -▸ **onMessage**(`callback`): `Promise`<[`EventEmitter`](verida_client_ts._internal_.EventEmitter.md)\> - -Register a callback to fire when a new message is received from another DID or application. - -Usage: - -``` -// configure the listener -const callback = (msg) => { console.log(msg) } -const emitter = messaging.onMessage(callback) -``` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `callback` | `any` | - -#### Returns - -`Promise`<[`EventEmitter`](verida_client_ts._internal_.EventEmitter.md)\> - -Returns an event emitter - -#### Defined in - -[packages/client-ts/src/context/messaging.ts:47](https://github.com/verida/verida-js/blob/c03b336/packages/client-ts/src/context/messaging.ts#L47) - -___ - -### send - -▸ **send**(`did`, `type`, `data`, `message`, `config`): `Promise`<``null`` \| `object`\> - -Send a message to another DID on the network. - -**`todo:`** Link to documentation - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `did` | `string` | string DID to receive the message | -| `type` | `string` | string Type of inbox message (See https://github.com/verida/schemas/tree/master/schemas/inbox/type). ie: `dataSend` | -| `data` | `object` | object Data to send. Structure of data will depend on the inbox message type. | -| `message` | `string` | string A human readable message that will be displayed to the user upon receipt of the message. Similar to an email subject. | -| `config` | [`MessageSendConfig`](verida_client_ts.ContextInterfaces.MessageSendConfig.md) | object Optional configuration. | - -#### Returns - -`Promise`<``null`` \| `object`\> - -#### Defined in - -[packages/client-ts/src/context/messaging.ts:26](https://github.com/verida/verida-js/blob/c03b336/packages/client-ts/src/context/messaging.ts#L26) diff --git a/docs/api/verida-js/interfaces/verida_client_ts.Notification.md b/docs/api/verida-js/interfaces/verida_client_ts.Notification.md deleted file mode 100644 index 205d691..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts.Notification.md +++ /dev/null @@ -1,71 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / Notification - -# Interface: Notification - -[@verida/client-ts](../modules/verida_client_ts.md).Notification - -Interface for notifications - -## Table of contents - -### Methods - -- [getErrors](verida_client_ts.Notification.md#geterrors) -- [init](verida_client_ts.Notification.md#init) -- [ping](verida_client_ts.Notification.md#ping) - -## Methods - -### getErrors - -▸ **getErrors**(): `string`[] - -#### Returns - -`string`[] - -#### Defined in - -[packages/client-ts/src/context/notification.ts:21](https://github.com/verida/verida-js/blob/039856c/packages/client-ts/src/context/notification.ts#L21) - -___ - -### init - -▸ **init**(): `Promise`<`void`\> - -Initialize notifications for the connected user - -(ie; connect to a notification server) - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -[packages/client-ts/src/context/notification.ts:13](https://github.com/verida/verida-js/blob/039856c/packages/client-ts/src/context/notification.ts#L13) - -___ - -### ping - -▸ **ping**(`recipientContextName`, `didToNotify`): `Promise`<`boolean`\> - -Ping a notification server to fetch new messages -TODO: Change this - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `recipientContextName` | `string` | -| `didToNotify` | `any` | - -#### Returns - -`Promise`<`boolean`\> - -#### Defined in - -[packages/client-ts/src/context/notification.ts:19](https://github.com/verida/verida-js/blob/039856c/packages/client-ts/src/context/notification.ts#L19) diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.AbortSignal.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.AbortSignal.md deleted file mode 100644 index e55bb7a..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.AbortSignal.md +++ /dev/null @@ -1,25 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / AbortSignal - -# Interface: AbortSignal - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).AbortSignal - -A signal object that allows you to communicate with a DOM request (such as a Fetch) and abort it if required via an AbortController object. - -## Table of contents - -### Properties - -- [aborted](verida_client_ts._internal_.AbortSignal.md#aborted) - -## Properties - -### aborted - -• `Readonly` **aborted**: `boolean` - -Returns true if this AbortSignal's AbortController has signaled to abort, and false otherwise. - -#### Defined in - -node_modules/@types/node/globals.d.ts:64 diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.AccountConfig.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.AccountConfig.md deleted file mode 100644 index 7385523..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.AccountConfig.md +++ /dev/null @@ -1,54 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / AccountConfig - -# Interface: AccountConfig - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).AccountConfig - -## Table of contents - -### Properties - -- [defaultDatabaseServer](verida_client_ts._internal_.AccountConfig.md#defaultdatabaseserver) -- [defaultMessageServer](verida_client_ts._internal_.AccountConfig.md#defaultmessageserver) -- [defaultNotificationServer](verida_client_ts._internal_.AccountConfig.md#defaultnotificationserver) -- [defaultStorageServer](verida_client_ts._internal_.AccountConfig.md#defaultstorageserver) - -## Properties - -### defaultDatabaseServer - -• **defaultDatabaseServer**: [`SecureContextEndpoint`](verida_client_ts._internal_.SecureContextEndpoint.md) - -#### Defined in - -packages/types/dist/AccountInterfaces.d.ts:7 - -___ - -### defaultMessageServer - -• **defaultMessageServer**: [`SecureContextEndpoint`](verida_client_ts._internal_.SecureContextEndpoint.md) - -#### Defined in - -packages/types/dist/AccountInterfaces.d.ts:8 - -___ - -### defaultNotificationServer - -• `Optional` **defaultNotificationServer**: [`SecureContextEndpoint`](verida_client_ts._internal_.SecureContextEndpoint.md) - -#### Defined in - -packages/types/dist/AccountInterfaces.d.ts:10 - -___ - -### defaultStorageServer - -• `Optional` **defaultStorageServer**: [`SecureContextEndpoint`](verida_client_ts._internal_.SecureContextEndpoint.md) - -#### Defined in - -packages/types/dist/AccountInterfaces.d.ts:9 diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.ArrayLike.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.ArrayLike.md deleted file mode 100644 index 0a9fb13..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.ArrayLike.md +++ /dev/null @@ -1,31 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / ArrayLike - -# Interface: ArrayLike - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).ArrayLike - -## Type parameters - -| Name | -| :------ | -| `T` | - -## Indexable - -▪ [n: `number`]: `T` - -## Table of contents - -### Properties - -- [length](verida_client_ts._internal_.ArrayLike.md#length) - -## Properties - -### length - -• `Readonly` **length**: `number` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1464 diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.AsyncFormatDefinition.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.AsyncFormatDefinition.md deleted file mode 100644 index 1bf1b42..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.AsyncFormatDefinition.md +++ /dev/null @@ -1,60 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / AsyncFormatDefinition - -# Interface: AsyncFormatDefinition - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).AsyncFormatDefinition - -## Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | extends `string` \| `number` | - -## Table of contents - -### Properties - -- [async](verida_client_ts._internal_.AsyncFormatDefinition.md#async) -- [compare](verida_client_ts._internal_.AsyncFormatDefinition.md#compare) -- [type](verida_client_ts._internal_.AsyncFormatDefinition.md#type) -- [validate](verida_client_ts._internal_.AsyncFormatDefinition.md#validate) - -## Properties - -### async - -• **async**: ``true`` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:166 - -___ - -### compare - -• `Optional` **compare**: [`FormatCompare`](../modules/verida_client_ts._internal_.md#formatcompare)<`T`\> - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:167 - -___ - -### type - -• `Optional` **type**: `T` extends `string` ? `undefined` \| ``"string"`` : ``"number"`` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:164 - -___ - -### validate - -• **validate**: [`AsyncFormatValidator`](../modules/verida_client_ts._internal_.md#asyncformatvalidator)<`T`\> - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:165 diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.AsyncIterableIterator.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.AsyncIterableIterator.md deleted file mode 100644 index a4dbd04..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.AsyncIterableIterator.md +++ /dev/null @@ -1,112 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / AsyncIterableIterator - -# Interface: AsyncIterableIterator - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).AsyncIterableIterator - -## Type parameters - -| Name | -| :------ | -| `T` | - -## Hierarchy - -- [`AsyncIterator`](verida_client_ts._internal_.AsyncIterator.md)<`T`\> - - ↳ **`AsyncIterableIterator`** - -## Table of contents - -### Methods - -- [[asyncIterator]](verida_client_ts._internal_.AsyncIterableIterator.md#[asynciterator]) -- [next](verida_client_ts._internal_.AsyncIterableIterator.md#next) -- [return](verida_client_ts._internal_.AsyncIterableIterator.md#return) -- [throw](verida_client_ts._internal_.AsyncIterableIterator.md#throw) - -## Methods - -### [asyncIterator] - -▸ **[asyncIterator]**(): [`AsyncIterableIterator`](verida_client_ts._internal_.AsyncIterableIterator.md)<`T`\> - -#### Returns - -[`AsyncIterableIterator`](verida_client_ts._internal_.AsyncIterableIterator.md)<`T`\> - -#### Defined in - -node_modules/typescript/lib/lib.es2018.asynciterable.d.ts:44 - -___ - -### next - -▸ **next**(...`args`): `Promise`<[`IteratorResult`](../modules/verida_client_ts._internal_.md#iteratorresult)<`T`, `any`\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `...args` | [] \| [`undefined`] | - -#### Returns - -`Promise`<[`IteratorResult`](../modules/verida_client_ts._internal_.md#iteratorresult)<`T`, `any`\>\> - -#### Inherited from - -[AsyncIterator](verida_client_ts._internal_.AsyncIterator.md).[next](verida_client_ts._internal_.AsyncIterator.md#next) - -#### Defined in - -node_modules/typescript/lib/lib.es2018.asynciterable.d.ts:34 - -___ - -### return - -▸ `Optional` **return**(`value?`): `Promise`<[`IteratorResult`](../modules/verida_client_ts._internal_.md#iteratorresult)<`T`, `any`\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value?` | `any` | - -#### Returns - -`Promise`<[`IteratorResult`](../modules/verida_client_ts._internal_.md#iteratorresult)<`T`, `any`\>\> - -#### Inherited from - -[AsyncIterator](verida_client_ts._internal_.AsyncIterator.md).[return](verida_client_ts._internal_.AsyncIterator.md#return) - -#### Defined in - -node_modules/typescript/lib/lib.es2018.asynciterable.d.ts:35 - -___ - -### throw - -▸ `Optional` **throw**(`e?`): `Promise`<[`IteratorResult`](../modules/verida_client_ts._internal_.md#iteratorresult)<`T`, `any`\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `e?` | `any` | - -#### Returns - -`Promise`<[`IteratorResult`](../modules/verida_client_ts._internal_.md#iteratorresult)<`T`, `any`\>\> - -#### Inherited from - -[AsyncIterator](verida_client_ts._internal_.AsyncIterator.md).[throw](verida_client_ts._internal_.AsyncIterator.md#throw) - -#### Defined in - -node_modules/typescript/lib/lib.es2018.asynciterable.d.ts:36 diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.AsyncIterator.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.AsyncIterator.md deleted file mode 100644 index 1f2c7bd..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.AsyncIterator.md +++ /dev/null @@ -1,87 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / AsyncIterator - -# Interface: AsyncIterator - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).AsyncIterator - -## Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `T` | -| `TReturn` | `any` | -| `TNext` | `undefined` | - -## Hierarchy - -- **`AsyncIterator`** - - ↳ [`AsyncIterableIterator`](verida_client_ts._internal_.AsyncIterableIterator.md) - -## Table of contents - -### Methods - -- [next](verida_client_ts._internal_.AsyncIterator.md#next) -- [return](verida_client_ts._internal_.AsyncIterator.md#return) -- [throw](verida_client_ts._internal_.AsyncIterator.md#throw) - -## Methods - -### next - -▸ **next**(...`args`): `Promise`<[`IteratorResult`](../modules/verida_client_ts._internal_.md#iteratorresult)<`T`, `TReturn`\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `...args` | [] \| [`TNext`] | - -#### Returns - -`Promise`<[`IteratorResult`](../modules/verida_client_ts._internal_.md#iteratorresult)<`T`, `TReturn`\>\> - -#### Defined in - -node_modules/typescript/lib/lib.es2018.asynciterable.d.ts:34 - -___ - -### return - -▸ `Optional` **return**(`value?`): `Promise`<[`IteratorResult`](../modules/verida_client_ts._internal_.md#iteratorresult)<`T`, `TReturn`\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value?` | `TReturn` \| [`PromiseLike`](verida_client_ts._internal_.PromiseLike.md)<`TReturn`\> | - -#### Returns - -`Promise`<[`IteratorResult`](../modules/verida_client_ts._internal_.md#iteratorresult)<`T`, `TReturn`\>\> - -#### Defined in - -node_modules/typescript/lib/lib.es2018.asynciterable.d.ts:35 - -___ - -### throw - -▸ `Optional` **throw**(`e?`): `Promise`<[`IteratorResult`](../modules/verida_client_ts._internal_.md#iteratorresult)<`T`, `TReturn`\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `e?` | `any` | - -#### Returns - -`Promise`<[`IteratorResult`](../modules/verida_client_ts._internal_.md#iteratorresult)<`T`, `TReturn`\>\> - -#### Defined in - -node_modules/typescript/lib/lib.es2018.asynciterable.d.ts:36 diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.AsyncSchema.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.AsyncSchema.md deleted file mode 100644 index f044378..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.AsyncSchema.md +++ /dev/null @@ -1,72 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / AsyncSchema - -# Interface: AsyncSchema - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).AsyncSchema - -## Hierarchy - -- [`_SchemaObject`](verida_client_ts._internal_._SchemaObject.md) - - ↳ **`AsyncSchema`** - -## Table of contents - -### Properties - -- [$async](verida_client_ts._internal_.AsyncSchema.md#$async) -- [$id](verida_client_ts._internal_.AsyncSchema.md#$id) -- [$schema](verida_client_ts._internal_.AsyncSchema.md#$schema) -- [id](verida_client_ts._internal_.AsyncSchema.md#id) - -## Properties - -### $async - -• **$async**: ``true`` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:21 - -___ - -### $id - -• `Optional` **$id**: `string` - -#### Inherited from - -[_SchemaObject](verida_client_ts._internal_._SchemaObject.md).[$id](verida_client_ts._internal_._SchemaObject.md#$id) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:9 - -___ - -### $schema - -• `Optional` **$schema**: `string` - -#### Inherited from - -[_SchemaObject](verida_client_ts._internal_._SchemaObject.md).[$schema](verida_client_ts._internal_._SchemaObject.md#$schema) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:10 - -___ - -### id - -• `Optional` **id**: `string` - -#### Inherited from - -[_SchemaObject](verida_client_ts._internal_._SchemaObject.md).[id](verida_client_ts._internal_._SchemaObject.md#id) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:8 diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.AsyncValidateFunction.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.AsyncValidateFunction.md deleted file mode 100644 index c627f65..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.AsyncValidateFunction.md +++ /dev/null @@ -1,147 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / AsyncValidateFunction - -# Interface: AsyncValidateFunction - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).AsyncValidateFunction - -## Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `unknown` | - -## Hierarchy - -- [`ValidateFunction`](verida_client_ts._internal_.ValidateFunction.md)<`T`\> - - ↳ **`AsyncValidateFunction`** - -## Callable - -### AsyncValidateFunction - -▸ **AsyncValidateFunction**(...`args`): `Promise`<`T`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `...args` | [data: any, dataCxt?: DataValidationCxt] | - -#### Returns - -`Promise`<`T`\> - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:70 - -### AsyncValidateFunction - -▸ **AsyncValidateFunction**(`data`, `dataCxt?`): data is T - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `any` | -| `dataCxt?` | [`DataValidationCxt`](verida_client_ts._internal_.DataValidationCxt.md)<`string` \| `number`\> | - -#### Returns - -data is T - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:47 - -## Table of contents - -### Properties - -- [$async](verida_client_ts._internal_.AsyncValidateFunction.md#$async) -- [errors](verida_client_ts._internal_.AsyncValidateFunction.md#errors) -- [evaluated](verida_client_ts._internal_.AsyncValidateFunction.md#evaluated) -- [schema](verida_client_ts._internal_.AsyncValidateFunction.md#schema) -- [schemaEnv](verida_client_ts._internal_.AsyncValidateFunction.md#schemaenv) -- [source](verida_client_ts._internal_.AsyncValidateFunction.md#source) - -## Properties - -### $async - -• **$async**: ``true`` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:71 - -___ - -### errors - -• `Optional` **errors**: ``null`` \| [`ErrorObject`](verida_client_ts._internal_.ErrorObject.md)<`string`, [`Record`](../modules/verida_client_ts._internal_.md#record)<`string`, `any`\>, `unknown`\>[] - -#### Inherited from - -[ValidateFunction](verida_client_ts._internal_.ValidateFunction.md).[errors](verida_client_ts._internal_.ValidateFunction.md#errors) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:48 - -___ - -### evaluated - -• `Optional` **evaluated**: [`Evaluated`](verida_client_ts._internal_.Evaluated.md) - -#### Inherited from - -[ValidateFunction](verida_client_ts._internal_.ValidateFunction.md).[evaluated](verida_client_ts._internal_.ValidateFunction.md#evaluated) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:49 - -___ - -### schema - -• **schema**: [`AnySchema`](../modules/verida_client_ts._internal_.md#anyschema) - -#### Inherited from - -[ValidateFunction](verida_client_ts._internal_.ValidateFunction.md).[schema](verida_client_ts._internal_.ValidateFunction.md#schema) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:50 - -___ - -### schemaEnv - -• **schemaEnv**: [`SchemaEnv`](../classes/verida_client_ts._internal_.SchemaEnv.md) - -#### Inherited from - -[ValidateFunction](verida_client_ts._internal_.ValidateFunction.md).[schemaEnv](verida_client_ts._internal_.ValidateFunction.md#schemaenv) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:51 - -___ - -### source - -• `Optional` **source**: [`SourceCode`](verida_client_ts._internal_.SourceCode.md) - -#### Inherited from - -[ValidateFunction](verida_client_ts._internal_.ValidateFunction.md).[source](verida_client_ts._internal_.ValidateFunction.md#source) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:52 diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.AuthContext.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.AuthContext.md deleted file mode 100644 index d2430de..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.AuthContext.md +++ /dev/null @@ -1,21 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / AuthContext - -# Interface: AuthContext - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).AuthContext - -## Table of contents - -### Properties - -- [publicSigningKey](verida_client_ts._internal_.AuthContext.md#publicsigningkey) - -## Properties - -### publicSigningKey - -• **publicSigningKey**: [`SecureContextPublicKey`](verida_client_ts._internal_.SecureContextPublicKey.md) - -#### Defined in - -packages/types/dist/AccountInterfaces.d.ts:13 diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.AuthTypeConfig.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.AuthTypeConfig.md deleted file mode 100644 index b570942..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.AuthTypeConfig.md +++ /dev/null @@ -1,21 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / AuthTypeConfig - -# Interface: AuthTypeConfig - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).AuthTypeConfig - -## Table of contents - -### Properties - -- [force](verida_client_ts._internal_.AuthTypeConfig.md#force) - -## Properties - -### force - -• `Optional` **force**: `boolean` - -#### Defined in - -packages/types/dist/AccountInterfaces.d.ts:16 diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.Block.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.Block.md deleted file mode 100644 index 04baf64..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.Block.md +++ /dev/null @@ -1,207 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / Block - -# Interface: Block - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).Block - -## Hierarchy - -- [`_Block`](verida_client_ts._internal_._Block.md) - - ↳ **`Block`** - -## Table of contents - -### Properties - -- [\_difficulty](verida_client_ts._internal_.Block.md#_difficulty) -- [baseFeePerGas](verida_client_ts._internal_.Block.md#basefeepergas) -- [difficulty](verida_client_ts._internal_.Block.md#difficulty) -- [extraData](verida_client_ts._internal_.Block.md#extradata) -- [gasLimit](verida_client_ts._internal_.Block.md#gaslimit) -- [gasUsed](verida_client_ts._internal_.Block.md#gasused) -- [hash](verida_client_ts._internal_.Block.md#hash) -- [miner](verida_client_ts._internal_.Block.md#miner) -- [nonce](verida_client_ts._internal_.Block.md#nonce) -- [number](verida_client_ts._internal_.Block.md#number) -- [parentHash](verida_client_ts._internal_.Block.md#parenthash) -- [timestamp](verida_client_ts._internal_.Block.md#timestamp) -- [transactions](verida_client_ts._internal_.Block.md#transactions) - -## Properties - -### \_difficulty - -• **\_difficulty**: [`BigNumber`](../classes/verida_client_ts._internal_.BigNumber.md) - -#### Inherited from - -[_Block](verida_client_ts._internal_._Block.md).[_difficulty](verida_client_ts._internal_._Block.md#_difficulty) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:41 - -___ - -### baseFeePerGas - -• `Optional` **baseFeePerGas**: ``null`` \| [`BigNumber`](../classes/verida_client_ts._internal_.BigNumber.md) - -#### Inherited from - -[_Block](verida_client_ts._internal_._Block.md).[baseFeePerGas](verida_client_ts._internal_._Block.md#basefeepergas) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:46 - -___ - -### difficulty - -• **difficulty**: `number` - -#### Inherited from - -[_Block](verida_client_ts._internal_._Block.md).[difficulty](verida_client_ts._internal_._Block.md#difficulty) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:40 - -___ - -### extraData - -• **extraData**: `string` - -#### Inherited from - -[_Block](verida_client_ts._internal_._Block.md).[extraData](verida_client_ts._internal_._Block.md#extradata) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:45 - -___ - -### gasLimit - -• **gasLimit**: [`BigNumber`](../classes/verida_client_ts._internal_.BigNumber.md) - -#### Inherited from - -[_Block](verida_client_ts._internal_._Block.md).[gasLimit](verida_client_ts._internal_._Block.md#gaslimit) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:42 - -___ - -### gasUsed - -• **gasUsed**: [`BigNumber`](../classes/verida_client_ts._internal_.BigNumber.md) - -#### Inherited from - -[_Block](verida_client_ts._internal_._Block.md).[gasUsed](verida_client_ts._internal_._Block.md#gasused) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:43 - -___ - -### hash - -• **hash**: `string` - -#### Inherited from - -[_Block](verida_client_ts._internal_._Block.md).[hash](verida_client_ts._internal_._Block.md#hash) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:35 - -___ - -### miner - -• **miner**: `string` - -#### Inherited from - -[_Block](verida_client_ts._internal_._Block.md).[miner](verida_client_ts._internal_._Block.md#miner) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:44 - -___ - -### nonce - -• **nonce**: `string` - -#### Inherited from - -[_Block](verida_client_ts._internal_._Block.md).[nonce](verida_client_ts._internal_._Block.md#nonce) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:39 - -___ - -### number - -• **number**: `number` - -#### Inherited from - -[_Block](verida_client_ts._internal_._Block.md).[number](verida_client_ts._internal_._Block.md#number) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:37 - -___ - -### parentHash - -• **parentHash**: `string` - -#### Inherited from - -[_Block](verida_client_ts._internal_._Block.md).[parentHash](verida_client_ts._internal_._Block.md#parenthash) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:36 - -___ - -### timestamp - -• **timestamp**: `number` - -#### Inherited from - -[_Block](verida_client_ts._internal_._Block.md).[timestamp](verida_client_ts._internal_._Block.md#timestamp) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:38 - -___ - -### transactions - -• **transactions**: `string`[] - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:49 diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.BlockWithTransactions.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.BlockWithTransactions.md deleted file mode 100644 index 7c2b611..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.BlockWithTransactions.md +++ /dev/null @@ -1,207 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / BlockWithTransactions - -# Interface: BlockWithTransactions - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).BlockWithTransactions - -## Hierarchy - -- [`_Block`](verida_client_ts._internal_._Block.md) - - ↳ **`BlockWithTransactions`** - -## Table of contents - -### Properties - -- [\_difficulty](verida_client_ts._internal_.BlockWithTransactions.md#_difficulty) -- [baseFeePerGas](verida_client_ts._internal_.BlockWithTransactions.md#basefeepergas) -- [difficulty](verida_client_ts._internal_.BlockWithTransactions.md#difficulty) -- [extraData](verida_client_ts._internal_.BlockWithTransactions.md#extradata) -- [gasLimit](verida_client_ts._internal_.BlockWithTransactions.md#gaslimit) -- [gasUsed](verida_client_ts._internal_.BlockWithTransactions.md#gasused) -- [hash](verida_client_ts._internal_.BlockWithTransactions.md#hash) -- [miner](verida_client_ts._internal_.BlockWithTransactions.md#miner) -- [nonce](verida_client_ts._internal_.BlockWithTransactions.md#nonce) -- [number](verida_client_ts._internal_.BlockWithTransactions.md#number) -- [parentHash](verida_client_ts._internal_.BlockWithTransactions.md#parenthash) -- [timestamp](verida_client_ts._internal_.BlockWithTransactions.md#timestamp) -- [transactions](verida_client_ts._internal_.BlockWithTransactions.md#transactions) - -## Properties - -### \_difficulty - -• **\_difficulty**: [`BigNumber`](../classes/verida_client_ts._internal_.BigNumber.md) - -#### Inherited from - -[_Block](verida_client_ts._internal_._Block.md).[_difficulty](verida_client_ts._internal_._Block.md#_difficulty) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:41 - -___ - -### baseFeePerGas - -• `Optional` **baseFeePerGas**: ``null`` \| [`BigNumber`](../classes/verida_client_ts._internal_.BigNumber.md) - -#### Inherited from - -[_Block](verida_client_ts._internal_._Block.md).[baseFeePerGas](verida_client_ts._internal_._Block.md#basefeepergas) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:46 - -___ - -### difficulty - -• **difficulty**: `number` - -#### Inherited from - -[_Block](verida_client_ts._internal_._Block.md).[difficulty](verida_client_ts._internal_._Block.md#difficulty) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:40 - -___ - -### extraData - -• **extraData**: `string` - -#### Inherited from - -[_Block](verida_client_ts._internal_._Block.md).[extraData](verida_client_ts._internal_._Block.md#extradata) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:45 - -___ - -### gasLimit - -• **gasLimit**: [`BigNumber`](../classes/verida_client_ts._internal_.BigNumber.md) - -#### Inherited from - -[_Block](verida_client_ts._internal_._Block.md).[gasLimit](verida_client_ts._internal_._Block.md#gaslimit) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:42 - -___ - -### gasUsed - -• **gasUsed**: [`BigNumber`](../classes/verida_client_ts._internal_.BigNumber.md) - -#### Inherited from - -[_Block](verida_client_ts._internal_._Block.md).[gasUsed](verida_client_ts._internal_._Block.md#gasused) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:43 - -___ - -### hash - -• **hash**: `string` - -#### Inherited from - -[_Block](verida_client_ts._internal_._Block.md).[hash](verida_client_ts._internal_._Block.md#hash) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:35 - -___ - -### miner - -• **miner**: `string` - -#### Inherited from - -[_Block](verida_client_ts._internal_._Block.md).[miner](verida_client_ts._internal_._Block.md#miner) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:44 - -___ - -### nonce - -• **nonce**: `string` - -#### Inherited from - -[_Block](verida_client_ts._internal_._Block.md).[nonce](verida_client_ts._internal_._Block.md#nonce) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:39 - -___ - -### number - -• **number**: `number` - -#### Inherited from - -[_Block](verida_client_ts._internal_._Block.md).[number](verida_client_ts._internal_._Block.md#number) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:37 - -___ - -### parentHash - -• **parentHash**: `string` - -#### Inherited from - -[_Block](verida_client_ts._internal_._Block.md).[parentHash](verida_client_ts._internal_._Block.md#parenthash) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:36 - -___ - -### timestamp - -• **timestamp**: `number` - -#### Inherited from - -[_Block](verida_client_ts._internal_._Block.md).[timestamp](verida_client_ts._internal_._Block.md#timestamp) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:38 - -___ - -### transactions - -• **transactions**: [`TransactionResponse`](verida_client_ts._internal_.TransactionResponse.md)[] - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:52 diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.BoxKeyPair.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.BoxKeyPair.md deleted file mode 100644 index 96bc5c2..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.BoxKeyPair.md +++ /dev/null @@ -1,32 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / BoxKeyPair - -# Interface: BoxKeyPair - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).BoxKeyPair - -## Table of contents - -### Properties - -- [publicKey](verida_client_ts._internal_.BoxKeyPair.md#publickey) -- [secretKey](verida_client_ts._internal_.BoxKeyPair.md#secretkey) - -## Properties - -### publicKey - -• **publicKey**: `Uint8Array` - -#### Defined in - -node_modules/tweetnacl/nacl.d.ts:10 - -___ - -### secretKey - -• **secretKey**: `Uint8Array` - -#### Defined in - -node_modules/tweetnacl/nacl.d.ts:11 diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.CallSite.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.CallSite.md deleted file mode 100644 index 39a7ae5..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.CallSite.md +++ /dev/null @@ -1,238 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / CallSite - -# Interface: CallSite - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).CallSite - -## Table of contents - -### Methods - -- [getColumnNumber](verida_client_ts._internal_.CallSite.md#getcolumnnumber) -- [getEvalOrigin](verida_client_ts._internal_.CallSite.md#getevalorigin) -- [getFileName](verida_client_ts._internal_.CallSite.md#getfilename) -- [getFunction](verida_client_ts._internal_.CallSite.md#getfunction) -- [getFunctionName](verida_client_ts._internal_.CallSite.md#getfunctionname) -- [getLineNumber](verida_client_ts._internal_.CallSite.md#getlinenumber) -- [getMethodName](verida_client_ts._internal_.CallSite.md#getmethodname) -- [getThis](verida_client_ts._internal_.CallSite.md#getthis) -- [getTypeName](verida_client_ts._internal_.CallSite.md#gettypename) -- [isConstructor](verida_client_ts._internal_.CallSite.md#isconstructor) -- [isEval](verida_client_ts._internal_.CallSite.md#iseval) -- [isNative](verida_client_ts._internal_.CallSite.md#isnative) -- [isToplevel](verida_client_ts._internal_.CallSite.md#istoplevel) - -## Methods - -### getColumnNumber - -▸ **getColumnNumber**(): ``null`` \| `number` - -Current column number [if this function was defined in a script] - -#### Returns - -``null`` \| `number` - -#### Defined in - -node_modules/@types/node/globals.d.ts:154 - -___ - -### getEvalOrigin - -▸ **getEvalOrigin**(): `undefined` \| `string` - -A call site object representing the location where eval was called -[if this function was created using a call to eval] - -#### Returns - -`undefined` \| `string` - -#### Defined in - -node_modules/@types/node/globals.d.ts:160 - -___ - -### getFileName - -▸ **getFileName**(): ``null`` \| `string` - -Name of the script [if this function was defined in a script] - -#### Returns - -``null`` \| `string` - -#### Defined in - -node_modules/@types/node/globals.d.ts:144 - -___ - -### getFunction - -▸ **getFunction**(): `undefined` \| `Function` - -Current function - -#### Returns - -`undefined` \| `Function` - -#### Defined in - -node_modules/@types/node/globals.d.ts:126 - -___ - -### getFunctionName - -▸ **getFunctionName**(): ``null`` \| `string` - -Name of the current function, typically its name property. -If a name property is not available an attempt will be made to try -to infer a name from the function's context. - -#### Returns - -``null`` \| `string` - -#### Defined in - -node_modules/@types/node/globals.d.ts:133 - -___ - -### getLineNumber - -▸ **getLineNumber**(): ``null`` \| `number` - -Current line number [if this function was defined in a script] - -#### Returns - -``null`` \| `number` - -#### Defined in - -node_modules/@types/node/globals.d.ts:149 - -___ - -### getMethodName - -▸ **getMethodName**(): ``null`` \| `string` - -Name of the property [of "this" or one of its prototypes] that holds -the current function - -#### Returns - -``null`` \| `string` - -#### Defined in - -node_modules/@types/node/globals.d.ts:139 - -___ - -### getThis - -▸ **getThis**(): `unknown` - -Value of "this" - -#### Returns - -`unknown` - -#### Defined in - -node_modules/@types/node/globals.d.ts:113 - -___ - -### getTypeName - -▸ **getTypeName**(): ``null`` \| `string` - -Type of "this" as a string. -This is the name of the function stored in the constructor field of -"this", if available. Otherwise the object's [[Class]] internal -property. - -#### Returns - -``null`` \| `string` - -#### Defined in - -node_modules/@types/node/globals.d.ts:121 - -___ - -### isConstructor - -▸ **isConstructor**(): `boolean` - -Is this a constructor call? - -#### Returns - -`boolean` - -#### Defined in - -node_modules/@types/node/globals.d.ts:180 - -___ - -### isEval - -▸ **isEval**(): `boolean` - -Does this call take place in code defined by a call to eval? - -#### Returns - -`boolean` - -#### Defined in - -node_modules/@types/node/globals.d.ts:170 - -___ - -### isNative - -▸ **isNative**(): `boolean` - -Is this call in native V8 code? - -#### Returns - -`boolean` - -#### Defined in - -node_modules/@types/node/globals.d.ts:175 - -___ - -### isToplevel - -▸ **isToplevel**(): `boolean` - -Is this a toplevel invocation, that is, is "this" the global object? - -#### Returns - -`boolean` - -#### Defined in - -node_modules/@types/node/globals.d.ts:165 diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.ClientConfig.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.ClientConfig.md deleted file mode 100644 index 016edec..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.ClientConfig.md +++ /dev/null @@ -1,64 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / ClientConfig - -# Interface: ClientConfig - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).ClientConfig - -Interface for ClientConfig - -## Table of contents - -### Properties - -- [didClientConfig](verida_client_ts._internal_.ClientConfig.md#didclientconfig) -- [environment](verida_client_ts._internal_.ClientConfig.md#environment) -- [schemaPaths](verida_client_ts._internal_.ClientConfig.md#schemapaths) -- [vaultAppName](verida_client_ts._internal_.ClientConfig.md#vaultappname) - -## Properties - -### didClientConfig - -• `Optional` **didClientConfig**: [`DIDClientConfig`](verida_client_ts._internal_.DIDClientConfig.md) - -#### Defined in - -packages/types/dist/NetworkInterfaces.d.ts:39 - -___ - -### environment - -• `Optional` **environment**: [`EnvironmentType`](../enums/verida_client_ts._internal_.EnvironmentType.md) - -Environment to load by default. - -Environment configuration can still be overridden by config items. - -#### Defined in - -packages/types/dist/NetworkInterfaces.d.ts:38 - -___ - -### schemaPaths - -• `Optional` **schemaPaths**: `object` - -Specify custom schema paths (typically for local development). - -#### Defined in - -packages/types/dist/NetworkInterfaces.d.ts:43 - -___ - -### vaultAppName - -• `Optional` **vaultAppName**: `string` - -Specify client's App name. - -#### Defined in - -packages/types/dist/NetworkInterfaces.d.ts:32 diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.CodeGenOptions.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.CodeGenOptions.md deleted file mode 100644 index b747a00..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.CodeGenOptions.md +++ /dev/null @@ -1,43 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / CodeGenOptions - -# Interface: CodeGenOptions - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).CodeGenOptions - -## Table of contents - -### Properties - -- [es5](verida_client_ts._internal_.CodeGenOptions.md#es5) -- [lines](verida_client_ts._internal_.CodeGenOptions.md#lines) -- [ownProperties](verida_client_ts._internal_.CodeGenOptions.md#ownproperties) - -## Properties - -### es5 - -• `Optional` **es5**: `boolean` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/index.d.ts:21 - -___ - -### lines - -• `Optional` **lines**: `boolean` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/index.d.ts:22 - -___ - -### ownProperties - -• `Optional` **ownProperties**: `boolean` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/index.d.ts:23 diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.CodeKeywordDefinition.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.CodeKeywordDefinition.md deleted file mode 100644 index b011ec0..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.CodeKeywordDefinition.md +++ /dev/null @@ -1,247 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / CodeKeywordDefinition - -# Interface: CodeKeywordDefinition - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).CodeKeywordDefinition - -## Hierarchy - -- [`_KeywordDef`](verida_client_ts._internal_._KeywordDef.md) - - ↳ **`CodeKeywordDefinition`** - -## Table of contents - -### Properties - -- [$data](verida_client_ts._internal_.CodeKeywordDefinition.md#$data) -- [$dataError](verida_client_ts._internal_.CodeKeywordDefinition.md#$dataerror) -- [allowUndefined](verida_client_ts._internal_.CodeKeywordDefinition.md#allowundefined) -- [before](verida_client_ts._internal_.CodeKeywordDefinition.md#before) -- [dependencies](verida_client_ts._internal_.CodeKeywordDefinition.md#dependencies) -- [error](verida_client_ts._internal_.CodeKeywordDefinition.md#error) -- [implements](verida_client_ts._internal_.CodeKeywordDefinition.md#implements) -- [keyword](verida_client_ts._internal_.CodeKeywordDefinition.md#keyword) -- [metaSchema](verida_client_ts._internal_.CodeKeywordDefinition.md#metaschema) -- [post](verida_client_ts._internal_.CodeKeywordDefinition.md#post) -- [schemaType](verida_client_ts._internal_.CodeKeywordDefinition.md#schematype) -- [trackErrors](verida_client_ts._internal_.CodeKeywordDefinition.md#trackerrors) -- [type](verida_client_ts._internal_.CodeKeywordDefinition.md#type) -- [validateSchema](verida_client_ts._internal_.CodeKeywordDefinition.md#validateschema) - -### Methods - -- [code](verida_client_ts._internal_.CodeKeywordDefinition.md#code) - -## Properties - -### $data - -• `Optional` **$data**: `boolean` - -#### Inherited from - -[_KeywordDef](verida_client_ts._internal_._KeywordDef.md).[$data](verida_client_ts._internal_._KeywordDef.md#$data) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:91 - -___ - -### $dataError - -• `Optional` **$dataError**: [`KeywordErrorDefinition`](verida_client_ts._internal_.KeywordErrorDefinition.md) - -#### Inherited from - -[_KeywordDef](verida_client_ts._internal_._KeywordDef.md).[$dataError](verida_client_ts._internal_._KeywordDef.md#$dataerror) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:99 - -___ - -### allowUndefined - -• `Optional` **allowUndefined**: `boolean` - -#### Inherited from - -[_KeywordDef](verida_client_ts._internal_._KeywordDef.md).[allowUndefined](verida_client_ts._internal_._KeywordDef.md#allowundefined) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:90 - -___ - -### before - -• `Optional` **before**: `string` - -#### Inherited from - -[_KeywordDef](verida_client_ts._internal_._KeywordDef.md).[before](verida_client_ts._internal_._KeywordDef.md#before) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:93 - -___ - -### dependencies - -• `Optional` **dependencies**: `string`[] - -#### Inherited from - -[_KeywordDef](verida_client_ts._internal_._KeywordDef.md).[dependencies](verida_client_ts._internal_._KeywordDef.md#dependencies) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:97 - -___ - -### error - -• `Optional` **error**: [`KeywordErrorDefinition`](verida_client_ts._internal_.KeywordErrorDefinition.md) - -#### Inherited from - -[_KeywordDef](verida_client_ts._internal_._KeywordDef.md).[error](verida_client_ts._internal_._KeywordDef.md#error) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:98 - -___ - -### implements - -• `Optional` **implements**: `string`[] - -#### Inherited from - -[_KeywordDef](verida_client_ts._internal_._KeywordDef.md).[implements](verida_client_ts._internal_._KeywordDef.md#implements) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:92 - -___ - -### keyword - -• **keyword**: `string` \| `string`[] - -#### Inherited from - -[_KeywordDef](verida_client_ts._internal_._KeywordDef.md).[keyword](verida_client_ts._internal_._KeywordDef.md#keyword) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:87 - -___ - -### metaSchema - -• `Optional` **metaSchema**: [`AnySchemaObject`](../modules/verida_client_ts._internal_.md#anyschemaobject) - -#### Inherited from - -[_KeywordDef](verida_client_ts._internal_._KeywordDef.md).[metaSchema](verida_client_ts._internal_._KeywordDef.md#metaschema) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:95 - -___ - -### post - -• `Optional` **post**: `boolean` - -#### Inherited from - -[_KeywordDef](verida_client_ts._internal_._KeywordDef.md).[post](verida_client_ts._internal_._KeywordDef.md#post) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:94 - -___ - -### schemaType - -• `Optional` **schemaType**: ``"string"`` \| ``"number"`` \| ``"boolean"`` \| ``"object"`` \| ``"integer"`` \| ``"array"`` \| ``"null"`` \| (``"string"`` \| ``"number"`` \| ``"boolean"`` \| ``"object"`` \| ``"integer"`` \| ``"array"`` \| ``"null"``)[] - -#### Inherited from - -[_KeywordDef](verida_client_ts._internal_._KeywordDef.md).[schemaType](verida_client_ts._internal_._KeywordDef.md#schematype) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:89 - -___ - -### trackErrors - -• `Optional` **trackErrors**: `boolean` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:103 - -___ - -### type - -• `Optional` **type**: ``"string"`` \| ``"number"`` \| ``"boolean"`` \| ``"object"`` \| ``"integer"`` \| ``"array"`` \| ``"null"`` \| (``"string"`` \| ``"number"`` \| ``"boolean"`` \| ``"object"`` \| ``"integer"`` \| ``"array"`` \| ``"null"``)[] - -#### Inherited from - -[_KeywordDef](verida_client_ts._internal_._KeywordDef.md).[type](verida_client_ts._internal_._KeywordDef.md#type) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:88 - -___ - -### validateSchema - -• `Optional` **validateSchema**: [`AnyValidateFunction`](../modules/verida_client_ts._internal_.md#anyvalidatefunction)<`any`\> - -#### Inherited from - -[_KeywordDef](verida_client_ts._internal_._KeywordDef.md).[validateSchema](verida_client_ts._internal_._KeywordDef.md#validateschema) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:96 - -## Methods - -### code - -▸ **code**(`cxt`, `ruleType?`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `cxt` | [`KeywordCxt`](../classes/verida_client_ts._internal_.KeywordCxt.md) | -| `ruleType?` | `string` | - -#### Returns - -`void` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:102 diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.CodeOptions.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.CodeOptions.md deleted file mode 100644 index d5cdae9..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.CodeOptions.md +++ /dev/null @@ -1,118 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / CodeOptions - -# Interface: CodeOptions - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).CodeOptions - -## Hierarchy - -- **`CodeOptions`** - - ↳ [`InstanceCodeOptions`](verida_client_ts._internal_.InstanceCodeOptions.md) - -## Table of contents - -### Properties - -- [es5](verida_client_ts._internal_.CodeOptions.md#es5) -- [esm](verida_client_ts._internal_.CodeOptions.md#esm) -- [formats](verida_client_ts._internal_.CodeOptions.md#formats) -- [lines](verida_client_ts._internal_.CodeOptions.md#lines) -- [optimize](verida_client_ts._internal_.CodeOptions.md#optimize) -- [regExp](verida_client_ts._internal_.CodeOptions.md#regexp) -- [source](verida_client_ts._internal_.CodeOptions.md#source) - -### Methods - -- [process](verida_client_ts._internal_.CodeOptions.md#process) - -## Properties - -### es5 - -• `Optional` **es5**: `boolean` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:74 - -___ - -### esm - -• `Optional` **esm**: `boolean` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:75 - -___ - -### formats - -• `Optional` **formats**: [`Code`](../modules/verida_client_ts._internal_.md#code) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:78 - -___ - -### lines - -• `Optional` **lines**: `boolean` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:76 - -___ - -### optimize - -• `Optional` **optimize**: `number` \| `boolean` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:77 - -___ - -### regExp - -• `Optional` **regExp**: [`RegExpEngine`](verida_client_ts._internal_.RegExpEngine.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:81 - -___ - -### source - -• `Optional` **source**: `boolean` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:79 - -## Methods - -### process - -▸ `Optional` **process**(`code`, `schema?`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `code` | `string` | -| `schema?` | [`SchemaEnv`](../classes/verida_client_ts._internal_.SchemaEnv.md) | - -#### Returns - -`string` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:80 diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.ContextCloseOptions.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.ContextCloseOptions.md deleted file mode 100644 index 9dd1b62..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.ContextCloseOptions.md +++ /dev/null @@ -1,27 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / ContextCloseOptions - -# Interface: ContextCloseOptions - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).ContextCloseOptions - -## Hierarchy - -- **`ContextCloseOptions`** - - ↳ [`DatabaseCloseOptions`](verida_client_ts._internal_.DatabaseCloseOptions.md) - -## Table of contents - -### Properties - -- [clearLocal](verida_client_ts._internal_.ContextCloseOptions.md#clearlocal) - -## Properties - -### clearLocal - -• `Optional` **clearLocal**: `boolean` - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:71 diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.ContextConfig.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.ContextConfig.md deleted file mode 100644 index 33acb9e..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.ContextConfig.md +++ /dev/null @@ -1,34 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / ContextConfig - -# Interface: ContextConfig - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).ContextConfig - -Interface for ContextConfig - -## Table of contents - -### Properties - -- [forceCreate](verida_client_ts._internal_.ContextConfig.md#forcecreate) -- [name](verida_client_ts._internal_.ContextConfig.md#name) - -## Properties - -### forceCreate - -• `Optional` **forceCreate**: `boolean` - -#### Defined in - -packages/types/dist/NetworkInterfaces.d.ts:50 - -___ - -### name - -• **name**: `string` - -#### Defined in - -packages/types/dist/NetworkInterfaces.d.ts:49 diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.ContextDatabaseInfo.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.ContextDatabaseInfo.md deleted file mode 100644 index c520eab..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.ContextDatabaseInfo.md +++ /dev/null @@ -1,65 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / ContextDatabaseInfo - -# Interface: ContextDatabaseInfo - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).ContextDatabaseInfo - -## Table of contents - -### Properties - -- [activeEndpoint](verida_client_ts._internal_.ContextDatabaseInfo.md#activeendpoint) -- [databases](verida_client_ts._internal_.ContextDatabaseInfo.md#databases) -- [endpoints](verida_client_ts._internal_.ContextDatabaseInfo.md#endpoints) -- [keys](verida_client_ts._internal_.ContextDatabaseInfo.md#keys) -- [name](verida_client_ts._internal_.ContextDatabaseInfo.md#name) - -## Properties - -### activeEndpoint - -• `Optional` **activeEndpoint**: `string` - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:136 - -___ - -### databases - -• **databases**: [`Record`](../modules/verida_client_ts._internal_.md#record)<`string`, `object`\> - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:138 - -___ - -### endpoints - -• **endpoints**: [`Record`](../modules/verida_client_ts._internal_.md#record)<`string`, `object`\> - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:137 - -___ - -### keys - -• **keys**: `any` - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:139 - -___ - -### name - -• **name**: `string` - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:135 diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.ContextInfo.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.ContextInfo.md deleted file mode 100644 index 388fba1..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.ContextInfo.md +++ /dev/null @@ -1,21 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / ContextInfo - -# Interface: ContextInfo - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).ContextInfo - -## Table of contents - -### Properties - -- [databases](verida_client_ts._internal_.ContextInfo.md#databases) - -## Properties - -### databases - -• **databases**: [`ContextDatabaseInfo`](verida_client_ts._internal_.ContextDatabaseInfo.md) - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:142 diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.CurrentOptions.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.CurrentOptions.md deleted file mode 100644 index bf82887..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.CurrentOptions.md +++ /dev/null @@ -1,518 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / CurrentOptions - -# Interface: CurrentOptions - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).CurrentOptions - -## Table of contents - -### Properties - -- [$comment](verida_client_ts._internal_.CurrentOptions.md#$comment) -- [$data](verida_client_ts._internal_.CurrentOptions.md#$data) -- [addUsedSchema](verida_client_ts._internal_.CurrentOptions.md#addusedschema) -- [allErrors](verida_client_ts._internal_.CurrentOptions.md#allerrors) -- [allowDate](verida_client_ts._internal_.CurrentOptions.md#allowdate) -- [allowMatchingProperties](verida_client_ts._internal_.CurrentOptions.md#allowmatchingproperties) -- [allowUnionTypes](verida_client_ts._internal_.CurrentOptions.md#allowuniontypes) -- [code](verida_client_ts._internal_.CurrentOptions.md#code) -- [coerceTypes](verida_client_ts._internal_.CurrentOptions.md#coercetypes) -- [defaultMeta](verida_client_ts._internal_.CurrentOptions.md#defaultmeta) -- [discriminator](verida_client_ts._internal_.CurrentOptions.md#discriminator) -- [dynamicRef](verida_client_ts._internal_.CurrentOptions.md#dynamicref) -- [formats](verida_client_ts._internal_.CurrentOptions.md#formats) -- [inlineRefs](verida_client_ts._internal_.CurrentOptions.md#inlinerefs) -- [int32range](verida_client_ts._internal_.CurrentOptions.md#int32range) -- [jtd](verida_client_ts._internal_.CurrentOptions.md#jtd) -- [keywords](verida_client_ts._internal_.CurrentOptions.md#keywords) -- [logger](verida_client_ts._internal_.CurrentOptions.md#logger) -- [loopEnum](verida_client_ts._internal_.CurrentOptions.md#loopenum) -- [loopRequired](verida_client_ts._internal_.CurrentOptions.md#looprequired) -- [messages](verida_client_ts._internal_.CurrentOptions.md#messages) -- [meta](verida_client_ts._internal_.CurrentOptions.md#meta) -- [multipleOfPrecision](verida_client_ts._internal_.CurrentOptions.md#multipleofprecision) -- [next](verida_client_ts._internal_.CurrentOptions.md#next) -- [ownProperties](verida_client_ts._internal_.CurrentOptions.md#ownproperties) -- [parseDate](verida_client_ts._internal_.CurrentOptions.md#parsedate) -- [passContext](verida_client_ts._internal_.CurrentOptions.md#passcontext) -- [removeAdditional](verida_client_ts._internal_.CurrentOptions.md#removeadditional) -- [schemaId](verida_client_ts._internal_.CurrentOptions.md#schemaid) -- [schemas](verida_client_ts._internal_.CurrentOptions.md#schemas) -- [strict](verida_client_ts._internal_.CurrentOptions.md#strict) -- [strictNumbers](verida_client_ts._internal_.CurrentOptions.md#strictnumbers) -- [strictRequired](verida_client_ts._internal_.CurrentOptions.md#strictrequired) -- [strictSchema](verida_client_ts._internal_.CurrentOptions.md#strictschema) -- [strictTuples](verida_client_ts._internal_.CurrentOptions.md#stricttuples) -- [strictTypes](verida_client_ts._internal_.CurrentOptions.md#stricttypes) -- [timestamp](verida_client_ts._internal_.CurrentOptions.md#timestamp) -- [unevaluated](verida_client_ts._internal_.CurrentOptions.md#unevaluated) -- [unicodeRegExp](verida_client_ts._internal_.CurrentOptions.md#unicoderegexp) -- [uriResolver](verida_client_ts._internal_.CurrentOptions.md#uriresolver) -- [useDefaults](verida_client_ts._internal_.CurrentOptions.md#usedefaults) -- [validateFormats](verida_client_ts._internal_.CurrentOptions.md#validateformats) -- [validateSchema](verida_client_ts._internal_.CurrentOptions.md#validateschema) -- [verbose](verida_client_ts._internal_.CurrentOptions.md#verbose) - -### Methods - -- [loadSchema](verida_client_ts._internal_.CurrentOptions.md#loadschema) - -## Properties - -### $comment - -• `Optional` **$comment**: ``true`` \| (`comment`: `string`, `schemaPath?`: `string`, `rootSchema?`: [`AnySchemaObject`](../modules/verida_client_ts._internal_.md#anyschemaobject)) => `unknown` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:40 - -___ - -### $data - -• `Optional` **$data**: `boolean` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:32 - -___ - -### addUsedSchema - -• `Optional` **addUsedSchema**: `boolean` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:61 - -___ - -### allErrors - -• `Optional` **allErrors**: `boolean` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:33 - -___ - -### allowDate - -• `Optional` **allowDate**: `boolean` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:39 - -___ - -### allowMatchingProperties - -• `Optional` **allowMatchingProperties**: `boolean` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:29 - -___ - -### allowUnionTypes - -• `Optional` **allowUnionTypes**: `boolean` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:30 - -___ - -### code - -• `Optional` **code**: [`CodeOptions`](verida_client_ts._internal_.CodeOptions.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:70 - -___ - -### coerceTypes - -• `Optional` **coerceTypes**: `boolean` \| ``"array"`` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:52 - -___ - -### defaultMeta - -• `Optional` **defaultMeta**: `string` \| [`AnySchemaObject`](../modules/verida_client_ts._internal_.md#anyschemaobject) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:59 - -___ - -### discriminator - -• `Optional` **discriminator**: `boolean` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:35 - -___ - -### dynamicRef - -• `Optional` **dynamicRef**: `boolean` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:55 - -___ - -### formats - -• `Optional` **formats**: `Object` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:41 - -___ - -### inlineRefs - -• `Optional` **inlineRefs**: `number` \| `boolean` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:62 - -___ - -### int32range - -• `Optional` **int32range**: `boolean` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:68 - -___ - -### jtd - -• `Optional` **jtd**: `boolean` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:57 - -___ - -### keywords - -• `Optional` **keywords**: [`Vocabulary`](../modules/verida_client_ts._internal_.md#vocabulary) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:44 - -___ - -### logger - -• `Optional` **logger**: ``false`` \| [`Logger`](verida_client_ts._internal_.Logger.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:48 - -___ - -### loopEnum - -• `Optional` **loopEnum**: `number` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:65 - -___ - -### loopRequired - -• `Optional` **loopRequired**: `number` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:64 - -___ - -### messages - -• `Optional` **messages**: `boolean` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:69 - -___ - -### meta - -• `Optional` **meta**: `boolean` \| [`SchemaObject`](verida_client_ts._internal_.SchemaObject.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:58 - -___ - -### multipleOfPrecision - -• `Optional` **multipleOfPrecision**: `number` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:67 - -___ - -### next - -• `Optional` **next**: `boolean` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:53 - -___ - -### ownProperties - -• `Optional` **ownProperties**: `boolean` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:66 - -___ - -### parseDate - -• `Optional` **parseDate**: `boolean` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:38 - -___ - -### passContext - -• `Optional` **passContext**: `boolean` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:63 - -___ - -### removeAdditional - -• `Optional` **removeAdditional**: `boolean` \| ``"all"`` \| ``"failing"`` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:50 - -___ - -### schemaId - -• `Optional` **schemaId**: ``"id"`` \| ``"$id"`` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:56 - -___ - -### schemas - -• `Optional` **schemas**: [`AnySchema`](../modules/verida_client_ts._internal_.md#anyschema)[] \| {} - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:45 - -___ - -### strict - -• `Optional` **strict**: `boolean` \| ``"log"`` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:23 - -___ - -### strictNumbers - -• `Optional` **strictNumbers**: `boolean` \| ``"log"`` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:25 - -___ - -### strictRequired - -• `Optional` **strictRequired**: `boolean` \| ``"log"`` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:28 - -___ - -### strictSchema - -• `Optional` **strictSchema**: `boolean` \| ``"log"`` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:24 - -___ - -### strictTuples - -• `Optional` **strictTuples**: `boolean` \| ``"log"`` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:27 - -___ - -### strictTypes - -• `Optional` **strictTypes**: `boolean` \| ``"log"`` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:26 - -___ - -### timestamp - -• `Optional` **timestamp**: ``"string"`` \| ``"date"`` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:37 - -___ - -### unevaluated - -• `Optional` **unevaluated**: `boolean` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:54 - -___ - -### unicodeRegExp - -• `Optional` **unicodeRegExp**: `boolean` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:36 - -___ - -### uriResolver - -• `Optional` **uriResolver**: [`UriResolver`](verida_client_ts._internal_.UriResolver.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:71 - -___ - -### useDefaults - -• `Optional` **useDefaults**: `boolean` \| ``"empty"`` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:51 - -___ - -### validateFormats - -• `Optional` **validateFormats**: `boolean` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:31 - -___ - -### validateSchema - -• `Optional` **validateSchema**: `boolean` \| ``"log"`` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:60 - -___ - -### verbose - -• `Optional` **verbose**: `boolean` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:34 - -## Methods - -### loadSchema - -▸ `Optional` **loadSchema**(`uri`): `Promise`<[`AnySchemaObject`](../modules/verida_client_ts._internal_.md#anyschemaobject)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `uri` | `string` | - -#### Returns - -`Promise`<[`AnySchemaObject`](../modules/verida_client_ts._internal_.md#anyschemaobject)\> - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:49 diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.DIDClientConfig.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.DIDClientConfig.md deleted file mode 100644 index 549668f..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.DIDClientConfig.md +++ /dev/null @@ -1,43 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / DIDClientConfig - -# Interface: DIDClientConfig - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).DIDClientConfig - -## Table of contents - -### Properties - -- [network](verida_client_ts._internal_.DIDClientConfig.md#network) -- [rpcUrl](verida_client_ts._internal_.DIDClientConfig.md#rpcurl) -- [timeout](verida_client_ts._internal_.DIDClientConfig.md#timeout) - -## Properties - -### network - -• **network**: [`EnvironmentType`](../enums/verida_client_ts._internal_.EnvironmentType.md) - -#### Defined in - -packages/types/dist/NetworkInterfaces.d.ts:21 - -___ - -### rpcUrl - -• `Optional` **rpcUrl**: `string` - -#### Defined in - -packages/types/dist/NetworkInterfaces.d.ts:22 - -___ - -### timeout - -• `Optional` **timeout**: `number` - -#### Defined in - -packages/types/dist/NetworkInterfaces.d.ts:23 diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.DIDContextConfigs.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.DIDContextConfigs.md deleted file mode 100644 index 2418d4f..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.DIDContextConfigs.md +++ /dev/null @@ -1,13 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / DIDContextConfigs - -# Interface: DIDContextConfigs - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).DIDContextConfigs - -Interface for DIDContextConfigs -key = contextName -value = SecureStorageContextConfig - -## Indexable - -▪ [key: `string`]: [`SecureContextConfig`](verida_client_ts._internal_.SecureContextConfig.md) diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.DIDDocumentStruct.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.DIDDocumentStruct.md deleted file mode 100644 index b934c2a..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.DIDDocumentStruct.md +++ /dev/null @@ -1,189 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / DIDDocumentStruct - -# Interface: DIDDocumentStruct - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).DIDDocumentStruct - -## Hierarchy - -- [`DIDDocument`](../modules/verida_client_ts._internal_.md#diddocument) - - ↳ **`DIDDocumentStruct`** - -## Table of contents - -### Properties - -- [@context](verida_client_ts._internal_.DIDDocumentStruct.md#@context) -- [alsoKnownAs](verida_client_ts._internal_.DIDDocumentStruct.md#alsoknownas) -- [assertionMethod](verida_client_ts._internal_.DIDDocumentStruct.md#assertionmethod) -- [authentication](verida_client_ts._internal_.DIDDocumentStruct.md#authentication) -- [capabilityDelegation](verida_client_ts._internal_.DIDDocumentStruct.md#capabilitydelegation) -- [capabilityInvocation](verida_client_ts._internal_.DIDDocumentStruct.md#capabilityinvocation) -- [controller](verida_client_ts._internal_.DIDDocumentStruct.md#controller) -- [id](verida_client_ts._internal_.DIDDocumentStruct.md#id) -- [keyAgreement](verida_client_ts._internal_.DIDDocumentStruct.md#keyagreement) -- [proof](verida_client_ts._internal_.DIDDocumentStruct.md#proof) -- [publicKey](verida_client_ts._internal_.DIDDocumentStruct.md#publickey) -- [service](verida_client_ts._internal_.DIDDocumentStruct.md#service) -- [verificationMethod](verida_client_ts._internal_.DIDDocumentStruct.md#verificationmethod) - -## Properties - -### @context - -• `Optional` **@context**: `string` \| `string`[] - -#### Inherited from - -DD.@context - -#### Defined in - -packages/did-document/node_modules/did-resolver/lib/resolver.d.ts:26 - -___ - -### alsoKnownAs - -• `Optional` **alsoKnownAs**: `string`[] - -#### Inherited from - -DD.alsoKnownAs - -#### Defined in - -packages/did-document/node_modules/did-resolver/lib/resolver.d.ts:28 - -___ - -### assertionMethod - -• **assertionMethod**: `undefined` \| (`string` \| [`VerificationMethod`](verida_client_ts._internal_.VerificationMethod.md))[] - -#### Inherited from - -DD.assertionMethod - -___ - -### authentication - -• **authentication**: `undefined` \| (`string` \| [`VerificationMethod`](verida_client_ts._internal_.VerificationMethod.md))[] - -#### Inherited from - -DD.authentication - -___ - -### capabilityDelegation - -• **capabilityDelegation**: `undefined` \| (`string` \| [`VerificationMethod`](verida_client_ts._internal_.VerificationMethod.md))[] - -#### Inherited from - -DD.capabilityDelegation - -___ - -### capabilityInvocation - -• **capabilityInvocation**: `undefined` \| (`string` \| [`VerificationMethod`](verida_client_ts._internal_.VerificationMethod.md))[] - -#### Inherited from - -DD.capabilityInvocation - -___ - -### controller - -• `Optional` **controller**: `string` \| `string`[] - -#### Inherited from - -DD.controller - -#### Defined in - -packages/did-document/node_modules/did-resolver/lib/resolver.d.ts:29 - -___ - -### id - -• **id**: `string` - -#### Inherited from - -DD.id - -#### Defined in - -packages/did-document/node_modules/did-resolver/lib/resolver.d.ts:27 - -___ - -### keyAgreement - -• **keyAgreement**: `undefined` \| (`string` \| [`VerificationMethod`](verida_client_ts._internal_.VerificationMethod.md))[] - -#### Inherited from - -DD.keyAgreement - -___ - -### proof - -• `Optional` **proof**: [`Proof`](verida_client_ts._internal_.Proof.md) - -#### Defined in - -packages/did-document/dist/interfaces.d.ts:14 - -___ - -### publicKey - -• `Optional` **publicKey**: [`VerificationMethod`](verida_client_ts._internal_.VerificationMethod.md)[] - -**`deprecated`** - -#### Inherited from - -DD.publicKey - -#### Defined in - -packages/did-document/node_modules/did-resolver/lib/resolver.d.ts:35 - -___ - -### service - -• `Optional` **service**: [`ServiceEndpoint`](verida_client_ts._internal_.ServiceEndpoint.md)[] - -#### Inherited from - -DD.service - -#### Defined in - -packages/did-document/node_modules/did-resolver/lib/resolver.d.ts:31 - -___ - -### verificationMethod - -• `Optional` **verificationMethod**: [`VerificationMethod`](verida_client_ts._internal_.VerificationMethod.md)[] - -#### Inherited from - -DD.verificationMethod - -#### Defined in - -packages/did-document/node_modules/did-resolver/lib/resolver.d.ts:30 diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.DOMEventTarget.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.DOMEventTarget.md deleted file mode 100644 index 60ffec8..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.DOMEventTarget.md +++ /dev/null @@ -1,34 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / DOMEventTarget - -# Interface: DOMEventTarget - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).DOMEventTarget - -## Table of contents - -### Methods - -- [addEventListener](verida_client_ts._internal_.DOMEventTarget.md#addeventlistener) - -## Methods - -### addEventListener - -▸ **addEventListener**(`eventName`, `listener`, `opts?`): `any` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | `string` | -| `listener` | (...`args`: `any`[]) => `void` | -| `opts?` | `Object` | -| `opts.once` | `boolean` | - -#### Returns - -`any` - -#### Defined in - -node_modules/@types/node/events.d.ts:48 diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.DataValidateFunction.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.DataValidateFunction.md deleted file mode 100644 index 2396976..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.DataValidateFunction.md +++ /dev/null @@ -1,41 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / DataValidateFunction - -# Interface: DataValidateFunction - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).DataValidateFunction - -## Callable - -### DataValidateFunction - -▸ **DataValidateFunction**(...`args`): `boolean` \| `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `...args` | [data: any, dataCxt?: DataValidationCxt] | - -#### Returns - -`boolean` \| `Promise`<`any`\> - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:108 - -## Table of contents - -### Properties - -- [errors](verida_client_ts._internal_.DataValidateFunction.md#errors) - -## Properties - -### errors - -• `Optional` **errors**: [`Partial`](../modules/verida_client_ts._internal_.md#partial)<[`ErrorObject`](verida_client_ts._internal_.ErrorObject.md)<`string`, [`Record`](../modules/verida_client_ts._internal_.md#record)<`string`, `any`\>, `unknown`\>\>[] - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:109 diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.DataValidationCxt.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.DataValidationCxt.md deleted file mode 100644 index c381d76..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.DataValidationCxt.md +++ /dev/null @@ -1,71 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / DataValidationCxt - -# Interface: DataValidationCxt - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).DataValidationCxt - -## Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | extends `string` \| `number` = `string` \| `number` | - -## Table of contents - -### Properties - -- [dynamicAnchors](verida_client_ts._internal_.DataValidationCxt.md#dynamicanchors) -- [instancePath](verida_client_ts._internal_.DataValidationCxt.md#instancepath) -- [parentData](verida_client_ts._internal_.DataValidationCxt.md#parentdata) -- [parentDataProperty](verida_client_ts._internal_.DataValidationCxt.md#parentdataproperty) -- [rootData](verida_client_ts._internal_.DataValidationCxt.md#rootdata) - -## Properties - -### dynamicAnchors - -• **dynamicAnchors**: `Object` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:42 - -___ - -### instancePath - -• **instancePath**: `string` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:36 - -___ - -### parentData - -• **parentData**: { [K in string \| number]: any } - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:37 - -___ - -### parentDataProperty - -• **parentDataProperty**: `T` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:40 - -___ - -### rootData - -• **rootData**: `any`[] \| [`Record`](../modules/verida_client_ts._internal_.md#record)<`string`, `any`\> - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:41 diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.DatabaseCloseOptions.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.DatabaseCloseOptions.md deleted file mode 100644 index 1e3e530..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.DatabaseCloseOptions.md +++ /dev/null @@ -1,31 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / DatabaseCloseOptions - -# Interface: DatabaseCloseOptions - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).DatabaseCloseOptions - -## Hierarchy - -- [`ContextCloseOptions`](verida_client_ts._internal_.ContextCloseOptions.md) - - ↳ **`DatabaseCloseOptions`** - -## Table of contents - -### Properties - -- [clearLocal](verida_client_ts._internal_.DatabaseCloseOptions.md#clearlocal) - -## Properties - -### clearLocal - -• `Optional` **clearLocal**: `boolean` - -#### Inherited from - -[ContextCloseOptions](verida_client_ts._internal_.ContextCloseOptions.md).[clearLocal](verida_client_ts._internal_.ContextCloseOptions.md#clearlocal) - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:71 diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.DatabaseDeleteConfig.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.DatabaseDeleteConfig.md deleted file mode 100644 index ac04eb0..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.DatabaseDeleteConfig.md +++ /dev/null @@ -1,21 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / DatabaseDeleteConfig - -# Interface: DatabaseDeleteConfig - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).DatabaseDeleteConfig - -## Table of contents - -### Properties - -- [localOnly](verida_client_ts._internal_.DatabaseDeleteConfig.md#localonly) - -## Properties - -### localOnly - -• `Optional` **localOnly**: `boolean` - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:68 diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.DatabaseEngines.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.DatabaseEngines.md deleted file mode 100644 index 94670d2..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.DatabaseEngines.md +++ /dev/null @@ -1,11 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / DatabaseEngines - -# Interface: DatabaseEngines - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).DatabaseEngines - -Interface for any DatabaseEngines - -## Indexable - -▪ [key: `string`]: [`IStorageEngine`](verida_client_ts._internal_.IStorageEngine.md) diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.DatabaseOpenConfig.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.DatabaseOpenConfig.md deleted file mode 100644 index 52a91e4..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.DatabaseOpenConfig.md +++ /dev/null @@ -1,187 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / DatabaseOpenConfig - -# Interface: DatabaseOpenConfig - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).DatabaseOpenConfig - -Interface for any DatabaseOpenConfig - -## Table of contents - -### Properties - -- [contextName](verida_client_ts._internal_.DatabaseOpenConfig.md#contextname) -- [createContext](verida_client_ts._internal_.DatabaseOpenConfig.md#createcontext) -- [did](verida_client_ts._internal_.DatabaseOpenConfig.md#did) -- [encryptionKey](verida_client_ts._internal_.DatabaseOpenConfig.md#encryptionkey) -- [endpoints](verida_client_ts._internal_.DatabaseOpenConfig.md#endpoints) -- [ignoreCache](verida_client_ts._internal_.DatabaseOpenConfig.md#ignorecache) -- [isOwner](verida_client_ts._internal_.DatabaseOpenConfig.md#isowner) -- [permissions](verida_client_ts._internal_.DatabaseOpenConfig.md#permissions) -- [readOnly](verida_client_ts._internal_.DatabaseOpenConfig.md#readonly) -- [saveDatabase](verida_client_ts._internal_.DatabaseOpenConfig.md#savedatabase) -- [signingContext](verida_client_ts._internal_.DatabaseOpenConfig.md#signingcontext) -- [token](verida_client_ts._internal_.DatabaseOpenConfig.md#token) -- [verifyEncryptionKey](verida_client_ts._internal_.DatabaseOpenConfig.md#verifyencryptionkey) - -## Properties - -### contextName - -• `Optional` **contextName**: `string` - -Optionally specify an external context to open - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:53 - -___ - -### createContext - -• `Optional` **createContext**: `boolean` - -Create an application context if it doesn't already exist for the connected account. - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:49 - -___ - -### did - -• `Optional` **did**: `string` - -Specify the DID that owns the database. - -This ensures the Verida client connects to the correct database server hosting the data for the specified `did`. - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:17 - -___ - -### encryptionKey - -• `Optional` **encryptionKey**: `Buffer` - -An optional encryption key to use for encrypting / decrypting data. - -This encryption key will not apply if the database is marked as `public`. - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:45 - -___ - -### endpoints - -• `Optional` **endpoints**: `string` \| `string`[] - -Specify an array of possible database connection strings to use when opening the database. - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:21 - -___ - -### ignoreCache - -• `Optional` **ignoreCache**: `boolean` - -Ignore any cached instance already created - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:61 - -___ - -### isOwner - -• `Optional` **isOwner**: `boolean` - -Boolean indicating if it's expected the current connected account is the owner of this database. - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:39 - -___ - -### permissions - -• `Optional` **permissions**: [`DatabasePermissionsConfig`](verida_client_ts._internal_.DatabasePermissionsConfig.md) - -Specify the permissions to use when opening this database. - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:11 - -___ - -### readOnly - -• `Optional` **readOnly**: `boolean` - -Open the database in read-only mode. - -This is useful when opening a database owned by an external `did` where the current authenticated account has no write access. - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:35 - -___ - -### saveDatabase - -• `Optional` **saveDatabase**: `boolean` - -Save this database into the user's master list of opened databases. - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:29 - -___ - -### signingContext - -• `Optional` **signingContext**: [`IContext`](verida_client_ts._internal_.IContext.md) - -Optionally specify the context used to sign data - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:57 - -___ - -### token - -• `Optional` **token**: `string` - -Specify a JWT token to use when opening the database. - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:25 - -___ - -### verifyEncryptionKey - -• `Optional` **verifyEncryptionKey**: `boolean` - -Verify the encryption key is correct when opening the database - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:65 diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.DatabasePermissionsConfig.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.DatabasePermissionsConfig.md deleted file mode 100644 index 6eb8aff..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.DatabasePermissionsConfig.md +++ /dev/null @@ -1,56 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / DatabasePermissionsConfig - -# Interface: DatabasePermissionsConfig - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).DatabasePermissionsConfig - -Interface for any PermissionsConfig - -## Table of contents - -### Properties - -- [read](verida_client_ts._internal_.DatabasePermissionsConfig.md#read) -- [readList](verida_client_ts._internal_.DatabasePermissionsConfig.md#readlist) -- [write](verida_client_ts._internal_.DatabasePermissionsConfig.md#write) -- [writeList](verida_client_ts._internal_.DatabasePermissionsConfig.md#writelist) - -## Properties - -### read - -• **read**: [`DatabasePermissionOptionsEnum`](../enums/verida_client_ts._internal_.DatabasePermissionOptionsEnum.md) - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:110 - -___ - -### readList - -• `Optional` **readList**: `string`[] - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:112 - -___ - -### write - -• **write**: [`DatabasePermissionOptionsEnum`](../enums/verida_client_ts._internal_.DatabasePermissionOptionsEnum.md) - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:111 - -___ - -### writeList - -• `Optional` **writeList**: `string`[] - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:113 diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.DatastoreOpenConfig.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.DatastoreOpenConfig.md deleted file mode 100644 index 2cfde59..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.DatastoreOpenConfig.md +++ /dev/null @@ -1,111 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / DatastoreOpenConfig - -# Interface: DatastoreOpenConfig - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).DatastoreOpenConfig - -Interface for any DatastoreOpenConfig - -## Table of contents - -### Properties - -- [contextName](verida_client_ts._internal_.DatastoreOpenConfig.md#contextname) -- [createContext](verida_client_ts._internal_.DatastoreOpenConfig.md#createcontext) -- [databaseName](verida_client_ts._internal_.DatastoreOpenConfig.md#databasename) -- [did](verida_client_ts._internal_.DatastoreOpenConfig.md#did) -- [encryptionKey](verida_client_ts._internal_.DatastoreOpenConfig.md#encryptionkey) -- [external](verida_client_ts._internal_.DatastoreOpenConfig.md#external) -- [permissions](verida_client_ts._internal_.DatastoreOpenConfig.md#permissions) -- [readOnly](verida_client_ts._internal_.DatastoreOpenConfig.md#readonly) -- [saveDatabase](verida_client_ts._internal_.DatastoreOpenConfig.md#savedatabase) - -## Properties - -### contextName - -• `Optional` **contextName**: `string` - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:87 - -___ - -### createContext - -• `Optional` **createContext**: `boolean` - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:85 - -___ - -### databaseName - -• `Optional` **databaseName**: `string` - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:84 - -___ - -### did - -• `Optional` **did**: `string` - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:80 - -___ - -### encryptionKey - -• `Optional` **encryptionKey**: `string` - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:83 - -___ - -### external - -• `Optional` **external**: `boolean` - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:86 - -___ - -### permissions - -• `Optional` **permissions**: [`DatabasePermissionsConfig`](verida_client_ts._internal_.DatabasePermissionsConfig.md) - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:79 - -___ - -### readOnly - -• `Optional` **readOnly**: `boolean` - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:82 - -___ - -### saveDatabase - -• `Optional` **saveDatabase**: `boolean` - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:81 diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.DbRegistryEntry.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.DbRegistryEntry.md deleted file mode 100644 index 691b5dc..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.DbRegistryEntry.md +++ /dev/null @@ -1,100 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / DbRegistryEntry - -# Interface: DbRegistryEntry - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).DbRegistryEntry - -Interface for DbRegistryEntry - -## Table of contents - -### Properties - -- [contextName](verida_client_ts._internal_.DbRegistryEntry.md#contextname) -- [dbHash](verida_client_ts._internal_.DbRegistryEntry.md#dbhash) -- [dbName](verida_client_ts._internal_.DbRegistryEntry.md#dbname) -- [did](verida_client_ts._internal_.DbRegistryEntry.md#did) -- [encryptionKey](verida_client_ts._internal_.DbRegistryEntry.md#encryptionkey) -- [endpoint](verida_client_ts._internal_.DbRegistryEntry.md#endpoint) -- [endpointType](verida_client_ts._internal_.DbRegistryEntry.md#endpointtype) -- [permissions](verida_client_ts._internal_.DbRegistryEntry.md#permissions) - -## Properties - -### contextName - -• **contextName**: `string` - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:159 - -___ - -### dbHash - -• **dbHash**: `string` - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:155 - -___ - -### dbName - -• **dbName**: `string` - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:156 - -___ - -### did - -• **did**: `string` - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:158 - -___ - -### encryptionKey - -• `Optional` **encryptionKey**: [`DbRegistryEntryEncryptionKey`](verida_client_ts._internal_.DbRegistryEntryEncryptionKey.md) - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:161 - -___ - -### endpoint - -• **endpoint**: `string` - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:162 - -___ - -### endpointType - -• **endpointType**: `string` - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:157 - -___ - -### permissions - -• **permissions**: [`DatabasePermissionsConfig`](verida_client_ts._internal_.DatabasePermissionsConfig.md) - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:160 diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.DbRegistryEntryEncryptionKey.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.DbRegistryEntryEncryptionKey.md deleted file mode 100644 index 0639df9..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.DbRegistryEntryEncryptionKey.md +++ /dev/null @@ -1,34 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / DbRegistryEntryEncryptionKey - -# Interface: DbRegistryEntryEncryptionKey - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).DbRegistryEntryEncryptionKey - -Interface for DbRegistryEntryEncryptionKey - -## Table of contents - -### Properties - -- [key](verida_client_ts._internal_.DbRegistryEntryEncryptionKey.md#key) -- [type](verida_client_ts._internal_.DbRegistryEntryEncryptionKey.md#type) - -## Properties - -### key - -• **key**: `string` - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:148 - -___ - -### type - -• **type**: `string` - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:149 diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.DefaultClientConfig.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.DefaultClientConfig.md deleted file mode 100644 index 8ef1583..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.DefaultClientConfig.md +++ /dev/null @@ -1,94 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / DefaultClientConfig - -# Interface: DefaultClientConfig - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).DefaultClientConfig - -## Hierarchy - -- [`DefaultEnvironmentConfig`](verida_client_ts._internal_.DefaultEnvironmentConfig.md) - - ↳ **`DefaultClientConfig`** - -## Table of contents - -### Properties - -- [defaultDatabaseServerUrl](verida_client_ts._internal_.DefaultClientConfig.md#defaultdatabaseserverurl) -- [defaultMessageServerUrl](verida_client_ts._internal_.DefaultClientConfig.md#defaultmessageserverurl) -- [environment](verida_client_ts._internal_.DefaultClientConfig.md#environment) -- [environments](verida_client_ts._internal_.DefaultClientConfig.md#environments) -- [schemaPaths](verida_client_ts._internal_.DefaultClientConfig.md#schemapaths) -- [vaultAppName](verida_client_ts._internal_.DefaultClientConfig.md#vaultappname) - -## Properties - -### defaultDatabaseServerUrl - -• `Optional` **defaultDatabaseServerUrl**: `string` - -#### Inherited from - -[DefaultEnvironmentConfig](verida_client_ts._internal_.DefaultEnvironmentConfig.md).[defaultDatabaseServerUrl](verida_client_ts._internal_.DefaultEnvironmentConfig.md#defaultdatabaseserverurl) - -#### Defined in - -packages/types/dist/NetworkInterfaces.d.ts:11 - -___ - -### defaultMessageServerUrl - -• `Optional` **defaultMessageServerUrl**: `string` - -#### Inherited from - -[DefaultEnvironmentConfig](verida_client_ts._internal_.DefaultEnvironmentConfig.md).[defaultMessageServerUrl](verida_client_ts._internal_.DefaultEnvironmentConfig.md#defaultmessageserverurl) - -#### Defined in - -packages/types/dist/NetworkInterfaces.d.ts:12 - -___ - -### environment - -• **environment**: [`EnvironmentType`](../enums/verida_client_ts._internal_.EnvironmentType.md) - -#### Defined in - -packages/types/dist/NetworkInterfaces.d.ts:16 - -___ - -### environments - -• **environments**: [`Record`](../modules/verida_client_ts._internal_.md#record)<`string`, [`DefaultEnvironmentConfig`](verida_client_ts._internal_.DefaultEnvironmentConfig.md)\> - -#### Defined in - -packages/types/dist/NetworkInterfaces.d.ts:17 - -___ - -### schemaPaths - -• `Optional` **schemaPaths**: [`Record`](../modules/verida_client_ts._internal_.md#record)<`string`, `string`\> - -#### Inherited from - -[DefaultEnvironmentConfig](verida_client_ts._internal_.DefaultEnvironmentConfig.md).[schemaPaths](verida_client_ts._internal_.DefaultEnvironmentConfig.md#schemapaths) - -#### Defined in - -packages/types/dist/NetworkInterfaces.d.ts:13 - -___ - -### vaultAppName - -• **vaultAppName**: `string` - -#### Defined in - -packages/types/dist/NetworkInterfaces.d.ts:18 diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.DefaultEnvironmentConfig.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.DefaultEnvironmentConfig.md deleted file mode 100644 index 4a6b54f..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.DefaultEnvironmentConfig.md +++ /dev/null @@ -1,49 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / DefaultEnvironmentConfig - -# Interface: DefaultEnvironmentConfig - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).DefaultEnvironmentConfig - -## Hierarchy - -- **`DefaultEnvironmentConfig`** - - ↳ [`DefaultClientConfig`](verida_client_ts._internal_.DefaultClientConfig.md) - -## Table of contents - -### Properties - -- [defaultDatabaseServerUrl](verida_client_ts._internal_.DefaultEnvironmentConfig.md#defaultdatabaseserverurl) -- [defaultMessageServerUrl](verida_client_ts._internal_.DefaultEnvironmentConfig.md#defaultmessageserverurl) -- [schemaPaths](verida_client_ts._internal_.DefaultEnvironmentConfig.md#schemapaths) - -## Properties - -### defaultDatabaseServerUrl - -• `Optional` **defaultDatabaseServerUrl**: `string` - -#### Defined in - -packages/types/dist/NetworkInterfaces.d.ts:11 - -___ - -### defaultMessageServerUrl - -• `Optional` **defaultMessageServerUrl**: `string` - -#### Defined in - -packages/types/dist/NetworkInterfaces.d.ts:12 - -___ - -### schemaPaths - -• `Optional` **schemaPaths**: [`Record`](../modules/verida_client_ts._internal_.md#record)<`string`, `string`\> - -#### Defined in - -packages/types/dist/NetworkInterfaces.d.ts:13 diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.DeprecatedOptions.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.DeprecatedOptions.md deleted file mode 100644 index 90673b3..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.DeprecatedOptions.md +++ /dev/null @@ -1,49 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / DeprecatedOptions - -# Interface: DeprecatedOptions - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).DeprecatedOptions - -## Table of contents - -### Properties - -- [ignoreKeywordsWithRef](verida_client_ts._internal_.DeprecatedOptions.md#ignorekeywordswithref) -- [jsPropertySyntax](verida_client_ts._internal_.DeprecatedOptions.md#jspropertysyntax) -- [unicode](verida_client_ts._internal_.DeprecatedOptions.md#unicode) - -## Properties - -### ignoreKeywordsWithRef - -• `Optional` **ignoreKeywordsWithRef**: `boolean` - -**`deprecated`** - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:89 - -___ - -### jsPropertySyntax - -• `Optional` **jsPropertySyntax**: `boolean` - -**`deprecated`** - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:91 - -___ - -### unicode - -• `Optional` **unicode**: `boolean` - -**`deprecated`** - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:93 diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.EndpointUsage.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.EndpointUsage.md deleted file mode 100644 index 46dded1..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.EndpointUsage.md +++ /dev/null @@ -1,43 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / EndpointUsage - -# Interface: EndpointUsage - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).EndpointUsage - -## Table of contents - -### Properties - -- [bytes](verida_client_ts._internal_.EndpointUsage.md#bytes) -- [databases](verida_client_ts._internal_.EndpointUsage.md#databases) -- [storageLimit](verida_client_ts._internal_.EndpointUsage.md#storagelimit) - -## Properties - -### bytes - -• **bytes**: `number` - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:131 - -___ - -### databases - -• **databases**: `number` - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:130 - -___ - -### storageLimit - -• **storageLimit**: `number` - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:132 diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.Endpoints.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.Endpoints.md deleted file mode 100644 index 997e2d8..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.Endpoints.md +++ /dev/null @@ -1,54 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / Endpoints - -# Interface: Endpoints - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).Endpoints - -## Table of contents - -### Properties - -- [database](verida_client_ts._internal_.Endpoints.md#database) -- [messaging](verida_client_ts._internal_.Endpoints.md#messaging) -- [notification](verida_client_ts._internal_.Endpoints.md#notification) -- [storage](verida_client_ts._internal_.Endpoints.md#storage) - -## Properties - -### database - -• **database**: [`SecureContextEndpoint`](verida_client_ts._internal_.SecureContextEndpoint-1.md) - -#### Defined in - -packages/did-document/dist/interfaces.d.ts:17 - -___ - -### messaging - -• **messaging**: [`SecureContextEndpoint`](verida_client_ts._internal_.SecureContextEndpoint-1.md) - -#### Defined in - -packages/did-document/dist/interfaces.d.ts:18 - -___ - -### notification - -• `Optional` **notification**: [`SecureContextEndpoint`](verida_client_ts._internal_.SecureContextEndpoint-1.md) - -#### Defined in - -packages/did-document/dist/interfaces.d.ts:20 - -___ - -### storage - -• `Optional` **storage**: [`SecureContextEndpoint`](verida_client_ts._internal_.SecureContextEndpoint-1.md) - -#### Defined in - -packages/did-document/dist/interfaces.d.ts:19 diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.Error.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.Error.md deleted file mode 100644 index 4f8d1e1..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.Error.md +++ /dev/null @@ -1,43 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / Error - -# Interface: Error - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).Error - -## Table of contents - -### Properties - -- [message](verida_client_ts._internal_.Error.md#message) -- [name](verida_client_ts._internal_.Error.md#name) -- [stack](verida_client_ts._internal_.Error.md#stack) - -## Properties - -### message - -• **message**: `string` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:974 - -___ - -### name - -• **name**: `string` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:973 - -___ - -### stack - -• `Optional` **stack**: `string` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:975 diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.ErrorObject.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.ErrorObject.md deleted file mode 100644 index 9f804a5..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.ErrorObject.md +++ /dev/null @@ -1,117 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / ErrorObject - -# Interface: ErrorObject - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).ErrorObject - -## Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends `string` = `string` | -| `P` | [`Record`](../modules/verida_client_ts._internal_.md#record)<`string`, `any`\> | -| `S` | `unknown` | - -## Table of contents - -### Properties - -- [data](verida_client_ts._internal_.ErrorObject.md#data) -- [instancePath](verida_client_ts._internal_.ErrorObject.md#instancepath) -- [keyword](verida_client_ts._internal_.ErrorObject.md#keyword) -- [message](verida_client_ts._internal_.ErrorObject.md#message) -- [params](verida_client_ts._internal_.ErrorObject.md#params) -- [parentSchema](verida_client_ts._internal_.ErrorObject.md#parentschema) -- [propertyName](verida_client_ts._internal_.ErrorObject.md#propertyname) -- [schema](verida_client_ts._internal_.ErrorObject.md#schema) -- [schemaPath](verida_client_ts._internal_.ErrorObject.md#schemapath) - -## Properties - -### data - -• `Optional` **data**: `unknown` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:83 - -___ - -### instancePath - -• **instancePath**: `string` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:76 - -___ - -### keyword - -• **keyword**: `K` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:75 - -___ - -### message - -• `Optional` **message**: `string` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:80 - -___ - -### params - -• **params**: `P` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:78 - -___ - -### parentSchema - -• `Optional` **parentSchema**: [`AnySchemaObject`](../modules/verida_client_ts._internal_.md#anyschemaobject) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:82 - -___ - -### propertyName - -• `Optional` **propertyName**: `string` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:79 - -___ - -### schema - -• `Optional` **schema**: `S` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:81 - -___ - -### schemaPath - -• **schemaPath**: `string` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:77 diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.ErrorPaths.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.ErrorPaths.md deleted file mode 100644 index acc3d32..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.ErrorPaths.md +++ /dev/null @@ -1,43 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / ErrorPaths - -# Interface: ErrorPaths - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).ErrorPaths - -## Table of contents - -### Properties - -- [instancePath](verida_client_ts._internal_.ErrorPaths.md#instancepath) -- [parentSchema](verida_client_ts._internal_.ErrorPaths.md#parentschema) -- [schemaPath](verida_client_ts._internal_.ErrorPaths.md#schemapath) - -## Properties - -### instancePath - -• `Optional` **instancePath**: [`Code`](../modules/verida_client_ts._internal_.md#code) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/errors.d.ts:6 - -___ - -### parentSchema - -• `Optional` **parentSchema**: `boolean` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/errors.d.ts:8 - -___ - -### schemaPath - -• `Optional` **schemaPath**: `string` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/errors.d.ts:7 diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.ErrorsTextOptions.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.ErrorsTextOptions.md deleted file mode 100644 index 6f78c15..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.ErrorsTextOptions.md +++ /dev/null @@ -1,32 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / ErrorsTextOptions - -# Interface: ErrorsTextOptions - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).ErrorsTextOptions - -## Table of contents - -### Properties - -- [dataVar](verida_client_ts._internal_.ErrorsTextOptions.md#datavar) -- [separator](verida_client_ts._internal_.ErrorsTextOptions.md#separator) - -## Properties - -### dataVar - -• `Optional` **dataVar**: `string` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:172 - -___ - -### separator - -• `Optional` **separator**: `string` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:171 diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.Evaluated.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.Evaluated.md deleted file mode 100644 index 6f69724..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.Evaluated.md +++ /dev/null @@ -1,54 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / Evaluated - -# Interface: Evaluated - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).Evaluated - -## Table of contents - -### Properties - -- [dynamicItems](verida_client_ts._internal_.Evaluated.md#dynamicitems) -- [dynamicProps](verida_client_ts._internal_.Evaluated.md#dynamicprops) -- [items](verida_client_ts._internal_.Evaluated.md#items) -- [props](verida_client_ts._internal_.Evaluated.md#props) - -## Properties - -### dynamicItems - -• **dynamicItems**: `boolean` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:67 - -___ - -### dynamicProps - -• **dynamicProps**: `boolean` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:66 - -___ - -### items - -• `Optional` **items**: [`EvaluatedItems`](../modules/verida_client_ts._internal_.md#evaluateditems) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:65 - -___ - -### props - -• `Optional` **props**: [`EvaluatedProperties`](../modules/verida_client_ts._internal_.md#evaluatedproperties) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:64 diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.EventEmitter.Abortable.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.EventEmitter.Abortable.md deleted file mode 100644 index 6873254..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.EventEmitter.Abortable.md +++ /dev/null @@ -1,23 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / [EventEmitter](../modules/verida_client_ts._internal_.EventEmitter.md) / Abortable - -# Interface: Abortable - -[](../modules/verida_client_ts._internal_.md).[EventEmitter](../modules/verida_client_ts._internal_.EventEmitter.md).Abortable - -## Table of contents - -### Properties - -- [signal](verida_client_ts._internal_.EventEmitter.Abortable.md#signal) - -## Properties - -### signal - -• `Optional` **signal**: [`AbortSignal`](../modules/verida_client_ts._internal_.md#abortsignal) - -When provided the corresponding `AbortController` can be used to cancel an asynchronous action. - -#### Defined in - -node_modules/@types/node/events.d.ts:289 diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.EventEmitter.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.EventEmitter.md deleted file mode 100644 index fe596b0..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.EventEmitter.md +++ /dev/null @@ -1,278 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / EventEmitter - -# Interface: EventEmitter - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).EventEmitter - -## Table of contents - -### Methods - -- [addListener](verida_client_ts._internal_.EventEmitter.md#addlistener) -- [emit](verida_client_ts._internal_.EventEmitter.md#emit) -- [eventNames](verida_client_ts._internal_.EventEmitter.md#eventnames) -- [getMaxListeners](verida_client_ts._internal_.EventEmitter.md#getmaxlisteners) -- [listenerCount](verida_client_ts._internal_.EventEmitter.md#listenercount) -- [listeners](verida_client_ts._internal_.EventEmitter.md#listeners) -- [on](verida_client_ts._internal_.EventEmitter.md#on) -- [once](verida_client_ts._internal_.EventEmitter.md#once) -- [prependListener](verida_client_ts._internal_.EventEmitter.md#prependlistener) -- [prependOnceListener](verida_client_ts._internal_.EventEmitter.md#prependoncelistener) -- [removeAllListeners](verida_client_ts._internal_.EventEmitter.md#removealllisteners) -- [removeListener](verida_client_ts._internal_.EventEmitter.md#removelistener) -- [setMaxListeners](verida_client_ts._internal_.EventEmitter.md#setmaxlisteners) - -## Methods - -### addListener - -▸ **addListener**(`event`, `listener`): [`EventEmitter`](verida_client_ts._internal_.EventEmitter.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | `string` \| `symbol` | -| `listener` | `Function` | - -#### Returns - -[`EventEmitter`](verida_client_ts._internal_.EventEmitter.md) - -#### Defined in - -node_modules/@types/pouchdb-core/index.d.ts:76 - -___ - -### emit - -▸ **emit**(`event`, ...`args`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | `string` \| `symbol` | -| `...args` | `any`[] | - -#### Returns - -`boolean` - -#### Defined in - -node_modules/@types/pouchdb-core/index.d.ts:84 - -___ - -### eventNames - -▸ **eventNames**(): (`string` \| `symbol`)[] - -#### Returns - -(`string` \| `symbol`)[] - -#### Defined in - -node_modules/@types/pouchdb-core/index.d.ts:88 - -___ - -### getMaxListeners - -▸ **getMaxListeners**(): `number` - -#### Returns - -`number` - -#### Defined in - -node_modules/@types/pouchdb-core/index.d.ts:82 - -___ - -### listenerCount - -▸ **listenerCount**(`type`): `number` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `type` | `string` \| `symbol` | - -#### Returns - -`number` - -#### Defined in - -node_modules/@types/pouchdb-core/index.d.ts:85 - -___ - -### listeners - -▸ **listeners**(`event`): `Function`[] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | `string` \| `symbol` | - -#### Returns - -`Function`[] - -#### Defined in - -node_modules/@types/pouchdb-core/index.d.ts:83 - -___ - -### on - -▸ **on**(`event`, `listener`): [`EventEmitter`](verida_client_ts._internal_.EventEmitter.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | `string` \| `symbol` | -| `listener` | `Function` | - -#### Returns - -[`EventEmitter`](verida_client_ts._internal_.EventEmitter.md) - -#### Defined in - -node_modules/@types/pouchdb-core/index.d.ts:77 - -___ - -### once - -▸ **once**(`event`, `listener`): [`EventEmitter`](verida_client_ts._internal_.EventEmitter.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | `string` \| `symbol` | -| `listener` | `Function` | - -#### Returns - -[`EventEmitter`](verida_client_ts._internal_.EventEmitter.md) - -#### Defined in - -node_modules/@types/pouchdb-core/index.d.ts:78 - -___ - -### prependListener - -▸ **prependListener**(`event`, `listener`): [`EventEmitter`](verida_client_ts._internal_.EventEmitter.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | `string` \| `symbol` | -| `listener` | `Function` | - -#### Returns - -[`EventEmitter`](verida_client_ts._internal_.EventEmitter.md) - -#### Defined in - -node_modules/@types/pouchdb-core/index.d.ts:86 - -___ - -### prependOnceListener - -▸ **prependOnceListener**(`event`, `listener`): [`EventEmitter`](verida_client_ts._internal_.EventEmitter.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | `string` \| `symbol` | -| `listener` | `Function` | - -#### Returns - -[`EventEmitter`](verida_client_ts._internal_.EventEmitter.md) - -#### Defined in - -node_modules/@types/pouchdb-core/index.d.ts:87 - -___ - -### removeAllListeners - -▸ **removeAllListeners**(`event?`): [`EventEmitter`](verida_client_ts._internal_.EventEmitter.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event?` | `string` \| `symbol` | - -#### Returns - -[`EventEmitter`](verida_client_ts._internal_.EventEmitter.md) - -#### Defined in - -node_modules/@types/pouchdb-core/index.d.ts:80 - -___ - -### removeListener - -▸ **removeListener**(`event`, `listener`): [`EventEmitter`](verida_client_ts._internal_.EventEmitter.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | `string` \| `symbol` | -| `listener` | `Function` | - -#### Returns - -[`EventEmitter`](verida_client_ts._internal_.EventEmitter.md) - -#### Defined in - -node_modules/@types/pouchdb-core/index.d.ts:79 - -___ - -### setMaxListeners - -▸ **setMaxListeners**(`n`): [`EventEmitter`](verida_client_ts._internal_.EventEmitter.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `n` | `number` | - -#### Returns - -[`EventEmitter`](verida_client_ts._internal_.EventEmitter.md) - -#### Defined in - -node_modules/@types/pouchdb-core/index.d.ts:81 diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.EventEmitterOptions.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.EventEmitterOptions.md deleted file mode 100644 index 07d5a75..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.EventEmitterOptions.md +++ /dev/null @@ -1,23 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / EventEmitterOptions - -# Interface: EventEmitterOptions - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).EventEmitterOptions - -## Table of contents - -### Properties - -- [captureRejections](verida_client_ts._internal_.EventEmitterOptions.md#capturerejections) - -## Properties - -### captureRejections - -• `Optional` **captureRejections**: `boolean` - -Enables automatic capturing of promise rejection. - -#### Defined in - -node_modules/@types/node/events.d.ts:42 diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.EventFilter.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.EventFilter.md deleted file mode 100644 index 5b8bc91..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.EventFilter.md +++ /dev/null @@ -1,38 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / EventFilter - -# Interface: EventFilter - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).EventFilter - -## Hierarchy - -- **`EventFilter`** - - ↳ [`Filter`](verida_client_ts._internal_.Filter.md) - -## Table of contents - -### Properties - -- [address](verida_client_ts._internal_.EventFilter.md#address) -- [topics](verida_client_ts._internal_.EventFilter.md#topics) - -## Properties - -### address - -• `Optional` **address**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:91 - -___ - -### topics - -• `Optional` **topics**: (``null`` \| `string` \| `string`[])[] - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:92 diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.FeeData.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.FeeData.md deleted file mode 100644 index 906c390..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.FeeData.md +++ /dev/null @@ -1,54 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / FeeData - -# Interface: FeeData - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).FeeData - -## Table of contents - -### Properties - -- [gasPrice](verida_client_ts._internal_.FeeData.md#gasprice) -- [lastBaseFeePerGas](verida_client_ts._internal_.FeeData.md#lastbasefeepergas) -- [maxFeePerGas](verida_client_ts._internal_.FeeData.md#maxfeepergas) -- [maxPriorityFeePerGas](verida_client_ts._internal_.FeeData.md#maxpriorityfeepergas) - -## Properties - -### gasPrice - -• **gasPrice**: ``null`` \| [`BigNumber`](../classes/verida_client_ts._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:88 - -___ - -### lastBaseFeePerGas - -• **lastBaseFeePerGas**: ``null`` \| [`BigNumber`](../classes/verida_client_ts._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:85 - -___ - -### maxFeePerGas - -• **maxFeePerGas**: ``null`` \| [`BigNumber`](../classes/verida_client_ts._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:86 - -___ - -### maxPriorityFeePerGas - -• **maxPriorityFeePerGas**: ``null`` \| [`BigNumber`](../classes/verida_client_ts._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:87 diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.FetchUriParams.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.FetchUriParams.md deleted file mode 100644 index 1ae3904..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.FetchUriParams.md +++ /dev/null @@ -1,65 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / FetchUriParams - -# Interface: FetchUriParams - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).FetchUriParams - -## Table of contents - -### Properties - -- [contextName](verida_client_ts._internal_.FetchUriParams.md#contextname) -- [dbName](verida_client_ts._internal_.FetchUriParams.md#dbname) -- [did](verida_client_ts._internal_.FetchUriParams.md#did) -- [id](verida_client_ts._internal_.FetchUriParams.md#id) -- [query](verida_client_ts._internal_.FetchUriParams.md#query) - -## Properties - -### contextName - -• **contextName**: `string` - -#### Defined in - -[packages/client-ts/src/interfaces.ts:71](https://github.com/verida/verida-js/blob/c03b336/packages/client-ts/src/interfaces.ts#L71) - -___ - -### dbName - -• **dbName**: `string` - -#### Defined in - -[packages/client-ts/src/interfaces.ts:72](https://github.com/verida/verida-js/blob/c03b336/packages/client-ts/src/interfaces.ts#L72) - -___ - -### did - -• **did**: `string` - -#### Defined in - -[packages/client-ts/src/interfaces.ts:70](https://github.com/verida/verida-js/blob/c03b336/packages/client-ts/src/interfaces.ts#L70) - -___ - -### id - -• **id**: `string` - -#### Defined in - -[packages/client-ts/src/interfaces.ts:73](https://github.com/verida/verida-js/blob/c03b336/packages/client-ts/src/interfaces.ts#L73) - -___ - -### query - -• **query**: `any` - -#### Defined in - -[packages/client-ts/src/interfaces.ts:74](https://github.com/verida/verida-js/blob/c03b336/packages/client-ts/src/interfaces.ts#L74) diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.Filter.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.Filter.md deleted file mode 100644 index 9664a34..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.Filter.md +++ /dev/null @@ -1,68 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / Filter - -# Interface: Filter - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).Filter - -## Hierarchy - -- [`EventFilter`](verida_client_ts._internal_.EventFilter.md) - - ↳ **`Filter`** - -## Table of contents - -### Properties - -- [address](verida_client_ts._internal_.Filter.md#address) -- [fromBlock](verida_client_ts._internal_.Filter.md#fromblock) -- [toBlock](verida_client_ts._internal_.Filter.md#toblock) -- [topics](verida_client_ts._internal_.Filter.md#topics) - -## Properties - -### address - -• `Optional` **address**: `string` - -#### Inherited from - -[EventFilter](verida_client_ts._internal_.EventFilter.md).[address](verida_client_ts._internal_.EventFilter.md#address) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:91 - -___ - -### fromBlock - -• `Optional` **fromBlock**: [`BlockTag`](../modules/verida_client_ts._internal_.md#blocktag) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:95 - -___ - -### toBlock - -• `Optional` **toBlock**: [`BlockTag`](../modules/verida_client_ts._internal_.md#blocktag) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:96 - -___ - -### topics - -• `Optional` **topics**: (``null`` \| `string` \| `string`[])[] - -#### Inherited from - -[EventFilter](verida_client_ts._internal_.EventFilter.md).[topics](verida_client_ts._internal_.EventFilter.md#topics) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:92 diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.FormatDefinition.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.FormatDefinition.md deleted file mode 100644 index 72e4566..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.FormatDefinition.md +++ /dev/null @@ -1,60 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / FormatDefinition - -# Interface: FormatDefinition - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).FormatDefinition - -## Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | extends `string` \| `number` | - -## Table of contents - -### Properties - -- [async](verida_client_ts._internal_.FormatDefinition.md#async) -- [compare](verida_client_ts._internal_.FormatDefinition.md#compare) -- [type](verida_client_ts._internal_.FormatDefinition.md#type) -- [validate](verida_client_ts._internal_.FormatDefinition.md#validate) - -## Properties - -### async - -• `Optional` **async**: ``false`` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:160 - -___ - -### compare - -• `Optional` **compare**: [`FormatCompare`](../modules/verida_client_ts._internal_.md#formatcompare)<`T`\> - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:161 - -___ - -### type - -• `Optional` **type**: `T` extends `string` ? `undefined` \| ``"string"`` : ``"number"`` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:158 - -___ - -### validate - -• **validate**: [`FormatValidator`](../modules/verida_client_ts._internal_.md#formatvalidator)<`T`\> \| `T` extends `string` ? `string` \| `RegExp` : `never` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:159 diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.FuncKeywordDefinition.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.FuncKeywordDefinition.md deleted file mode 100644 index c50e953..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.FuncKeywordDefinition.md +++ /dev/null @@ -1,290 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / FuncKeywordDefinition - -# Interface: FuncKeywordDefinition - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).FuncKeywordDefinition - -## Hierarchy - -- [`_KeywordDef`](verida_client_ts._internal_._KeywordDef.md) - - ↳ **`FuncKeywordDefinition`** - - ↳↳ [`MacroKeywordDefinition`](verida_client_ts._internal_.MacroKeywordDefinition.md) - -## Table of contents - -### Properties - -- [$data](verida_client_ts._internal_.FuncKeywordDefinition.md#$data) -- [$dataError](verida_client_ts._internal_.FuncKeywordDefinition.md#$dataerror) -- [allowUndefined](verida_client_ts._internal_.FuncKeywordDefinition.md#allowundefined) -- [async](verida_client_ts._internal_.FuncKeywordDefinition.md#async) -- [before](verida_client_ts._internal_.FuncKeywordDefinition.md#before) -- [compile](verida_client_ts._internal_.FuncKeywordDefinition.md#compile) -- [dependencies](verida_client_ts._internal_.FuncKeywordDefinition.md#dependencies) -- [error](verida_client_ts._internal_.FuncKeywordDefinition.md#error) -- [errors](verida_client_ts._internal_.FuncKeywordDefinition.md#errors) -- [implements](verida_client_ts._internal_.FuncKeywordDefinition.md#implements) -- [keyword](verida_client_ts._internal_.FuncKeywordDefinition.md#keyword) -- [metaSchema](verida_client_ts._internal_.FuncKeywordDefinition.md#metaschema) -- [modifying](verida_client_ts._internal_.FuncKeywordDefinition.md#modifying) -- [post](verida_client_ts._internal_.FuncKeywordDefinition.md#post) -- [schema](verida_client_ts._internal_.FuncKeywordDefinition.md#schema) -- [schemaType](verida_client_ts._internal_.FuncKeywordDefinition.md#schematype) -- [type](verida_client_ts._internal_.FuncKeywordDefinition.md#type) -- [valid](verida_client_ts._internal_.FuncKeywordDefinition.md#valid) -- [validate](verida_client_ts._internal_.FuncKeywordDefinition.md#validate) -- [validateSchema](verida_client_ts._internal_.FuncKeywordDefinition.md#validateschema) - -## Properties - -### $data - -• `Optional` **$data**: `boolean` - -#### Inherited from - -[_KeywordDef](verida_client_ts._internal_._KeywordDef.md).[$data](verida_client_ts._internal_._KeywordDef.md#$data) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:91 - -___ - -### $dataError - -• `Optional` **$dataError**: [`KeywordErrorDefinition`](verida_client_ts._internal_.KeywordErrorDefinition.md) - -#### Inherited from - -[_KeywordDef](verida_client_ts._internal_._KeywordDef.md).[$dataError](verida_client_ts._internal_._KeywordDef.md#$dataerror) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:99 - -___ - -### allowUndefined - -• `Optional` **allowUndefined**: `boolean` - -#### Inherited from - -[_KeywordDef](verida_client_ts._internal_._KeywordDef.md).[allowUndefined](verida_client_ts._internal_._KeywordDef.md#allowundefined) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:90 - -___ - -### async - -• `Optional` **async**: `boolean` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:120 - -___ - -### before - -• `Optional` **before**: `string` - -#### Inherited from - -[_KeywordDef](verida_client_ts._internal_._KeywordDef.md).[before](verida_client_ts._internal_._KeywordDef.md#before) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:93 - -___ - -### compile - -• `Optional` **compile**: [`CompileKeywordFunc`](../modules/verida_client_ts._internal_.md#compilekeywordfunc) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:117 - -___ - -### dependencies - -• `Optional` **dependencies**: `string`[] - -#### Inherited from - -[_KeywordDef](verida_client_ts._internal_._KeywordDef.md).[dependencies](verida_client_ts._internal_._KeywordDef.md#dependencies) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:97 - -___ - -### error - -• `Optional` **error**: [`KeywordErrorDefinition`](verida_client_ts._internal_.KeywordErrorDefinition.md) - -#### Inherited from - -[_KeywordDef](verida_client_ts._internal_._KeywordDef.md).[error](verida_client_ts._internal_._KeywordDef.md#error) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:98 - -___ - -### errors - -• `Optional` **errors**: `boolean` \| ``"full"`` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:122 - -___ - -### implements - -• `Optional` **implements**: `string`[] - -#### Inherited from - -[_KeywordDef](verida_client_ts._internal_._KeywordDef.md).[implements](verida_client_ts._internal_._KeywordDef.md#implements) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:92 - -___ - -### keyword - -• **keyword**: `string` \| `string`[] - -#### Inherited from - -[_KeywordDef](verida_client_ts._internal_._KeywordDef.md).[keyword](verida_client_ts._internal_._KeywordDef.md#keyword) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:87 - -___ - -### metaSchema - -• `Optional` **metaSchema**: [`AnySchemaObject`](../modules/verida_client_ts._internal_.md#anyschemaobject) - -#### Inherited from - -[_KeywordDef](verida_client_ts._internal_._KeywordDef.md).[metaSchema](verida_client_ts._internal_._KeywordDef.md#metaschema) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:95 - -___ - -### modifying - -• `Optional` **modifying**: `boolean` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:119 - -___ - -### post - -• `Optional` **post**: `boolean` - -#### Inherited from - -[_KeywordDef](verida_client_ts._internal_._KeywordDef.md).[post](verida_client_ts._internal_._KeywordDef.md#post) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:94 - -___ - -### schema - -• `Optional` **schema**: `boolean` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:118 - -___ - -### schemaType - -• `Optional` **schemaType**: ``"string"`` \| ``"number"`` \| ``"boolean"`` \| ``"object"`` \| ``"integer"`` \| ``"array"`` \| ``"null"`` \| (``"string"`` \| ``"number"`` \| ``"boolean"`` \| ``"object"`` \| ``"integer"`` \| ``"array"`` \| ``"null"``)[] - -#### Inherited from - -[_KeywordDef](verida_client_ts._internal_._KeywordDef.md).[schemaType](verida_client_ts._internal_._KeywordDef.md#schematype) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:89 - -___ - -### type - -• `Optional` **type**: ``"string"`` \| ``"number"`` \| ``"boolean"`` \| ``"object"`` \| ``"integer"`` \| ``"array"`` \| ``"null"`` \| (``"string"`` \| ``"number"`` \| ``"boolean"`` \| ``"object"`` \| ``"integer"`` \| ``"array"`` \| ``"null"``)[] - -#### Inherited from - -[_KeywordDef](verida_client_ts._internal_._KeywordDef.md).[type](verida_client_ts._internal_._KeywordDef.md#type) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:88 - -___ - -### valid - -• `Optional` **valid**: `boolean` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:121 - -___ - -### validate - -• `Optional` **validate**: [`SchemaValidateFunction`](verida_client_ts._internal_.SchemaValidateFunction.md) \| [`DataValidateFunction`](verida_client_ts._internal_.DataValidateFunction.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:116 - -___ - -### validateSchema - -• `Optional` **validateSchema**: [`AnyValidateFunction`](../modules/verida_client_ts._internal_.md#anyvalidatefunction)<`any`\> - -#### Inherited from - -[_KeywordDef](verida_client_ts._internal_._KeywordDef.md).[validateSchema](verida_client_ts._internal_._KeywordDef.md#validateschema) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:96 diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.Hexable.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.Hexable.md deleted file mode 100644 index 3a1a3c5..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.Hexable.md +++ /dev/null @@ -1,29 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / Hexable - -# Interface: Hexable - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).Hexable - -## Implemented by - -- [`BigNumber`](../classes/verida_client_ts._internal_.BigNumber.md) - -## Table of contents - -### Methods - -- [toHexString](verida_client_ts._internal_.Hexable.md#tohexstring) - -## Methods - -### toHexString - -▸ **toHexString**(): `string` - -#### Returns - -`string` - -#### Defined in - -node_modules/@ethersproject/bytes/lib/index.d.ts:8 diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.IAccount.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.IAccount.md deleted file mode 100644 index c184359..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.IAccount.md +++ /dev/null @@ -1,270 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / IAccount - -# Interface: IAccount - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).IAccount - -## Implemented by - -- [`default`](../classes/verida_client_ts._internal_.default.md) - -## Table of contents - -### Methods - -- [createDidJwt](verida_client_ts._internal_.IAccount.md#createdidjwt) -- [did](verida_client_ts._internal_.IAccount.md#did) -- [disconnect](verida_client_ts._internal_.IAccount.md#disconnect) -- [disconnectDevice](verida_client_ts._internal_.IAccount.md#disconnectdevice) -- [getAuthContext](verida_client_ts._internal_.IAccount.md#getauthcontext) -- [keyring](verida_client_ts._internal_.IAccount.md#keyring) -- [linkStorage](verida_client_ts._internal_.IAccount.md#linkstorage) -- [linkStorageContextService](verida_client_ts._internal_.IAccount.md#linkstoragecontextservice) -- [setAccountConfig](verida_client_ts._internal_.IAccount.md#setaccountconfig) -- [sign](verida_client_ts._internal_.IAccount.md#sign) -- [storageConfig](verida_client_ts._internal_.IAccount.md#storageconfig) -- [unlinkStorage](verida_client_ts._internal_.IAccount.md#unlinkstorage) - -## Methods - -### createDidJwt - -▸ **createDidJwt**(`contextName`, `data`, `config`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | -| `data` | `object` | -| `config` | `any` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -packages/types/dist/IAccount.d.ts:13 - -___ - -### did - -▸ **did**(): `Promise`<`string`\> - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -packages/types/dist/IAccount.d.ts:7 - -___ - -### disconnect - -▸ **disconnect**(`contextName?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName?` | `string` | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -packages/types/dist/IAccount.d.ts:14 - -___ - -### disconnectDevice - -▸ **disconnectDevice**(`contextName`, `deviceId`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | -| `deviceId` | `string` | - -#### Returns - -`Promise`<`boolean`\> - -#### Defined in - -packages/types/dist/IAccount.d.ts:16 - -___ - -### getAuthContext - -▸ **getAuthContext**(`contextName`, `contextConfig`, `authConfig?`, `authType?`): `Promise`<[`AuthContext`](verida_client_ts._internal_.AuthContext.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | -| `contextConfig` | [`SecureContextConfig`](verida_client_ts._internal_.SecureContextConfig.md) | -| `authConfig?` | [`AuthTypeConfig`](verida_client_ts._internal_.AuthTypeConfig.md) | -| `authType?` | `string` | - -#### Returns - -`Promise`<[`AuthContext`](verida_client_ts._internal_.AuthContext.md)\> - -#### Defined in - -packages/types/dist/IAccount.d.ts:15 - -___ - -### keyring - -▸ **keyring**(`contextName`): `Promise`<[`IKeyring`](verida_client_ts._internal_.IKeyring.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | - -#### Returns - -`Promise`<[`IKeyring`](verida_client_ts._internal_.IKeyring.md)\> - -#### Defined in - -packages/types/dist/IAccount.d.ts:5 - -___ - -### linkStorage - -▸ **linkStorage**(`storageConfig`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `storageConfig` | [`SecureContextConfig`](verida_client_ts._internal_.SecureContextConfig.md) | - -#### Returns - -`Promise`<`boolean`\> - -#### Defined in - -packages/types/dist/IAccount.d.ts:8 - -___ - -### linkStorageContextService - -▸ **linkStorageContextService**(`contextName`, `endpointType`, `serverType`, `endpointUris`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | -| `endpointType` | `string` | -| `serverType` | `string` | -| `endpointUris` | `string`[] | - -#### Returns - -`Promise`<`boolean`\> - -#### Defined in - -packages/types/dist/IAccount.d.ts:11 - -___ - -### setAccountConfig - -▸ **setAccountConfig**(`accountConfig`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `accountConfig` | [`AccountConfig`](verida_client_ts._internal_.AccountConfig.md) | - -#### Returns - -`void` - -#### Defined in - -packages/types/dist/IAccount.d.ts:12 - -___ - -### sign - -▸ **sign**(`input`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `input` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -packages/types/dist/IAccount.d.ts:6 - -___ - -### storageConfig - -▸ **storageConfig**(`contextName`, `forceCreate`): `Promise`<`undefined` \| [`SecureContextConfig`](verida_client_ts._internal_.SecureContextConfig.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | -| `forceCreate` | `boolean` | - -#### Returns - -`Promise`<`undefined` \| [`SecureContextConfig`](verida_client_ts._internal_.SecureContextConfig.md)\> - -#### Defined in - -packages/types/dist/IAccount.d.ts:10 - -___ - -### unlinkStorage - -▸ **unlinkStorage**(`contextName`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | - -#### Returns - -`Promise`<`boolean`\> - -#### Defined in - -packages/types/dist/IAccount.d.ts:9 diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.IClient.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.IClient.md deleted file mode 100644 index cda51d5..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.IClient.md +++ /dev/null @@ -1,183 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / IClient - -# Interface: IClient - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).IClient - -## Implemented by - -- [`Client`](../classes/verida_client_ts.Client.md) - -## Table of contents - -### Methods - -- [connect](verida_client_ts._internal_.IClient.md#connect) -- [getContextConfig](verida_client_ts._internal_.IClient.md#getcontextconfig) -- [getSchema](verida_client_ts._internal_.IClient.md#getschema) -- [getValidDataSignatures](verida_client_ts._internal_.IClient.md#getvaliddatasignatures) -- [isConnected](verida_client_ts._internal_.IClient.md#isconnected) -- [openContext](verida_client_ts._internal_.IClient.md#opencontext) -- [openExternalContext](verida_client_ts._internal_.IClient.md#openexternalcontext) -- [openPublicProfile](verida_client_ts._internal_.IClient.md#openpublicprofile) - -## Methods - -### connect - -▸ **connect**(`account`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `account` | [`IAccount`](verida_client_ts._internal_.IAccount.md) | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -packages/types/dist/IClient.d.ts:7 - -___ - -### getContextConfig - -▸ **getContextConfig**(`did`, `contextName`): `Promise`<`undefined` \| [`SecureContextConfig`](verida_client_ts._internal_.SecureContextConfig.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did` | `string` | -| `contextName` | `string` | - -#### Returns - -`Promise`<`undefined` \| [`SecureContextConfig`](verida_client_ts._internal_.SecureContextConfig.md)\> - -#### Defined in - -packages/types/dist/IClient.d.ts:11 - -___ - -### getSchema - -▸ **getSchema**(`schemaUri`): `Promise`<[`ISchema`](verida_client_ts._internal_.ISchema.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schemaUri` | `string` | - -#### Returns - -`Promise`<[`ISchema`](verida_client_ts._internal_.ISchema.md)\> - -#### Defined in - -packages/types/dist/IClient.d.ts:14 - -___ - -### getValidDataSignatures - -▸ **getValidDataSignatures**(`data`, `did?`): `Promise`<`string`[]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `any` | -| `did?` | `string` | - -#### Returns - -`Promise`<`string`[]\> - -#### Defined in - -packages/types/dist/IClient.d.ts:13 - -___ - -### isConnected - -▸ **isConnected**(): `void` - -#### Returns - -`void` - -#### Defined in - -packages/types/dist/IClient.d.ts:8 - -___ - -### openContext - -▸ **openContext**(`contextName`, `forceCreate`): `Promise`<`undefined` \| [`IContext`](verida_client_ts._internal_.IContext.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | -| `forceCreate` | `boolean` | - -#### Returns - -`Promise`<`undefined` \| [`IContext`](verida_client_ts._internal_.IContext.md)\> - -#### Defined in - -packages/types/dist/IClient.d.ts:9 - -___ - -### openExternalContext - -▸ **openExternalContext**(`contextName`, `did`): `Promise`<[`IContext`](verida_client_ts._internal_.IContext.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | -| `did` | `string` | - -#### Returns - -`Promise`<[`IContext`](verida_client_ts._internal_.IContext.md)\> - -#### Defined in - -packages/types/dist/IClient.d.ts:10 - -___ - -### openPublicProfile - -▸ **openPublicProfile**(`did`, `contextName`, `profileName`, `fallbackContext`): `Promise`<`undefined` \| [`IProfile`](verida_client_ts._internal_.IProfile.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did` | `string` | -| `contextName` | `string` | -| `profileName` | `string` | -| `fallbackContext` | ``null`` \| `string` | - -#### Returns - -`Promise`<`undefined` \| [`IProfile`](verida_client_ts._internal_.IProfile.md)\> - -#### Defined in - -packages/types/dist/IClient.d.ts:12 diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.IContext.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.IContext.md deleted file mode 100644 index 1480b14..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.IContext.md +++ /dev/null @@ -1,406 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / IContext - -# Interface: IContext - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).IContext - -## Implemented by - -- [`Context`](../classes/verida_client_ts.Context.md) - -## Table of contents - -### Methods - -- [addEndpoint](verida_client_ts._internal_.IContext.md#addendpoint) -- [clearDatabaseCache](verida_client_ts._internal_.IContext.md#cleardatabasecache) -- [close](verida_client_ts._internal_.IContext.md#close) -- [disconnect](verida_client_ts._internal_.IContext.md#disconnect) -- [getAccount](verida_client_ts._internal_.IContext.md#getaccount) -- [getAuthContext](verida_client_ts._internal_.IContext.md#getauthcontext) -- [getClient](verida_client_ts._internal_.IContext.md#getclient) -- [getContextConfig](verida_client_ts._internal_.IContext.md#getcontextconfig) -- [getContextName](verida_client_ts._internal_.IContext.md#getcontextname) -- [getDatabaseEngine](verida_client_ts._internal_.IContext.md#getdatabaseengine) -- [getDbRegistry](verida_client_ts._internal_.IContext.md#getdbregistry) -- [getDidContextManager](verida_client_ts._internal_.IContext.md#getdidcontextmanager) -- [getMessaging](verida_client_ts._internal_.IContext.md#getmessaging) -- [getNotification](verida_client_ts._internal_.IContext.md#getnotification) -- [info](verida_client_ts._internal_.IContext.md#info) -- [openDatabase](verida_client_ts._internal_.IContext.md#opendatabase) -- [openDatastore](verida_client_ts._internal_.IContext.md#opendatastore) -- [openExternalDatabase](verida_client_ts._internal_.IContext.md#openexternaldatabase) -- [openExternalDatastore](verida_client_ts._internal_.IContext.md#openexternaldatastore) -- [openProfile](verida_client_ts._internal_.IContext.md#openprofile) - -## Methods - -### addEndpoint - -▸ **addEndpoint**(`engineType`, `endpointUri`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `engineType` | [`ContextEngineType`](../enums/verida_client_ts._internal_.ContextEngineType.md) | -| `endpointUri` | `string` | - -#### Returns - -`void` - -#### Defined in - -packages/types/dist/IContext.d.ts:32 - -___ - -### clearDatabaseCache - -▸ **clearDatabaseCache**(`did`, `databaseName`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did` | `string` | -| `databaseName` | `string` | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -packages/types/dist/IContext.d.ts:34 - -___ - -### close - -▸ **close**(`options?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options?` | [`ContextCloseOptions`](verida_client_ts._internal_.ContextCloseOptions.md) | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -packages/types/dist/IContext.d.ts:33 - -___ - -### disconnect - -▸ **disconnect**(): `Promise`<`boolean`\> - -#### Returns - -`Promise`<`boolean`\> - -#### Defined in - -packages/types/dist/IContext.d.ts:20 - -___ - -### getAccount - -▸ **getAccount**(): [`IAccount`](verida_client_ts._internal_.IAccount.md) - -#### Returns - -[`IAccount`](verida_client_ts._internal_.IAccount.md) - -#### Defined in - -packages/types/dist/IContext.d.ts:17 - -___ - -### getAuthContext - -▸ **getAuthContext**(`authConfig?`, `authType?`): `Promise`<[`AuthContext`](verida_client_ts._internal_.AuthContext.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `authConfig?` | [`AuthTypeConfig`](verida_client_ts._internal_.AuthTypeConfig.md) | -| `authType?` | `string` | - -#### Returns - -`Promise`<[`AuthContext`](verida_client_ts._internal_.AuthContext.md)\> - -#### Defined in - -packages/types/dist/IContext.d.ts:31 - -___ - -### getClient - -▸ **getClient**(): [`IClient`](verida_client_ts._internal_.IClient.md) - -#### Returns - -[`IClient`](verida_client_ts._internal_.IClient.md) - -#### Defined in - -packages/types/dist/IContext.d.ts:19 - -___ - -### getContextConfig - -▸ **getContextConfig**(`did?`, `forceCreate?`, `customContextName?`): `Promise`<[`SecureContextConfig`](verida_client_ts._internal_.SecureContextConfig.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did?` | `string` | -| `forceCreate?` | `boolean` | -| `customContextName?` | `string` | - -#### Returns - -`Promise`<[`SecureContextConfig`](verida_client_ts._internal_.SecureContextConfig.md)\> - -#### Defined in - -packages/types/dist/IContext.d.ts:15 - -___ - -### getContextName - -▸ **getContextName**(): `string` - -#### Returns - -`string` - -#### Defined in - -packages/types/dist/IContext.d.ts:16 - -___ - -### getDatabaseEngine - -▸ **getDatabaseEngine**(`did`, `createContext?`): `Promise`<[`IStorageEngine`](verida_client_ts._internal_.IStorageEngine.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did` | `string` | -| `createContext?` | `boolean` | - -#### Returns - -`Promise`<[`IStorageEngine`](verida_client_ts._internal_.IStorageEngine.md)\> - -#### Defined in - -packages/types/dist/IContext.d.ts:21 - -___ - -### getDbRegistry - -▸ **getDbRegistry**(): [`IDbRegistry`](verida_client_ts._internal_.IDbRegistry.md) - -#### Returns - -[`IDbRegistry`](verida_client_ts._internal_.IDbRegistry.md) - -#### Defined in - -packages/types/dist/IContext.d.ts:29 - -___ - -### getDidContextManager - -▸ **getDidContextManager**(): [`IDIDContextManager`](verida_client_ts._internal_.IDIDContextManager.md) - -#### Returns - -[`IDIDContextManager`](verida_client_ts._internal_.IDIDContextManager.md) - -#### Defined in - -packages/types/dist/IContext.d.ts:18 - -___ - -### getMessaging - -▸ **getMessaging**(`messageConfig`): `Promise`<[`IMessaging`](verida_client_ts._internal_.IMessaging.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `messageConfig` | [`MessagesConfig`](verida_client_ts._internal_.MessagesConfig.md) | - -#### Returns - -`Promise`<[`IMessaging`](verida_client_ts._internal_.IMessaging.md)\> - -#### Defined in - -packages/types/dist/IContext.d.ts:22 - -___ - -### getNotification - -▸ **getNotification**(`did`, `contextName`): `Promise`<`undefined` \| [`INotification`](verida_client_ts._internal_.INotification.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did` | `string` | -| `contextName` | `string` | - -#### Returns - -`Promise`<`undefined` \| [`INotification`](verida_client_ts._internal_.INotification.md)\> - -#### Defined in - -packages/types/dist/IContext.d.ts:23 - -___ - -### info - -▸ **info**(): `Promise`<[`ContextInfo`](verida_client_ts._internal_.ContextInfo.md)\> - -#### Returns - -`Promise`<[`ContextInfo`](verida_client_ts._internal_.ContextInfo.md)\> - -#### Defined in - -packages/types/dist/IContext.d.ts:30 - -___ - -### openDatabase - -▸ **openDatabase**(`databaseName`, `config?`): `Promise`<[`IDatabase`](verida_client_ts._internal_.IDatabase.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `databaseName` | `string` | -| `config?` | [`DatabaseOpenConfig`](verida_client_ts._internal_.DatabaseOpenConfig.md) | - -#### Returns - -`Promise`<[`IDatabase`](verida_client_ts._internal_.IDatabase.md)\> - -#### Defined in - -packages/types/dist/IContext.d.ts:25 - -___ - -### openDatastore - -▸ **openDatastore**(`schemaUri`, `config?`): `Promise`<[`IDatastore`](verida_client_ts._internal_.IDatastore.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schemaUri` | `string` | -| `config?` | [`DatastoreOpenConfig`](verida_client_ts._internal_.DatastoreOpenConfig.md) | - -#### Returns - -`Promise`<[`IDatastore`](verida_client_ts._internal_.IDatastore.md)\> - -#### Defined in - -packages/types/dist/IContext.d.ts:27 - -___ - -### openExternalDatabase - -▸ **openExternalDatabase**(`databaseName`, `did`, `config?`): `Promise`<[`IDatabase`](verida_client_ts._internal_.IDatabase.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `databaseName` | `string` | -| `did` | `string` | -| `config?` | [`DatabaseOpenConfig`](verida_client_ts._internal_.DatabaseOpenConfig.md) | - -#### Returns - -`Promise`<[`IDatabase`](verida_client_ts._internal_.IDatabase.md)\> - -#### Defined in - -packages/types/dist/IContext.d.ts:26 - -___ - -### openExternalDatastore - -▸ **openExternalDatastore**(`schemaUri`, `did`, `options?`): `Promise`<[`IDatastore`](verida_client_ts._internal_.IDatastore.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schemaUri` | `string` | -| `did` | `string` | -| `options?` | [`DatastoreOpenConfig`](verida_client_ts._internal_.DatastoreOpenConfig.md) | - -#### Returns - -`Promise`<[`IDatastore`](verida_client_ts._internal_.IDatastore.md)\> - -#### Defined in - -packages/types/dist/IContext.d.ts:28 - -___ - -### openProfile - -▸ **openProfile**(`profileName?`, `did?`): `Promise`<`undefined` \| [`IProfile`](verida_client_ts._internal_.IProfile.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `profileName?` | `string` | -| `did?` | `string` | - -#### Returns - -`Promise`<`undefined` \| [`IProfile`](verida_client_ts._internal_.IProfile.md)\> - -#### Defined in - -packages/types/dist/IContext.d.ts:24 diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.IDIDClient.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.IDIDClient.md deleted file mode 100644 index 85bbe41..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.IDIDClient.md +++ /dev/null @@ -1,155 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / IDIDClient - -# Interface: IDIDClient - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).IDIDClient - -## Implemented by - -- [`DIDClient`](../classes/verida_client_ts._internal_.DIDClient.md) - -## Table of contents - -### Methods - -- [authenticate](verida_client_ts._internal_.IDIDClient.md#authenticate) -- [authenticated](verida_client_ts._internal_.IDIDClient.md#authenticated) -- [get](verida_client_ts._internal_.IDIDClient.md#get) -- [getDid](verida_client_ts._internal_.IDIDClient.md#getdid) -- [getLastEndpointErrors](verida_client_ts._internal_.IDIDClient.md#getlastendpointerrors) -- [getPublicKey](verida_client_ts._internal_.IDIDClient.md#getpublickey) -- [getRpcUrl](verida_client_ts._internal_.IDIDClient.md#getrpcurl) -- [save](verida_client_ts._internal_.IDIDClient.md#save) - -## Methods - -### authenticate - -▸ **authenticate**(`veridaPrivateKey`, `callType`, `web3Config`, `defaultEndpoints`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `veridaPrivateKey` | `string` | -| `callType` | [`Web3CallType`](../modules/verida_client_ts._internal_.md#web3calltype) | -| `web3Config` | [`Web3SelfTransactionConfigPart`](verida_client_ts._internal_.Web3SelfTransactionConfigPart.md) \| [`Web3MetaTransactionConfig`](verida_client_ts._internal_.Web3MetaTransactionConfig.md) | -| `defaultEndpoints` | `string`[] | - -#### Returns - -`void` - -#### Defined in - -packages/types/dist/IDIDClient.d.ts:4 - -___ - -### authenticated - -▸ **authenticated**(): `boolean` - -#### Returns - -`boolean` - -#### Defined in - -packages/types/dist/IDIDClient.d.ts:5 - -___ - -### get - -▸ **get**(`did`): `Promise`<[`IDIDDocument`](verida_client_ts._internal_.IDIDDocument.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did` | `string` | - -#### Returns - -`Promise`<[`IDIDDocument`](verida_client_ts._internal_.IDIDDocument.md)\> - -#### Defined in - -packages/types/dist/IDIDClient.d.ts:10 - -___ - -### getDid - -▸ **getDid**(): `undefined` \| `string` - -#### Returns - -`undefined` \| `string` - -#### Defined in - -packages/types/dist/IDIDClient.d.ts:6 - -___ - -### getLastEndpointErrors - -▸ **getLastEndpointErrors**(): [`VdaDidEndpointResponses`](../modules/verida_client_ts._internal_.md#vdadidendpointresponses) - -#### Returns - -[`VdaDidEndpointResponses`](../modules/verida_client_ts._internal_.md#vdadidendpointresponses) - -#### Defined in - -packages/types/dist/IDIDClient.d.ts:9 - -___ - -### getPublicKey - -▸ **getPublicKey**(): `undefined` \| `string` - -#### Returns - -`undefined` \| `string` - -#### Defined in - -packages/types/dist/IDIDClient.d.ts:7 - -___ - -### getRpcUrl - -▸ **getRpcUrl**(): `string` - -#### Returns - -`string` - -#### Defined in - -packages/types/dist/IDIDClient.d.ts:11 - -___ - -### save - -▸ **save**(`document`): `Promise`<[`VdaDidEndpointResponses`](../modules/verida_client_ts._internal_.md#vdadidendpointresponses)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `document` | [`IDIDDocument`](verida_client_ts._internal_.IDIDDocument.md) | - -#### Returns - -`Promise`<[`VdaDidEndpointResponses`](../modules/verida_client_ts._internal_.md#vdadidendpointresponses)\> - -#### Defined in - -packages/types/dist/IDIDClient.d.ts:8 diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.IDIDContextManager.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.IDIDContextManager.md deleted file mode 100644 index 620ef37..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.IDIDContextManager.md +++ /dev/null @@ -1,145 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / IDIDContextManager - -# Interface: IDIDContextManager - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).IDIDContextManager - -## Table of contents - -### Methods - -- [getContextDatabaseServer](verida_client_ts._internal_.IDIDContextManager.md#getcontextdatabaseserver) -- [getContextMessageServer](verida_client_ts._internal_.IDIDContextManager.md#getcontextmessageserver) -- [getContextStorageServer](verida_client_ts._internal_.IDIDContextManager.md#getcontextstorageserver) -- [getDIDContextConfig](verida_client_ts._internal_.IDIDContextManager.md#getdidcontextconfig) -- [getDIDContextHashConfig](verida_client_ts._internal_.IDIDContextManager.md#getdidcontexthashconfig) -- [setAccount](verida_client_ts._internal_.IDIDContextManager.md#setaccount) - -## Methods - -### getContextDatabaseServer - -▸ **getContextDatabaseServer**(`did`, `contextName`, `forceCreate`): `Promise`<[`SecureContextEndpoint`](verida_client_ts._internal_.SecureContextEndpoint.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did` | `string` | -| `contextName` | `string` | -| `forceCreate` | `boolean` | - -#### Returns - -`Promise`<[`SecureContextEndpoint`](verida_client_ts._internal_.SecureContextEndpoint.md)\> - -#### Defined in - -packages/types/dist/IDIDContextManager.d.ts:6 - -___ - -### getContextMessageServer - -▸ **getContextMessageServer**(`did`, `contextName`, `forceCreate`): `Promise`<[`SecureContextEndpoint`](verida_client_ts._internal_.SecureContextEndpoint.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did` | `string` | -| `contextName` | `string` | -| `forceCreate` | `boolean` | - -#### Returns - -`Promise`<[`SecureContextEndpoint`](verida_client_ts._internal_.SecureContextEndpoint.md)\> - -#### Defined in - -packages/types/dist/IDIDContextManager.d.ts:8 - -___ - -### getContextStorageServer - -▸ **getContextStorageServer**(`did`, `contextName`, `forceCreate`): `Promise`<[`SecureContextEndpoint`](verida_client_ts._internal_.SecureContextEndpoint.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did` | `string` | -| `contextName` | `string` | -| `forceCreate` | `boolean` | - -#### Returns - -`Promise`<[`SecureContextEndpoint`](verida_client_ts._internal_.SecureContextEndpoint.md)\> - -#### Defined in - -packages/types/dist/IDIDContextManager.d.ts:7 - -___ - -### getDIDContextConfig - -▸ **getDIDContextConfig**(`did`, `contextName`, `forceCreate?`): `Promise`<[`SecureContextConfig`](verida_client_ts._internal_.SecureContextConfig.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did` | `string` | -| `contextName` | `string` | -| `forceCreate?` | `boolean` | - -#### Returns - -`Promise`<[`SecureContextConfig`](verida_client_ts._internal_.SecureContextConfig.md)\> - -#### Defined in - -packages/types/dist/IDIDContextManager.d.ts:10 - -___ - -### getDIDContextHashConfig - -▸ **getDIDContextHashConfig**(`did`, `contextHash`): `Promise`<[`SecureContextConfig`](verida_client_ts._internal_.SecureContextConfig.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did` | `string` | -| `contextHash` | `string` | - -#### Returns - -`Promise`<[`SecureContextConfig`](verida_client_ts._internal_.SecureContextConfig.md)\> - -#### Defined in - -packages/types/dist/IDIDContextManager.d.ts:9 - -___ - -### setAccount - -▸ **setAccount**(`account`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `account` | [`IAccount`](verida_client_ts._internal_.IAccount.md) | - -#### Returns - -`void` - -#### Defined in - -packages/types/dist/IDIDContextManager.d.ts:5 diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.IDIDDocument.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.IDIDDocument.md deleted file mode 100644 index 80e7cd5..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.IDIDDocument.md +++ /dev/null @@ -1,364 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / IDIDDocument - -# Interface: IDIDDocument - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).IDIDDocument - -## Implemented by - -- [`default`](../classes/verida_client_ts._internal_.default-1.md) - -## Table of contents - -### Accessors - -- [id](verida_client_ts._internal_.IDIDDocument.md#id) - -### Methods - -- [addContext](verida_client_ts._internal_.IDIDDocument.md#addcontext) -- [addContextAsymKey](verida_client_ts._internal_.IDIDDocument.md#addcontextasymkey) -- [addContextService](verida_client_ts._internal_.IDIDDocument.md#addcontextservice) -- [addContextSignKey](verida_client_ts._internal_.IDIDDocument.md#addcontextsignkey) -- [buildTimestamp](verida_client_ts._internal_.IDIDDocument.md#buildtimestamp) -- [export](verida_client_ts._internal_.IDIDDocument.md#export) -- [getErrors](verida_client_ts._internal_.IDIDDocument.md#geterrors) -- [import](verida_client_ts._internal_.IDIDDocument.md#import) -- [locateContextProof](verida_client_ts._internal_.IDIDDocument.md#locatecontextproof) -- [locateServiceEndpoint](verida_client_ts._internal_.IDIDDocument.md#locateserviceendpoint) -- [removeContext](verida_client_ts._internal_.IDIDDocument.md#removecontext) -- [setAttributes](verida_client_ts._internal_.IDIDDocument.md#setattributes) -- [signProof](verida_client_ts._internal_.IDIDDocument.md#signproof) -- [verifyContextSignature](verida_client_ts._internal_.IDIDDocument.md#verifycontextsignature) -- [verifyProof](verida_client_ts._internal_.IDIDDocument.md#verifyproof) -- [verifySig](verida_client_ts._internal_.IDIDDocument.md#verifysig) - -## Accessors - -### id - -• `get` **id**(): `string` - -#### Returns - -`string` - -#### Defined in - -packages/types/dist/IDIDDocument.d.ts:5 - -## Methods - -### addContext - -▸ **addContext**(`contextName`, `keyring`, `privateKey`, `endpoints`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | -| `keyring` | [`IKeyring`](verida_client_ts._internal_.IKeyring.md) | -| `privateKey` | `string` | -| `endpoints` | [`SecureContextEndpoints`](verida_client_ts._internal_.SecureContextEndpoints.md) | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -packages/types/dist/IDIDDocument.d.ts:7 - -___ - -### addContextAsymKey - -▸ **addContextAsymKey**(`contextHash`, `publicKeyHex`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextHash` | `string` | -| `publicKeyHex` | `string` | - -#### Returns - -`void` - -#### Defined in - -packages/types/dist/IDIDDocument.d.ts:14 - -___ - -### addContextService - -▸ **addContextService**(`contextHash`, `endpointType`, `serviceType`, `endpointUris`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextHash` | `string` | -| `endpointType` | [`SecureContextEndpointType`](../enums/verida_client_ts._internal_.SecureContextEndpointType.md) | -| `serviceType` | `string` | -| `endpointUris` | [`ServiceEndpoint`](../modules/verida_client_ts._internal_.md#serviceendpoint)[] | - -#### Returns - -`void` - -#### Defined in - -packages/types/dist/IDIDDocument.d.ts:12 - -___ - -### addContextSignKey - -▸ **addContextSignKey**(`contextHash`, `publicKeyHex`, `proof`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextHash` | `string` | -| `publicKeyHex` | `string` | -| `proof` | `string` | - -#### Returns - -`void` - -#### Defined in - -packages/types/dist/IDIDDocument.d.ts:13 - -___ - -### buildTimestamp - -▸ **buildTimestamp**(`date`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `date` | `Date` | - -#### Returns - -`string` - -#### Defined in - -packages/types/dist/IDIDDocument.d.ts:21 - -___ - -### export - -▸ **export**(): [`VeridaDocInterface`](verida_client_ts._internal_.VeridaDocInterface.md) - -#### Returns - -[`VeridaDocInterface`](verida_client_ts._internal_.VeridaDocInterface.md) - -#### Defined in - -packages/types/dist/IDIDDocument.d.ts:11 - -___ - -### getErrors - -▸ **getErrors**(): `string`[] - -#### Returns - -`string`[] - -#### Defined in - -packages/types/dist/IDIDDocument.d.ts:6 - -___ - -### import - -▸ **import**(`doc`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `doc` | [`VeridaDocInterface`](verida_client_ts._internal_.VeridaDocInterface.md) | - -#### Returns - -`void` - -#### Defined in - -packages/types/dist/IDIDDocument.d.ts:10 - -___ - -### locateContextProof - -▸ **locateContextProof**(`contextName`): `undefined` \| `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | - -#### Returns - -`undefined` \| `string` - -#### Defined in - -packages/types/dist/IDIDDocument.d.ts:18 - -___ - -### locateServiceEndpoint - -▸ **locateServiceEndpoint**(`contextName`, `endpointType`): `undefined` \| [`Service`](verida_client_ts._internal_.Service.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | -| `endpointType` | [`SecureContextEndpointType`](../enums/verida_client_ts._internal_.SecureContextEndpointType.md) | - -#### Returns - -`undefined` \| [`Service`](verida_client_ts._internal_.Service.md) - -#### Defined in - -packages/types/dist/IDIDDocument.d.ts:17 - -___ - -### removeContext - -▸ **removeContext**(`contextName`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | - -#### Returns - -`boolean` - -#### Defined in - -packages/types/dist/IDIDDocument.d.ts:8 - -___ - -### setAttributes - -▸ **setAttributes**(`attributes`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `attributes` | [`Record`](../modules/verida_client_ts._internal_.md#record)<`string`, `any`\> | - -#### Returns - -`void` - -#### Defined in - -packages/types/dist/IDIDDocument.d.ts:9 - -___ - -### signProof - -▸ **signProof**(`privateKey`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `privateKey` | `string` \| `Uint8Array` | - -#### Returns - -`void` - -#### Defined in - -packages/types/dist/IDIDDocument.d.ts:19 - -___ - -### verifyContextSignature - -▸ **verifyContextSignature**(`data`, `contextName`, `signature`, `contextIsHash`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `any` | -| `contextName` | `string` | -| `signature` | `string` | -| `contextIsHash` | `boolean` | - -#### Returns - -`boolean` - -#### Defined in - -packages/types/dist/IDIDDocument.d.ts:16 - -___ - -### verifyProof - -▸ **verifyProof**(): `boolean` - -#### Returns - -`boolean` - -#### Defined in - -packages/types/dist/IDIDDocument.d.ts:20 - -___ - -### verifySig - -▸ **verifySig**(`data`, `signature`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `any` | -| `signature` | `string` | - -#### Returns - -`boolean` - -#### Defined in - -packages/types/dist/IDIDDocument.d.ts:15 diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.IDatabase.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.IDatabase.md deleted file mode 100644 index f7492ef..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.IDatabase.md +++ /dev/null @@ -1,261 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / IDatabase - -# Interface: IDatabase - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).IDatabase - -Interface for any database returned from a storage engine - -## Table of contents - -### Methods - -- [changes](verida_client_ts._internal_.IDatabase.md#changes) -- [close](verida_client_ts._internal_.IDatabase.md#close) -- [delete](verida_client_ts._internal_.IDatabase.md#delete) -- [deleteAll](verida_client_ts._internal_.IDatabase.md#deleteall) -- [destroy](verida_client_ts._internal_.IDatabase.md#destroy) -- [get](verida_client_ts._internal_.IDatabase.md#get) -- [getDb](verida_client_ts._internal_.IDatabase.md#getdb) -- [getMany](verida_client_ts._internal_.IDatabase.md#getmany) -- [info](verida_client_ts._internal_.IDatabase.md#info) -- [registryEntry](verida_client_ts._internal_.IDatabase.md#registryentry) -- [save](verida_client_ts._internal_.IDatabase.md#save) -- [updateUsers](verida_client_ts._internal_.IDatabase.md#updateusers) -- [usage](verida_client_ts._internal_.IDatabase.md#usage) - -## Methods - -### changes - -▸ **changes**(`cb`, `options?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `cb` | `Function` | -| `options?` | `any` | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -packages/types/dist/IDatabase.d.ts:11 - -___ - -### close - -▸ **close**(`options?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options?` | [`DatabaseCloseOptions`](verida_client_ts._internal_.DatabaseCloseOptions.md) | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -packages/types/dist/IDatabase.d.ts:16 - -___ - -### delete - -▸ **delete**(`doc`, `options?`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `doc` | `any` | -| `options?` | `any` | - -#### Returns - -`Promise`<`boolean`\> - -#### Defined in - -packages/types/dist/IDatabase.d.ts:9 - -___ - -### deleteAll - -▸ **deleteAll**(): `Promise`<`void`\> - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -packages/types/dist/IDatabase.d.ts:10 - -___ - -### destroy - -▸ **destroy**(`options?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options?` | [`DatabaseDeleteConfig`](verida_client_ts._internal_.DatabaseDeleteConfig.md) | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -packages/types/dist/IDatabase.d.ts:17 - -___ - -### get - -▸ **get**(`docId`, `options?`): `Promise`<`undefined` \| `object`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `docId` | `any` | -| `options?` | `any` | - -#### Returns - -`Promise`<`undefined` \| `object`\> - -#### Defined in - -packages/types/dist/IDatabase.d.ts:8 - -___ - -### getDb - -▸ **getDb**(): `Promise`<`any`\> - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -packages/types/dist/IDatabase.d.ts:13 - -___ - -### getMany - -▸ **getMany**(`filter?`, `options?`): `Promise`<`object`[]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `filter?` | `any` | -| `options?` | `any` | - -#### Returns - -`Promise`<`object`[]\> - -#### Defined in - -packages/types/dist/IDatabase.d.ts:7 - -___ - -### info - -▸ **info**(): `Promise`<`any`\> - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -packages/types/dist/IDatabase.d.ts:14 - -___ - -### registryEntry - -▸ **registryEntry**(): `Promise`<[`DbRegistryEntry`](verida_client_ts._internal_.DbRegistryEntry.md)\> - -#### Returns - -`Promise`<[`DbRegistryEntry`](verida_client_ts._internal_.DbRegistryEntry.md)\> - -#### Defined in - -packages/types/dist/IDatabase.d.ts:15 - -___ - -### save - -▸ **save**(`data`, `options?`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `any` | -| `options?` | `any` | - -#### Returns - -`Promise`<`boolean`\> - -#### Defined in - -packages/types/dist/IDatabase.d.ts:6 - -___ - -### updateUsers - -▸ **updateUsers**(`readList`, `writeList`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `readList` | `string`[] | -| `writeList` | `string`[] | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -packages/types/dist/IDatabase.d.ts:12 - -___ - -### usage - -▸ **usage**(): `Promise`<[`EndpointUsage`](verida_client_ts._internal_.EndpointUsage.md)\> - -#### Returns - -`Promise`<[`EndpointUsage`](verida_client_ts._internal_.EndpointUsage.md)\> - -#### Defined in - -packages/types/dist/IDatabase.d.ts:18 diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.IDatastore.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.IDatastore.md deleted file mode 100644 index 5becd8f..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.IDatastore.md +++ /dev/null @@ -1,253 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / IDatastore - -# Interface: IDatastore - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).IDatastore - -## Implemented by - -- [`Datastore`](../classes/verida_client_ts._internal_.Datastore.md) - -## Table of contents - -### Properties - -- [errors](verida_client_ts._internal_.IDatastore.md#errors) - -### Methods - -- [changes](verida_client_ts._internal_.IDatastore.md#changes) -- [close](verida_client_ts._internal_.IDatastore.md#close) -- [delete](verida_client_ts._internal_.IDatastore.md#delete) -- [deleteAll](verida_client_ts._internal_.IDatastore.md#deleteall) -- [ensureIndexes](verida_client_ts._internal_.IDatastore.md#ensureindexes) -- [get](verida_client_ts._internal_.IDatastore.md#get) -- [getDb](verida_client_ts._internal_.IDatastore.md#getdb) -- [getMany](verida_client_ts._internal_.IDatastore.md#getmany) -- [getOne](verida_client_ts._internal_.IDatastore.md#getone) -- [save](verida_client_ts._internal_.IDatastore.md#save) -- [updateUsers](verida_client_ts._internal_.IDatastore.md#updateusers) - -## Properties - -### errors - -• **errors**: `any` - -#### Defined in - -packages/types/dist/IDatastore.d.ts:4 - -## Methods - -### changes - -▸ **changes**(`cb`, `options`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `cb` | `any` | -| `options` | `any` | - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -packages/types/dist/IDatastore.d.ts:12 - -___ - -### close - -▸ **close**(`options?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options?` | [`DatabaseCloseOptions`](verida_client_ts._internal_.DatabaseCloseOptions.md) | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -packages/types/dist/IDatastore.d.ts:15 - -___ - -### delete - -▸ **delete**(`docId`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `docId` | `string` | - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -packages/types/dist/IDatastore.d.ts:9 - -___ - -### deleteAll - -▸ **deleteAll**(): `Promise`<`void`\> - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -packages/types/dist/IDatastore.d.ts:10 - -___ - -### ensureIndexes - -▸ **ensureIndexes**(`indexes`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `indexes` | `any` | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -packages/types/dist/IDatastore.d.ts:13 - -___ - -### get - -▸ **get**(`key`, `options`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `key` | `string` | -| `options` | `any` | - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -packages/types/dist/IDatastore.d.ts:8 - -___ - -### getDb - -▸ **getDb**(): `Promise`<[`IDatabase`](verida_client_ts._internal_.IDatabase.md)\> - -#### Returns - -`Promise`<[`IDatabase`](verida_client_ts._internal_.IDatabase.md)\> - -#### Defined in - -packages/types/dist/IDatastore.d.ts:11 - -___ - -### getMany - -▸ **getMany**(`customFilter?`, `options?`): `Promise`<`object`[]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `customFilter?` | `any` | -| `options?` | `any` | - -#### Returns - -`Promise`<`object`[]\> - -#### Defined in - -packages/types/dist/IDatastore.d.ts:6 - -___ - -### getOne - -▸ **getOne**(`customFilter?`, `options?`): `Promise`<`undefined` \| `object`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `customFilter?` | `any` | -| `options?` | `any` | - -#### Returns - -`Promise`<`undefined` \| `object`\> - -#### Defined in - -packages/types/dist/IDatastore.d.ts:7 - -___ - -### save - -▸ **save**(`data`, `options`): `Promise`<`boolean` \| `object`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `any` | -| `options` | `any` | - -#### Returns - -`Promise`<`boolean` \| `object`\> - -#### Defined in - -packages/types/dist/IDatastore.d.ts:5 - -___ - -### updateUsers - -▸ **updateUsers**(`readList`, `writeList`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `readList` | `string`[] | -| `writeList` | `string`[] | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -packages/types/dist/IDatastore.d.ts:14 diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.IDbRegistry.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.IDbRegistry.md deleted file mode 100644 index 80fa7a0..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.IDbRegistry.md +++ /dev/null @@ -1,119 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / IDbRegistry - -# Interface: IDbRegistry - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).IDbRegistry - -## Implemented by - -- [`DbRegistry`](../classes/verida_client_ts._internal_.DbRegistry.md) - -## Table of contents - -### Methods - -- [get](verida_client_ts._internal_.IDbRegistry.md#get) -- [getMany](verida_client_ts._internal_.IDbRegistry.md#getmany) -- [init](verida_client_ts._internal_.IDbRegistry.md#init) -- [removeDb](verida_client_ts._internal_.IDbRegistry.md#removedb) -- [saveDb](verida_client_ts._internal_.IDbRegistry.md#savedb) - -## Methods - -### get - -▸ **get**(`dbName`, `did`, `contextName`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `dbName` | `string` | -| `did` | `string` | -| `contextName` | `string` | - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -packages/types/dist/IDbRegistry.d.ts:6 - -___ - -### getMany - -▸ **getMany**(`filter`, `options`): `Promise`<`any`[]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `filter` | `any` | -| `options` | `any` | - -#### Returns - -`Promise`<`any`[]\> - -#### Defined in - -packages/types/dist/IDbRegistry.d.ts:5 - -___ - -### init - -▸ **init**(): `Promise`<`void`\> - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -packages/types/dist/IDbRegistry.d.ts:7 - -___ - -### removeDb - -▸ **removeDb**(`databaseName`, `did`, `contextName`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `databaseName` | `string` | -| `did` | `string` | -| `contextName` | `string` | - -#### Returns - -`Promise`<`boolean`\> - -#### Defined in - -packages/types/dist/IDbRegistry.d.ts:4 - -___ - -### saveDb - -▸ **saveDb**(`database`, `checkPermissions`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `database` | [`IDatabase`](verida_client_ts._internal_.IDatabase.md) | -| `checkPermissions` | `boolean` | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -packages/types/dist/IDbRegistry.d.ts:3 diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.IKeyring.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.IKeyring.md deleted file mode 100644 index 9f0c10b..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.IKeyring.md +++ /dev/null @@ -1,266 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / IKeyring - -# Interface: IKeyring - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).IKeyring - -## Implemented by - -- [`default`](../classes/verida_client_ts._internal_.default-2.md) - -## Table of contents - -### Methods - -- [\_init](verida_client_ts._internal_.IKeyring.md#_init) -- [asymDecrypt](verida_client_ts._internal_.IKeyring.md#asymdecrypt) -- [asymEncrypt](verida_client_ts._internal_.IKeyring.md#asymencrypt) -- [buildSharedKeyEnd](verida_client_ts._internal_.IKeyring.md#buildsharedkeyend) -- [buildSharedKeyStart](verida_client_ts._internal_.IKeyring.md#buildsharedkeystart) -- [getKeys](verida_client_ts._internal_.IKeyring.md#getkeys) -- [getSeed](verida_client_ts._internal_.IKeyring.md#getseed) -- [getStorageContextKey](verida_client_ts._internal_.IKeyring.md#getstoragecontextkey) -- [publicKeys](verida_client_ts._internal_.IKeyring.md#publickeys) -- [sign](verida_client_ts._internal_.IKeyring.md#sign) -- [symDecrypt](verida_client_ts._internal_.IKeyring.md#symdecrypt) -- [symEncrypt](verida_client_ts._internal_.IKeyring.md#symencrypt) -- [verifySig](verida_client_ts._internal_.IKeyring.md#verifysig) - -## Methods - -### \_init - -▸ **_init**(): `Promise`<`void`\> - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:3 - -___ - -### asymDecrypt - -▸ **asymDecrypt**(`messageWithNonce`, `secretOrSharedKey`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `messageWithNonce` | `string` | -| `secretOrSharedKey` | `Uint8Array` | - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:10 - -___ - -### asymEncrypt - -▸ **asymEncrypt**(`data`, `secretOrSharedKey`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `string` | -| `secretOrSharedKey` | `Uint8Array` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:9 - -___ - -### buildSharedKeyEnd - -▸ **buildSharedKeyEnd**(`publicKey`): `Promise`<`Uint8Array`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `publicKey` | `Uint8Array` | - -#### Returns - -`Promise`<`Uint8Array`\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:12 - -___ - -### buildSharedKeyStart - -▸ **buildSharedKeyStart**(`privateKey`): `Promise`<`Uint8Array`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `privateKey` | `Uint8Array` | - -#### Returns - -`Promise`<`Uint8Array`\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:11 - -___ - -### getKeys - -▸ **getKeys**(): `Promise`<`any`\> - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:2 - -___ - -### getSeed - -▸ **getSeed**(): `string` - -#### Returns - -`string` - -#### Defined in - -packages/types/dist/IKeyring.d.ts:13 - -___ - -### getStorageContextKey - -▸ **getStorageContextKey**(`databaseName`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `databaseName` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:14 - -___ - -### publicKeys - -▸ **publicKeys**(): `Promise`<[`KeyringPublicKeys`](verida_client_ts._internal_.KeyringPublicKeys.md)\> - -#### Returns - -`Promise`<[`KeyringPublicKeys`](verida_client_ts._internal_.KeyringPublicKeys.md)\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:4 - -___ - -### sign - -▸ **sign**(`data`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `any` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:5 - -___ - -### symDecrypt - -▸ **symDecrypt**(`data`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `string` | - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:8 - -___ - -### symEncrypt - -▸ **symEncrypt**(`data`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:7 - -___ - -### verifySig - -▸ **verifySig**(`data`, `sig`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `string` | -| `sig` | `string` | - -#### Returns - -`Promise`<`boolean`\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:6 diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.IMessaging.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.IMessaging.md deleted file mode 100644 index 0a6e384..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.IMessaging.md +++ /dev/null @@ -1,180 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / IMessaging - -# Interface: IMessaging - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).IMessaging - -Interface Messaging - -## Table of contents - -### Methods - -- [connectAccount](verida_client_ts._internal_.IMessaging.md#connectaccount) -- [getInbox](verida_client_ts._internal_.IMessaging.md#getinbox) -- [getMessages](verida_client_ts._internal_.IMessaging.md#getmessages) -- [init](verida_client_ts._internal_.IMessaging.md#init) -- [offMessage](verida_client_ts._internal_.IMessaging.md#offmessage) -- [onMessage](verida_client_ts._internal_.IMessaging.md#onmessage) -- [send](verida_client_ts._internal_.IMessaging.md#send) - -## Methods - -### connectAccount - -▸ **connectAccount**(`account`): `Promise`<`void`\> - -Connect an account to this messaging instance. - -Used internally. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `account` | [`IAccount`](verida_client_ts._internal_.IAccount.md) | Account | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -packages/types/dist/IMessaging.d.ts:62 - -___ - -### getInbox - -▸ **getInbox**(): `Promise`<`any`\> - -Get the underlying inbox instance specific for the message storage type. - -#### Returns - -`Promise`<`any`\> - -any Currently returns a `Datastore` instance. - -#### Defined in - -packages/types/dist/IMessaging.d.ts:54 - -___ - -### getMessages - -▸ **getMessages**(`filter?`, `options?`): `Promise`<`any`\> - -Get messages from this inbox. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `filter?` | `object` | object An optional datastore filter | -| `options?` | `any` | object An optional list of datastore options | - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -packages/types/dist/IMessaging.d.ts:48 - -___ - -### init - -▸ **init**(): `Promise`<`void`\> - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -packages/types/dist/IMessaging.d.ts:9 - -___ - -### offMessage - -▸ **offMessage**(`callback`): `Promise`<`void`\> - -Unregister a callback to fire when a new message is received - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `callback` | `any` | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -packages/types/dist/IMessaging.d.ts:41 - -___ - -### onMessage - -▸ **onMessage**(`callback`): `Promise`<[`EventEmitter`](../classes/verida_client_ts._internal_.EventEmitter-1.md)\> - -Register a callback to fire when a new message is received from another DID or application. - -Usage: - -``` -// configure the listener -const callback = (msg) => { console.log(msg) } -const emitter = messaging.onMessage(callback) -``` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `callback` | `any` | - -#### Returns - -`Promise`<[`EventEmitter`](../classes/verida_client_ts._internal_.EventEmitter-1.md)\> - -Returns an event emitter - -#### Defined in - -packages/types/dist/IMessaging.d.ts:35 - -___ - -### send - -▸ **send**(`did`, `type`, `data`, `message`, `config`): `Promise`<``null`` \| `object`\> - -Send a message to another DID on the network. - -**`todo:`** Link to documentation - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `did` | `string` | string DID to receive the message | -| `type` | `string` | string Type of inbox message (See https://github.com/verida/schemas/tree/master/schemas/inbox/type). ie: `dataSend` | -| `data` | `object` | object Data to send. Structure of data will depend on the inbox message type. | -| `message` | `string` | string A human readable message that will be displayed to the user upon receipt of the message. Similar to an email subject. | -| `config` | [`MessageSendConfig`](verida_client_ts._internal_.MessageSendConfig.md) | object Optional configuration. | - -#### Returns - -`Promise`<``null`` \| `object`\> - -#### Defined in - -packages/types/dist/IMessaging.d.ts:21 diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.INotification.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.INotification.md deleted file mode 100644 index 2ec2e67..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.INotification.md +++ /dev/null @@ -1,71 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / INotification - -# Interface: INotification - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).INotification - -Interface for notifications - -## Table of contents - -### Methods - -- [getErrors](verida_client_ts._internal_.INotification.md#geterrors) -- [init](verida_client_ts._internal_.INotification.md#init) -- [ping](verida_client_ts._internal_.INotification.md#ping) - -## Methods - -### getErrors - -▸ **getErrors**(): `string`[] - -#### Returns - -`string`[] - -#### Defined in - -packages/types/dist/INotification.d.ts:16 - -___ - -### init - -▸ **init**(): `Promise`<`void`\> - -Initialize notifications for the connected user - -(ie; connect to a notification server) - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -packages/types/dist/INotification.d.ts:10 - -___ - -### ping - -▸ **ping**(`recipientContextName`, `didToNotify`): `Promise`<`boolean`\> - -Ping a notification server to fetch new messages -TODO: Change this - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `recipientContextName` | `string` | -| `didToNotify` | `any` | - -#### Returns - -`Promise`<`boolean`\> - -#### Defined in - -packages/types/dist/INotification.d.ts:15 diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.IProfile.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.IProfile.md deleted file mode 100644 index 9eddcbc..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.IProfile.md +++ /dev/null @@ -1,144 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / IProfile - -# Interface: IProfile - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).IProfile - -## Implemented by - -- [`Profile`](../classes/verida_client_ts._internal_.Profile.md) - -## Table of contents - -### Methods - -- [delete](verida_client_ts._internal_.IProfile.md#delete) -- [get](verida_client_ts._internal_.IProfile.md#get) -- [getMany](verida_client_ts._internal_.IProfile.md#getmany) -- [listen](verida_client_ts._internal_.IProfile.md#listen) -- [set](verida_client_ts._internal_.IProfile.md#set) -- [setMany](verida_client_ts._internal_.IProfile.md#setmany) - -## Methods - -### delete - -▸ **delete**(`key`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `key` | `string` | - -#### Returns - -`Promise`<`boolean`\> - -#### Defined in - -packages/types/dist/IProfile.d.ts:7 - -___ - -### get - -▸ **get**(`key`, `options?`, `extended?`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `key` | `string` | -| `options?` | `any` | -| `extended?` | `boolean` | - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -packages/types/dist/IProfile.d.ts:6 - -___ - -### getMany - -▸ **getMany**(`filter`, `options`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `filter` | `any` | -| `options` | `any` | - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -packages/types/dist/IProfile.d.ts:8 - -___ - -### listen - -▸ **listen**(`callback`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `callback` | `any` | - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -packages/types/dist/IProfile.d.ts:11 - -___ - -### set - -▸ **set**(`key`, `value`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `key` | `string` | -| `value` | `any` | - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -packages/types/dist/IProfile.d.ts:9 - -___ - -### setMany - -▸ **setMany**(`data`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `any` | - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -packages/types/dist/IProfile.d.ts:10 diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.ISchema.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.ISchema.md deleted file mode 100644 index 66076b7..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.ISchema.md +++ /dev/null @@ -1,94 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / ISchema - -# Interface: ISchema - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).ISchema - -## Implemented by - -- [`Schema`](../classes/verida_client_ts._internal_.Schema.md) - -## Table of contents - -### Properties - -- [errors](verida_client_ts._internal_.ISchema.md#errors) - -### Methods - -- [getAppearance](verida_client_ts._internal_.ISchema.md#getappearance) -- [getSchemaJson](verida_client_ts._internal_.ISchema.md#getschemajson) -- [getSpecification](verida_client_ts._internal_.ISchema.md#getspecification) -- [validate](verida_client_ts._internal_.ISchema.md#validate) - -## Properties - -### errors - -• **errors**: `string`[] - -#### Defined in - -packages/types/dist/ISchema.d.ts:2 - -## Methods - -### getAppearance - -▸ **getAppearance**(): `Promise`<`any`\> - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -packages/types/dist/ISchema.d.ts:6 - -___ - -### getSchemaJson - -▸ **getSchemaJson**(): `Promise`<`object`\> - -#### Returns - -`Promise`<`object`\> - -#### Defined in - -packages/types/dist/ISchema.d.ts:5 - -___ - -### getSpecification - -▸ **getSpecification**(): `Promise`<`any`\> - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -packages/types/dist/ISchema.d.ts:3 - -___ - -### validate - -▸ **validate**(`data`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `any` | - -#### Returns - -`Promise`<`boolean`\> - -#### Defined in - -packages/types/dist/ISchema.d.ts:4 diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.IStorageEngine.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.IStorageEngine.md deleted file mode 100644 index e1c3103..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.IStorageEngine.md +++ /dev/null @@ -1,211 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / IStorageEngine - -# Interface: IStorageEngine - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).IStorageEngine - -**`emits`** EndpointUnavailable - -## Table of contents - -### Methods - -- [addEndpoint](verida_client_ts._internal_.IStorageEngine.md#addendpoint) -- [connectAccount](verida_client_ts._internal_.IStorageEngine.md#connectaccount) -- [deleteDatabase](verida_client_ts._internal_.IStorageEngine.md#deletedatabase) -- [getAccount](verida_client_ts._internal_.IStorageEngine.md#getaccount) -- [getContextConfig](verida_client_ts._internal_.IStorageEngine.md#getcontextconfig) -- [getDbRegistry](verida_client_ts._internal_.IStorageEngine.md#getdbregistry) -- [getKeyring](verida_client_ts._internal_.IStorageEngine.md#getkeyring) -- [info](verida_client_ts._internal_.IStorageEngine.md#info) -- [logout](verida_client_ts._internal_.IStorageEngine.md#logout) -- [openDatabase](verida_client_ts._internal_.IStorageEngine.md#opendatabase) -- [openDatastore](verida_client_ts._internal_.IStorageEngine.md#opendatastore) - -## Methods - -### addEndpoint - -▸ **addEndpoint**(`context`, `uri`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `context` | [`IContext`](verida_client_ts._internal_.IContext.md) | -| `uri` | `string` | - -#### Returns - -`Promise`<`boolean`\> - -#### Defined in - -packages/types/dist/IStorageEngine.d.ts:22 - -___ - -### connectAccount - -▸ **connectAccount**(`account`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `account` | [`IAccount`](verida_client_ts._internal_.IAccount.md) | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -packages/types/dist/IStorageEngine.d.ts:16 - -___ - -### deleteDatabase - -▸ **deleteDatabase**(`databaseName`, `config?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `databaseName` | `string` | -| `config?` | [`DatabaseDeleteConfig`](verida_client_ts._internal_.DatabaseDeleteConfig.md) | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -packages/types/dist/IStorageEngine.d.ts:20 - -___ - -### getAccount - -▸ **getAccount**(): [`IAccount`](verida_client_ts._internal_.IAccount.md) - -#### Returns - -[`IAccount`](verida_client_ts._internal_.IAccount.md) - -#### Defined in - -packages/types/dist/IStorageEngine.d.ts:15 - -___ - -### getContextConfig - -▸ **getContextConfig**(): [`SecureContextConfig`](verida_client_ts._internal_.SecureContextConfig.md) - -#### Returns - -[`SecureContextConfig`](verida_client_ts._internal_.SecureContextConfig.md) - -#### Defined in - -packages/types/dist/IStorageEngine.d.ts:14 - -___ - -### getDbRegistry - -▸ **getDbRegistry**(): [`IDbRegistry`](verida_client_ts._internal_.IDbRegistry.md) - -#### Returns - -[`IDbRegistry`](verida_client_ts._internal_.IDbRegistry.md) - -#### Defined in - -packages/types/dist/IStorageEngine.d.ts:17 - -___ - -### getKeyring - -▸ **getKeyring**(): [`IKeyring`](verida_client_ts._internal_.IKeyring.md) - -#### Returns - -[`IKeyring`](verida_client_ts._internal_.IKeyring.md) - -#### Defined in - -packages/types/dist/IStorageEngine.d.ts:13 - -___ - -### info - -▸ **info**(): `Promise`<[`ContextDatabaseInfo`](verida_client_ts._internal_.ContextDatabaseInfo.md)\> - -#### Returns - -`Promise`<[`ContextDatabaseInfo`](verida_client_ts._internal_.ContextDatabaseInfo.md)\> - -#### Defined in - -packages/types/dist/IStorageEngine.d.ts:23 - -___ - -### logout - -▸ **logout**(): `void` - -#### Returns - -`void` - -#### Defined in - -packages/types/dist/IStorageEngine.d.ts:21 - -___ - -### openDatabase - -▸ **openDatabase**(`databaseName`, `config`): `Promise`<[`IDatabase`](verida_client_ts._internal_.IDatabase.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `databaseName` | `string` | -| `config` | [`DatabaseOpenConfig`](verida_client_ts._internal_.DatabaseOpenConfig.md) | - -#### Returns - -`Promise`<[`IDatabase`](verida_client_ts._internal_.IDatabase.md)\> - -#### Defined in - -packages/types/dist/IStorageEngine.d.ts:18 - -___ - -### openDatastore - -▸ **openDatastore**(`schemaName`, `config`): `Promise`<[`IDatastore`](verida_client_ts._internal_.IDatastore.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schemaName` | `string` | -| `config` | [`DatastoreOpenConfig`](verida_client_ts._internal_.DatastoreOpenConfig.md) | - -#### Returns - -`Promise`<[`IDatastore`](verida_client_ts._internal_.IDatastore.md)\> - -#### Defined in - -packages/types/dist/IStorageEngine.d.ts:19 diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.InstanceCodeOptions.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.InstanceCodeOptions.md deleted file mode 100644 index e6625a9..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.InstanceCodeOptions.md +++ /dev/null @@ -1,150 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / InstanceCodeOptions - -# Interface: InstanceCodeOptions - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).InstanceCodeOptions - -## Hierarchy - -- [`CodeOptions`](verida_client_ts._internal_.CodeOptions.md) - - ↳ **`InstanceCodeOptions`** - -## Table of contents - -### Properties - -- [es5](verida_client_ts._internal_.InstanceCodeOptions.md#es5) -- [esm](verida_client_ts._internal_.InstanceCodeOptions.md#esm) -- [formats](verida_client_ts._internal_.InstanceCodeOptions.md#formats) -- [lines](verida_client_ts._internal_.InstanceCodeOptions.md#lines) -- [optimize](verida_client_ts._internal_.InstanceCodeOptions.md#optimize) -- [regExp](verida_client_ts._internal_.InstanceCodeOptions.md#regexp) -- [source](verida_client_ts._internal_.InstanceCodeOptions.md#source) - -### Methods - -- [process](verida_client_ts._internal_.InstanceCodeOptions.md#process) - -## Properties - -### es5 - -• `Optional` **es5**: `boolean` - -#### Inherited from - -[CodeOptions](verida_client_ts._internal_.CodeOptions.md).[es5](verida_client_ts._internal_.CodeOptions.md#es5) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:74 - -___ - -### esm - -• `Optional` **esm**: `boolean` - -#### Inherited from - -[CodeOptions](verida_client_ts._internal_.CodeOptions.md).[esm](verida_client_ts._internal_.CodeOptions.md#esm) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:75 - -___ - -### formats - -• `Optional` **formats**: [`Code`](../modules/verida_client_ts._internal_.md#code) - -#### Inherited from - -[CodeOptions](verida_client_ts._internal_.CodeOptions.md).[formats](verida_client_ts._internal_.CodeOptions.md#formats) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:78 - -___ - -### lines - -• `Optional` **lines**: `boolean` - -#### Inherited from - -[CodeOptions](verida_client_ts._internal_.CodeOptions.md).[lines](verida_client_ts._internal_.CodeOptions.md#lines) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:76 - -___ - -### optimize - -• **optimize**: `number` - -#### Overrides - -[CodeOptions](verida_client_ts._internal_.CodeOptions.md).[optimize](verida_client_ts._internal_.CodeOptions.md#optimize) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:85 - -___ - -### regExp - -• **regExp**: [`RegExpEngine`](verida_client_ts._internal_.RegExpEngine.md) - -#### Overrides - -[CodeOptions](verida_client_ts._internal_.CodeOptions.md).[regExp](verida_client_ts._internal_.CodeOptions.md#regexp) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:84 - -___ - -### source - -• `Optional` **source**: `boolean` - -#### Inherited from - -[CodeOptions](verida_client_ts._internal_.CodeOptions.md).[source](verida_client_ts._internal_.CodeOptions.md#source) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:79 - -## Methods - -### process - -▸ `Optional` **process**(`code`, `schema?`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `code` | `string` | -| `schema?` | [`SchemaEnv`](../classes/verida_client_ts._internal_.SchemaEnv.md) | - -#### Returns - -`string` - -#### Inherited from - -[CodeOptions](verida_client_ts._internal_.CodeOptions.md).[process](verida_client_ts._internal_.CodeOptions.md#process) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:80 diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.IteratorReturnResult.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.IteratorReturnResult.md deleted file mode 100644 index 9649650..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.IteratorReturnResult.md +++ /dev/null @@ -1,38 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / IteratorReturnResult - -# Interface: IteratorReturnResult - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).IteratorReturnResult - -## Type parameters - -| Name | -| :------ | -| `TReturn` | - -## Table of contents - -### Properties - -- [done](verida_client_ts._internal_.IteratorReturnResult.md#done) -- [value](verida_client_ts._internal_.IteratorReturnResult.md#value) - -## Properties - -### done - -• **done**: ``true`` - -#### Defined in - -node_modules/typescript/lib/lib.es2015.iterable.d.ts:37 - -___ - -### value - -• **value**: `TReturn` - -#### Defined in - -node_modules/typescript/lib/lib.es2015.iterable.d.ts:38 diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.IteratorYieldResult.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.IteratorYieldResult.md deleted file mode 100644 index 8b43261..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.IteratorYieldResult.md +++ /dev/null @@ -1,38 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / IteratorYieldResult - -# Interface: IteratorYieldResult - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).IteratorYieldResult - -## Type parameters - -| Name | -| :------ | -| `TYield` | - -## Table of contents - -### Properties - -- [done](verida_client_ts._internal_.IteratorYieldResult.md#done) -- [value](verida_client_ts._internal_.IteratorYieldResult.md#value) - -## Properties - -### done - -• `Optional` **done**: ``false`` - -#### Defined in - -node_modules/typescript/lib/lib.es2015.iterable.d.ts:32 - -___ - -### value - -• **value**: `TYield` - -#### Defined in - -node_modules/typescript/lib/lib.es2015.iterable.d.ts:33 diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.JsonWebKey.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.JsonWebKey.md deleted file mode 100644 index ea8e4db..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.JsonWebKey.md +++ /dev/null @@ -1,145 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / JsonWebKey - -# Interface: JsonWebKey - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).JsonWebKey - -Encapsulates a JSON web key type that includes only the public properties that -can be used in DID documents. - -The private properties are intentionally omitted to discourage the use -(and accidental disclosure) of private keys in DID documents. - -**`see`** [RFC7517 JsonWebKey (JWK)](https://www.rfc-editor.org/rfc/rfc7517) - -## Hierarchy - -- [`Extensible`](../modules/verida_client_ts._internal_.md#extensible) - - ↳ **`JsonWebKey`** - -## Table of contents - -### Properties - -- [alg](verida_client_ts._internal_.JsonWebKey.md#alg) -- [crv](verida_client_ts._internal_.JsonWebKey.md#crv) -- [e](verida_client_ts._internal_.JsonWebKey.md#e) -- [ext](verida_client_ts._internal_.JsonWebKey.md#ext) -- [key\_ops](verida_client_ts._internal_.JsonWebKey.md#key_ops) -- [kid](verida_client_ts._internal_.JsonWebKey.md#kid) -- [kty](verida_client_ts._internal_.JsonWebKey.md#kty) -- [n](verida_client_ts._internal_.JsonWebKey.md#n) -- [use](verida_client_ts._internal_.JsonWebKey.md#use) -- [x](verida_client_ts._internal_.JsonWebKey.md#x) -- [y](verida_client_ts._internal_.JsonWebKey.md#y) - -## Properties - -### alg - -• `Optional` **alg**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:103 - -___ - -### crv - -• `Optional` **crv**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:104 - -___ - -### e - -• `Optional` **e**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:105 - -___ - -### ext - -• `Optional` **ext**: `boolean` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:106 - -___ - -### key\_ops - -• `Optional` **key\_ops**: `string`[] - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:107 - -___ - -### kid - -• `Optional` **kid**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:108 - -___ - -### kty - -• **kty**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:109 - -___ - -### n - -• `Optional` **n**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:110 - -___ - -### use - -• `Optional` **use**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:111 - -___ - -### x - -• `Optional` **x**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:112 - -___ - -### y - -• `Optional` **y**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:113 diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.KeyringPublicKeys.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.KeyringPublicKeys.md deleted file mode 100644 index 30d3bc1..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.KeyringPublicKeys.md +++ /dev/null @@ -1,76 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / KeyringPublicKeys - -# Interface: KeyringPublicKeys - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).KeyringPublicKeys - -## Table of contents - -### Properties - -- [asymPublicKey](verida_client_ts._internal_.KeyringPublicKeys.md#asympublickey) -- [asymPublicKeyBase58](verida_client_ts._internal_.KeyringPublicKeys.md#asympublickeybase58) -- [asymPublicKeyHex](verida_client_ts._internal_.KeyringPublicKeys.md#asympublickeyhex) -- [signPublicKey](verida_client_ts._internal_.KeyringPublicKeys.md#signpublickey) -- [signPublicKeyBase58](verida_client_ts._internal_.KeyringPublicKeys.md#signpublickeybase58) -- [signPublicKeyHex](verida_client_ts._internal_.KeyringPublicKeys.md#signpublickeyhex) - -## Properties - -### asymPublicKey - -• **asymPublicKey**: `Uint8Array` - -#### Defined in - -packages/types/dist/IKeyring.d.ts:17 - -___ - -### asymPublicKeyBase58 - -• **asymPublicKeyBase58**: `string` - -#### Defined in - -packages/types/dist/IKeyring.d.ts:19 - -___ - -### asymPublicKeyHex - -• **asymPublicKeyHex**: `string` - -#### Defined in - -packages/types/dist/IKeyring.d.ts:18 - -___ - -### signPublicKey - -• **signPublicKey**: `Uint8Array` - -#### Defined in - -packages/types/dist/IKeyring.d.ts:20 - -___ - -### signPublicKeyBase58 - -• **signPublicKeyBase58**: `string` - -#### Defined in - -packages/types/dist/IKeyring.d.ts:22 - -___ - -### signPublicKeyHex - -• **signPublicKeyHex**: `string` - -#### Defined in - -packages/types/dist/IKeyring.d.ts:21 diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.KeywordErrorCxt.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.KeywordErrorCxt.md deleted file mode 100644 index cea65da..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.KeywordErrorCxt.md +++ /dev/null @@ -1,146 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / KeywordErrorCxt - -# Interface: KeywordErrorCxt - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).KeywordErrorCxt - -## Implemented by - -- [`KeywordCxt`](../classes/verida_client_ts._internal_.KeywordCxt.md) - -## Table of contents - -### Properties - -- [$data](verida_client_ts._internal_.KeywordErrorCxt.md#$data) -- [data](verida_client_ts._internal_.KeywordErrorCxt.md#data) -- [errsCount](verida_client_ts._internal_.KeywordErrorCxt.md#errscount) -- [gen](verida_client_ts._internal_.KeywordErrorCxt.md#gen) -- [it](verida_client_ts._internal_.KeywordErrorCxt.md#it) -- [keyword](verida_client_ts._internal_.KeywordErrorCxt.md#keyword) -- [params](verida_client_ts._internal_.KeywordErrorCxt.md#params) -- [parentSchema](verida_client_ts._internal_.KeywordErrorCxt.md#parentschema) -- [schema](verida_client_ts._internal_.KeywordErrorCxt.md#schema) -- [schemaCode](verida_client_ts._internal_.KeywordErrorCxt.md#schemacode) -- [schemaType](verida_client_ts._internal_.KeywordErrorCxt.md#schematype) -- [schemaValue](verida_client_ts._internal_.KeywordErrorCxt.md#schemavalue) - -## Properties - -### $data - -• `Optional` **$data**: `string` \| ``false`` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:141 - -___ - -### data - -• **data**: [`Name`](../classes/verida_client_ts._internal_.Name.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:140 - -___ - -### errsCount - -• `Optional` **errsCount**: [`Name`](../classes/verida_client_ts._internal_.Name.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:147 - -___ - -### gen - -• **gen**: [`CodeGen`](../classes/verida_client_ts._internal_.CodeGen.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:138 - -___ - -### it - -• **it**: [`SchemaCxt`](verida_client_ts._internal_.SchemaCxt.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:149 - -___ - -### keyword - -• **keyword**: `string` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:139 - -___ - -### params - -• **params**: [`KeywordCxtParams`](../modules/verida_client_ts._internal_.md#keywordcxtparams) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:148 - -___ - -### parentSchema - -• `Optional` **parentSchema**: [`AnySchemaObject`](../modules/verida_client_ts._internal_.md#anyschemaobject) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:143 - -___ - -### schema - -• **schema**: `any` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:142 - -___ - -### schemaCode - -• **schemaCode**: `number` \| `boolean` \| [`Code`](../modules/verida_client_ts._internal_.md#code) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:144 - -___ - -### schemaType - -• `Optional` **schemaType**: (``"string"`` \| ``"number"`` \| ``"boolean"`` \| ``"object"`` \| ``"integer"`` \| ``"array"`` \| ``"null"``)[] - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:146 - -___ - -### schemaValue - -• **schemaValue**: `number` \| `boolean` \| [`Code`](../modules/verida_client_ts._internal_.md#code) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:145 diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.KeywordErrorDefinition.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.KeywordErrorDefinition.md deleted file mode 100644 index a65b541..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.KeywordErrorDefinition.md +++ /dev/null @@ -1,32 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / KeywordErrorDefinition - -# Interface: KeywordErrorDefinition - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).KeywordErrorDefinition - -## Table of contents - -### Properties - -- [message](verida_client_ts._internal_.KeywordErrorDefinition.md#message) -- [params](verida_client_ts._internal_.KeywordErrorDefinition.md#params) - -## Properties - -### message - -• **message**: `string` \| [`Code`](../modules/verida_client_ts._internal_.md#code) \| (`cxt`: [`KeywordErrorCxt`](verida_client_ts._internal_.KeywordErrorCxt.md)) => `string` \| [`Code`](../modules/verida_client_ts._internal_.md#code) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:133 - -___ - -### params - -• `Optional` **params**: [`Code`](../modules/verida_client_ts._internal_.md#code) \| (`cxt`: [`KeywordErrorCxt`](verida_client_ts._internal_.KeywordErrorCxt.md)) => [`Code`](../modules/verida_client_ts._internal_.md#code) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:134 diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.Log.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.Log.md deleted file mode 100644 index 1723d4a..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.Log.md +++ /dev/null @@ -1,109 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / Log - -# Interface: Log - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).Log - -## Table of contents - -### Properties - -- [address](verida_client_ts._internal_.Log.md#address) -- [blockHash](verida_client_ts._internal_.Log.md#blockhash) -- [blockNumber](verida_client_ts._internal_.Log.md#blocknumber) -- [data](verida_client_ts._internal_.Log.md#data) -- [logIndex](verida_client_ts._internal_.Log.md#logindex) -- [removed](verida_client_ts._internal_.Log.md#removed) -- [topics](verida_client_ts._internal_.Log.md#topics) -- [transactionHash](verida_client_ts._internal_.Log.md#transactionhash) -- [transactionIndex](verida_client_ts._internal_.Log.md#transactionindex) - -## Properties - -### address - -• **address**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:59 - -___ - -### blockHash - -• **blockHash**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:56 - -___ - -### blockNumber - -• **blockNumber**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:55 - -___ - -### data - -• **data**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:60 - -___ - -### logIndex - -• **logIndex**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:63 - -___ - -### removed - -• **removed**: `boolean` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:58 - -___ - -### topics - -• **topics**: `string`[] - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:61 - -___ - -### transactionHash - -• **transactionHash**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:62 - -___ - -### transactionIndex - -• **transactionIndex**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:57 diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.Logger.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.Logger.md deleted file mode 100644 index 7a8ab68..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.Logger.md +++ /dev/null @@ -1,73 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / Logger - -# Interface: Logger - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).Logger - -## Table of contents - -### Methods - -- [error](verida_client_ts._internal_.Logger.md#error) -- [log](verida_client_ts._internal_.Logger.md#log) -- [warn](verida_client_ts._internal_.Logger.md#warn) - -## Methods - -### error - -▸ **error**(...`args`): `unknown` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `...args` | `unknown`[] | - -#### Returns - -`unknown` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:104 - -___ - -### log - -▸ **log**(...`args`): `unknown` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `...args` | `unknown`[] | - -#### Returns - -`unknown` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:102 - -___ - -### warn - -▸ **warn**(...`args`): `unknown` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `...args` | `unknown`[] | - -#### Returns - -`unknown` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:103 diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.MacroKeywordDefinition.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.MacroKeywordDefinition.md deleted file mode 100644 index 2f5d5b0..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.MacroKeywordDefinition.md +++ /dev/null @@ -1,327 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / MacroKeywordDefinition - -# Interface: MacroKeywordDefinition - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).MacroKeywordDefinition - -## Hierarchy - -- [`FuncKeywordDefinition`](verida_client_ts._internal_.FuncKeywordDefinition.md) - - ↳ **`MacroKeywordDefinition`** - -## Table of contents - -### Properties - -- [$data](verida_client_ts._internal_.MacroKeywordDefinition.md#$data) -- [$dataError](verida_client_ts._internal_.MacroKeywordDefinition.md#$dataerror) -- [allowUndefined](verida_client_ts._internal_.MacroKeywordDefinition.md#allowundefined) -- [async](verida_client_ts._internal_.MacroKeywordDefinition.md#async) -- [before](verida_client_ts._internal_.MacroKeywordDefinition.md#before) -- [compile](verida_client_ts._internal_.MacroKeywordDefinition.md#compile) -- [dependencies](verida_client_ts._internal_.MacroKeywordDefinition.md#dependencies) -- [error](verida_client_ts._internal_.MacroKeywordDefinition.md#error) -- [errors](verida_client_ts._internal_.MacroKeywordDefinition.md#errors) -- [implements](verida_client_ts._internal_.MacroKeywordDefinition.md#implements) -- [keyword](verida_client_ts._internal_.MacroKeywordDefinition.md#keyword) -- [macro](verida_client_ts._internal_.MacroKeywordDefinition.md#macro) -- [metaSchema](verida_client_ts._internal_.MacroKeywordDefinition.md#metaschema) -- [modifying](verida_client_ts._internal_.MacroKeywordDefinition.md#modifying) -- [post](verida_client_ts._internal_.MacroKeywordDefinition.md#post) -- [schema](verida_client_ts._internal_.MacroKeywordDefinition.md#schema) -- [schemaType](verida_client_ts._internal_.MacroKeywordDefinition.md#schematype) -- [type](verida_client_ts._internal_.MacroKeywordDefinition.md#type) -- [valid](verida_client_ts._internal_.MacroKeywordDefinition.md#valid) -- [validate](verida_client_ts._internal_.MacroKeywordDefinition.md#validate) -- [validateSchema](verida_client_ts._internal_.MacroKeywordDefinition.md#validateschema) - -## Properties - -### $data - -• `Optional` **$data**: `boolean` - -#### Inherited from - -[FuncKeywordDefinition](verida_client_ts._internal_.FuncKeywordDefinition.md).[$data](verida_client_ts._internal_.FuncKeywordDefinition.md#$data) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:91 - -___ - -### $dataError - -• `Optional` **$dataError**: [`KeywordErrorDefinition`](verida_client_ts._internal_.KeywordErrorDefinition.md) - -#### Inherited from - -[FuncKeywordDefinition](verida_client_ts._internal_.FuncKeywordDefinition.md).[$dataError](verida_client_ts._internal_.FuncKeywordDefinition.md#$dataerror) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:99 - -___ - -### allowUndefined - -• `Optional` **allowUndefined**: `boolean` - -#### Inherited from - -[FuncKeywordDefinition](verida_client_ts._internal_.FuncKeywordDefinition.md).[allowUndefined](verida_client_ts._internal_.FuncKeywordDefinition.md#allowundefined) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:90 - -___ - -### async - -• `Optional` **async**: `boolean` - -#### Inherited from - -[FuncKeywordDefinition](verida_client_ts._internal_.FuncKeywordDefinition.md).[async](verida_client_ts._internal_.FuncKeywordDefinition.md#async) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:120 - -___ - -### before - -• `Optional` **before**: `string` - -#### Inherited from - -[FuncKeywordDefinition](verida_client_ts._internal_.FuncKeywordDefinition.md).[before](verida_client_ts._internal_.FuncKeywordDefinition.md#before) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:93 - -___ - -### compile - -• `Optional` **compile**: [`CompileKeywordFunc`](../modules/verida_client_ts._internal_.md#compilekeywordfunc) - -#### Inherited from - -[FuncKeywordDefinition](verida_client_ts._internal_.FuncKeywordDefinition.md).[compile](verida_client_ts._internal_.FuncKeywordDefinition.md#compile) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:117 - -___ - -### dependencies - -• `Optional` **dependencies**: `string`[] - -#### Inherited from - -[FuncKeywordDefinition](verida_client_ts._internal_.FuncKeywordDefinition.md).[dependencies](verida_client_ts._internal_.FuncKeywordDefinition.md#dependencies) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:97 - -___ - -### error - -• `Optional` **error**: [`KeywordErrorDefinition`](verida_client_ts._internal_.KeywordErrorDefinition.md) - -#### Inherited from - -[FuncKeywordDefinition](verida_client_ts._internal_.FuncKeywordDefinition.md).[error](verida_client_ts._internal_.FuncKeywordDefinition.md#error) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:98 - -___ - -### errors - -• `Optional` **errors**: `boolean` \| ``"full"`` - -#### Inherited from - -[FuncKeywordDefinition](verida_client_ts._internal_.FuncKeywordDefinition.md).[errors](verida_client_ts._internal_.FuncKeywordDefinition.md#errors) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:122 - -___ - -### implements - -• `Optional` **implements**: `string`[] - -#### Inherited from - -[FuncKeywordDefinition](verida_client_ts._internal_.FuncKeywordDefinition.md).[implements](verida_client_ts._internal_.FuncKeywordDefinition.md#implements) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:92 - -___ - -### keyword - -• **keyword**: `string` \| `string`[] - -#### Inherited from - -[FuncKeywordDefinition](verida_client_ts._internal_.FuncKeywordDefinition.md).[keyword](verida_client_ts._internal_.FuncKeywordDefinition.md#keyword) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:87 - -___ - -### macro - -• **macro**: [`MacroKeywordFunc`](../modules/verida_client_ts._internal_.md#macrokeywordfunc) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:125 - -___ - -### metaSchema - -• `Optional` **metaSchema**: [`AnySchemaObject`](../modules/verida_client_ts._internal_.md#anyschemaobject) - -#### Inherited from - -[FuncKeywordDefinition](verida_client_ts._internal_.FuncKeywordDefinition.md).[metaSchema](verida_client_ts._internal_.FuncKeywordDefinition.md#metaschema) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:95 - -___ - -### modifying - -• `Optional` **modifying**: `boolean` - -#### Inherited from - -[FuncKeywordDefinition](verida_client_ts._internal_.FuncKeywordDefinition.md).[modifying](verida_client_ts._internal_.FuncKeywordDefinition.md#modifying) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:119 - -___ - -### post - -• `Optional` **post**: `boolean` - -#### Inherited from - -[FuncKeywordDefinition](verida_client_ts._internal_.FuncKeywordDefinition.md).[post](verida_client_ts._internal_.FuncKeywordDefinition.md#post) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:94 - -___ - -### schema - -• `Optional` **schema**: `boolean` - -#### Inherited from - -[FuncKeywordDefinition](verida_client_ts._internal_.FuncKeywordDefinition.md).[schema](verida_client_ts._internal_.FuncKeywordDefinition.md#schema) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:118 - -___ - -### schemaType - -• `Optional` **schemaType**: ``"string"`` \| ``"number"`` \| ``"boolean"`` \| ``"object"`` \| ``"integer"`` \| ``"array"`` \| ``"null"`` \| (``"string"`` \| ``"number"`` \| ``"boolean"`` \| ``"object"`` \| ``"integer"`` \| ``"array"`` \| ``"null"``)[] - -#### Inherited from - -[FuncKeywordDefinition](verida_client_ts._internal_.FuncKeywordDefinition.md).[schemaType](verida_client_ts._internal_.FuncKeywordDefinition.md#schematype) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:89 - -___ - -### type - -• `Optional` **type**: ``"string"`` \| ``"number"`` \| ``"boolean"`` \| ``"object"`` \| ``"integer"`` \| ``"array"`` \| ``"null"`` \| (``"string"`` \| ``"number"`` \| ``"boolean"`` \| ``"object"`` \| ``"integer"`` \| ``"array"`` \| ``"null"``)[] - -#### Inherited from - -[FuncKeywordDefinition](verida_client_ts._internal_.FuncKeywordDefinition.md).[type](verida_client_ts._internal_.FuncKeywordDefinition.md#type) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:88 - -___ - -### valid - -• `Optional` **valid**: `boolean` - -#### Inherited from - -[FuncKeywordDefinition](verida_client_ts._internal_.FuncKeywordDefinition.md).[valid](verida_client_ts._internal_.FuncKeywordDefinition.md#valid) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:121 - -___ - -### validate - -• `Optional` **validate**: [`SchemaValidateFunction`](verida_client_ts._internal_.SchemaValidateFunction.md) \| [`DataValidateFunction`](verida_client_ts._internal_.DataValidateFunction.md) - -#### Inherited from - -[FuncKeywordDefinition](verida_client_ts._internal_.FuncKeywordDefinition.md).[validate](verida_client_ts._internal_.FuncKeywordDefinition.md#validate) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:116 - -___ - -### validateSchema - -• `Optional` **validateSchema**: [`AnyValidateFunction`](../modules/verida_client_ts._internal_.md#anyvalidatefunction)<`any`\> - -#### Inherited from - -[FuncKeywordDefinition](verida_client_ts._internal_.FuncKeywordDefinition.md).[validateSchema](verida_client_ts._internal_.FuncKeywordDefinition.md#validateschema) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:96 diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.MessageSendConfig.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.MessageSendConfig.md deleted file mode 100644 index 307ac8c..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.MessageSendConfig.md +++ /dev/null @@ -1,56 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / MessageSendConfig - -# Interface: MessageSendConfig - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).MessageSendConfig - -Interface for any MessageSendConfig - -## Table of contents - -### Properties - -- [did](verida_client_ts._internal_.MessageSendConfig.md#did) -- [expiry](verida_client_ts._internal_.MessageSendConfig.md#expiry) -- [openUrl](verida_client_ts._internal_.MessageSendConfig.md#openurl) -- [recipientContextName](verida_client_ts._internal_.MessageSendConfig.md#recipientcontextname) - -## Properties - -### did - -• **did**: `string` - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:124 - -___ - -### expiry - -• `Optional` **expiry**: [`Number`](../modules/verida_client_ts._internal_.md#number) - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:125 - -___ - -### openUrl - -• `Optional` **openUrl**: `string` - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:127 - -___ - -### recipientContextName - -• `Optional` **recipientContextName**: `string` - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:126 diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.MessagesConfig.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.MessagesConfig.md deleted file mode 100644 index d61c235..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.MessagesConfig.md +++ /dev/null @@ -1,23 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / MessagesConfig - -# Interface: MessagesConfig - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).MessagesConfig - -Interface for any MessagesConfig - -## Table of contents - -### Properties - -- [maxItems](verida_client_ts._internal_.MessagesConfig.md#maxitems) - -## Properties - -### maxItems - -• `Optional` **maxItems**: [`Number`](../modules/verida_client_ts._internal_.md#number) - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:93 diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.NameClientConfig.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.NameClientConfig.md deleted file mode 100644 index 6eb07eb..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.NameClientConfig.md +++ /dev/null @@ -1,77 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / NameClientConfig - -# Interface: NameClientConfig - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).NameClientConfig - -Interface for vda-name-client instance creation. Same as VDA-DID configuration - -**`param`** DID - -**`param`** private key of DID. Used to generate signature in transactions to chains - -**`param`** Target chain name or chain id. - -**`param`** : VDA-DID run mode. Values from vda-did-resolver - -**`param`** Web3 configuration depending on call type. Values from vda-did-resolver - -## Table of contents - -### Properties - -- [callType](verida_client_ts._internal_.NameClientConfig.md#calltype) -- [did](verida_client_ts._internal_.NameClientConfig.md#did) -- [network](verida_client_ts._internal_.NameClientConfig.md#network) -- [signKey](verida_client_ts._internal_.NameClientConfig.md#signkey) -- [web3Options](verida_client_ts._internal_.NameClientConfig.md#web3options) - -## Properties - -### callType - -• `Optional` **callType**: [`Web3CallType`](../modules/verida_client_ts._internal_.md#web3calltype) - -#### Defined in - -packages/vda-name-client/build/src/blockchain/blockchainApi.d.ts:14 - -___ - -### did - -• `Optional` **did**: `string` - -#### Defined in - -packages/vda-name-client/build/src/blockchain/blockchainApi.d.ts:12 - -___ - -### network - -• **network**: [`EnvironmentType`](../enums/verida_client_ts._internal_.EnvironmentType.md) - -#### Defined in - -packages/vda-name-client/build/src/blockchain/blockchainApi.d.ts:11 - -___ - -### signKey - -• `Optional` **signKey**: `string` - -#### Defined in - -packages/vda-name-client/build/src/blockchain/blockchainApi.d.ts:13 - -___ - -### web3Options - -• `Optional` **web3Options**: [`Web3MetaTransactionConfig`](verida_client_ts._internal_.Web3MetaTransactionConfig.md) \| [`Web3SelfTransactionConfig`](verida_client_ts._internal_.Web3SelfTransactionConfig.md) - -#### Defined in - -packages/vda-name-client/build/src/blockchain/blockchainApi.d.ts:15 diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.NameValue.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.NameValue.md deleted file mode 100644 index ea61728..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.NameValue.md +++ /dev/null @@ -1,43 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / NameValue - -# Interface: NameValue - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).NameValue - -## Table of contents - -### Properties - -- [code](verida_client_ts._internal_.NameValue.md#code) -- [key](verida_client_ts._internal_.NameValue.md#key) -- [ref](verida_client_ts._internal_.NameValue.md#ref) - -## Properties - -### code - -• `Optional` **code**: [`Code`](../modules/verida_client_ts._internal_.md#code) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/scope.d.ts:9 - -___ - -### key - -• `Optional` **key**: `unknown` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/scope.d.ts:8 - -___ - -### ref - -• **ref**: `unknown` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/scope.d.ts:7 diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.NetworkConnectionConfig.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.NetworkConnectionConfig.md deleted file mode 100644 index 61a3711..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.NetworkConnectionConfig.md +++ /dev/null @@ -1,45 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / NetworkConnectionConfig - -# Interface: NetworkConnectionConfig - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).NetworkConnectionConfig - -Interface for NetworkConnectionConfig - -## Table of contents - -### Properties - -- [account](verida_client_ts._internal_.NetworkConnectionConfig.md#account) -- [client](verida_client_ts._internal_.NetworkConnectionConfig.md#client) -- [context](verida_client_ts._internal_.NetworkConnectionConfig.md#context) - -## Properties - -### account - -• **account**: [`IAccount`](verida_client_ts._internal_.IAccount.md) - -#### Defined in - -packages/types/dist/NetworkInterfaces.d.ts:58 - -___ - -### client - -• `Optional` **client**: [`ClientConfig`](verida_client_ts._internal_.ClientConfig.md) - -#### Defined in - -packages/types/dist/NetworkInterfaces.d.ts:56 - -___ - -### context - -• **context**: [`ContextConfig`](verida_client_ts._internal_.ContextConfig.md) - -#### Defined in - -packages/types/dist/NetworkInterfaces.d.ts:57 diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.NodeEventTarget.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.NodeEventTarget.md deleted file mode 100644 index ff18c30..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.NodeEventTarget.md +++ /dev/null @@ -1,32 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / NodeEventTarget - -# Interface: NodeEventTarget - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).NodeEventTarget - -## Table of contents - -### Methods - -- [once](verida_client_ts._internal_.NodeEventTarget.md#once) - -## Methods - -### once - -▸ **once**(`eventName`, `listener`): [`NodeEventTarget`](verida_client_ts._internal_.NodeEventTarget.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | `string` \| `symbol` | -| `listener` | (...`args`: `any`[]) => `void` | - -#### Returns - -[`NodeEventTarget`](verida_client_ts._internal_.NodeEventTarget.md) - -#### Defined in - -node_modules/@types/node/events.d.ts:45 diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.Number.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.Number.md deleted file mode 100644 index dd002fa..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.Number.md +++ /dev/null @@ -1,143 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / Number - -# Interface: Number - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).Number - -## Table of contents - -### Methods - -- [toExponential](verida_client_ts._internal_.Number.md#toexponential) -- [toFixed](verida_client_ts._internal_.Number.md#tofixed) -- [toLocaleString](verida_client_ts._internal_.Number.md#tolocalestring) -- [toPrecision](verida_client_ts._internal_.Number.md#toprecision) -- [toString](verida_client_ts._internal_.Number.md#tostring) -- [valueOf](verida_client_ts._internal_.Number.md#valueof) - -## Methods - -### toExponential - -▸ **toExponential**(`fractionDigits?`): `string` - -Returns a string containing a number represented in exponential notation. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `fractionDigits?` | `number` | Number of digits after the decimal point. Must be in the range 0 - 20, inclusive. | - -#### Returns - -`string` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:559 - -___ - -### toFixed - -▸ **toFixed**(`fractionDigits?`): `string` - -Returns a string representing a number in fixed-point notation. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `fractionDigits?` | `number` | Number of digits after the decimal point. Must be in the range 0 - 20, inclusive. | - -#### Returns - -`string` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:553 - -___ - -### toLocaleString - -▸ **toLocaleString**(`locales?`, `options?`): `string` - -Converts a number to a string by using the current or specified locale. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `locales?` | `string` \| `string`[] | A locale string or array of locale strings that contain one or more language or locale tags. If you include more than one locale string, list them in descending order of priority so that the first entry is the preferred locale. If you omit this parameter, the default locale of the JavaScript runtime is used. | -| `options?` | `NumberFormatOptions` | An object that contains one or more properties that specify comparison options. | - -#### Returns - -`string` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:4412 - -___ - -### toPrecision - -▸ **toPrecision**(`precision?`): `string` - -Returns a string containing a number represented either in exponential or fixed-point notation with a specified number of digits. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `precision?` | `number` | Number of significant digits. Must be in the range 1 - 21, inclusive. | - -#### Returns - -`string` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:565 - -___ - -### toString - -▸ **toString**(`radix?`): `string` - -Returns a string representation of an object. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `radix?` | `number` | Specifies a radix for converting numeric values to strings. This value is only used for numbers. | - -#### Returns - -`string` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:547 - -___ - -### valueOf - -▸ **valueOf**(): `number` - -Returns the primitive value of the specified object. - -#### Returns - -`number` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:568 diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.NumberKeywords.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.NumberKeywords.md deleted file mode 100644 index 1de72a9..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.NumberKeywords.md +++ /dev/null @@ -1,76 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / NumberKeywords - -# Interface: NumberKeywords - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).NumberKeywords - -## Table of contents - -### Properties - -- [exclusiveMaximum](verida_client_ts._internal_.NumberKeywords.md#exclusivemaximum) -- [exclusiveMinimum](verida_client_ts._internal_.NumberKeywords.md#exclusiveminimum) -- [format](verida_client_ts._internal_.NumberKeywords.md#format) -- [maximum](verida_client_ts._internal_.NumberKeywords.md#maximum) -- [minimum](verida_client_ts._internal_.NumberKeywords.md#minimum) -- [multipleOf](verida_client_ts._internal_.NumberKeywords.md#multipleof) - -## Properties - -### exclusiveMaximum - -• `Optional` **exclusiveMaximum**: `number` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/json-schema.d.ts:11 - -___ - -### exclusiveMinimum - -• `Optional` **exclusiveMinimum**: `number` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/json-schema.d.ts:10 - -___ - -### format - -• `Optional` **format**: `string` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/json-schema.d.ts:13 - -___ - -### maximum - -• `Optional` **maximum**: `number` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/json-schema.d.ts:9 - -___ - -### minimum - -• `Optional` **minimum**: `number` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/json-schema.d.ts:8 - -___ - -### multipleOf - -• `Optional` **multipleOf**: `number` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/json-schema.d.ts:12 diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.OnceBlockable.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.OnceBlockable.md deleted file mode 100644 index 8a97bf2..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.OnceBlockable.md +++ /dev/null @@ -1,36 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / OnceBlockable - -# Interface: OnceBlockable - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).OnceBlockable - -## Implemented by - -- [`Provider`](../classes/verida_client_ts._internal_.Provider.md) - -## Table of contents - -### Methods - -- [once](verida_client_ts._internal_.OnceBlockable.md#once) - -## Methods - -### once - -▸ **once**(`eventName`, `handler`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | ``"block"`` | -| `handler` | () => `void` | - -#### Returns - -`void` - -#### Defined in - -node_modules/@ethersproject/web/lib/index.d.ts:19 diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.ProfileDocument.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.ProfileDocument.md deleted file mode 100644 index ee9cf69..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.ProfileDocument.md +++ /dev/null @@ -1,25 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / ProfileDocument - -# Interface: ProfileDocument - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).ProfileDocument - -## Indexable - -▪ [key: `string`]: `string` - -## Table of contents - -### Properties - -- [\_id](verida_client_ts._internal_.ProfileDocument.md#_id) - -## Properties - -### \_id - -• **\_id**: `string` - -#### Defined in - -[packages/client-ts/src/context/profiles/profile.ts:9](https://github.com/verida/verida-js/blob/5040472/packages/client-ts/src/context/profiles/profile.ts#L9) diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.PromiseLike.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.PromiseLike.md deleted file mode 100644 index c047ed3..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.PromiseLike.md +++ /dev/null @@ -1,49 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / PromiseLike - -# Interface: PromiseLike - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).PromiseLike - -## Type parameters - -| Name | -| :------ | -| `T` | - -## Table of contents - -### Methods - -- [then](verida_client_ts._internal_.PromiseLike.md#then) - -## Methods - -### then - -▸ **then**<`TResult1`, `TResult2`\>(`onfulfilled?`, `onrejected?`): [`PromiseLike`](verida_client_ts._internal_.PromiseLike.md)<`TResult1` \| `TResult2`\> - -Attaches callbacks for the resolution and/or rejection of the Promise. - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `TResult1` | `T` | -| `TResult2` | `never` | - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `onfulfilled?` | ``null`` \| (`value`: `T`) => `TResult1` \| [`PromiseLike`](verida_client_ts._internal_.PromiseLike.md)<`TResult1`\> | The callback to execute when the Promise is resolved. | -| `onrejected?` | ``null`` \| (`reason`: `any`) => `TResult2` \| [`PromiseLike`](verida_client_ts._internal_.PromiseLike.md)<`TResult2`\> | The callback to execute when the Promise is rejected. | - -#### Returns - -[`PromiseLike`](verida_client_ts._internal_.PromiseLike.md)<`TResult1` \| `TResult2`\> - -A Promise for the completion of which ever callback is executed. - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1440 diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.Proof.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.Proof.md deleted file mode 100644 index e3c0d06..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.Proof.md +++ /dev/null @@ -1,54 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / Proof - -# Interface: Proof - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).Proof - -## Table of contents - -### Properties - -- [proofPurpose](verida_client_ts._internal_.Proof.md#proofpurpose) -- [proofValue](verida_client_ts._internal_.Proof.md#proofvalue) -- [type](verida_client_ts._internal_.Proof.md#type) -- [verificationMethod](verida_client_ts._internal_.Proof.md#verificationmethod) - -## Properties - -### proofPurpose - -• **proofPurpose**: ``"assertionMethod"`` - -#### Defined in - -packages/did-document/dist/interfaces.d.ts:10 - -___ - -### proofValue - -• **proofValue**: `string` - -#### Defined in - -packages/did-document/dist/interfaces.d.ts:11 - -___ - -### type - -• **type**: ``"EcdsaSecp256k1VerificationKey2019"`` - -#### Defined in - -packages/did-document/dist/interfaces.d.ts:8 - -___ - -### verificationMethod - -• **verificationMethod**: `string` - -#### Defined in - -packages/did-document/dist/interfaces.d.ts:9 diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.ProofInterface.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.ProofInterface.md deleted file mode 100644 index 0752e82..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.ProofInterface.md +++ /dev/null @@ -1,54 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / ProofInterface - -# Interface: ProofInterface - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).ProofInterface - -## Table of contents - -### Properties - -- [proofPurpose](verida_client_ts._internal_.ProofInterface.md#proofpurpose) -- [proofValue](verida_client_ts._internal_.ProofInterface.md#proofvalue) -- [type](verida_client_ts._internal_.ProofInterface.md#type) -- [verificationMethod](verida_client_ts._internal_.ProofInterface.md#verificationmethod) - -## Properties - -### proofPurpose - -• **proofPurpose**: `string` - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:34 - -___ - -### proofValue - -• **proofValue**: `string` - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:35 - -___ - -### type - -• **type**: `string` - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:32 - -___ - -### verificationMethod - -• **verificationMethod**: `string` - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:33 diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.RegExpEngine.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.RegExpEngine.md deleted file mode 100644 index 7f165d1..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.RegExpEngine.md +++ /dev/null @@ -1,42 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / RegExpEngine - -# Interface: RegExpEngine - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).RegExpEngine - -## Callable - -### RegExpEngine - -▸ **RegExpEngine**(`pattern`, `u`): [`RegExpLike`](verida_client_ts._internal_.RegExpLike.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `pattern` | `string` | -| `u` | `string` | - -#### Returns - -[`RegExpLike`](verida_client_ts._internal_.RegExpLike.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:172 - -## Table of contents - -### Properties - -- [code](verida_client_ts._internal_.RegExpEngine.md#code) - -## Properties - -### code - -• **code**: `string` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:173 diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.RegExpLike.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.RegExpLike.md deleted file mode 100644 index c228b10..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.RegExpLike.md +++ /dev/null @@ -1,31 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / RegExpLike - -# Interface: RegExpLike - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).RegExpLike - -## Table of contents - -### Methods - -- [test](verida_client_ts._internal_.RegExpLike.md#test) - -## Methods - -### test - -▸ **test**(`s`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `s` | `string` | - -#### Returns - -`boolean` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:176 diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.Rule.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.Rule.md deleted file mode 100644 index 99ceac0..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.Rule.md +++ /dev/null @@ -1,32 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / Rule - -# Interface: Rule - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).Rule - -## Table of contents - -### Properties - -- [definition](verida_client_ts._internal_.Rule.md#definition) -- [keyword](verida_client_ts._internal_.Rule.md#keyword) - -## Properties - -### definition - -• **definition**: [`AddedKeywordDefinition`](../modules/verida_client_ts._internal_.md#addedkeyworddefinition) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/rules.d.ts:25 - -___ - -### keyword - -• **keyword**: `string` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/rules.d.ts:24 diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.RuleGroup.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.RuleGroup.md deleted file mode 100644 index 50112c3..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.RuleGroup.md +++ /dev/null @@ -1,32 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / RuleGroup - -# Interface: RuleGroup - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).RuleGroup - -## Table of contents - -### Properties - -- [rules](verida_client_ts._internal_.RuleGroup.md#rules) -- [type](verida_client_ts._internal_.RuleGroup.md#type) - -## Properties - -### rules - -• **rules**: [`Rule`](verida_client_ts._internal_.Rule.md)[] - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/rules.d.ts:21 - -___ - -### type - -• `Optional` **type**: ``"string"`` \| ``"number"`` \| ``"boolean"`` \| ``"object"`` \| ``"integer"`` \| ``"array"`` \| ``"null"`` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/rules.d.ts:20 diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.SchemaCxt.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.SchemaCxt.md deleted file mode 100644 index d7c04d0..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.SchemaCxt.md +++ /dev/null @@ -1,346 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / SchemaCxt - -# Interface: SchemaCxt - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).SchemaCxt - -## Hierarchy - -- **`SchemaCxt`** - - ↳ [`SchemaObjCxt`](verida_client_ts._internal_.SchemaObjCxt.md) - -## Table of contents - -### Properties - -- [ValidationError](verida_client_ts._internal_.SchemaCxt.md#validationerror) -- [allErrors](verida_client_ts._internal_.SchemaCxt.md#allerrors) -- [baseId](verida_client_ts._internal_.SchemaCxt.md#baseid) -- [compositeRule](verida_client_ts._internal_.SchemaCxt.md#compositerule) -- [createErrors](verida_client_ts._internal_.SchemaCxt.md#createerrors) -- [data](verida_client_ts._internal_.SchemaCxt.md#data) -- [dataLevel](verida_client_ts._internal_.SchemaCxt.md#datalevel) -- [dataNames](verida_client_ts._internal_.SchemaCxt.md#datanames) -- [dataPathArr](verida_client_ts._internal_.SchemaCxt.md#datapatharr) -- [dataTypes](verida_client_ts._internal_.SchemaCxt.md#datatypes) -- [definedProperties](verida_client_ts._internal_.SchemaCxt.md#definedproperties) -- [errSchemaPath](verida_client_ts._internal_.SchemaCxt.md#errschemapath) -- [errorPath](verida_client_ts._internal_.SchemaCxt.md#errorpath) -- [evaluated](verida_client_ts._internal_.SchemaCxt.md#evaluated) -- [gen](verida_client_ts._internal_.SchemaCxt.md#gen) -- [items](verida_client_ts._internal_.SchemaCxt.md#items) -- [jtdDiscriminator](verida_client_ts._internal_.SchemaCxt.md#jtddiscriminator) -- [jtdMetadata](verida_client_ts._internal_.SchemaCxt.md#jtdmetadata) -- [opts](verida_client_ts._internal_.SchemaCxt.md#opts) -- [parentData](verida_client_ts._internal_.SchemaCxt.md#parentdata) -- [parentDataProperty](verida_client_ts._internal_.SchemaCxt.md#parentdataproperty) -- [propertyName](verida_client_ts._internal_.SchemaCxt.md#propertyname) -- [props](verida_client_ts._internal_.SchemaCxt.md#props) -- [rootId](verida_client_ts._internal_.SchemaCxt.md#rootid) -- [schema](verida_client_ts._internal_.SchemaCxt.md#schema) -- [schemaEnv](verida_client_ts._internal_.SchemaCxt.md#schemaenv) -- [schemaPath](verida_client_ts._internal_.SchemaCxt.md#schemapath) -- [self](verida_client_ts._internal_.SchemaCxt.md#self) -- [topSchemaRef](verida_client_ts._internal_.SchemaCxt.md#topschemaref) -- [validateName](verida_client_ts._internal_.SchemaCxt.md#validatename) - -## Properties - -### ValidationError - -• `Optional` `Readonly` **ValidationError**: [`Name`](../classes/verida_client_ts._internal_.Name.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:24 - -___ - -### allErrors - -• `Optional` `Readonly` **allErrors**: `boolean` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:12 - -___ - -### baseId - -• **baseId**: `string` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:28 - -___ - -### compositeRule - -• `Optional` `Readonly` **compositeRule**: `boolean` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:33 - -___ - -### createErrors - -• `Optional` `Readonly` **createErrors**: `boolean` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:38 - -___ - -### data - -• `Readonly` **data**: [`Name`](../classes/verida_client_ts._internal_.Name.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:13 - -___ - -### dataLevel - -• `Readonly` **dataLevel**: `number` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:18 - -___ - -### dataNames - -• `Readonly` **dataNames**: [`Name`](../classes/verida_client_ts._internal_.Name.md)[] - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:16 - -___ - -### dataPathArr - -• `Readonly` **dataPathArr**: (`number` \| [`Code`](../modules/verida_client_ts._internal_.md#code))[] - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:17 - -___ - -### dataTypes - -• **dataTypes**: (``"string"`` \| ``"number"`` \| ``"boolean"`` \| ``"object"`` \| ``"integer"`` \| ``"array"`` \| ``"null"``)[] - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:19 - -___ - -### definedProperties - -• **definedProperties**: `Set`<`string`\> - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:20 - -___ - -### errSchemaPath - -• `Readonly` **errSchemaPath**: `string` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:30 - -___ - -### errorPath - -• `Readonly` **errorPath**: [`Code`](../modules/verida_client_ts._internal_.md#code) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:31 - -___ - -### evaluated - -• `Optional` **evaluated**: [`Name`](../classes/verida_client_ts._internal_.Name.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:23 - -___ - -### gen - -• `Readonly` **gen**: [`CodeGen`](../classes/verida_client_ts._internal_.CodeGen.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:11 - -___ - -### items - -• `Optional` **items**: [`Name`](../classes/verida_client_ts._internal_.Name.md) \| [`EvaluatedItems`](../modules/verida_client_ts._internal_.md#evaluateditems) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:35 - -___ - -### jtdDiscriminator - -• `Optional` **jtdDiscriminator**: `string` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:36 - -___ - -### jtdMetadata - -• `Optional` **jtdMetadata**: `boolean` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:37 - -___ - -### opts - -• `Readonly` **opts**: [`InstanceOptions`](../modules/verida_client_ts._internal_.md#instanceoptions) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:39 - -___ - -### parentData - -• `Readonly` **parentData**: [`Name`](../classes/verida_client_ts._internal_.Name.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:14 - -___ - -### parentDataProperty - -• `Readonly` **parentDataProperty**: `number` \| [`Code`](../modules/verida_client_ts._internal_.md#code) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:15 - -___ - -### propertyName - -• `Optional` `Readonly` **propertyName**: [`Name`](../classes/verida_client_ts._internal_.Name.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:32 - -___ - -### props - -• `Optional` **props**: [`Name`](../classes/verida_client_ts._internal_.Name.md) \| [`EvaluatedProperties`](../modules/verida_client_ts._internal_.md#evaluatedproperties) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:34 - -___ - -### rootId - -• `Readonly` **rootId**: `string` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:27 - -___ - -### schema - -• `Readonly` **schema**: [`AnySchema`](../modules/verida_client_ts._internal_.md#anyschema) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:25 - -___ - -### schemaEnv - -• `Readonly` **schemaEnv**: [`SchemaEnv`](../classes/verida_client_ts._internal_.SchemaEnv.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:26 - -___ - -### schemaPath - -• `Readonly` **schemaPath**: [`Code`](../modules/verida_client_ts._internal_.md#code) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:29 - -___ - -### self - -• `Readonly` **self**: [`default`](../classes/verida_client_ts._internal_.default-3.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:40 - -___ - -### topSchemaRef - -• `Readonly` **topSchemaRef**: [`Code`](../modules/verida_client_ts._internal_.md#code) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:21 - -___ - -### validateName - -• `Readonly` **validateName**: [`Name`](../classes/verida_client_ts._internal_.Name.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:22 diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.SchemaEnvArgs.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.SchemaEnvArgs.md deleted file mode 100644 index da04f10..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.SchemaEnvArgs.md +++ /dev/null @@ -1,91 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / SchemaEnvArgs - -# Interface: SchemaEnvArgs - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).SchemaEnvArgs - -## Implemented by - -- [`SchemaEnv`](../classes/verida_client_ts._internal_.SchemaEnv.md) - -## Table of contents - -### Properties - -- [baseId](verida_client_ts._internal_.SchemaEnvArgs.md#baseid) -- [localRefs](verida_client_ts._internal_.SchemaEnvArgs.md#localrefs) -- [meta](verida_client_ts._internal_.SchemaEnvArgs.md#meta) -- [root](verida_client_ts._internal_.SchemaEnvArgs.md#root) -- [schema](verida_client_ts._internal_.SchemaEnvArgs.md#schema) -- [schemaId](verida_client_ts._internal_.SchemaEnvArgs.md#schemaid) -- [schemaPath](verida_client_ts._internal_.SchemaEnvArgs.md#schemapath) - -## Properties - -### baseId - -• `Optional` `Readonly` **baseId**: `string` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:49 - -___ - -### localRefs - -• `Optional` `Readonly` **localRefs**: [`LocalRefs`](../modules/verida_client_ts._internal_.md#localrefs) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:51 - -___ - -### meta - -• `Optional` `Readonly` **meta**: `boolean` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:52 - -___ - -### root - -• `Optional` `Readonly` **root**: [`SchemaEnv`](../classes/verida_client_ts._internal_.SchemaEnv.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:48 - -___ - -### schema - -• `Readonly` **schema**: [`AnySchema`](../modules/verida_client_ts._internal_.md#anyschema) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:46 - -___ - -### schemaId - -• `Optional` `Readonly` **schemaId**: ``"id"`` \| ``"$id"`` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:47 - -___ - -### schemaPath - -• `Optional` `Readonly` **schemaPath**: `string` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:50 diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.SchemaObjCxt.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.SchemaObjCxt.md deleted file mode 100644 index e6b8ed9..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.SchemaObjCxt.md +++ /dev/null @@ -1,466 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / SchemaObjCxt - -# Interface: SchemaObjCxt - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).SchemaObjCxt - -## Hierarchy - -- [`SchemaCxt`](verida_client_ts._internal_.SchemaCxt.md) - - ↳ **`SchemaObjCxt`** - -## Table of contents - -### Properties - -- [ValidationError](verida_client_ts._internal_.SchemaObjCxt.md#validationerror) -- [allErrors](verida_client_ts._internal_.SchemaObjCxt.md#allerrors) -- [baseId](verida_client_ts._internal_.SchemaObjCxt.md#baseid) -- [compositeRule](verida_client_ts._internal_.SchemaObjCxt.md#compositerule) -- [createErrors](verida_client_ts._internal_.SchemaObjCxt.md#createerrors) -- [data](verida_client_ts._internal_.SchemaObjCxt.md#data) -- [dataLevel](verida_client_ts._internal_.SchemaObjCxt.md#datalevel) -- [dataNames](verida_client_ts._internal_.SchemaObjCxt.md#datanames) -- [dataPathArr](verida_client_ts._internal_.SchemaObjCxt.md#datapatharr) -- [dataTypes](verida_client_ts._internal_.SchemaObjCxt.md#datatypes) -- [definedProperties](verida_client_ts._internal_.SchemaObjCxt.md#definedproperties) -- [errSchemaPath](verida_client_ts._internal_.SchemaObjCxt.md#errschemapath) -- [errorPath](verida_client_ts._internal_.SchemaObjCxt.md#errorpath) -- [evaluated](verida_client_ts._internal_.SchemaObjCxt.md#evaluated) -- [gen](verida_client_ts._internal_.SchemaObjCxt.md#gen) -- [items](verida_client_ts._internal_.SchemaObjCxt.md#items) -- [jtdDiscriminator](verida_client_ts._internal_.SchemaObjCxt.md#jtddiscriminator) -- [jtdMetadata](verida_client_ts._internal_.SchemaObjCxt.md#jtdmetadata) -- [opts](verida_client_ts._internal_.SchemaObjCxt.md#opts) -- [parentData](verida_client_ts._internal_.SchemaObjCxt.md#parentdata) -- [parentDataProperty](verida_client_ts._internal_.SchemaObjCxt.md#parentdataproperty) -- [propertyName](verida_client_ts._internal_.SchemaObjCxt.md#propertyname) -- [props](verida_client_ts._internal_.SchemaObjCxt.md#props) -- [rootId](verida_client_ts._internal_.SchemaObjCxt.md#rootid) -- [schema](verida_client_ts._internal_.SchemaObjCxt.md#schema) -- [schemaEnv](verida_client_ts._internal_.SchemaObjCxt.md#schemaenv) -- [schemaPath](verida_client_ts._internal_.SchemaObjCxt.md#schemapath) -- [self](verida_client_ts._internal_.SchemaObjCxt.md#self) -- [topSchemaRef](verida_client_ts._internal_.SchemaObjCxt.md#topschemaref) -- [validateName](verida_client_ts._internal_.SchemaObjCxt.md#validatename) - -## Properties - -### ValidationError - -• `Optional` `Readonly` **ValidationError**: [`Name`](../classes/verida_client_ts._internal_.Name.md) - -#### Inherited from - -[SchemaCxt](verida_client_ts._internal_.SchemaCxt.md).[ValidationError](verida_client_ts._internal_.SchemaCxt.md#validationerror) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:24 - -___ - -### allErrors - -• `Optional` `Readonly` **allErrors**: `boolean` - -#### Inherited from - -[SchemaCxt](verida_client_ts._internal_.SchemaCxt.md).[allErrors](verida_client_ts._internal_.SchemaCxt.md#allerrors) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:12 - -___ - -### baseId - -• **baseId**: `string` - -#### Inherited from - -[SchemaCxt](verida_client_ts._internal_.SchemaCxt.md).[baseId](verida_client_ts._internal_.SchemaCxt.md#baseid) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:28 - -___ - -### compositeRule - -• `Optional` `Readonly` **compositeRule**: `boolean` - -#### Inherited from - -[SchemaCxt](verida_client_ts._internal_.SchemaCxt.md).[compositeRule](verida_client_ts._internal_.SchemaCxt.md#compositerule) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:33 - -___ - -### createErrors - -• `Optional` `Readonly` **createErrors**: `boolean` - -#### Inherited from - -[SchemaCxt](verida_client_ts._internal_.SchemaCxt.md).[createErrors](verida_client_ts._internal_.SchemaCxt.md#createerrors) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:38 - -___ - -### data - -• `Readonly` **data**: [`Name`](../classes/verida_client_ts._internal_.Name.md) - -#### Inherited from - -[SchemaCxt](verida_client_ts._internal_.SchemaCxt.md).[data](verida_client_ts._internal_.SchemaCxt.md#data) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:13 - -___ - -### dataLevel - -• `Readonly` **dataLevel**: `number` - -#### Inherited from - -[SchemaCxt](verida_client_ts._internal_.SchemaCxt.md).[dataLevel](verida_client_ts._internal_.SchemaCxt.md#datalevel) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:18 - -___ - -### dataNames - -• `Readonly` **dataNames**: [`Name`](../classes/verida_client_ts._internal_.Name.md)[] - -#### Inherited from - -[SchemaCxt](verida_client_ts._internal_.SchemaCxt.md).[dataNames](verida_client_ts._internal_.SchemaCxt.md#datanames) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:16 - -___ - -### dataPathArr - -• `Readonly` **dataPathArr**: (`number` \| [`Code`](../modules/verida_client_ts._internal_.md#code))[] - -#### Inherited from - -[SchemaCxt](verida_client_ts._internal_.SchemaCxt.md).[dataPathArr](verida_client_ts._internal_.SchemaCxt.md#datapatharr) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:17 - -___ - -### dataTypes - -• **dataTypes**: (``"string"`` \| ``"number"`` \| ``"boolean"`` \| ``"object"`` \| ``"integer"`` \| ``"array"`` \| ``"null"``)[] - -#### Inherited from - -[SchemaCxt](verida_client_ts._internal_.SchemaCxt.md).[dataTypes](verida_client_ts._internal_.SchemaCxt.md#datatypes) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:19 - -___ - -### definedProperties - -• **definedProperties**: `Set`<`string`\> - -#### Inherited from - -[SchemaCxt](verida_client_ts._internal_.SchemaCxt.md).[definedProperties](verida_client_ts._internal_.SchemaCxt.md#definedproperties) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:20 - -___ - -### errSchemaPath - -• `Readonly` **errSchemaPath**: `string` - -#### Inherited from - -[SchemaCxt](verida_client_ts._internal_.SchemaCxt.md).[errSchemaPath](verida_client_ts._internal_.SchemaCxt.md#errschemapath) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:30 - -___ - -### errorPath - -• `Readonly` **errorPath**: [`Code`](../modules/verida_client_ts._internal_.md#code) - -#### Inherited from - -[SchemaCxt](verida_client_ts._internal_.SchemaCxt.md).[errorPath](verida_client_ts._internal_.SchemaCxt.md#errorpath) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:31 - -___ - -### evaluated - -• `Optional` **evaluated**: [`Name`](../classes/verida_client_ts._internal_.Name.md) - -#### Inherited from - -[SchemaCxt](verida_client_ts._internal_.SchemaCxt.md).[evaluated](verida_client_ts._internal_.SchemaCxt.md#evaluated) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:23 - -___ - -### gen - -• `Readonly` **gen**: [`CodeGen`](../classes/verida_client_ts._internal_.CodeGen.md) - -#### Inherited from - -[SchemaCxt](verida_client_ts._internal_.SchemaCxt.md).[gen](verida_client_ts._internal_.SchemaCxt.md#gen) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:11 - -___ - -### items - -• `Optional` **items**: [`Name`](../classes/verida_client_ts._internal_.Name.md) \| [`EvaluatedItems`](../modules/verida_client_ts._internal_.md#evaluateditems) - -#### Inherited from - -[SchemaCxt](verida_client_ts._internal_.SchemaCxt.md).[items](verida_client_ts._internal_.SchemaCxt.md#items) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:35 - -___ - -### jtdDiscriminator - -• `Optional` **jtdDiscriminator**: `string` - -#### Inherited from - -[SchemaCxt](verida_client_ts._internal_.SchemaCxt.md).[jtdDiscriminator](verida_client_ts._internal_.SchemaCxt.md#jtddiscriminator) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:36 - -___ - -### jtdMetadata - -• `Optional` **jtdMetadata**: `boolean` - -#### Inherited from - -[SchemaCxt](verida_client_ts._internal_.SchemaCxt.md).[jtdMetadata](verida_client_ts._internal_.SchemaCxt.md#jtdmetadata) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:37 - -___ - -### opts - -• `Readonly` **opts**: [`InstanceOptions`](../modules/verida_client_ts._internal_.md#instanceoptions) - -#### Inherited from - -[SchemaCxt](verida_client_ts._internal_.SchemaCxt.md).[opts](verida_client_ts._internal_.SchemaCxt.md#opts) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:39 - -___ - -### parentData - -• `Readonly` **parentData**: [`Name`](../classes/verida_client_ts._internal_.Name.md) - -#### Inherited from - -[SchemaCxt](verida_client_ts._internal_.SchemaCxt.md).[parentData](verida_client_ts._internal_.SchemaCxt.md#parentdata) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:14 - -___ - -### parentDataProperty - -• `Readonly` **parentDataProperty**: `number` \| [`Code`](../modules/verida_client_ts._internal_.md#code) - -#### Inherited from - -[SchemaCxt](verida_client_ts._internal_.SchemaCxt.md).[parentDataProperty](verida_client_ts._internal_.SchemaCxt.md#parentdataproperty) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:15 - -___ - -### propertyName - -• `Optional` `Readonly` **propertyName**: [`Name`](../classes/verida_client_ts._internal_.Name.md) - -#### Inherited from - -[SchemaCxt](verida_client_ts._internal_.SchemaCxt.md).[propertyName](verida_client_ts._internal_.SchemaCxt.md#propertyname) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:32 - -___ - -### props - -• `Optional` **props**: [`Name`](../classes/verida_client_ts._internal_.Name.md) \| [`EvaluatedProperties`](../modules/verida_client_ts._internal_.md#evaluatedproperties) - -#### Inherited from - -[SchemaCxt](verida_client_ts._internal_.SchemaCxt.md).[props](verida_client_ts._internal_.SchemaCxt.md#props) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:34 - -___ - -### rootId - -• `Readonly` **rootId**: `string` - -#### Inherited from - -[SchemaCxt](verida_client_ts._internal_.SchemaCxt.md).[rootId](verida_client_ts._internal_.SchemaCxt.md#rootid) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:27 - -___ - -### schema - -• `Readonly` **schema**: [`AnySchemaObject`](../modules/verida_client_ts._internal_.md#anyschemaobject) - -#### Overrides - -[SchemaCxt](verida_client_ts._internal_.SchemaCxt.md).[schema](verida_client_ts._internal_.SchemaCxt.md#schema) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:43 - -___ - -### schemaEnv - -• `Readonly` **schemaEnv**: [`SchemaEnv`](../classes/verida_client_ts._internal_.SchemaEnv.md) - -#### Inherited from - -[SchemaCxt](verida_client_ts._internal_.SchemaCxt.md).[schemaEnv](verida_client_ts._internal_.SchemaCxt.md#schemaenv) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:26 - -___ - -### schemaPath - -• `Readonly` **schemaPath**: [`Code`](../modules/verida_client_ts._internal_.md#code) - -#### Inherited from - -[SchemaCxt](verida_client_ts._internal_.SchemaCxt.md).[schemaPath](verida_client_ts._internal_.SchemaCxt.md#schemapath) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:29 - -___ - -### self - -• `Readonly` **self**: [`default`](../classes/verida_client_ts._internal_.default-3.md) - -#### Inherited from - -[SchemaCxt](verida_client_ts._internal_.SchemaCxt.md).[self](verida_client_ts._internal_.SchemaCxt.md#self) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:40 - -___ - -### topSchemaRef - -• `Readonly` **topSchemaRef**: [`Code`](../modules/verida_client_ts._internal_.md#code) - -#### Inherited from - -[SchemaCxt](verida_client_ts._internal_.SchemaCxt.md).[topSchemaRef](verida_client_ts._internal_.SchemaCxt.md#topschemaref) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:21 - -___ - -### validateName - -• `Readonly` **validateName**: [`Name`](../classes/verida_client_ts._internal_.Name.md) - -#### Inherited from - -[SchemaCxt](verida_client_ts._internal_.SchemaCxt.md).[validateName](verida_client_ts._internal_.SchemaCxt.md#validatename) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:22 diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.SchemaObject.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.SchemaObject.md deleted file mode 100644 index 8d10afc..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.SchemaObject.md +++ /dev/null @@ -1,76 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / SchemaObject - -# Interface: SchemaObject - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).SchemaObject - -## Hierarchy - -- [`_SchemaObject`](verida_client_ts._internal_._SchemaObject.md) - - ↳ **`SchemaObject`** - -## Indexable - -▪ [x: `string`]: `any` - -## Table of contents - -### Properties - -- [$async](verida_client_ts._internal_.SchemaObject.md#$async) -- [$id](verida_client_ts._internal_.SchemaObject.md#$id) -- [$schema](verida_client_ts._internal_.SchemaObject.md#$schema) -- [id](verida_client_ts._internal_.SchemaObject.md#id) - -## Properties - -### $async - -• `Optional` **$async**: ``false`` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:17 - -___ - -### $id - -• `Optional` **$id**: `string` - -#### Overrides - -[_SchemaObject](verida_client_ts._internal_._SchemaObject.md).[$id](verida_client_ts._internal_._SchemaObject.md#$id) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:15 - -___ - -### $schema - -• `Optional` **$schema**: `string` - -#### Overrides - -[_SchemaObject](verida_client_ts._internal_._SchemaObject.md).[$schema](verida_client_ts._internal_._SchemaObject.md#$schema) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:16 - -___ - -### id - -• `Optional` **id**: `string` - -#### Overrides - -[_SchemaObject](verida_client_ts._internal_._SchemaObject.md).[id](verida_client_ts._internal_._SchemaObject.md#id) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:14 diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.SchemaValidateFunction.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.SchemaValidateFunction.md deleted file mode 100644 index 904721c..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.SchemaValidateFunction.md +++ /dev/null @@ -1,44 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / SchemaValidateFunction - -# Interface: SchemaValidateFunction - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).SchemaValidateFunction - -## Callable - -### SchemaValidateFunction - -▸ **SchemaValidateFunction**(`schema`, `data`, `parentSchema?`, `dataCxt?`): `boolean` \| `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schema` | `any` | -| `data` | `any` | -| `parentSchema?` | [`AnySchemaObject`](../modules/verida_client_ts._internal_.md#anyschemaobject) | -| `dataCxt?` | [`DataValidationCxt`](verida_client_ts._internal_.DataValidationCxt.md)<`string` \| `number`\> | - -#### Returns - -`boolean` \| `Promise`<`any`\> - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:112 - -## Table of contents - -### Properties - -- [errors](verida_client_ts._internal_.SchemaValidateFunction.md#errors) - -## Properties - -### errors - -• `Optional` **errors**: [`Partial`](../modules/verida_client_ts._internal_.md#partial)<[`ErrorObject`](verida_client_ts._internal_.ErrorObject.md)<`string`, [`Record`](../modules/verida_client_ts._internal_.md#record)<`string`, `any`\>, `unknown`\>\>[] - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:113 diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.ScopeOptions.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.ScopeOptions.md deleted file mode 100644 index b1e8943..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.ScopeOptions.md +++ /dev/null @@ -1,38 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / ScopeOptions - -# Interface: ScopeOptions - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).ScopeOptions - -## Hierarchy - -- **`ScopeOptions`** - - ↳ [`ValueScopeOptions`](verida_client_ts._internal_.ValueScopeOptions.md) - -## Table of contents - -### Properties - -- [parent](verida_client_ts._internal_.ScopeOptions.md#parent) -- [prefixes](verida_client_ts._internal_.ScopeOptions.md#prefixes) - -## Properties - -### parent - -• `Optional` **parent**: [`Scope`](../classes/verida_client_ts._internal_.Scope.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/scope.d.ts:14 - -___ - -### prefixes - -• `Optional` **prefixes**: `Set`<`string`\> - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/scope.d.ts:13 diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.ScopePath.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.ScopePath.md deleted file mode 100644 index 34c9507..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.ScopePath.md +++ /dev/null @@ -1,32 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / ScopePath - -# Interface: ScopePath - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).ScopePath - -## Table of contents - -### Properties - -- [itemIndex](verida_client_ts._internal_.ScopePath.md#itemindex) -- [property](verida_client_ts._internal_.ScopePath.md#property) - -## Properties - -### itemIndex - -• **itemIndex**: `number` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/scope.d.ts:54 - -___ - -### property - -• **property**: `string` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/scope.d.ts:53 diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.SecureContextConfig.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.SecureContextConfig.md deleted file mode 100644 index 5df87ed..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.SecureContextConfig.md +++ /dev/null @@ -1,43 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / SecureContextConfig - -# Interface: SecureContextConfig - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).SecureContextConfig - -## Table of contents - -### Properties - -- [id](verida_client_ts._internal_.SecureContextConfig.md#id) -- [publicKeys](verida_client_ts._internal_.SecureContextConfig.md#publickeys) -- [services](verida_client_ts._internal_.SecureContextConfig.md#services) - -## Properties - -### id - -• **id**: `string` - -#### Defined in - -packages/types/dist/StorageLinkInterfaces.d.ts:17 - -___ - -### publicKeys - -• **publicKeys**: [`SecureStorageContextPublicKeys`](verida_client_ts._internal_.SecureStorageContextPublicKeys.md) - -#### Defined in - -packages/types/dist/StorageLinkInterfaces.d.ts:18 - -___ - -### services - -• **services**: [`SecureContextServices`](verida_client_ts._internal_.SecureContextServices.md) - -#### Defined in - -packages/types/dist/StorageLinkInterfaces.d.ts:19 diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.SecureContextEndpoint-1.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.SecureContextEndpoint-1.md deleted file mode 100644 index e04f32b..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.SecureContextEndpoint-1.md +++ /dev/null @@ -1,43 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / SecureContextEndpoint - -# Interface: SecureContextEndpoint - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).SecureContextEndpoint - -## Table of contents - -### Properties - -- [config](verida_client_ts._internal_.SecureContextEndpoint-1.md#config) -- [endpointUri](verida_client_ts._internal_.SecureContextEndpoint-1.md#endpointuri) -- [type](verida_client_ts._internal_.SecureContextEndpoint-1.md#type) - -## Properties - -### config - -• `Optional` **config**: `object` - -#### Defined in - -packages/did-document/dist/interfaces.d.ts:5 - -___ - -### endpointUri - -• **endpointUri**: `string` - -#### Defined in - -packages/did-document/dist/interfaces.d.ts:4 - -___ - -### type - -• **type**: `string` - -#### Defined in - -packages/did-document/dist/interfaces.d.ts:3 diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.SecureContextEndpoint.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.SecureContextEndpoint.md deleted file mode 100644 index 441b5e7..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.SecureContextEndpoint.md +++ /dev/null @@ -1,43 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / SecureContextEndpoint - -# Interface: SecureContextEndpoint - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).SecureContextEndpoint - -## Table of contents - -### Properties - -- [config](verida_client_ts._internal_.SecureContextEndpoint.md#config) -- [endpointUri](verida_client_ts._internal_.SecureContextEndpoint.md#endpointuri) -- [type](verida_client_ts._internal_.SecureContextEndpoint.md#type) - -## Properties - -### config - -• `Optional` **config**: `object` - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:5 - -___ - -### endpointUri - -• **endpointUri**: [`ServiceEndpoint`](../modules/verida_client_ts._internal_.md#serviceendpoint)[] - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:4 - -___ - -### type - -• **type**: `string` - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:3 diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.SecureContextEndpoints.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.SecureContextEndpoints.md deleted file mode 100644 index b2e533c..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.SecureContextEndpoints.md +++ /dev/null @@ -1,54 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / SecureContextEndpoints - -# Interface: SecureContextEndpoints - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).SecureContextEndpoints - -## Table of contents - -### Properties - -- [database](verida_client_ts._internal_.SecureContextEndpoints.md#database) -- [messaging](verida_client_ts._internal_.SecureContextEndpoints.md#messaging) -- [notification](verida_client_ts._internal_.SecureContextEndpoints.md#notification) -- [storage](verida_client_ts._internal_.SecureContextEndpoints.md#storage) - -## Properties - -### database - -• **database**: [`SecureContextEndpoint`](verida_client_ts._internal_.SecureContextEndpoint.md) - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:8 - -___ - -### messaging - -• **messaging**: [`SecureContextEndpoint`](verida_client_ts._internal_.SecureContextEndpoint.md) - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:9 - -___ - -### notification - -• `Optional` **notification**: [`SecureContextEndpoint`](verida_client_ts._internal_.SecureContextEndpoint.md) - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:11 - -___ - -### storage - -• `Optional` **storage**: [`SecureContextEndpoint`](verida_client_ts._internal_.SecureContextEndpoint.md) - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:10 diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.SecureContextPublicKey.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.SecureContextPublicKey.md deleted file mode 100644 index fcb7d88..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.SecureContextPublicKey.md +++ /dev/null @@ -1,32 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / SecureContextPublicKey - -# Interface: SecureContextPublicKey - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).SecureContextPublicKey - -## Table of contents - -### Properties - -- [publicKeyHex](verida_client_ts._internal_.SecureContextPublicKey.md#publickeyhex) -- [type](verida_client_ts._internal_.SecureContextPublicKey.md#type) - -## Properties - -### publicKeyHex - -• **publicKeyHex**: `string` - -#### Defined in - -packages/types/dist/StorageLinkInterfaces.d.ts:4 - -___ - -### type - -• **type**: `string` - -#### Defined in - -packages/types/dist/StorageLinkInterfaces.d.ts:3 diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.SecureContextServices.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.SecureContextServices.md deleted file mode 100644 index aae8374..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.SecureContextServices.md +++ /dev/null @@ -1,54 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / SecureContextServices - -# Interface: SecureContextServices - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).SecureContextServices - -## Table of contents - -### Properties - -- [databaseServer](verida_client_ts._internal_.SecureContextServices.md#databaseserver) -- [messageServer](verida_client_ts._internal_.SecureContextServices.md#messageserver) -- [notificationServer](verida_client_ts._internal_.SecureContextServices.md#notificationserver) -- [storageServer](verida_client_ts._internal_.SecureContextServices.md#storageserver) - -## Properties - -### databaseServer - -• **databaseServer**: [`SecureContextEndpoint`](verida_client_ts._internal_.SecureContextEndpoint.md) - -#### Defined in - -packages/types/dist/StorageLinkInterfaces.d.ts:11 - -___ - -### messageServer - -• **messageServer**: [`SecureContextEndpoint`](verida_client_ts._internal_.SecureContextEndpoint.md) - -#### Defined in - -packages/types/dist/StorageLinkInterfaces.d.ts:12 - -___ - -### notificationServer - -• `Optional` **notificationServer**: [`SecureContextEndpoint`](verida_client_ts._internal_.SecureContextEndpoint.md) - -#### Defined in - -packages/types/dist/StorageLinkInterfaces.d.ts:14 - -___ - -### storageServer - -• `Optional` **storageServer**: [`SecureContextEndpoint`](verida_client_ts._internal_.SecureContextEndpoint.md) - -#### Defined in - -packages/types/dist/StorageLinkInterfaces.d.ts:13 diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.SecureStorageContextPublicKeys.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.SecureStorageContextPublicKeys.md deleted file mode 100644 index f7b312d..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.SecureStorageContextPublicKeys.md +++ /dev/null @@ -1,32 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / SecureStorageContextPublicKeys - -# Interface: SecureStorageContextPublicKeys - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).SecureStorageContextPublicKeys - -## Table of contents - -### Properties - -- [asymKey](verida_client_ts._internal_.SecureStorageContextPublicKeys.md#asymkey) -- [signKey](verida_client_ts._internal_.SecureStorageContextPublicKeys.md#signkey) - -## Properties - -### asymKey - -• **asymKey**: [`SecureContextPublicKey`](verida_client_ts._internal_.SecureContextPublicKey.md) - -#### Defined in - -packages/types/dist/StorageLinkInterfaces.d.ts:7 - -___ - -### signKey - -• **signKey**: [`SecureContextPublicKey`](verida_client_ts._internal_.SecureContextPublicKey.md) - -#### Defined in - -packages/types/dist/StorageLinkInterfaces.d.ts:8 diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.Service.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.Service.md deleted file mode 100644 index 68d0744..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.Service.md +++ /dev/null @@ -1,53 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / Service - -# Interface: Service - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).Service - -Represents a Service entry in a [DID document](https://www.w3.org/TR/did-core/#did-document-properties). - -**`see`** [https://www.w3.org/TR/did-core/#services](https://www.w3.org/TR/did-core/#services) - -**`see`** [https://www.w3.org/TR/did-core/#service-properties](https://www.w3.org/TR/did-core/#service-properties) - -## Indexable - -▪ [x: `string`]: `any` - -## Table of contents - -### Properties - -- [id](verida_client_ts._internal_.Service.md#id) -- [serviceEndpoint](verida_client_ts._internal_.Service.md#serviceendpoint) -- [type](verida_client_ts._internal_.Service.md#type) - -## Properties - -### id - -• **id**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:81 - -___ - -### serviceEndpoint - -• **serviceEndpoint**: [`ServiceEndpoint`](../modules/verida_client_ts._internal_.md#serviceendpoint) \| [`ServiceEndpoint`](../modules/verida_client_ts._internal_.md#serviceendpoint)[] - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:83 - -___ - -### type - -• **type**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:82 diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.ServiceEndpoint.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.ServiceEndpoint.md deleted file mode 100644 index e8fd6e1..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.ServiceEndpoint.md +++ /dev/null @@ -1,54 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / ServiceEndpoint - -# Interface: ServiceEndpoint - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).ServiceEndpoint - -## Table of contents - -### Properties - -- [description](verida_client_ts._internal_.ServiceEndpoint.md#description) -- [id](verida_client_ts._internal_.ServiceEndpoint.md#id) -- [serviceEndpoint](verida_client_ts._internal_.ServiceEndpoint.md#serviceendpoint) -- [type](verida_client_ts._internal_.ServiceEndpoint.md#type) - -## Properties - -### description - -• `Optional` **description**: `string` - -#### Defined in - -packages/did-document/node_modules/did-resolver/lib/resolver.d.ts:43 - -___ - -### id - -• **id**: `string` - -#### Defined in - -packages/did-document/node_modules/did-resolver/lib/resolver.d.ts:40 - -___ - -### serviceEndpoint - -• **serviceEndpoint**: `string` - -#### Defined in - -packages/did-document/node_modules/did-resolver/lib/resolver.d.ts:42 - -___ - -### type - -• **type**: `string` - -#### Defined in - -packages/did-document/node_modules/did-resolver/lib/resolver.d.ts:41 diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.SignKeyPair.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.SignKeyPair.md deleted file mode 100644 index ab9af9f..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.SignKeyPair.md +++ /dev/null @@ -1,32 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / SignKeyPair - -# Interface: SignKeyPair - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).SignKeyPair - -## Table of contents - -### Properties - -- [publicKey](verida_client_ts._internal_.SignKeyPair.md#publickey) -- [secretKey](verida_client_ts._internal_.SignKeyPair.md#secretkey) - -## Properties - -### publicKey - -• **publicKey**: `Uint8Array` - -#### Defined in - -node_modules/tweetnacl/nacl.d.ts:15 - -___ - -### secretKey - -• **secretKey**: `Uint8Array` - -#### Defined in - -node_modules/tweetnacl/nacl.d.ts:16 diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.SourceCode.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.SourceCode.md deleted file mode 100644 index f4aadb0..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.SourceCode.md +++ /dev/null @@ -1,54 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / SourceCode - -# Interface: SourceCode - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).SourceCode - -## Table of contents - -### Properties - -- [evaluated](verida_client_ts._internal_.SourceCode.md#evaluated) -- [scopeValues](verida_client_ts._internal_.SourceCode.md#scopevalues) -- [validateCode](verida_client_ts._internal_.SourceCode.md#validatecode) -- [validateName](verida_client_ts._internal_.SourceCode.md#validatename) - -## Properties - -### evaluated - -• `Optional` **evaluated**: [`Code`](../modules/verida_client_ts._internal_.md#code) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:33 - -___ - -### scopeValues - -• **scopeValues**: [`ScopeValueSets`](../modules/verida_client_ts._internal_.md#scopevaluesets) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:32 - -___ - -### validateCode - -• **validateCode**: `string` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:31 - -___ - -### validateName - -• **validateName**: [`ValueScopeName`](../classes/verida_client_ts._internal_.ValueScopeName.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:30 diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.StaticEventEmitterOptions.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.StaticEventEmitterOptions.md deleted file mode 100644 index e5f3c2c..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.StaticEventEmitterOptions.md +++ /dev/null @@ -1,21 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / StaticEventEmitterOptions - -# Interface: StaticEventEmitterOptions - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).StaticEventEmitterOptions - -## Table of contents - -### Properties - -- [signal](verida_client_ts._internal_.StaticEventEmitterOptions.md#signal) - -## Properties - -### signal - -• `Optional` **signal**: [`AbortSignal`](../modules/verida_client_ts._internal_.md#abortsignal) - -#### Defined in - -node_modules/@types/node/events.d.ts:57 diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.StringKeywords.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.StringKeywords.md deleted file mode 100644 index 2f136c1..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.StringKeywords.md +++ /dev/null @@ -1,54 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / StringKeywords - -# Interface: StringKeywords - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).StringKeywords - -## Table of contents - -### Properties - -- [format](verida_client_ts._internal_.StringKeywords.md#format) -- [maxLength](verida_client_ts._internal_.StringKeywords.md#maxlength) -- [minLength](verida_client_ts._internal_.StringKeywords.md#minlength) -- [pattern](verida_client_ts._internal_.StringKeywords.md#pattern) - -## Properties - -### format - -• `Optional` **format**: `string` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/json-schema.d.ts:19 - -___ - -### maxLength - -• `Optional` **maxLength**: `number` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/json-schema.d.ts:17 - -___ - -### minLength - -• `Optional` **minLength**: `number` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/json-schema.d.ts:16 - -___ - -### pattern - -• `Optional` **pattern**: `string` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/json-schema.d.ts:18 diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.Transaction.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.Transaction.md deleted file mode 100644 index b21c4ac..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.Transaction.md +++ /dev/null @@ -1,192 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / Transaction - -# Interface: Transaction - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).Transaction - -## Hierarchy - -- **`Transaction`** - - ↳ [`TransactionResponse`](verida_client_ts._internal_.TransactionResponse.md) - -## Table of contents - -### Properties - -- [accessList](verida_client_ts._internal_.Transaction.md#accesslist) -- [chainId](verida_client_ts._internal_.Transaction.md#chainid) -- [data](verida_client_ts._internal_.Transaction.md#data) -- [from](verida_client_ts._internal_.Transaction.md#from) -- [gasLimit](verida_client_ts._internal_.Transaction.md#gaslimit) -- [gasPrice](verida_client_ts._internal_.Transaction.md#gasprice) -- [hash](verida_client_ts._internal_.Transaction.md#hash) -- [maxFeePerGas](verida_client_ts._internal_.Transaction.md#maxfeepergas) -- [maxPriorityFeePerGas](verida_client_ts._internal_.Transaction.md#maxpriorityfeepergas) -- [nonce](verida_client_ts._internal_.Transaction.md#nonce) -- [r](verida_client_ts._internal_.Transaction.md#r) -- [s](verida_client_ts._internal_.Transaction.md#s) -- [to](verida_client_ts._internal_.Transaction.md#to) -- [type](verida_client_ts._internal_.Transaction.md#type) -- [v](verida_client_ts._internal_.Transaction.md#v) -- [value](verida_client_ts._internal_.Transaction.md#value) - -## Properties - -### accessList - -• `Optional` **accessList**: [`AccessList`](../modules/verida_client_ts._internal_.md#accesslist) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:40 - -___ - -### chainId - -• **chainId**: `number` - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:35 - -___ - -### data - -• **data**: `string` - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:33 - -___ - -### from - -• `Optional` **from**: `string` - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:29 - -___ - -### gasLimit - -• **gasLimit**: [`BigNumber`](../classes/verida_client_ts._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:31 - -___ - -### gasPrice - -• `Optional` **gasPrice**: [`BigNumber`](../classes/verida_client_ts._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:32 - -___ - -### hash - -• `Optional` **hash**: `string` - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:27 - -___ - -### maxFeePerGas - -• `Optional` **maxFeePerGas**: [`BigNumber`](../classes/verida_client_ts._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:42 - -___ - -### maxPriorityFeePerGas - -• `Optional` **maxPriorityFeePerGas**: [`BigNumber`](../classes/verida_client_ts._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:41 - -___ - -### nonce - -• **nonce**: `number` - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:30 - -___ - -### r - -• `Optional` **r**: `string` - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:36 - -___ - -### s - -• `Optional` **s**: `string` - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:37 - -___ - -### to - -• `Optional` **to**: `string` - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:28 - -___ - -### type - -• `Optional` **type**: ``null`` \| `number` - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:39 - -___ - -### v - -• `Optional` **v**: `number` - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:38 - -___ - -### value - -• **value**: [`BigNumber`](../classes/verida_client_ts._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:34 diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.TransactionReceipt.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.TransactionReceipt.md deleted file mode 100644 index aa5ff43..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.TransactionReceipt.md +++ /dev/null @@ -1,197 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / TransactionReceipt - -# Interface: TransactionReceipt - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).TransactionReceipt - -## Table of contents - -### Properties - -- [blockHash](verida_client_ts._internal_.TransactionReceipt.md#blockhash) -- [blockNumber](verida_client_ts._internal_.TransactionReceipt.md#blocknumber) -- [byzantium](verida_client_ts._internal_.TransactionReceipt.md#byzantium) -- [confirmations](verida_client_ts._internal_.TransactionReceipt.md#confirmations) -- [contractAddress](verida_client_ts._internal_.TransactionReceipt.md#contractaddress) -- [cumulativeGasUsed](verida_client_ts._internal_.TransactionReceipt.md#cumulativegasused) -- [effectiveGasPrice](verida_client_ts._internal_.TransactionReceipt.md#effectivegasprice) -- [from](verida_client_ts._internal_.TransactionReceipt.md#from) -- [gasUsed](verida_client_ts._internal_.TransactionReceipt.md#gasused) -- [logs](verida_client_ts._internal_.TransactionReceipt.md#logs) -- [logsBloom](verida_client_ts._internal_.TransactionReceipt.md#logsbloom) -- [root](verida_client_ts._internal_.TransactionReceipt.md#root) -- [status](verida_client_ts._internal_.TransactionReceipt.md#status) -- [to](verida_client_ts._internal_.TransactionReceipt.md#to) -- [transactionHash](verida_client_ts._internal_.TransactionReceipt.md#transactionhash) -- [transactionIndex](verida_client_ts._internal_.TransactionReceipt.md#transactionindex) -- [type](verida_client_ts._internal_.TransactionReceipt.md#type) - -## Properties - -### blockHash - -• **blockHash**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:73 - -___ - -### blockNumber - -• **blockNumber**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:76 - -___ - -### byzantium - -• **byzantium**: `boolean` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:80 - -___ - -### confirmations - -• **confirmations**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:77 - -___ - -### contractAddress - -• **contractAddress**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:68 - -___ - -### cumulativeGasUsed - -• **cumulativeGasUsed**: [`BigNumber`](../classes/verida_client_ts._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:78 - -___ - -### effectiveGasPrice - -• **effectiveGasPrice**: [`BigNumber`](../classes/verida_client_ts._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:79 - -___ - -### from - -• **from**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:67 - -___ - -### gasUsed - -• **gasUsed**: [`BigNumber`](../classes/verida_client_ts._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:71 - -___ - -### logs - -• **logs**: [`Log`](verida_client_ts._internal_.Log.md)[] - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:75 - -___ - -### logsBloom - -• **logsBloom**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:72 - -___ - -### root - -• `Optional` **root**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:70 - -___ - -### status - -• `Optional` **status**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:82 - -___ - -### to - -• **to**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:66 - -___ - -### transactionHash - -• **transactionHash**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:74 - -___ - -### transactionIndex - -• **transactionIndex**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:69 - -___ - -### type - -• **type**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:81 diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.TransactionResponse.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.TransactionResponse.md deleted file mode 100644 index f2171d1..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.TransactionResponse.md +++ /dev/null @@ -1,335 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / TransactionResponse - -# Interface: TransactionResponse - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).TransactionResponse - -## Hierarchy - -- [`Transaction`](verida_client_ts._internal_.Transaction.md) - - ↳ **`TransactionResponse`** - -## Table of contents - -### Properties - -- [accessList](verida_client_ts._internal_.TransactionResponse.md#accesslist) -- [blockHash](verida_client_ts._internal_.TransactionResponse.md#blockhash) -- [blockNumber](verida_client_ts._internal_.TransactionResponse.md#blocknumber) -- [chainId](verida_client_ts._internal_.TransactionResponse.md#chainid) -- [confirmations](verida_client_ts._internal_.TransactionResponse.md#confirmations) -- [data](verida_client_ts._internal_.TransactionResponse.md#data) -- [from](verida_client_ts._internal_.TransactionResponse.md#from) -- [gasLimit](verida_client_ts._internal_.TransactionResponse.md#gaslimit) -- [gasPrice](verida_client_ts._internal_.TransactionResponse.md#gasprice) -- [hash](verida_client_ts._internal_.TransactionResponse.md#hash) -- [maxFeePerGas](verida_client_ts._internal_.TransactionResponse.md#maxfeepergas) -- [maxPriorityFeePerGas](verida_client_ts._internal_.TransactionResponse.md#maxpriorityfeepergas) -- [nonce](verida_client_ts._internal_.TransactionResponse.md#nonce) -- [r](verida_client_ts._internal_.TransactionResponse.md#r) -- [raw](verida_client_ts._internal_.TransactionResponse.md#raw) -- [s](verida_client_ts._internal_.TransactionResponse.md#s) -- [timestamp](verida_client_ts._internal_.TransactionResponse.md#timestamp) -- [to](verida_client_ts._internal_.TransactionResponse.md#to) -- [type](verida_client_ts._internal_.TransactionResponse.md#type) -- [v](verida_client_ts._internal_.TransactionResponse.md#v) -- [value](verida_client_ts._internal_.TransactionResponse.md#value) - -### Methods - -- [wait](verida_client_ts._internal_.TransactionResponse.md#wait) - -## Properties - -### accessList - -• `Optional` **accessList**: [`AccessList`](../modules/verida_client_ts._internal_.md#accesslist) - -#### Inherited from - -[Transaction](verida_client_ts._internal_.Transaction.md).[accessList](verida_client_ts._internal_.Transaction.md#accesslist) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:40 - -___ - -### blockHash - -• `Optional` **blockHash**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:26 - -___ - -### blockNumber - -• `Optional` **blockNumber**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:25 - -___ - -### chainId - -• **chainId**: `number` - -#### Inherited from - -[Transaction](verida_client_ts._internal_.Transaction.md).[chainId](verida_client_ts._internal_.Transaction.md#chainid) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:35 - -___ - -### confirmations - -• **confirmations**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:28 - -___ - -### data - -• **data**: `string` - -#### Inherited from - -[Transaction](verida_client_ts._internal_.Transaction.md).[data](verida_client_ts._internal_.Transaction.md#data) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:33 - -___ - -### from - -• **from**: `string` - -#### Overrides - -[Transaction](verida_client_ts._internal_.Transaction.md).[from](verida_client_ts._internal_.Transaction.md#from) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:29 - -___ - -### gasLimit - -• **gasLimit**: [`BigNumber`](../classes/verida_client_ts._internal_.BigNumber.md) - -#### Inherited from - -[Transaction](verida_client_ts._internal_.Transaction.md).[gasLimit](verida_client_ts._internal_.Transaction.md#gaslimit) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:31 - -___ - -### gasPrice - -• `Optional` **gasPrice**: [`BigNumber`](../classes/verida_client_ts._internal_.BigNumber.md) - -#### Inherited from - -[Transaction](verida_client_ts._internal_.Transaction.md).[gasPrice](verida_client_ts._internal_.Transaction.md#gasprice) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:32 - -___ - -### hash - -• **hash**: `string` - -#### Overrides - -[Transaction](verida_client_ts._internal_.Transaction.md).[hash](verida_client_ts._internal_.Transaction.md#hash) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:24 - -___ - -### maxFeePerGas - -• `Optional` **maxFeePerGas**: [`BigNumber`](../classes/verida_client_ts._internal_.BigNumber.md) - -#### Inherited from - -[Transaction](verida_client_ts._internal_.Transaction.md).[maxFeePerGas](verida_client_ts._internal_.Transaction.md#maxfeepergas) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:42 - -___ - -### maxPriorityFeePerGas - -• `Optional` **maxPriorityFeePerGas**: [`BigNumber`](../classes/verida_client_ts._internal_.BigNumber.md) - -#### Inherited from - -[Transaction](verida_client_ts._internal_.Transaction.md).[maxPriorityFeePerGas](verida_client_ts._internal_.Transaction.md#maxpriorityfeepergas) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:41 - -___ - -### nonce - -• **nonce**: `number` - -#### Inherited from - -[Transaction](verida_client_ts._internal_.Transaction.md).[nonce](verida_client_ts._internal_.Transaction.md#nonce) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:30 - -___ - -### r - -• `Optional` **r**: `string` - -#### Inherited from - -[Transaction](verida_client_ts._internal_.Transaction.md).[r](verida_client_ts._internal_.Transaction.md#r) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:36 - -___ - -### raw - -• `Optional` **raw**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:30 - -___ - -### s - -• `Optional` **s**: `string` - -#### Inherited from - -[Transaction](verida_client_ts._internal_.Transaction.md).[s](verida_client_ts._internal_.Transaction.md#s) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:37 - -___ - -### timestamp - -• `Optional` **timestamp**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:27 - -___ - -### to - -• `Optional` **to**: `string` - -#### Inherited from - -[Transaction](verida_client_ts._internal_.Transaction.md).[to](verida_client_ts._internal_.Transaction.md#to) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:28 - -___ - -### type - -• `Optional` **type**: ``null`` \| `number` - -#### Inherited from - -[Transaction](verida_client_ts._internal_.Transaction.md).[type](verida_client_ts._internal_.Transaction.md#type) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:39 - -___ - -### v - -• `Optional` **v**: `number` - -#### Inherited from - -[Transaction](verida_client_ts._internal_.Transaction.md).[v](verida_client_ts._internal_.Transaction.md#v) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:38 - -___ - -### value - -• **value**: [`BigNumber`](../classes/verida_client_ts._internal_.BigNumber.md) - -#### Inherited from - -[Transaction](verida_client_ts._internal_.Transaction.md).[value](verida_client_ts._internal_.Transaction.md#value) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:34 - -## Methods - -### wait - -▸ **wait**(`confirmations?`): `Promise`<[`TransactionReceipt`](verida_client_ts._internal_.TransactionReceipt.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `confirmations?` | `number` | - -#### Returns - -`Promise`<[`TransactionReceipt`](verida_client_ts._internal_.TransactionReceipt.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:31 diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.URIComponents.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.URIComponents.md deleted file mode 100644 index e215528..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.URIComponents.md +++ /dev/null @@ -1,109 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / URIComponents - -# Interface: URIComponents - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).URIComponents - -## Table of contents - -### Properties - -- [error](verida_client_ts._internal_.URIComponents.md#error) -- [fragment](verida_client_ts._internal_.URIComponents.md#fragment) -- [host](verida_client_ts._internal_.URIComponents.md#host) -- [path](verida_client_ts._internal_.URIComponents.md#path) -- [port](verida_client_ts._internal_.URIComponents.md#port) -- [query](verida_client_ts._internal_.URIComponents.md#query) -- [reference](verida_client_ts._internal_.URIComponents.md#reference) -- [scheme](verida_client_ts._internal_.URIComponents.md#scheme) -- [userinfo](verida_client_ts._internal_.URIComponents.md#userinfo) - -## Properties - -### error - -• `Optional` **error**: `string` - -#### Defined in - -node_modules/uri-js/dist/es5/uri.all.d.ts:10 - -___ - -### fragment - -• `Optional` **fragment**: `string` - -#### Defined in - -node_modules/uri-js/dist/es5/uri.all.d.ts:8 - -___ - -### host - -• `Optional` **host**: `string` - -#### Defined in - -node_modules/uri-js/dist/es5/uri.all.d.ts:4 - -___ - -### path - -• `Optional` **path**: `string` - -#### Defined in - -node_modules/uri-js/dist/es5/uri.all.d.ts:6 - -___ - -### port - -• `Optional` **port**: `string` \| `number` - -#### Defined in - -node_modules/uri-js/dist/es5/uri.all.d.ts:5 - -___ - -### query - -• `Optional` **query**: `string` - -#### Defined in - -node_modules/uri-js/dist/es5/uri.all.d.ts:7 - -___ - -### reference - -• `Optional` **reference**: `string` - -#### Defined in - -node_modules/uri-js/dist/es5/uri.all.d.ts:9 - -___ - -### scheme - -• `Optional` **scheme**: `string` - -#### Defined in - -node_modules/uri-js/dist/es5/uri.all.d.ts:2 - -___ - -### userinfo - -• `Optional` **userinfo**: `string` - -#### Defined in - -node_modules/uri-js/dist/es5/uri.all.d.ts:3 diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.UriResolver.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.UriResolver.md deleted file mode 100644 index e1dd545..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.UriResolver.md +++ /dev/null @@ -1,74 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / UriResolver - -# Interface: UriResolver - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).UriResolver - -## Table of contents - -### Methods - -- [parse](verida_client_ts._internal_.UriResolver.md#parse) -- [resolve](verida_client_ts._internal_.UriResolver.md#resolve) -- [serialize](verida_client_ts._internal_.UriResolver.md#serialize) - -## Methods - -### parse - -▸ **parse**(`uri`): [`URIComponents`](verida_client_ts._internal_.URIComponents.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `uri` | `string` | - -#### Returns - -[`URIComponents`](verida_client_ts._internal_.URIComponents.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:179 - -___ - -### resolve - -▸ **resolve**(`base`, `path`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `base` | `string` | -| `path` | `string` | - -#### Returns - -`string` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:180 - -___ - -### serialize - -▸ **serialize**(`component`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `component` | [`URIComponents`](verida_client_ts._internal_.URIComponents.md) | - -#### Returns - -`string` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:181 diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.VSOptions.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.VSOptions.md deleted file mode 100644 index c6ae08a..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.VSOptions.md +++ /dev/null @@ -1,102 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / VSOptions - -# Interface: VSOptions - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).VSOptions - -## Hierarchy - -- [`ValueScopeOptions`](verida_client_ts._internal_.ValueScopeOptions.md) - - ↳ **`VSOptions`** - -## Table of contents - -### Properties - -- [\_n](verida_client_ts._internal_.VSOptions.md#_n) -- [es5](verida_client_ts._internal_.VSOptions.md#es5) -- [lines](verida_client_ts._internal_.VSOptions.md#lines) -- [parent](verida_client_ts._internal_.VSOptions.md#parent) -- [prefixes](verida_client_ts._internal_.VSOptions.md#prefixes) -- [scope](verida_client_ts._internal_.VSOptions.md#scope) - -## Properties - -### \_n - -• **\_n**: [`Code`](../modules/verida_client_ts._internal_.md#code) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/scope.d.ts:64 - -___ - -### es5 - -• `Optional` **es5**: `boolean` - -#### Inherited from - -[ValueScopeOptions](verida_client_ts._internal_.ValueScopeOptions.md).[es5](verida_client_ts._internal_.ValueScopeOptions.md#es5) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/scope.d.ts:18 - -___ - -### lines - -• `Optional` **lines**: `boolean` - -#### Inherited from - -[ValueScopeOptions](verida_client_ts._internal_.ValueScopeOptions.md).[lines](verida_client_ts._internal_.ValueScopeOptions.md#lines) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/scope.d.ts:19 - -___ - -### parent - -• `Optional` **parent**: [`Scope`](../classes/verida_client_ts._internal_.Scope.md) - -#### Inherited from - -[ValueScopeOptions](verida_client_ts._internal_.ValueScopeOptions.md).[parent](verida_client_ts._internal_.ValueScopeOptions.md#parent) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/scope.d.ts:14 - -___ - -### prefixes - -• `Optional` **prefixes**: `Set`<`string`\> - -#### Inherited from - -[ValueScopeOptions](verida_client_ts._internal_.ValueScopeOptions.md).[prefixes](verida_client_ts._internal_.ValueScopeOptions.md#prefixes) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/scope.d.ts:13 - -___ - -### scope - -• **scope**: [`ScopeStore`](../modules/verida_client_ts._internal_.md#scopestore) - -#### Inherited from - -[ValueScopeOptions](verida_client_ts._internal_.ValueScopeOptions.md).[scope](verida_client_ts._internal_.ValueScopeOptions.md#scope) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/scope.d.ts:17 diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.ValidateFunction.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.ValidateFunction.md deleted file mode 100644 index 02a5ed9..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.ValidateFunction.md +++ /dev/null @@ -1,98 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / ValidateFunction - -# Interface: ValidateFunction - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).ValidateFunction - -## Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `unknown` | - -## Hierarchy - -- **`ValidateFunction`** - - ↳ [`AsyncValidateFunction`](verida_client_ts._internal_.AsyncValidateFunction.md) - -## Callable - -### ValidateFunction - -▸ **ValidateFunction**(`data`, `dataCxt?`): data is T - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `any` | -| `dataCxt?` | [`DataValidationCxt`](verida_client_ts._internal_.DataValidationCxt.md)<`string` \| `number`\> | - -#### Returns - -data is T - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:47 - -## Table of contents - -### Properties - -- [errors](verida_client_ts._internal_.ValidateFunction.md#errors) -- [evaluated](verida_client_ts._internal_.ValidateFunction.md#evaluated) -- [schema](verida_client_ts._internal_.ValidateFunction.md#schema) -- [schemaEnv](verida_client_ts._internal_.ValidateFunction.md#schemaenv) -- [source](verida_client_ts._internal_.ValidateFunction.md#source) - -## Properties - -### errors - -• `Optional` **errors**: ``null`` \| [`ErrorObject`](verida_client_ts._internal_.ErrorObject.md)<`string`, [`Record`](../modules/verida_client_ts._internal_.md#record)<`string`, `any`\>, `unknown`\>[] - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:48 - -___ - -### evaluated - -• `Optional` **evaluated**: [`Evaluated`](verida_client_ts._internal_.Evaluated.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:49 - -___ - -### schema - -• **schema**: [`AnySchema`](../modules/verida_client_ts._internal_.md#anyschema) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:50 - -___ - -### schemaEnv - -• **schemaEnv**: [`SchemaEnv`](../classes/verida_client_ts._internal_.SchemaEnv.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:51 - -___ - -### source - -• `Optional` **source**: [`SourceCode`](verida_client_ts._internal_.SourceCode.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:52 diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.ValidationRules.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.ValidationRules.md deleted file mode 100644 index 8a74e41..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.ValidationRules.md +++ /dev/null @@ -1,65 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / ValidationRules - -# Interface: ValidationRules - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).ValidationRules - -## Table of contents - -### Properties - -- [all](verida_client_ts._internal_.ValidationRules.md#all) -- [keywords](verida_client_ts._internal_.ValidationRules.md#keywords) -- [post](verida_client_ts._internal_.ValidationRules.md#post) -- [rules](verida_client_ts._internal_.ValidationRules.md#rules) -- [types](verida_client_ts._internal_.ValidationRules.md#types) - -## Properties - -### all - -• **all**: `Object` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/rules.d.ts:11 - -___ - -### keywords - -• **keywords**: `Object` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/rules.d.ts:14 - -___ - -### post - -• **post**: [`RuleGroup`](verida_client_ts._internal_.RuleGroup.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/rules.d.ts:10 - -___ - -### rules - -• **rules**: [`RuleGroup`](verida_client_ts._internal_.RuleGroup.md)[] - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/rules.d.ts:9 - -___ - -### types - -• **types**: [`ValidationTypes`](../modules/verida_client_ts._internal_.md#validationtypes) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/rules.d.ts:17 diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.ValueScopeOptions.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.ValueScopeOptions.md deleted file mode 100644 index 70f1541..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.ValueScopeOptions.md +++ /dev/null @@ -1,81 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / ValueScopeOptions - -# Interface: ValueScopeOptions - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).ValueScopeOptions - -## Hierarchy - -- [`ScopeOptions`](verida_client_ts._internal_.ScopeOptions.md) - - ↳ **`ValueScopeOptions`** - - ↳↳ [`VSOptions`](verida_client_ts._internal_.VSOptions.md) - -## Table of contents - -### Properties - -- [es5](verida_client_ts._internal_.ValueScopeOptions.md#es5) -- [lines](verida_client_ts._internal_.ValueScopeOptions.md#lines) -- [parent](verida_client_ts._internal_.ValueScopeOptions.md#parent) -- [prefixes](verida_client_ts._internal_.ValueScopeOptions.md#prefixes) -- [scope](verida_client_ts._internal_.ValueScopeOptions.md#scope) - -## Properties - -### es5 - -• `Optional` **es5**: `boolean` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/scope.d.ts:18 - -___ - -### lines - -• `Optional` **lines**: `boolean` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/scope.d.ts:19 - -___ - -### parent - -• `Optional` **parent**: [`Scope`](../classes/verida_client_ts._internal_.Scope.md) - -#### Inherited from - -[ScopeOptions](verida_client_ts._internal_.ScopeOptions.md).[parent](verida_client_ts._internal_.ScopeOptions.md#parent) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/scope.d.ts:14 - -___ - -### prefixes - -• `Optional` **prefixes**: `Set`<`string`\> - -#### Inherited from - -[ScopeOptions](verida_client_ts._internal_.ScopeOptions.md).[prefixes](verida_client_ts._internal_.ScopeOptions.md#prefixes) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/scope.d.ts:13 - -___ - -### scope - -• **scope**: [`ScopeStore`](../modules/verida_client_ts._internal_.md#scopestore) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/scope.d.ts:17 diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.VdaClientConfig.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.VdaClientConfig.md deleted file mode 100644 index 2fb86f2..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.VdaClientConfig.md +++ /dev/null @@ -1,77 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / VdaClientConfig - -# Interface: VdaClientConfig - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).VdaClientConfig - -Interface for vda-xxx-client instance creation. - -**`param`** DID - -**`param`** private key of DID. Used to generate signature in transactions to chains - -**`param`** Target chain name or chain id. - -**`param`** : VDA-DID run mode. Values from vda-did-resolver - -**`param`** Web3 configuration depending on call type. Values from vda-did-resolver - -## Table of contents - -### Properties - -- [callType](verida_client_ts._internal_.VdaClientConfig.md#calltype) -- [did](verida_client_ts._internal_.VdaClientConfig.md#did) -- [network](verida_client_ts._internal_.VdaClientConfig.md#network) -- [signKey](verida_client_ts._internal_.VdaClientConfig.md#signkey) -- [web3Options](verida_client_ts._internal_.VdaClientConfig.md#web3options) - -## Properties - -### callType - -• `Optional` **callType**: [`Web3CallType`](../modules/verida_client_ts._internal_.md#web3calltype) - -#### Defined in - -packages/types/dist/VdaClientConfig.d.ts:15 - -___ - -### did - -• `Optional` **did**: `string` - -#### Defined in - -packages/types/dist/VdaClientConfig.d.ts:13 - -___ - -### network - -• **network**: [`EnvironmentType`](../enums/verida_client_ts._internal_.EnvironmentType.md) - -#### Defined in - -packages/types/dist/VdaClientConfig.d.ts:12 - -___ - -### signKey - -• `Optional` **signKey**: `string` - -#### Defined in - -packages/types/dist/VdaClientConfig.d.ts:14 - -___ - -### web3Options - -• `Optional` **web3Options**: [`Web3MetaTransactionConfig`](verida_client_ts._internal_.Web3MetaTransactionConfig.md) \| [`Web3SelfTransactionConfig`](verida_client_ts._internal_.Web3SelfTransactionConfig.md) - -#### Defined in - -packages/types/dist/VdaClientConfig.d.ts:16 diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.VdaDidEndpointResponse.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.VdaDidEndpointResponse.md deleted file mode 100644 index c1ec700..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.VdaDidEndpointResponse.md +++ /dev/null @@ -1,32 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / VdaDidEndpointResponse - -# Interface: VdaDidEndpointResponse - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).VdaDidEndpointResponse - -## Table of contents - -### Properties - -- [message](verida_client_ts._internal_.VdaDidEndpointResponse.md#message) -- [status](verida_client_ts._internal_.VdaDidEndpointResponse.md#status) - -## Properties - -### message - -• `Optional` **message**: `string` - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:111 - -___ - -### status - -• **status**: ``"success"`` \| ``"fail"`` - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:110 diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.VeridaDocInterface.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.VeridaDocInterface.md deleted file mode 100644 index 8bfc1b3..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.VeridaDocInterface.md +++ /dev/null @@ -1,233 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / VeridaDocInterface - -# Interface: VeridaDocInterface - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).VeridaDocInterface - -## Hierarchy - -- [`DIDDocument`](../modules/verida_client_ts._internal_.md#diddocument) - - ↳ **`VeridaDocInterface`** - -## Table of contents - -### Properties - -- [@context](verida_client_ts._internal_.VeridaDocInterface.md#@context) -- [alsoKnownAs](verida_client_ts._internal_.VeridaDocInterface.md#alsoknownas) -- [assertionMethod](verida_client_ts._internal_.VeridaDocInterface.md#assertionmethod) -- [authentication](verida_client_ts._internal_.VeridaDocInterface.md#authentication) -- [capabilityDelegation](verida_client_ts._internal_.VeridaDocInterface.md#capabilitydelegation) -- [capabilityInvocation](verida_client_ts._internal_.VeridaDocInterface.md#capabilityinvocation) -- [controller](verida_client_ts._internal_.VeridaDocInterface.md#controller) -- [created](verida_client_ts._internal_.VeridaDocInterface.md#created) -- [deactivated](verida_client_ts._internal_.VeridaDocInterface.md#deactivated) -- [id](verida_client_ts._internal_.VeridaDocInterface.md#id) -- [keyAgreement](verida_client_ts._internal_.VeridaDocInterface.md#keyagreement) -- [proof](verida_client_ts._internal_.VeridaDocInterface.md#proof) -- [publicKey](verida_client_ts._internal_.VeridaDocInterface.md#publickey) -- [service](verida_client_ts._internal_.VeridaDocInterface.md#service) -- [updated](verida_client_ts._internal_.VeridaDocInterface.md#updated) -- [verificationMethod](verida_client_ts._internal_.VeridaDocInterface.md#verificationmethod) -- [versionId](verida_client_ts._internal_.VeridaDocInterface.md#versionid) - -## Properties - -### @context - -• `Optional` **@context**: `string` \| `string`[] - -#### Inherited from - -DocInterface.@context - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:61 - -___ - -### alsoKnownAs - -• `Optional` **alsoKnownAs**: `string`[] - -#### Inherited from - -DocInterface.alsoKnownAs - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:63 - -___ - -### assertionMethod - -• **assertionMethod**: `undefined` \| (`string` \| [`VerificationMethod`](verida_client_ts._internal_.VerificationMethod.md))[] - -#### Inherited from - -DocInterface.assertionMethod - -___ - -### authentication - -• **authentication**: `undefined` \| (`string` \| [`VerificationMethod`](verida_client_ts._internal_.VerificationMethod.md))[] - -#### Inherited from - -DocInterface.authentication - -___ - -### capabilityDelegation - -• **capabilityDelegation**: `undefined` \| (`string` \| [`VerificationMethod`](verida_client_ts._internal_.VerificationMethod.md))[] - -#### Inherited from - -DocInterface.capabilityDelegation - -___ - -### capabilityInvocation - -• **capabilityInvocation**: `undefined` \| (`string` \| [`VerificationMethod`](verida_client_ts._internal_.VerificationMethod.md))[] - -#### Inherited from - -DocInterface.capabilityInvocation - -___ - -### controller - -• `Optional` **controller**: `string` \| `string`[] - -#### Inherited from - -DocInterface.controller - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:64 - -___ - -### created - -• `Optional` **created**: `string` - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:39 - -___ - -### deactivated - -• `Optional` **deactivated**: `string` - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:41 - -___ - -### id - -• **id**: `string` - -#### Inherited from - -DocInterface.id - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:62 - -___ - -### keyAgreement - -• **keyAgreement**: `undefined` \| (`string` \| [`VerificationMethod`](verida_client_ts._internal_.VerificationMethod.md))[] - -#### Inherited from - -DocInterface.keyAgreement - -___ - -### proof - -• `Optional` **proof**: [`ProofInterface`](verida_client_ts._internal_.ProofInterface.md) - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:42 - -___ - -### publicKey - -• `Optional` **publicKey**: [`VerificationMethod`](verida_client_ts._internal_.VerificationMethod.md)[] - -**`deprecated`** - -#### Inherited from - -DocInterface.publicKey - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:70 - -___ - -### service - -• `Optional` **service**: [`Service`](verida_client_ts._internal_.Service.md)[] - -#### Inherited from - -DocInterface.service - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:66 - -___ - -### updated - -• `Optional` **updated**: `string` - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:40 - -___ - -### verificationMethod - -• `Optional` **verificationMethod**: [`VerificationMethod`](verida_client_ts._internal_.VerificationMethod.md)[] - -#### Inherited from - -DocInterface.verificationMethod - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:65 - -___ - -### versionId - -• **versionId**: `number` - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:38 diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.VerificationMethod.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.VerificationMethod.md deleted file mode 100644 index 8ba20ac..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.VerificationMethod.md +++ /dev/null @@ -1,129 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / VerificationMethod - -# Interface: VerificationMethod - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).VerificationMethod - -Represents the properties of a Verification Method listed in a DID document. - -This data type includes public key representations that are no longer present in the spec but are still used by -several DID methods / resolvers and kept for backward compatibility. - -**`see`** [https://www.w3.org/TR/did-core/#verification-methods](https://www.w3.org/TR/did-core/#verification-methods) - -**`see`** [https://www.w3.org/TR/did-core/#verification-method-properties](https://www.w3.org/TR/did-core/#verification-method-properties) - -## Table of contents - -### Properties - -- [blockchainAccountId](verida_client_ts._internal_.VerificationMethod.md#blockchainaccountid) -- [controller](verida_client_ts._internal_.VerificationMethod.md#controller) -- [ethereumAddress](verida_client_ts._internal_.VerificationMethod.md#ethereumaddress) -- [id](verida_client_ts._internal_.VerificationMethod.md#id) -- [publicKeyBase58](verida_client_ts._internal_.VerificationMethod.md#publickeybase58) -- [publicKeyBase64](verida_client_ts._internal_.VerificationMethod.md#publickeybase64) -- [publicKeyHex](verida_client_ts._internal_.VerificationMethod.md#publickeyhex) -- [publicKeyJwk](verida_client_ts._internal_.VerificationMethod.md#publickeyjwk) -- [publicKeyMultibase](verida_client_ts._internal_.VerificationMethod.md#publickeymultibase) -- [type](verida_client_ts._internal_.VerificationMethod.md#type) - -## Properties - -### blockchainAccountId - -• `Optional` **blockchainAccountId**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:133 - -___ - -### controller - -• **controller**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:127 - -___ - -### ethereumAddress - -• `Optional` **ethereumAddress**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:134 - -___ - -### id - -• **id**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:125 - -___ - -### publicKeyBase58 - -• `Optional` **publicKeyBase58**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:128 - -___ - -### publicKeyBase64 - -• `Optional` **publicKeyBase64**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:129 - -___ - -### publicKeyHex - -• `Optional` **publicKeyHex**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:131 - -___ - -### publicKeyJwk - -• `Optional` **publicKeyJwk**: [`JsonWebKey`](verida_client_ts._internal_.JsonWebKey.md) - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:130 - -___ - -### publicKeyMultibase - -• `Optional` **publicKeyMultibase**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:132 - -___ - -### type - -• **type**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:126 diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.Web3GasConfiguration.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.Web3GasConfiguration.md deleted file mode 100644 index 244c005..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.Web3GasConfiguration.md +++ /dev/null @@ -1,91 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / Web3GasConfiguration - -# Interface: Web3GasConfiguration - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).Web3GasConfiguration - -Gas configuration - -eip1559Mode - optional - Once this parameter is set, all other parameters are not used. Gas information is pulled from network. - -maxFeePerGas - optional - Used for EIP1559 chains -maxPriorityFeePerGas - optional - Used for EIP1559 chains -gasLimit - optional - Used for non EIP1559 chains -gasPrice - optional - Used for non EIP1559 chains - -## Hierarchy - -- **`Web3GasConfiguration`** - - ↳ [`Web3SelfTransactionConfig`](verida_client_ts._internal_.Web3SelfTransactionConfig.md) - -## Table of contents - -### Properties - -- [eip1559Mode](verida_client_ts._internal_.Web3GasConfiguration.md#eip1559mode) -- [eip1559gasStationUrl](verida_client_ts._internal_.Web3GasConfiguration.md#eip1559gasstationurl) -- [gasLimit](verida_client_ts._internal_.Web3GasConfiguration.md#gaslimit) -- [gasPrice](verida_client_ts._internal_.Web3GasConfiguration.md#gasprice) -- [maxFeePerGas](verida_client_ts._internal_.Web3GasConfiguration.md#maxfeepergas) -- [maxPriorityFeePerGas](verida_client_ts._internal_.Web3GasConfiguration.md#maxpriorityfeepergas) - -## Properties - -### eip1559Mode - -• `Optional` **eip1559Mode**: [`EIP1559GasMode`](../modules/verida_client_ts._internal_.md#eip1559gasmode) - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:24 - -___ - -### eip1559gasStationUrl - -• `Optional` **eip1559gasStationUrl**: `string` - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:25 - -___ - -### gasLimit - -• `Optional` **gasLimit**: [`BigNumber`](../classes/verida_client_ts._internal_.BigNumber.md) - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:28 - -___ - -### gasPrice - -• `Optional` **gasPrice**: [`BigNumber`](../classes/verida_client_ts._internal_.BigNumber.md) - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:29 - -___ - -### maxFeePerGas - -• `Optional` **maxFeePerGas**: [`BigNumber`](../classes/verida_client_ts._internal_.BigNumber.md) - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:26 - -___ - -### maxPriorityFeePerGas - -• `Optional` **maxPriorityFeePerGas**: [`BigNumber`](../classes/verida_client_ts._internal_.BigNumber.md) - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:27 diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.Web3GaslessPostConfig.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.Web3GaslessPostConfig.md deleted file mode 100644 index c07102c..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.Web3GaslessPostConfig.md +++ /dev/null @@ -1,37 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / Web3GaslessPostConfig - -# Interface: Web3GaslessPostConfig - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).Web3GaslessPostConfig - -Configuration type for gasless post - -## Indexable - -▪ [key: `string`]: `any` - -## Table of contents - -### Properties - -- [headers](verida_client_ts._internal_.Web3GaslessPostConfig.md#headers) - -## Properties - -### headers - -• **headers**: `Object` - -#### Index signature - -▪ [key: `string`]: `any` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `user-agent` | `string` | - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:64 diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.Web3GaslessRequestConfig.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.Web3GaslessRequestConfig.md deleted file mode 100644 index b618386..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.Web3GaslessRequestConfig.md +++ /dev/null @@ -1,37 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / Web3GaslessRequestConfig - -# Interface: Web3GaslessRequestConfig - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).Web3GaslessRequestConfig - -Configuration type for gasless request - -## Indexable - -▪ [key: `string`]: `any` - -## Table of contents - -### Properties - -- [headers](verida_client_ts._internal_.Web3GaslessRequestConfig.md#headers) - -## Properties - -### headers - -• **headers**: `Object` - -#### Index signature - -▪ [key: `string`]: `any` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `context-name` | `string` | - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:56 diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.Web3MetaTransactionConfig.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.Web3MetaTransactionConfig.md deleted file mode 100644 index 7ec5fd9..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.Web3MetaTransactionConfig.md +++ /dev/null @@ -1,45 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / Web3MetaTransactionConfig - -# Interface: Web3MetaTransactionConfig - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).Web3MetaTransactionConfig - -Configuration type for gasless mode - -## Table of contents - -### Properties - -- [endpointUrl](verida_client_ts._internal_.Web3MetaTransactionConfig.md#endpointurl) -- [postConfig](verida_client_ts._internal_.Web3MetaTransactionConfig.md#postconfig) -- [serverConfig](verida_client_ts._internal_.Web3MetaTransactionConfig.md#serverconfig) - -## Properties - -### endpointUrl - -• **endpointUrl**: `string` - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:51 - -___ - -### postConfig - -• **postConfig**: [`Web3GaslessPostConfig`](verida_client_ts._internal_.Web3GaslessPostConfig.md) - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:50 - -___ - -### serverConfig - -• **serverConfig**: [`Web3GaslessRequestConfig`](verida_client_ts._internal_.Web3GaslessRequestConfig.md) - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:49 diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.Web3SelfTransactionConfig.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.Web3SelfTransactionConfig.md deleted file mode 100644 index 3a6914b..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.Web3SelfTransactionConfig.md +++ /dev/null @@ -1,179 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / Web3SelfTransactionConfig - -# Interface: Web3SelfTransactionConfig - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).Web3SelfTransactionConfig - -Configuration type for Web3 mode - -signer - optional - a Signer that sign the blockchain transactions. If a 'signer' is not provided, then 'contract' with an attached signer need to be used to make transactions -provider - optional - a web3 provider. At least one of `signer`,`provider`, or `rpcUrl` is required -rpcUrl - optinal - a JSON-RPC URL that can be used to connect to an ethereum network. At least one of `signer`, `provider`, or `rpcUrl` is required -web3 - optional - Can use provider or web.currentProvider as a provider. - -## Hierarchy - -- [`Web3GasConfiguration`](verida_client_ts._internal_.Web3GasConfiguration.md) - - ↳ **`Web3SelfTransactionConfig`** - -## Table of contents - -### Properties - -- [eip1559Mode](verida_client_ts._internal_.Web3SelfTransactionConfig.md#eip1559mode) -- [eip1559gasStationUrl](verida_client_ts._internal_.Web3SelfTransactionConfig.md#eip1559gasstationurl) -- [gasLimit](verida_client_ts._internal_.Web3SelfTransactionConfig.md#gaslimit) -- [gasPrice](verida_client_ts._internal_.Web3SelfTransactionConfig.md#gasprice) -- [maxFeePerGas](verida_client_ts._internal_.Web3SelfTransactionConfig.md#maxfeepergas) -- [maxPriorityFeePerGas](verida_client_ts._internal_.Web3SelfTransactionConfig.md#maxpriorityfeepergas) -- [methodDefaults](verida_client_ts._internal_.Web3SelfTransactionConfig.md#methoddefaults) -- [privateKey](verida_client_ts._internal_.Web3SelfTransactionConfig.md#privatekey) -- [provider](verida_client_ts._internal_.Web3SelfTransactionConfig.md#provider) -- [rpcUrl](verida_client_ts._internal_.Web3SelfTransactionConfig.md#rpcurl) -- [signer](verida_client_ts._internal_.Web3SelfTransactionConfig.md#signer) -- [web3](verida_client_ts._internal_.Web3SelfTransactionConfig.md#web3) - -## Properties - -### eip1559Mode - -• `Optional` **eip1559Mode**: [`EIP1559GasMode`](../modules/verida_client_ts._internal_.md#eip1559gasmode) - -#### Inherited from - -[Web3GasConfiguration](verida_client_ts._internal_.Web3GasConfiguration.md).[eip1559Mode](verida_client_ts._internal_.Web3GasConfiguration.md#eip1559mode) - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:24 - -___ - -### eip1559gasStationUrl - -• `Optional` **eip1559gasStationUrl**: `string` - -#### Inherited from - -[Web3GasConfiguration](verida_client_ts._internal_.Web3GasConfiguration.md).[eip1559gasStationUrl](verida_client_ts._internal_.Web3GasConfiguration.md#eip1559gasstationurl) - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:25 - -___ - -### gasLimit - -• `Optional` **gasLimit**: [`BigNumber`](../classes/verida_client_ts._internal_.BigNumber.md) - -#### Inherited from - -[Web3GasConfiguration](verida_client_ts._internal_.Web3GasConfiguration.md).[gasLimit](verida_client_ts._internal_.Web3GasConfiguration.md#gaslimit) - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:28 - -___ - -### gasPrice - -• `Optional` **gasPrice**: [`BigNumber`](../classes/verida_client_ts._internal_.BigNumber.md) - -#### Inherited from - -[Web3GasConfiguration](verida_client_ts._internal_.Web3GasConfiguration.md).[gasPrice](verida_client_ts._internal_.Web3GasConfiguration.md#gasprice) - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:29 - -___ - -### maxFeePerGas - -• `Optional` **maxFeePerGas**: [`BigNumber`](../classes/verida_client_ts._internal_.BigNumber.md) - -#### Inherited from - -[Web3GasConfiguration](verida_client_ts._internal_.Web3GasConfiguration.md).[maxFeePerGas](verida_client_ts._internal_.Web3GasConfiguration.md#maxfeepergas) - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:26 - -___ - -### maxPriorityFeePerGas - -• `Optional` **maxPriorityFeePerGas**: [`BigNumber`](../classes/verida_client_ts._internal_.BigNumber.md) - -#### Inherited from - -[Web3GasConfiguration](verida_client_ts._internal_.Web3GasConfiguration.md).[maxPriorityFeePerGas](verida_client_ts._internal_.Web3GasConfiguration.md#maxpriorityfeepergas) - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:27 - -___ - -### methodDefaults - -• `Optional` **methodDefaults**: [`Record`](../modules/verida_client_ts._internal_.md#record)<`string`, [`Web3GasConfiguration`](verida_client_ts._internal_.Web3GasConfiguration.md)\> - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:45 - -___ - -### privateKey - -• `Optional` **privateKey**: `string` - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:41 - -___ - -### provider - -• `Optional` **provider**: [`Provider`](../classes/verida_client_ts._internal_.Provider.md) - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:42 - -___ - -### rpcUrl - -• `Optional` **rpcUrl**: `string` - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:43 - -___ - -### signer - -• `Optional` **signer**: [`Signer`](../classes/verida_client_ts._internal_.Signer.md) - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:40 - -___ - -### web3 - -• `Optional` **web3**: `any` - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:44 diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.Web3SelfTransactionConfigPart.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.Web3SelfTransactionConfigPart.md deleted file mode 100644 index c75ef87..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.Web3SelfTransactionConfigPart.md +++ /dev/null @@ -1,32 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / Web3SelfTransactionConfigPart - -# Interface: Web3SelfTransactionConfigPart - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).Web3SelfTransactionConfigPart - -## Table of contents - -### Properties - -- [privateKey](verida_client_ts._internal_.Web3SelfTransactionConfigPart.md#privatekey) -- [signer](verida_client_ts._internal_.Web3SelfTransactionConfigPart.md#signer) - -## Properties - -### privateKey - -• `Optional` **privateKey**: `string` - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:116 - -___ - -### signer - -• `Optional` **signer**: [`Signer`](../classes/verida_client_ts._internal_.Signer.md) - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:115 diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_._Block.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_._Block.md deleted file mode 100644 index 1101dea..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_._Block.md +++ /dev/null @@ -1,150 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / \_Block - -# Interface: \_Block - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md)._Block - -## Hierarchy - -- **`_Block`** - - ↳ [`Block`](verida_client_ts._internal_.Block.md) - - ↳ [`BlockWithTransactions`](verida_client_ts._internal_.BlockWithTransactions.md) - -## Table of contents - -### Properties - -- [\_difficulty](verida_client_ts._internal_._Block.md#_difficulty) -- [baseFeePerGas](verida_client_ts._internal_._Block.md#basefeepergas) -- [difficulty](verida_client_ts._internal_._Block.md#difficulty) -- [extraData](verida_client_ts._internal_._Block.md#extradata) -- [gasLimit](verida_client_ts._internal_._Block.md#gaslimit) -- [gasUsed](verida_client_ts._internal_._Block.md#gasused) -- [hash](verida_client_ts._internal_._Block.md#hash) -- [miner](verida_client_ts._internal_._Block.md#miner) -- [nonce](verida_client_ts._internal_._Block.md#nonce) -- [number](verida_client_ts._internal_._Block.md#number) -- [parentHash](verida_client_ts._internal_._Block.md#parenthash) -- [timestamp](verida_client_ts._internal_._Block.md#timestamp) - -## Properties - -### \_difficulty - -• **\_difficulty**: [`BigNumber`](../classes/verida_client_ts._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:41 - -___ - -### baseFeePerGas - -• `Optional` **baseFeePerGas**: ``null`` \| [`BigNumber`](../classes/verida_client_ts._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:46 - -___ - -### difficulty - -• **difficulty**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:40 - -___ - -### extraData - -• **extraData**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:45 - -___ - -### gasLimit - -• **gasLimit**: [`BigNumber`](../classes/verida_client_ts._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:42 - -___ - -### gasUsed - -• **gasUsed**: [`BigNumber`](../classes/verida_client_ts._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:43 - -___ - -### hash - -• **hash**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:35 - -___ - -### miner - -• **miner**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:44 - -___ - -### nonce - -• **nonce**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:39 - -___ - -### number - -• **number**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:37 - -___ - -### parentHash - -• **parentHash**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:36 - -___ - -### timestamp - -• **timestamp**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:38 diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_._KeywordDef.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_._KeywordDef.md deleted file mode 100644 index 74f202d..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_._KeywordDef.md +++ /dev/null @@ -1,161 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / \_KeywordDef - -# Interface: \_KeywordDef - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md)._KeywordDef - -## Hierarchy - -- **`_KeywordDef`** - - ↳ [`CodeKeywordDefinition`](verida_client_ts._internal_.CodeKeywordDefinition.md) - - ↳ [`FuncKeywordDefinition`](verida_client_ts._internal_.FuncKeywordDefinition.md) - -## Table of contents - -### Properties - -- [$data](verida_client_ts._internal_._KeywordDef.md#$data) -- [$dataError](verida_client_ts._internal_._KeywordDef.md#$dataerror) -- [allowUndefined](verida_client_ts._internal_._KeywordDef.md#allowundefined) -- [before](verida_client_ts._internal_._KeywordDef.md#before) -- [dependencies](verida_client_ts._internal_._KeywordDef.md#dependencies) -- [error](verida_client_ts._internal_._KeywordDef.md#error) -- [implements](verida_client_ts._internal_._KeywordDef.md#implements) -- [keyword](verida_client_ts._internal_._KeywordDef.md#keyword) -- [metaSchema](verida_client_ts._internal_._KeywordDef.md#metaschema) -- [post](verida_client_ts._internal_._KeywordDef.md#post) -- [schemaType](verida_client_ts._internal_._KeywordDef.md#schematype) -- [type](verida_client_ts._internal_._KeywordDef.md#type) -- [validateSchema](verida_client_ts._internal_._KeywordDef.md#validateschema) - -## Properties - -### $data - -• `Optional` **$data**: `boolean` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:91 - -___ - -### $dataError - -• `Optional` **$dataError**: [`KeywordErrorDefinition`](verida_client_ts._internal_.KeywordErrorDefinition.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:99 - -___ - -### allowUndefined - -• `Optional` **allowUndefined**: `boolean` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:90 - -___ - -### before - -• `Optional` **before**: `string` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:93 - -___ - -### dependencies - -• `Optional` **dependencies**: `string`[] - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:97 - -___ - -### error - -• `Optional` **error**: [`KeywordErrorDefinition`](verida_client_ts._internal_.KeywordErrorDefinition.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:98 - -___ - -### implements - -• `Optional` **implements**: `string`[] - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:92 - -___ - -### keyword - -• **keyword**: `string` \| `string`[] - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:87 - -___ - -### metaSchema - -• `Optional` **metaSchema**: [`AnySchemaObject`](../modules/verida_client_ts._internal_.md#anyschemaobject) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:95 - -___ - -### post - -• `Optional` **post**: `boolean` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:94 - -___ - -### schemaType - -• `Optional` **schemaType**: ``"string"`` \| ``"number"`` \| ``"boolean"`` \| ``"object"`` \| ``"integer"`` \| ``"array"`` \| ``"null"`` \| (``"string"`` \| ``"number"`` \| ``"boolean"`` \| ``"object"`` \| ``"integer"`` \| ``"array"`` \| ``"null"``)[] - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:89 - -___ - -### type - -• `Optional` **type**: ``"string"`` \| ``"number"`` \| ``"boolean"`` \| ``"object"`` \| ``"integer"`` \| ``"array"`` \| ``"null"`` \| (``"string"`` \| ``"number"`` \| ``"boolean"`` \| ``"object"`` \| ``"integer"`` \| ``"array"`` \| ``"null"``)[] - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:88 - -___ - -### validateSchema - -• `Optional` **validateSchema**: [`AnyValidateFunction`](../modules/verida_client_ts._internal_.md#anyvalidatefunction)<`any`\> - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:96 diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_._SchemaObject.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_._SchemaObject.md deleted file mode 100644 index efae8ec..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_._SchemaObject.md +++ /dev/null @@ -1,55 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / \_SchemaObject - -# Interface: \_SchemaObject - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md)._SchemaObject - -## Hierarchy - -- **`_SchemaObject`** - - ↳ [`AsyncSchema`](verida_client_ts._internal_.AsyncSchema.md) - - ↳ [`SchemaObject`](verida_client_ts._internal_.SchemaObject.md) - -## Indexable - -▪ [x: `string`]: `any` - -## Table of contents - -### Properties - -- [$id](verida_client_ts._internal_._SchemaObject.md#$id) -- [$schema](verida_client_ts._internal_._SchemaObject.md#$schema) -- [id](verida_client_ts._internal_._SchemaObject.md#id) - -## Properties - -### $id - -• `Optional` **$id**: `string` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:9 - -___ - -### $schema - -• `Optional` **$schema**: `string` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:10 - -___ - -### id - -• `Optional` **id**: `string` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:8 diff --git a/docs/api/verida-js/interfaces/verida_client_ts._internal_.default-7.md b/docs/api/verida-js/interfaces/verida_client_ts._internal_.default-7.md deleted file mode 100644 index 94ce2cc..0000000 --- a/docs/api/verida-js/interfaces/verida_client_ts._internal_.default-7.md +++ /dev/null @@ -1,71 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](../modules/verida_client_ts.md) / [](../modules/verida_client_ts._internal_.md) / default - -# Interface: default - -[@verida/client-ts](../modules/verida_client_ts.md).[](../modules/verida_client_ts._internal_.md).default - -Interface for notifications - -## Table of contents - -### Methods - -- [getErrors](verida_client_ts._internal_.default-7.md#geterrors) -- [init](verida_client_ts._internal_.default-7.md#init) -- [ping](verida_client_ts._internal_.default-7.md#ping) - -## Methods - -### getErrors - -▸ **getErrors**(): `string`[] - -#### Returns - -`string`[] - -#### Defined in - -[packages/client-ts/src/context/notification.ts:21](https://github.com/verida/verida-js/blob/c03b336/packages/client-ts/src/context/notification.ts#L21) - -___ - -### init - -▸ **init**(): `Promise`<`void`\> - -Initialize notifications for the connected user - -(ie; connect to a notification server) - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -[packages/client-ts/src/context/notification.ts:13](https://github.com/verida/verida-js/blob/c03b336/packages/client-ts/src/context/notification.ts#L13) - -___ - -### ping - -▸ **ping**(`recipientContextName`, `didToNotify`): `Promise`<`boolean`\> - -Ping a notification server to fetch new messages -TODO: Change this - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `recipientContextName` | `string` | -| `didToNotify` | `any` | - -#### Returns - -`Promise`<`boolean`\> - -#### Defined in - -[packages/client-ts/src/context/notification.ts:19](https://github.com/verida/verida-js/blob/c03b336/packages/client-ts/src/context/notification.ts#L19) diff --git a/docs/api/verida-js/interfaces/verida_did_client._internal_.ArrayLike.md b/docs/api/verida-js/interfaces/verida_did_client._internal_.ArrayLike.md deleted file mode 100644 index 84ce9c3..0000000 --- a/docs/api/verida-js/interfaces/verida_did_client._internal_.ArrayLike.md +++ /dev/null @@ -1,31 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/did-client](../modules/verida_did_client.md) / [](../modules/verida_did_client._internal_.md) / ArrayLike - -# Interface: ArrayLike - -[@verida/did-client](../modules/verida_did_client.md).[](../modules/verida_did_client._internal_.md).ArrayLike - -## Type parameters - -| Name | -| :------ | -| `T` | - -## Indexable - -▪ [n: `number`]: `T` - -## Table of contents - -### Properties - -- [length](verida_did_client._internal_.ArrayLike.md#length) - -## Properties - -### length - -• `Readonly` **length**: `number` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1464 diff --git a/docs/api/verida-js/interfaces/verida_did_client._internal_.Block.md b/docs/api/verida-js/interfaces/verida_did_client._internal_.Block.md deleted file mode 100644 index 2d63622..0000000 --- a/docs/api/verida-js/interfaces/verida_did_client._internal_.Block.md +++ /dev/null @@ -1,207 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/did-client](../modules/verida_did_client.md) / [](../modules/verida_did_client._internal_.md) / Block - -# Interface: Block - -[@verida/did-client](../modules/verida_did_client.md).[](../modules/verida_did_client._internal_.md).Block - -## Hierarchy - -- [`_Block`](verida_did_client._internal_._Block.md) - - ↳ **`Block`** - -## Table of contents - -### Properties - -- [\_difficulty](verida_did_client._internal_.Block.md#_difficulty) -- [baseFeePerGas](verida_did_client._internal_.Block.md#basefeepergas) -- [difficulty](verida_did_client._internal_.Block.md#difficulty) -- [extraData](verida_did_client._internal_.Block.md#extradata) -- [gasLimit](verida_did_client._internal_.Block.md#gaslimit) -- [gasUsed](verida_did_client._internal_.Block.md#gasused) -- [hash](verida_did_client._internal_.Block.md#hash) -- [miner](verida_did_client._internal_.Block.md#miner) -- [nonce](verida_did_client._internal_.Block.md#nonce) -- [number](verida_did_client._internal_.Block.md#number) -- [parentHash](verida_did_client._internal_.Block.md#parenthash) -- [timestamp](verida_did_client._internal_.Block.md#timestamp) -- [transactions](verida_did_client._internal_.Block.md#transactions) - -## Properties - -### \_difficulty - -• **\_difficulty**: [`BigNumber`](../classes/verida_did_client._internal_.BigNumber.md) - -#### Inherited from - -[_Block](verida_did_client._internal_._Block.md).[_difficulty](verida_did_client._internal_._Block.md#_difficulty) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:41 - -___ - -### baseFeePerGas - -• `Optional` **baseFeePerGas**: ``null`` \| [`BigNumber`](../classes/verida_did_client._internal_.BigNumber.md) - -#### Inherited from - -[_Block](verida_did_client._internal_._Block.md).[baseFeePerGas](verida_did_client._internal_._Block.md#basefeepergas) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:46 - -___ - -### difficulty - -• **difficulty**: `number` - -#### Inherited from - -[_Block](verida_did_client._internal_._Block.md).[difficulty](verida_did_client._internal_._Block.md#difficulty) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:40 - -___ - -### extraData - -• **extraData**: `string` - -#### Inherited from - -[_Block](verida_did_client._internal_._Block.md).[extraData](verida_did_client._internal_._Block.md#extradata) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:45 - -___ - -### gasLimit - -• **gasLimit**: [`BigNumber`](../classes/verida_did_client._internal_.BigNumber.md) - -#### Inherited from - -[_Block](verida_did_client._internal_._Block.md).[gasLimit](verida_did_client._internal_._Block.md#gaslimit) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:42 - -___ - -### gasUsed - -• **gasUsed**: [`BigNumber`](../classes/verida_did_client._internal_.BigNumber.md) - -#### Inherited from - -[_Block](verida_did_client._internal_._Block.md).[gasUsed](verida_did_client._internal_._Block.md#gasused) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:43 - -___ - -### hash - -• **hash**: `string` - -#### Inherited from - -[_Block](verida_did_client._internal_._Block.md).[hash](verida_did_client._internal_._Block.md#hash) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:35 - -___ - -### miner - -• **miner**: `string` - -#### Inherited from - -[_Block](verida_did_client._internal_._Block.md).[miner](verida_did_client._internal_._Block.md#miner) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:44 - -___ - -### nonce - -• **nonce**: `string` - -#### Inherited from - -[_Block](verida_did_client._internal_._Block.md).[nonce](verida_did_client._internal_._Block.md#nonce) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:39 - -___ - -### number - -• **number**: `number` - -#### Inherited from - -[_Block](verida_did_client._internal_._Block.md).[number](verida_did_client._internal_._Block.md#number) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:37 - -___ - -### parentHash - -• **parentHash**: `string` - -#### Inherited from - -[_Block](verida_did_client._internal_._Block.md).[parentHash](verida_did_client._internal_._Block.md#parenthash) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:36 - -___ - -### timestamp - -• **timestamp**: `number` - -#### Inherited from - -[_Block](verida_did_client._internal_._Block.md).[timestamp](verida_did_client._internal_._Block.md#timestamp) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:38 - -___ - -### transactions - -• **transactions**: `string`[] - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:49 diff --git a/docs/api/verida-js/interfaces/verida_did_client._internal_.BlockWithTransactions.md b/docs/api/verida-js/interfaces/verida_did_client._internal_.BlockWithTransactions.md deleted file mode 100644 index bb54633..0000000 --- a/docs/api/verida-js/interfaces/verida_did_client._internal_.BlockWithTransactions.md +++ /dev/null @@ -1,207 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/did-client](../modules/verida_did_client.md) / [](../modules/verida_did_client._internal_.md) / BlockWithTransactions - -# Interface: BlockWithTransactions - -[@verida/did-client](../modules/verida_did_client.md).[](../modules/verida_did_client._internal_.md).BlockWithTransactions - -## Hierarchy - -- [`_Block`](verida_did_client._internal_._Block.md) - - ↳ **`BlockWithTransactions`** - -## Table of contents - -### Properties - -- [\_difficulty](verida_did_client._internal_.BlockWithTransactions.md#_difficulty) -- [baseFeePerGas](verida_did_client._internal_.BlockWithTransactions.md#basefeepergas) -- [difficulty](verida_did_client._internal_.BlockWithTransactions.md#difficulty) -- [extraData](verida_did_client._internal_.BlockWithTransactions.md#extradata) -- [gasLimit](verida_did_client._internal_.BlockWithTransactions.md#gaslimit) -- [gasUsed](verida_did_client._internal_.BlockWithTransactions.md#gasused) -- [hash](verida_did_client._internal_.BlockWithTransactions.md#hash) -- [miner](verida_did_client._internal_.BlockWithTransactions.md#miner) -- [nonce](verida_did_client._internal_.BlockWithTransactions.md#nonce) -- [number](verida_did_client._internal_.BlockWithTransactions.md#number) -- [parentHash](verida_did_client._internal_.BlockWithTransactions.md#parenthash) -- [timestamp](verida_did_client._internal_.BlockWithTransactions.md#timestamp) -- [transactions](verida_did_client._internal_.BlockWithTransactions.md#transactions) - -## Properties - -### \_difficulty - -• **\_difficulty**: [`BigNumber`](../classes/verida_did_client._internal_.BigNumber.md) - -#### Inherited from - -[_Block](verida_did_client._internal_._Block.md).[_difficulty](verida_did_client._internal_._Block.md#_difficulty) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:41 - -___ - -### baseFeePerGas - -• `Optional` **baseFeePerGas**: ``null`` \| [`BigNumber`](../classes/verida_did_client._internal_.BigNumber.md) - -#### Inherited from - -[_Block](verida_did_client._internal_._Block.md).[baseFeePerGas](verida_did_client._internal_._Block.md#basefeepergas) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:46 - -___ - -### difficulty - -• **difficulty**: `number` - -#### Inherited from - -[_Block](verida_did_client._internal_._Block.md).[difficulty](verida_did_client._internal_._Block.md#difficulty) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:40 - -___ - -### extraData - -• **extraData**: `string` - -#### Inherited from - -[_Block](verida_did_client._internal_._Block.md).[extraData](verida_did_client._internal_._Block.md#extradata) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:45 - -___ - -### gasLimit - -• **gasLimit**: [`BigNumber`](../classes/verida_did_client._internal_.BigNumber.md) - -#### Inherited from - -[_Block](verida_did_client._internal_._Block.md).[gasLimit](verida_did_client._internal_._Block.md#gaslimit) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:42 - -___ - -### gasUsed - -• **gasUsed**: [`BigNumber`](../classes/verida_did_client._internal_.BigNumber.md) - -#### Inherited from - -[_Block](verida_did_client._internal_._Block.md).[gasUsed](verida_did_client._internal_._Block.md#gasused) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:43 - -___ - -### hash - -• **hash**: `string` - -#### Inherited from - -[_Block](verida_did_client._internal_._Block.md).[hash](verida_did_client._internal_._Block.md#hash) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:35 - -___ - -### miner - -• **miner**: `string` - -#### Inherited from - -[_Block](verida_did_client._internal_._Block.md).[miner](verida_did_client._internal_._Block.md#miner) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:44 - -___ - -### nonce - -• **nonce**: `string` - -#### Inherited from - -[_Block](verida_did_client._internal_._Block.md).[nonce](verida_did_client._internal_._Block.md#nonce) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:39 - -___ - -### number - -• **number**: `number` - -#### Inherited from - -[_Block](verida_did_client._internal_._Block.md).[number](verida_did_client._internal_._Block.md#number) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:37 - -___ - -### parentHash - -• **parentHash**: `string` - -#### Inherited from - -[_Block](verida_did_client._internal_._Block.md).[parentHash](verida_did_client._internal_._Block.md#parenthash) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:36 - -___ - -### timestamp - -• **timestamp**: `number` - -#### Inherited from - -[_Block](verida_did_client._internal_._Block.md).[timestamp](verida_did_client._internal_._Block.md#timestamp) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:38 - -___ - -### transactions - -• **transactions**: [`TransactionResponse`](verida_did_client._internal_.TransactionResponse.md)[] - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:52 diff --git a/docs/api/verida-js/interfaces/verida_did_client._internal_.DIDClientConfig.md b/docs/api/verida-js/interfaces/verida_did_client._internal_.DIDClientConfig.md deleted file mode 100644 index 5756e8a..0000000 --- a/docs/api/verida-js/interfaces/verida_did_client._internal_.DIDClientConfig.md +++ /dev/null @@ -1,43 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/did-client](../modules/verida_did_client.md) / [](../modules/verida_did_client._internal_.md) / DIDClientConfig - -# Interface: DIDClientConfig - -[@verida/did-client](../modules/verida_did_client.md).[](../modules/verida_did_client._internal_.md).DIDClientConfig - -## Table of contents - -### Properties - -- [network](verida_did_client._internal_.DIDClientConfig.md#network) -- [rpcUrl](verida_did_client._internal_.DIDClientConfig.md#rpcurl) -- [timeout](verida_did_client._internal_.DIDClientConfig.md#timeout) - -## Properties - -### network - -• **network**: [`EnvironmentType`](../enums/verida_did_client._internal_.EnvironmentType.md) - -#### Defined in - -packages/types/dist/NetworkInterfaces.d.ts:21 - -___ - -### rpcUrl - -• `Optional` **rpcUrl**: `string` - -#### Defined in - -packages/types/dist/NetworkInterfaces.d.ts:22 - -___ - -### timeout - -• `Optional` **timeout**: `number` - -#### Defined in - -packages/types/dist/NetworkInterfaces.d.ts:23 diff --git a/docs/api/verida-js/interfaces/verida_did_client._internal_.DIDDocumentMetadata.md b/docs/api/verida-js/interfaces/verida_did_client._internal_.DIDDocumentMetadata.md deleted file mode 100644 index 3ae570c..0000000 --- a/docs/api/verida-js/interfaces/verida_did_client._internal_.DIDDocumentMetadata.md +++ /dev/null @@ -1,108 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/did-client](../modules/verida_did_client.md) / [](../modules/verida_did_client._internal_.md) / DIDDocumentMetadata - -# Interface: DIDDocumentMetadata - -[@verida/did-client](../modules/verida_did_client.md).[](../modules/verida_did_client._internal_.md).DIDDocumentMetadata - -Represents metadata about the DID document resulting from a [Resolvable.resolve](verida_did_client._internal_.Resolvable.md#resolve) operation. - -**`see`** [https://www.w3.org/TR/did-core/#did-document-metadata](https://www.w3.org/TR/did-core/#did-document-metadata) - -## Hierarchy - -- [`Extensible`](../modules/verida_did_client._internal_.md#extensible) - - ↳ **`DIDDocumentMetadata`** - -## Table of contents - -### Properties - -- [canonicalId](verida_did_client._internal_.DIDDocumentMetadata.md#canonicalid) -- [created](verida_did_client._internal_.DIDDocumentMetadata.md#created) -- [deactivated](verida_did_client._internal_.DIDDocumentMetadata.md#deactivated) -- [equivalentId](verida_did_client._internal_.DIDDocumentMetadata.md#equivalentid) -- [nextUpdate](verida_did_client._internal_.DIDDocumentMetadata.md#nextupdate) -- [nextVersionId](verida_did_client._internal_.DIDDocumentMetadata.md#nextversionid) -- [updated](verida_did_client._internal_.DIDDocumentMetadata.md#updated) -- [versionId](verida_did_client._internal_.DIDDocumentMetadata.md#versionid) - -## Properties - -### canonicalId - -• `Optional` **canonicalId**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:47 - -___ - -### created - -• `Optional` **created**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:40 - -___ - -### deactivated - -• `Optional` **deactivated**: `boolean` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:42 - -___ - -### equivalentId - -• `Optional` **equivalentId**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:46 - -___ - -### nextUpdate - -• `Optional` **nextUpdate**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:44 - -___ - -### nextVersionId - -• `Optional` **nextVersionId**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:45 - -___ - -### updated - -• `Optional` **updated**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:41 - -___ - -### versionId - -• `Optional` **versionId**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:43 diff --git a/docs/api/verida-js/interfaces/verida_did_client._internal_.DIDDocumentStruct.md b/docs/api/verida-js/interfaces/verida_did_client._internal_.DIDDocumentStruct.md deleted file mode 100644 index d3b718a..0000000 --- a/docs/api/verida-js/interfaces/verida_did_client._internal_.DIDDocumentStruct.md +++ /dev/null @@ -1,189 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/did-client](../modules/verida_did_client.md) / [](../modules/verida_did_client._internal_.md) / DIDDocumentStruct - -# Interface: DIDDocumentStruct - -[@verida/did-client](../modules/verida_did_client.md).[](../modules/verida_did_client._internal_.md).DIDDocumentStruct - -## Hierarchy - -- [`DIDDocument`](../modules/verida_did_client._internal_.md#diddocument) - - ↳ **`DIDDocumentStruct`** - -## Table of contents - -### Properties - -- [@context](verida_did_client._internal_.DIDDocumentStruct.md#@context) -- [alsoKnownAs](verida_did_client._internal_.DIDDocumentStruct.md#alsoknownas) -- [assertionMethod](verida_did_client._internal_.DIDDocumentStruct.md#assertionmethod) -- [authentication](verida_did_client._internal_.DIDDocumentStruct.md#authentication) -- [capabilityDelegation](verida_did_client._internal_.DIDDocumentStruct.md#capabilitydelegation) -- [capabilityInvocation](verida_did_client._internal_.DIDDocumentStruct.md#capabilityinvocation) -- [controller](verida_did_client._internal_.DIDDocumentStruct.md#controller) -- [id](verida_did_client._internal_.DIDDocumentStruct.md#id) -- [keyAgreement](verida_did_client._internal_.DIDDocumentStruct.md#keyagreement) -- [proof](verida_did_client._internal_.DIDDocumentStruct.md#proof) -- [publicKey](verida_did_client._internal_.DIDDocumentStruct.md#publickey) -- [service](verida_did_client._internal_.DIDDocumentStruct.md#service) -- [verificationMethod](verida_did_client._internal_.DIDDocumentStruct.md#verificationmethod) - -## Properties - -### @context - -• `Optional` **@context**: `string` \| `string`[] - -#### Inherited from - -DD.@context - -#### Defined in - -packages/did-document/node_modules/did-resolver/lib/resolver.d.ts:26 - -___ - -### alsoKnownAs - -• `Optional` **alsoKnownAs**: `string`[] - -#### Inherited from - -DD.alsoKnownAs - -#### Defined in - -packages/did-document/node_modules/did-resolver/lib/resolver.d.ts:28 - -___ - -### assertionMethod - -• **assertionMethod**: `undefined` \| (`string` \| [`VerificationMethod`](verida_did_client._internal_.VerificationMethod.md))[] - -#### Inherited from - -DD.assertionMethod - -___ - -### authentication - -• **authentication**: `undefined` \| (`string` \| [`VerificationMethod`](verida_did_client._internal_.VerificationMethod.md))[] - -#### Inherited from - -DD.authentication - -___ - -### capabilityDelegation - -• **capabilityDelegation**: `undefined` \| (`string` \| [`VerificationMethod`](verida_did_client._internal_.VerificationMethod.md))[] - -#### Inherited from - -DD.capabilityDelegation - -___ - -### capabilityInvocation - -• **capabilityInvocation**: `undefined` \| (`string` \| [`VerificationMethod`](verida_did_client._internal_.VerificationMethod.md))[] - -#### Inherited from - -DD.capabilityInvocation - -___ - -### controller - -• `Optional` **controller**: `string` \| `string`[] - -#### Inherited from - -DD.controller - -#### Defined in - -packages/did-document/node_modules/did-resolver/lib/resolver.d.ts:29 - -___ - -### id - -• **id**: `string` - -#### Inherited from - -DD.id - -#### Defined in - -packages/did-document/node_modules/did-resolver/lib/resolver.d.ts:27 - -___ - -### keyAgreement - -• **keyAgreement**: `undefined` \| (`string` \| [`VerificationMethod`](verida_did_client._internal_.VerificationMethod.md))[] - -#### Inherited from - -DD.keyAgreement - -___ - -### proof - -• `Optional` **proof**: [`Proof`](verida_did_client._internal_.Proof.md) - -#### Defined in - -packages/did-document/dist/interfaces.d.ts:14 - -___ - -### publicKey - -• `Optional` **publicKey**: [`VerificationMethod`](verida_did_client._internal_.VerificationMethod.md)[] - -**`deprecated`** - -#### Inherited from - -DD.publicKey - -#### Defined in - -packages/did-document/node_modules/did-resolver/lib/resolver.d.ts:35 - -___ - -### service - -• `Optional` **service**: [`ServiceEndpoint`](verida_did_client._internal_.ServiceEndpoint.md)[] - -#### Inherited from - -DD.service - -#### Defined in - -packages/did-document/node_modules/did-resolver/lib/resolver.d.ts:31 - -___ - -### verificationMethod - -• `Optional` **verificationMethod**: [`VerificationMethod`](verida_did_client._internal_.VerificationMethod.md)[] - -#### Inherited from - -DD.verificationMethod - -#### Defined in - -packages/did-document/node_modules/did-resolver/lib/resolver.d.ts:30 diff --git a/docs/api/verida-js/interfaces/verida_did_client._internal_.DIDResolutionMetadata.md b/docs/api/verida-js/interfaces/verida_did_client._internal_.DIDResolutionMetadata.md deleted file mode 100644 index ddbf29a..0000000 --- a/docs/api/verida-js/interfaces/verida_did_client._internal_.DIDResolutionMetadata.md +++ /dev/null @@ -1,42 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/did-client](../modules/verida_did_client.md) / [](../modules/verida_did_client._internal_.md) / DIDResolutionMetadata - -# Interface: DIDResolutionMetadata - -[@verida/did-client](../modules/verida_did_client.md).[](../modules/verida_did_client._internal_.md).DIDResolutionMetadata - -Encapsulates the resolution metadata resulting from a [Resolvable.resolve](verida_did_client._internal_.Resolvable.md#resolve) operation. - -**`see`** [https://www.w3.org/TR/did-core/#did-resolution-metadata](https://www.w3.org/TR/did-core/#did-resolution-metadata) - -## Hierarchy - -- [`Extensible`](../modules/verida_did_client._internal_.md#extensible) - - ↳ **`DIDResolutionMetadata`** - -## Table of contents - -### Properties - -- [contentType](verida_did_client._internal_.DIDResolutionMetadata.md#contenttype) -- [error](verida_did_client._internal_.DIDResolutionMetadata.md#error) - -## Properties - -### contentType - -• `Optional` **contentType**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:31 - -___ - -### error - -• `Optional` **error**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:32 diff --git a/docs/api/verida-js/interfaces/verida_did_client._internal_.DIDResolutionOptions.md b/docs/api/verida-js/interfaces/verida_did_client._internal_.DIDResolutionOptions.md deleted file mode 100644 index b6ed435..0000000 --- a/docs/api/verida-js/interfaces/verida_did_client._internal_.DIDResolutionOptions.md +++ /dev/null @@ -1,31 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/did-client](../modules/verida_did_client.md) / [](../modules/verida_did_client._internal_.md) / DIDResolutionOptions - -# Interface: DIDResolutionOptions - -[@verida/did-client](../modules/verida_did_client.md).[](../modules/verida_did_client._internal_.md).DIDResolutionOptions - -Describes the options forwarded to the resolver when executing a [Resolvable.resolve](verida_did_client._internal_.Resolvable.md#resolve) operation. - -**`see`** [https://www.w3.org/TR/did-core/#did-resolution-options](https://www.w3.org/TR/did-core/#did-resolution-options) - -## Hierarchy - -- [`Extensible`](../modules/verida_did_client._internal_.md#extensible) - - ↳ **`DIDResolutionOptions`** - -## Table of contents - -### Properties - -- [accept](verida_did_client._internal_.DIDResolutionOptions.md#accept) - -## Properties - -### accept - -• `Optional` **accept**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:23 diff --git a/docs/api/verida-js/interfaces/verida_did_client._internal_.DIDResolutionResult.md b/docs/api/verida-js/interfaces/verida_did_client._internal_.DIDResolutionResult.md deleted file mode 100644 index bbbadf3..0000000 --- a/docs/api/verida-js/interfaces/verida_did_client._internal_.DIDResolutionResult.md +++ /dev/null @@ -1,60 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/did-client](../modules/verida_did_client.md) / [](../modules/verida_did_client._internal_.md) / DIDResolutionResult - -# Interface: DIDResolutionResult - -[@verida/did-client](../modules/verida_did_client.md).[](../modules/verida_did_client._internal_.md).DIDResolutionResult - -Defines the result of a DID resolution operation. - -**`see`** [Resolvable.resolve](verida_did_client._internal_.Resolvable.md#resolve) - -**`see`** [https://www.w3.org/TR/did-core/#did-resolution](https://www.w3.org/TR/did-core/#did-resolution) - -## Table of contents - -### Properties - -- [@context](verida_did_client._internal_.DIDResolutionResult.md#@context) -- [didDocument](verida_did_client._internal_.DIDResolutionResult.md#diddocument) -- [didDocumentMetadata](verida_did_client._internal_.DIDResolutionResult.md#diddocumentmetadata) -- [didResolutionMetadata](verida_did_client._internal_.DIDResolutionResult.md#didresolutionmetadata) - -## Properties - -### @context - -• `Optional` **@context**: `string` \| `string`[] - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:12 - -___ - -### didDocument - -• **didDocument**: ``null`` \| [`DIDDocument`](../modules/verida_did_client._internal_.md#diddocument) - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:14 - -___ - -### didDocumentMetadata - -• **didDocumentMetadata**: [`DIDDocumentMetadata`](verida_did_client._internal_.DIDDocumentMetadata.md) - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:15 - -___ - -### didResolutionMetadata - -• **didResolutionMetadata**: [`DIDResolutionMetadata`](verida_did_client._internal_.DIDResolutionMetadata.md) - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:13 diff --git a/docs/api/verida-js/interfaces/verida_did_client._internal_.Endpoints.md b/docs/api/verida-js/interfaces/verida_did_client._internal_.Endpoints.md deleted file mode 100644 index a28ebed..0000000 --- a/docs/api/verida-js/interfaces/verida_did_client._internal_.Endpoints.md +++ /dev/null @@ -1,54 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/did-client](../modules/verida_did_client.md) / [](../modules/verida_did_client._internal_.md) / Endpoints - -# Interface: Endpoints - -[@verida/did-client](../modules/verida_did_client.md).[](../modules/verida_did_client._internal_.md).Endpoints - -## Table of contents - -### Properties - -- [database](verida_did_client._internal_.Endpoints.md#database) -- [messaging](verida_did_client._internal_.Endpoints.md#messaging) -- [notification](verida_did_client._internal_.Endpoints.md#notification) -- [storage](verida_did_client._internal_.Endpoints.md#storage) - -## Properties - -### database - -• **database**: [`SecureContextEndpoint`](verida_did_client._internal_.SecureContextEndpoint.md) - -#### Defined in - -packages/did-document/dist/interfaces.d.ts:17 - -___ - -### messaging - -• **messaging**: [`SecureContextEndpoint`](verida_did_client._internal_.SecureContextEndpoint.md) - -#### Defined in - -packages/did-document/dist/interfaces.d.ts:18 - -___ - -### notification - -• `Optional` **notification**: [`SecureContextEndpoint`](verida_did_client._internal_.SecureContextEndpoint.md) - -#### Defined in - -packages/did-document/dist/interfaces.d.ts:20 - -___ - -### storage - -• `Optional` **storage**: [`SecureContextEndpoint`](verida_did_client._internal_.SecureContextEndpoint.md) - -#### Defined in - -packages/did-document/dist/interfaces.d.ts:19 diff --git a/docs/api/verida-js/interfaces/verida_did_client._internal_.EventFilter.md b/docs/api/verida-js/interfaces/verida_did_client._internal_.EventFilter.md deleted file mode 100644 index c232a3c..0000000 --- a/docs/api/verida-js/interfaces/verida_did_client._internal_.EventFilter.md +++ /dev/null @@ -1,38 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/did-client](../modules/verida_did_client.md) / [](../modules/verida_did_client._internal_.md) / EventFilter - -# Interface: EventFilter - -[@verida/did-client](../modules/verida_did_client.md).[](../modules/verida_did_client._internal_.md).EventFilter - -## Hierarchy - -- **`EventFilter`** - - ↳ [`Filter`](verida_did_client._internal_.Filter.md) - -## Table of contents - -### Properties - -- [address](verida_did_client._internal_.EventFilter.md#address) -- [topics](verida_did_client._internal_.EventFilter.md#topics) - -## Properties - -### address - -• `Optional` **address**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:91 - -___ - -### topics - -• `Optional` **topics**: (``null`` \| `string` \| `string`[])[] - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:92 diff --git a/docs/api/verida-js/interfaces/verida_did_client._internal_.FeeData.md b/docs/api/verida-js/interfaces/verida_did_client._internal_.FeeData.md deleted file mode 100644 index 80b65da..0000000 --- a/docs/api/verida-js/interfaces/verida_did_client._internal_.FeeData.md +++ /dev/null @@ -1,54 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/did-client](../modules/verida_did_client.md) / [](../modules/verida_did_client._internal_.md) / FeeData - -# Interface: FeeData - -[@verida/did-client](../modules/verida_did_client.md).[](../modules/verida_did_client._internal_.md).FeeData - -## Table of contents - -### Properties - -- [gasPrice](verida_did_client._internal_.FeeData.md#gasprice) -- [lastBaseFeePerGas](verida_did_client._internal_.FeeData.md#lastbasefeepergas) -- [maxFeePerGas](verida_did_client._internal_.FeeData.md#maxfeepergas) -- [maxPriorityFeePerGas](verida_did_client._internal_.FeeData.md#maxpriorityfeepergas) - -## Properties - -### gasPrice - -• **gasPrice**: ``null`` \| [`BigNumber`](../classes/verida_did_client._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:88 - -___ - -### lastBaseFeePerGas - -• **lastBaseFeePerGas**: ``null`` \| [`BigNumber`](../classes/verida_did_client._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:85 - -___ - -### maxFeePerGas - -• **maxFeePerGas**: ``null`` \| [`BigNumber`](../classes/verida_did_client._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:86 - -___ - -### maxPriorityFeePerGas - -• **maxPriorityFeePerGas**: ``null`` \| [`BigNumber`](../classes/verida_did_client._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:87 diff --git a/docs/api/verida-js/interfaces/verida_did_client._internal_.Filter.md b/docs/api/verida-js/interfaces/verida_did_client._internal_.Filter.md deleted file mode 100644 index f863664..0000000 --- a/docs/api/verida-js/interfaces/verida_did_client._internal_.Filter.md +++ /dev/null @@ -1,68 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/did-client](../modules/verida_did_client.md) / [](../modules/verida_did_client._internal_.md) / Filter - -# Interface: Filter - -[@verida/did-client](../modules/verida_did_client.md).[](../modules/verida_did_client._internal_.md).Filter - -## Hierarchy - -- [`EventFilter`](verida_did_client._internal_.EventFilter.md) - - ↳ **`Filter`** - -## Table of contents - -### Properties - -- [address](verida_did_client._internal_.Filter.md#address) -- [fromBlock](verida_did_client._internal_.Filter.md#fromblock) -- [toBlock](verida_did_client._internal_.Filter.md#toblock) -- [topics](verida_did_client._internal_.Filter.md#topics) - -## Properties - -### address - -• `Optional` **address**: `string` - -#### Inherited from - -[EventFilter](verida_did_client._internal_.EventFilter.md).[address](verida_did_client._internal_.EventFilter.md#address) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:91 - -___ - -### fromBlock - -• `Optional` **fromBlock**: [`BlockTag`](../modules/verida_did_client._internal_.md#blocktag) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:95 - -___ - -### toBlock - -• `Optional` **toBlock**: [`BlockTag`](../modules/verida_did_client._internal_.md#blocktag) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:96 - -___ - -### topics - -• `Optional` **topics**: (``null`` \| `string` \| `string`[])[] - -#### Inherited from - -[EventFilter](verida_did_client._internal_.EventFilter.md).[topics](verida_did_client._internal_.EventFilter.md#topics) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:92 diff --git a/docs/api/verida-js/interfaces/verida_did_client._internal_.Hexable.md b/docs/api/verida-js/interfaces/verida_did_client._internal_.Hexable.md deleted file mode 100644 index 4bc69ba..0000000 --- a/docs/api/verida-js/interfaces/verida_did_client._internal_.Hexable.md +++ /dev/null @@ -1,29 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/did-client](../modules/verida_did_client.md) / [](../modules/verida_did_client._internal_.md) / Hexable - -# Interface: Hexable - -[@verida/did-client](../modules/verida_did_client.md).[](../modules/verida_did_client._internal_.md).Hexable - -## Implemented by - -- [`BigNumber`](../classes/verida_did_client._internal_.BigNumber.md) - -## Table of contents - -### Methods - -- [toHexString](verida_did_client._internal_.Hexable.md#tohexstring) - -## Methods - -### toHexString - -▸ **toHexString**(): `string` - -#### Returns - -`string` - -#### Defined in - -node_modules/@ethersproject/bytes/lib/index.d.ts:8 diff --git a/docs/api/verida-js/interfaces/verida_did_client._internal_.IDIDClient.md b/docs/api/verida-js/interfaces/verida_did_client._internal_.IDIDClient.md deleted file mode 100644 index 077f2ba..0000000 --- a/docs/api/verida-js/interfaces/verida_did_client._internal_.IDIDClient.md +++ /dev/null @@ -1,155 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/did-client](../modules/verida_did_client.md) / [](../modules/verida_did_client._internal_.md) / IDIDClient - -# Interface: IDIDClient - -[@verida/did-client](../modules/verida_did_client.md).[](../modules/verida_did_client._internal_.md).IDIDClient - -## Implemented by - -- [`DIDClient`](../classes/verida_did_client.DIDClient.md) - -## Table of contents - -### Methods - -- [authenticate](verida_did_client._internal_.IDIDClient.md#authenticate) -- [authenticated](verida_did_client._internal_.IDIDClient.md#authenticated) -- [get](verida_did_client._internal_.IDIDClient.md#get) -- [getDid](verida_did_client._internal_.IDIDClient.md#getdid) -- [getLastEndpointErrors](verida_did_client._internal_.IDIDClient.md#getlastendpointerrors) -- [getPublicKey](verida_did_client._internal_.IDIDClient.md#getpublickey) -- [getRpcUrl](verida_did_client._internal_.IDIDClient.md#getrpcurl) -- [save](verida_did_client._internal_.IDIDClient.md#save) - -## Methods - -### authenticate - -▸ **authenticate**(`veridaPrivateKey`, `callType`, `web3Config`, `defaultEndpoints`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `veridaPrivateKey` | `string` | -| `callType` | [`Web3CallType`](../modules/verida_did_client._internal_.md#web3calltype) | -| `web3Config` | [`Web3SelfTransactionConfigPart`](verida_did_client._internal_.Web3SelfTransactionConfigPart.md) \| [`Web3MetaTransactionConfig`](verida_did_client._internal_.Web3MetaTransactionConfig.md) | -| `defaultEndpoints` | `string`[] | - -#### Returns - -`void` - -#### Defined in - -packages/types/dist/IDIDClient.d.ts:4 - -___ - -### authenticated - -▸ **authenticated**(): `boolean` - -#### Returns - -`boolean` - -#### Defined in - -packages/types/dist/IDIDClient.d.ts:5 - -___ - -### get - -▸ **get**(`did`): `Promise`<[`IDIDDocument`](verida_did_client._internal_.IDIDDocument.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did` | `string` | - -#### Returns - -`Promise`<[`IDIDDocument`](verida_did_client._internal_.IDIDDocument.md)\> - -#### Defined in - -packages/types/dist/IDIDClient.d.ts:10 - -___ - -### getDid - -▸ **getDid**(): `undefined` \| `string` - -#### Returns - -`undefined` \| `string` - -#### Defined in - -packages/types/dist/IDIDClient.d.ts:6 - -___ - -### getLastEndpointErrors - -▸ **getLastEndpointErrors**(): [`VdaDidEndpointResponses`](../modules/verida_did_client._internal_.md#vdadidendpointresponses) - -#### Returns - -[`VdaDidEndpointResponses`](../modules/verida_did_client._internal_.md#vdadidendpointresponses) - -#### Defined in - -packages/types/dist/IDIDClient.d.ts:9 - -___ - -### getPublicKey - -▸ **getPublicKey**(): `undefined` \| `string` - -#### Returns - -`undefined` \| `string` - -#### Defined in - -packages/types/dist/IDIDClient.d.ts:7 - -___ - -### getRpcUrl - -▸ **getRpcUrl**(): `string` - -#### Returns - -`string` - -#### Defined in - -packages/types/dist/IDIDClient.d.ts:11 - -___ - -### save - -▸ **save**(`document`): `Promise`<[`VdaDidEndpointResponses`](../modules/verida_did_client._internal_.md#vdadidendpointresponses)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `document` | [`IDIDDocument`](verida_did_client._internal_.IDIDDocument.md) | - -#### Returns - -`Promise`<[`VdaDidEndpointResponses`](../modules/verida_did_client._internal_.md#vdadidendpointresponses)\> - -#### Defined in - -packages/types/dist/IDIDClient.d.ts:8 diff --git a/docs/api/verida-js/interfaces/verida_did_client._internal_.IDIDDocument.md b/docs/api/verida-js/interfaces/verida_did_client._internal_.IDIDDocument.md deleted file mode 100644 index 5ff8d15..0000000 --- a/docs/api/verida-js/interfaces/verida_did_client._internal_.IDIDDocument.md +++ /dev/null @@ -1,364 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/did-client](../modules/verida_did_client.md) / [](../modules/verida_did_client._internal_.md) / IDIDDocument - -# Interface: IDIDDocument - -[@verida/did-client](../modules/verida_did_client.md).[](../modules/verida_did_client._internal_.md).IDIDDocument - -## Implemented by - -- [`default`](../classes/verida_did_client._internal_.default-1.md) - -## Table of contents - -### Accessors - -- [id](verida_did_client._internal_.IDIDDocument.md#id) - -### Methods - -- [addContext](verida_did_client._internal_.IDIDDocument.md#addcontext) -- [addContextAsymKey](verida_did_client._internal_.IDIDDocument.md#addcontextasymkey) -- [addContextService](verida_did_client._internal_.IDIDDocument.md#addcontextservice) -- [addContextSignKey](verida_did_client._internal_.IDIDDocument.md#addcontextsignkey) -- [buildTimestamp](verida_did_client._internal_.IDIDDocument.md#buildtimestamp) -- [export](verida_did_client._internal_.IDIDDocument.md#export) -- [getErrors](verida_did_client._internal_.IDIDDocument.md#geterrors) -- [import](verida_did_client._internal_.IDIDDocument.md#import) -- [locateContextProof](verida_did_client._internal_.IDIDDocument.md#locatecontextproof) -- [locateServiceEndpoint](verida_did_client._internal_.IDIDDocument.md#locateserviceendpoint) -- [removeContext](verida_did_client._internal_.IDIDDocument.md#removecontext) -- [setAttributes](verida_did_client._internal_.IDIDDocument.md#setattributes) -- [signProof](verida_did_client._internal_.IDIDDocument.md#signproof) -- [verifyContextSignature](verida_did_client._internal_.IDIDDocument.md#verifycontextsignature) -- [verifyProof](verida_did_client._internal_.IDIDDocument.md#verifyproof) -- [verifySig](verida_did_client._internal_.IDIDDocument.md#verifysig) - -## Accessors - -### id - -• `get` **id**(): `string` - -#### Returns - -`string` - -#### Defined in - -packages/types/dist/IDIDDocument.d.ts:5 - -## Methods - -### addContext - -▸ **addContext**(`contextName`, `keyring`, `privateKey`, `endpoints`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | -| `keyring` | [`IKeyring`](verida_did_client._internal_.IKeyring.md) | -| `privateKey` | `string` | -| `endpoints` | [`SecureContextEndpoints`](verida_did_client._internal_.SecureContextEndpoints.md) | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -packages/types/dist/IDIDDocument.d.ts:7 - -___ - -### addContextAsymKey - -▸ **addContextAsymKey**(`contextHash`, `publicKeyHex`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextHash` | `string` | -| `publicKeyHex` | `string` | - -#### Returns - -`void` - -#### Defined in - -packages/types/dist/IDIDDocument.d.ts:14 - -___ - -### addContextService - -▸ **addContextService**(`contextHash`, `endpointType`, `serviceType`, `endpointUris`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextHash` | `string` | -| `endpointType` | [`SecureContextEndpointType`](../enums/verida_did_client._internal_.SecureContextEndpointType.md) | -| `serviceType` | `string` | -| `endpointUris` | [`ServiceEndpoint`](../modules/verida_did_client._internal_.md#serviceendpoint)[] | - -#### Returns - -`void` - -#### Defined in - -packages/types/dist/IDIDDocument.d.ts:12 - -___ - -### addContextSignKey - -▸ **addContextSignKey**(`contextHash`, `publicKeyHex`, `proof`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextHash` | `string` | -| `publicKeyHex` | `string` | -| `proof` | `string` | - -#### Returns - -`void` - -#### Defined in - -packages/types/dist/IDIDDocument.d.ts:13 - -___ - -### buildTimestamp - -▸ **buildTimestamp**(`date`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `date` | `Date` | - -#### Returns - -`string` - -#### Defined in - -packages/types/dist/IDIDDocument.d.ts:21 - -___ - -### export - -▸ **export**(): [`VeridaDocInterface`](verida_did_client._internal_.VeridaDocInterface.md) - -#### Returns - -[`VeridaDocInterface`](verida_did_client._internal_.VeridaDocInterface.md) - -#### Defined in - -packages/types/dist/IDIDDocument.d.ts:11 - -___ - -### getErrors - -▸ **getErrors**(): `string`[] - -#### Returns - -`string`[] - -#### Defined in - -packages/types/dist/IDIDDocument.d.ts:6 - -___ - -### import - -▸ **import**(`doc`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `doc` | [`VeridaDocInterface`](verida_did_client._internal_.VeridaDocInterface.md) | - -#### Returns - -`void` - -#### Defined in - -packages/types/dist/IDIDDocument.d.ts:10 - -___ - -### locateContextProof - -▸ **locateContextProof**(`contextName`): `undefined` \| `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | - -#### Returns - -`undefined` \| `string` - -#### Defined in - -packages/types/dist/IDIDDocument.d.ts:18 - -___ - -### locateServiceEndpoint - -▸ **locateServiceEndpoint**(`contextName`, `endpointType`): `undefined` \| [`Service`](verida_did_client._internal_.Service.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | -| `endpointType` | [`SecureContextEndpointType`](../enums/verida_did_client._internal_.SecureContextEndpointType.md) | - -#### Returns - -`undefined` \| [`Service`](verida_did_client._internal_.Service.md) - -#### Defined in - -packages/types/dist/IDIDDocument.d.ts:17 - -___ - -### removeContext - -▸ **removeContext**(`contextName`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | - -#### Returns - -`boolean` - -#### Defined in - -packages/types/dist/IDIDDocument.d.ts:8 - -___ - -### setAttributes - -▸ **setAttributes**(`attributes`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `attributes` | [`Record`](../modules/verida_did_client._internal_.md#record)<`string`, `any`\> | - -#### Returns - -`void` - -#### Defined in - -packages/types/dist/IDIDDocument.d.ts:9 - -___ - -### signProof - -▸ **signProof**(`privateKey`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `privateKey` | `string` \| `Uint8Array` | - -#### Returns - -`void` - -#### Defined in - -packages/types/dist/IDIDDocument.d.ts:19 - -___ - -### verifyContextSignature - -▸ **verifyContextSignature**(`data`, `contextName`, `signature`, `contextIsHash`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `any` | -| `contextName` | `string` | -| `signature` | `string` | -| `contextIsHash` | `boolean` | - -#### Returns - -`boolean` - -#### Defined in - -packages/types/dist/IDIDDocument.d.ts:16 - -___ - -### verifyProof - -▸ **verifyProof**(): `boolean` - -#### Returns - -`boolean` - -#### Defined in - -packages/types/dist/IDIDDocument.d.ts:20 - -___ - -### verifySig - -▸ **verifySig**(`data`, `signature`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `any` | -| `signature` | `string` | - -#### Returns - -`boolean` - -#### Defined in - -packages/types/dist/IDIDDocument.d.ts:15 diff --git a/docs/api/verida-js/interfaces/verida_did_client._internal_.IKeyring.md b/docs/api/verida-js/interfaces/verida_did_client._internal_.IKeyring.md deleted file mode 100644 index a9e65ce..0000000 --- a/docs/api/verida-js/interfaces/verida_did_client._internal_.IKeyring.md +++ /dev/null @@ -1,262 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/did-client](../modules/verida_did_client.md) / [](../modules/verida_did_client._internal_.md) / IKeyring - -# Interface: IKeyring - -[@verida/did-client](../modules/verida_did_client.md).[](../modules/verida_did_client._internal_.md).IKeyring - -## Table of contents - -### Methods - -- [\_init](verida_did_client._internal_.IKeyring.md#_init) -- [asymDecrypt](verida_did_client._internal_.IKeyring.md#asymdecrypt) -- [asymEncrypt](verida_did_client._internal_.IKeyring.md#asymencrypt) -- [buildSharedKeyEnd](verida_did_client._internal_.IKeyring.md#buildsharedkeyend) -- [buildSharedKeyStart](verida_did_client._internal_.IKeyring.md#buildsharedkeystart) -- [getKeys](verida_did_client._internal_.IKeyring.md#getkeys) -- [getSeed](verida_did_client._internal_.IKeyring.md#getseed) -- [getStorageContextKey](verida_did_client._internal_.IKeyring.md#getstoragecontextkey) -- [publicKeys](verida_did_client._internal_.IKeyring.md#publickeys) -- [sign](verida_did_client._internal_.IKeyring.md#sign) -- [symDecrypt](verida_did_client._internal_.IKeyring.md#symdecrypt) -- [symEncrypt](verida_did_client._internal_.IKeyring.md#symencrypt) -- [verifySig](verida_did_client._internal_.IKeyring.md#verifysig) - -## Methods - -### \_init - -▸ **_init**(): `Promise`<`void`\> - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:3 - -___ - -### asymDecrypt - -▸ **asymDecrypt**(`messageWithNonce`, `secretOrSharedKey`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `messageWithNonce` | `string` | -| `secretOrSharedKey` | `Uint8Array` | - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:10 - -___ - -### asymEncrypt - -▸ **asymEncrypt**(`data`, `secretOrSharedKey`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `string` | -| `secretOrSharedKey` | `Uint8Array` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:9 - -___ - -### buildSharedKeyEnd - -▸ **buildSharedKeyEnd**(`publicKey`): `Promise`<`Uint8Array`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `publicKey` | `Uint8Array` | - -#### Returns - -`Promise`<`Uint8Array`\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:12 - -___ - -### buildSharedKeyStart - -▸ **buildSharedKeyStart**(`privateKey`): `Promise`<`Uint8Array`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `privateKey` | `Uint8Array` | - -#### Returns - -`Promise`<`Uint8Array`\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:11 - -___ - -### getKeys - -▸ **getKeys**(): `Promise`<`any`\> - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:2 - -___ - -### getSeed - -▸ **getSeed**(): `string` - -#### Returns - -`string` - -#### Defined in - -packages/types/dist/IKeyring.d.ts:13 - -___ - -### getStorageContextKey - -▸ **getStorageContextKey**(`databaseName`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `databaseName` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:14 - -___ - -### publicKeys - -▸ **publicKeys**(): `Promise`<[`KeyringPublicKeys`](verida_did_client._internal_.KeyringPublicKeys.md)\> - -#### Returns - -`Promise`<[`KeyringPublicKeys`](verida_did_client._internal_.KeyringPublicKeys.md)\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:4 - -___ - -### sign - -▸ **sign**(`data`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `any` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:5 - -___ - -### symDecrypt - -▸ **symDecrypt**(`data`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `string` | - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:8 - -___ - -### symEncrypt - -▸ **symEncrypt**(`data`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:7 - -___ - -### verifySig - -▸ **verifySig**(`data`, `sig`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `string` | -| `sig` | `string` | - -#### Returns - -`Promise`<`boolean`\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:6 diff --git a/docs/api/verida-js/interfaces/verida_did_client._internal_.JsonWebKey.md b/docs/api/verida-js/interfaces/verida_did_client._internal_.JsonWebKey.md deleted file mode 100644 index b70d960..0000000 --- a/docs/api/verida-js/interfaces/verida_did_client._internal_.JsonWebKey.md +++ /dev/null @@ -1,145 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/did-client](../modules/verida_did_client.md) / [](../modules/verida_did_client._internal_.md) / JsonWebKey - -# Interface: JsonWebKey - -[@verida/did-client](../modules/verida_did_client.md).[](../modules/verida_did_client._internal_.md).JsonWebKey - -Encapsulates a JSON web key type that includes only the public properties that -can be used in DID documents. - -The private properties are intentionally omitted to discourage the use -(and accidental disclosure) of private keys in DID documents. - -**`see`** [RFC7517 JsonWebKey (JWK)](https://www.rfc-editor.org/rfc/rfc7517) - -## Hierarchy - -- [`Extensible`](../modules/verida_did_client._internal_.md#extensible) - - ↳ **`JsonWebKey`** - -## Table of contents - -### Properties - -- [alg](verida_did_client._internal_.JsonWebKey.md#alg) -- [crv](verida_did_client._internal_.JsonWebKey.md#crv) -- [e](verida_did_client._internal_.JsonWebKey.md#e) -- [ext](verida_did_client._internal_.JsonWebKey.md#ext) -- [key\_ops](verida_did_client._internal_.JsonWebKey.md#key_ops) -- [kid](verida_did_client._internal_.JsonWebKey.md#kid) -- [kty](verida_did_client._internal_.JsonWebKey.md#kty) -- [n](verida_did_client._internal_.JsonWebKey.md#n) -- [use](verida_did_client._internal_.JsonWebKey.md#use) -- [x](verida_did_client._internal_.JsonWebKey.md#x) -- [y](verida_did_client._internal_.JsonWebKey.md#y) - -## Properties - -### alg - -• `Optional` **alg**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:103 - -___ - -### crv - -• `Optional` **crv**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:104 - -___ - -### e - -• `Optional` **e**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:105 - -___ - -### ext - -• `Optional` **ext**: `boolean` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:106 - -___ - -### key\_ops - -• `Optional` **key\_ops**: `string`[] - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:107 - -___ - -### kid - -• `Optional` **kid**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:108 - -___ - -### kty - -• **kty**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:109 - -___ - -### n - -• `Optional` **n**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:110 - -___ - -### use - -• `Optional` **use**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:111 - -___ - -### x - -• `Optional` **x**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:112 - -___ - -### y - -• `Optional` **y**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:113 diff --git a/docs/api/verida-js/interfaces/verida_did_client._internal_.KeyringPublicKeys.md b/docs/api/verida-js/interfaces/verida_did_client._internal_.KeyringPublicKeys.md deleted file mode 100644 index cecc4c2..0000000 --- a/docs/api/verida-js/interfaces/verida_did_client._internal_.KeyringPublicKeys.md +++ /dev/null @@ -1,76 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/did-client](../modules/verida_did_client.md) / [](../modules/verida_did_client._internal_.md) / KeyringPublicKeys - -# Interface: KeyringPublicKeys - -[@verida/did-client](../modules/verida_did_client.md).[](../modules/verida_did_client._internal_.md).KeyringPublicKeys - -## Table of contents - -### Properties - -- [asymPublicKey](verida_did_client._internal_.KeyringPublicKeys.md#asympublickey) -- [asymPublicKeyBase58](verida_did_client._internal_.KeyringPublicKeys.md#asympublickeybase58) -- [asymPublicKeyHex](verida_did_client._internal_.KeyringPublicKeys.md#asympublickeyhex) -- [signPublicKey](verida_did_client._internal_.KeyringPublicKeys.md#signpublickey) -- [signPublicKeyBase58](verida_did_client._internal_.KeyringPublicKeys.md#signpublickeybase58) -- [signPublicKeyHex](verida_did_client._internal_.KeyringPublicKeys.md#signpublickeyhex) - -## Properties - -### asymPublicKey - -• **asymPublicKey**: `Uint8Array` - -#### Defined in - -packages/types/dist/IKeyring.d.ts:17 - -___ - -### asymPublicKeyBase58 - -• **asymPublicKeyBase58**: `string` - -#### Defined in - -packages/types/dist/IKeyring.d.ts:19 - -___ - -### asymPublicKeyHex - -• **asymPublicKeyHex**: `string` - -#### Defined in - -packages/types/dist/IKeyring.d.ts:18 - -___ - -### signPublicKey - -• **signPublicKey**: `Uint8Array` - -#### Defined in - -packages/types/dist/IKeyring.d.ts:20 - -___ - -### signPublicKeyBase58 - -• **signPublicKeyBase58**: `string` - -#### Defined in - -packages/types/dist/IKeyring.d.ts:22 - -___ - -### signPublicKeyHex - -• **signPublicKeyHex**: `string` - -#### Defined in - -packages/types/dist/IKeyring.d.ts:21 diff --git a/docs/api/verida-js/interfaces/verida_did_client._internal_.LegacyResolverRegistry.md b/docs/api/verida-js/interfaces/verida_did_client._internal_.LegacyResolverRegistry.md deleted file mode 100644 index 944ee2b..0000000 --- a/docs/api/verida-js/interfaces/verida_did_client._internal_.LegacyResolverRegistry.md +++ /dev/null @@ -1,9 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/did-client](../modules/verida_did_client.md) / [](../modules/verida_did_client._internal_.md) / LegacyResolverRegistry - -# Interface: LegacyResolverRegistry - -[@verida/did-client](../modules/verida_did_client.md).[](../modules/verida_did_client._internal_.md).LegacyResolverRegistry - -## Indexable - -▪ [index: `string`]: [`LegacyDIDResolver`](../modules/verida_did_client._internal_.md#legacydidresolver) diff --git a/docs/api/verida-js/interfaces/verida_did_client._internal_.Log.md b/docs/api/verida-js/interfaces/verida_did_client._internal_.Log.md deleted file mode 100644 index 3190677..0000000 --- a/docs/api/verida-js/interfaces/verida_did_client._internal_.Log.md +++ /dev/null @@ -1,109 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/did-client](../modules/verida_did_client.md) / [](../modules/verida_did_client._internal_.md) / Log - -# Interface: Log - -[@verida/did-client](../modules/verida_did_client.md).[](../modules/verida_did_client._internal_.md).Log - -## Table of contents - -### Properties - -- [address](verida_did_client._internal_.Log.md#address) -- [blockHash](verida_did_client._internal_.Log.md#blockhash) -- [blockNumber](verida_did_client._internal_.Log.md#blocknumber) -- [data](verida_did_client._internal_.Log.md#data) -- [logIndex](verida_did_client._internal_.Log.md#logindex) -- [removed](verida_did_client._internal_.Log.md#removed) -- [topics](verida_did_client._internal_.Log.md#topics) -- [transactionHash](verida_did_client._internal_.Log.md#transactionhash) -- [transactionIndex](verida_did_client._internal_.Log.md#transactionindex) - -## Properties - -### address - -• **address**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:59 - -___ - -### blockHash - -• **blockHash**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:56 - -___ - -### blockNumber - -• **blockNumber**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:55 - -___ - -### data - -• **data**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:60 - -___ - -### logIndex - -• **logIndex**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:63 - -___ - -### removed - -• **removed**: `boolean` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:58 - -___ - -### topics - -• **topics**: `string`[] - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:61 - -___ - -### transactionHash - -• **transactionHash**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:62 - -___ - -### transactionIndex - -• **transactionIndex**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:57 diff --git a/docs/api/verida-js/interfaces/verida_did_client._internal_.OnceBlockable.md b/docs/api/verida-js/interfaces/verida_did_client._internal_.OnceBlockable.md deleted file mode 100644 index e5ce23e..0000000 --- a/docs/api/verida-js/interfaces/verida_did_client._internal_.OnceBlockable.md +++ /dev/null @@ -1,36 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/did-client](../modules/verida_did_client.md) / [](../modules/verida_did_client._internal_.md) / OnceBlockable - -# Interface: OnceBlockable - -[@verida/did-client](../modules/verida_did_client.md).[](../modules/verida_did_client._internal_.md).OnceBlockable - -## Implemented by - -- [`Provider`](../classes/verida_did_client._internal_.Provider.md) - -## Table of contents - -### Methods - -- [once](verida_did_client._internal_.OnceBlockable.md#once) - -## Methods - -### once - -▸ **once**(`eventName`, `handler`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | ``"block"`` | -| `handler` | () => `void` | - -#### Returns - -`void` - -#### Defined in - -node_modules/@ethersproject/web/lib/index.d.ts:19 diff --git a/docs/api/verida-js/interfaces/verida_did_client._internal_.Params.md b/docs/api/verida-js/interfaces/verida_did_client._internal_.Params.md deleted file mode 100644 index ee88d2c..0000000 --- a/docs/api/verida-js/interfaces/verida_did_client._internal_.Params.md +++ /dev/null @@ -1,11 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/did-client](../modules/verida_did_client.md) / [](../modules/verida_did_client._internal_.md) / Params - -# Interface: Params - -[@verida/did-client](../modules/verida_did_client.md).[](../modules/verida_did_client._internal_.md).Params - -URI params resulting from parsing a DID URI - -## Indexable - -▪ [index: `string`]: `string` diff --git a/docs/api/verida-js/interfaces/verida_did_client._internal_.ParsedDID.md b/docs/api/verida-js/interfaces/verida_did_client._internal_.ParsedDID.md deleted file mode 100644 index 9360440..0000000 --- a/docs/api/verida-js/interfaces/verida_did_client._internal_.ParsedDID.md +++ /dev/null @@ -1,106 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/did-client](../modules/verida_did_client.md) / [](../modules/verida_did_client._internal_.md) / ParsedDID - -# Interface: ParsedDID - -[@verida/did-client](../modules/verida_did_client.md).[](../modules/verida_did_client._internal_.md).ParsedDID - -An object containing the results of parsing a DID URI string. - -This is forwarded to implementations of particular DID resolvers when calling the `resolve` method. - -**`see`** [Resolver](../classes/verida_did_client._internal_.Resolver.md) - -**`see`** [Resolvable.resolve](verida_did_client._internal_.Resolvable.md#resolve) - -## Table of contents - -### Properties - -- [did](verida_did_client._internal_.ParsedDID.md#did) -- [didUrl](verida_did_client._internal_.ParsedDID.md#didurl) -- [fragment](verida_did_client._internal_.ParsedDID.md#fragment) -- [id](verida_did_client._internal_.ParsedDID.md#id) -- [method](verida_did_client._internal_.ParsedDID.md#method) -- [params](verida_did_client._internal_.ParsedDID.md#params) -- [path](verida_did_client._internal_.ParsedDID.md#path) -- [query](verida_did_client._internal_.ParsedDID.md#query) - -## Properties - -### did - -• **did**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:151 - -___ - -### didUrl - -• **didUrl**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:152 - -___ - -### fragment - -• `Optional` **fragment**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:156 - -___ - -### id - -• **id**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:154 - -___ - -### method - -• **method**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:153 - -___ - -### params - -• `Optional` **params**: [`Params`](verida_did_client._internal_.Params.md) - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:158 - -___ - -### path - -• `Optional` **path**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:155 - -___ - -### query - -• `Optional` **query**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:157 diff --git a/docs/api/verida-js/interfaces/verida_did_client._internal_.Proof.md b/docs/api/verida-js/interfaces/verida_did_client._internal_.Proof.md deleted file mode 100644 index bd78e62..0000000 --- a/docs/api/verida-js/interfaces/verida_did_client._internal_.Proof.md +++ /dev/null @@ -1,54 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/did-client](../modules/verida_did_client.md) / [](../modules/verida_did_client._internal_.md) / Proof - -# Interface: Proof - -[@verida/did-client](../modules/verida_did_client.md).[](../modules/verida_did_client._internal_.md).Proof - -## Table of contents - -### Properties - -- [proofPurpose](verida_did_client._internal_.Proof.md#proofpurpose) -- [proofValue](verida_did_client._internal_.Proof.md#proofvalue) -- [type](verida_did_client._internal_.Proof.md#type) -- [verificationMethod](verida_did_client._internal_.Proof.md#verificationmethod) - -## Properties - -### proofPurpose - -• **proofPurpose**: ``"assertionMethod"`` - -#### Defined in - -packages/did-document/dist/interfaces.d.ts:10 - -___ - -### proofValue - -• **proofValue**: `string` - -#### Defined in - -packages/did-document/dist/interfaces.d.ts:11 - -___ - -### type - -• **type**: ``"EcdsaSecp256k1VerificationKey2019"`` - -#### Defined in - -packages/did-document/dist/interfaces.d.ts:8 - -___ - -### verificationMethod - -• **verificationMethod**: `string` - -#### Defined in - -packages/did-document/dist/interfaces.d.ts:9 diff --git a/docs/api/verida-js/interfaces/verida_did_client._internal_.ProofInterface.md b/docs/api/verida-js/interfaces/verida_did_client._internal_.ProofInterface.md deleted file mode 100644 index 76b8b9c..0000000 --- a/docs/api/verida-js/interfaces/verida_did_client._internal_.ProofInterface.md +++ /dev/null @@ -1,54 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/did-client](../modules/verida_did_client.md) / [](../modules/verida_did_client._internal_.md) / ProofInterface - -# Interface: ProofInterface - -[@verida/did-client](../modules/verida_did_client.md).[](../modules/verida_did_client._internal_.md).ProofInterface - -## Table of contents - -### Properties - -- [proofPurpose](verida_did_client._internal_.ProofInterface.md#proofpurpose) -- [proofValue](verida_did_client._internal_.ProofInterface.md#proofvalue) -- [type](verida_did_client._internal_.ProofInterface.md#type) -- [verificationMethod](verida_did_client._internal_.ProofInterface.md#verificationmethod) - -## Properties - -### proofPurpose - -• **proofPurpose**: `string` - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:34 - -___ - -### proofValue - -• **proofValue**: `string` - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:35 - -___ - -### type - -• **type**: `string` - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:32 - -___ - -### verificationMethod - -• **verificationMethod**: `string` - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:33 diff --git a/docs/api/verida-js/interfaces/verida_did_client._internal_.Resolvable.md b/docs/api/verida-js/interfaces/verida_did_client._internal_.Resolvable.md deleted file mode 100644 index cf86397..0000000 --- a/docs/api/verida-js/interfaces/verida_did_client._internal_.Resolvable.md +++ /dev/null @@ -1,38 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/did-client](../modules/verida_did_client.md) / [](../modules/verida_did_client._internal_.md) / Resolvable - -# Interface: Resolvable - -[@verida/did-client](../modules/verida_did_client.md).[](../modules/verida_did_client._internal_.md).Resolvable - -The method signature implemented by this resolver. - -## Implemented by - -- [`Resolver`](../classes/verida_did_client._internal_.Resolver.md) - -## Table of contents - -### Methods - -- [resolve](verida_did_client._internal_.Resolvable.md#resolve) - -## Methods - -### resolve - -▸ **resolve**(`didUrl`, `options?`): `Promise`<[`DIDResolutionResult`](verida_did_client._internal_.DIDResolutionResult.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `didUrl` | `string` | -| `options?` | [`DIDResolutionOptions`](verida_did_client._internal_.DIDResolutionOptions.md) | - -#### Returns - -`Promise`<[`DIDResolutionResult`](verida_did_client._internal_.DIDResolutionResult.md)\> - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:189 diff --git a/docs/api/verida-js/interfaces/verida_did_client._internal_.ResolverOptions.md b/docs/api/verida-js/interfaces/verida_did_client._internal_.ResolverOptions.md deleted file mode 100644 index 9313f18..0000000 --- a/docs/api/verida-js/interfaces/verida_did_client._internal_.ResolverOptions.md +++ /dev/null @@ -1,32 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/did-client](../modules/verida_did_client.md) / [](../modules/verida_did_client._internal_.md) / ResolverOptions - -# Interface: ResolverOptions - -[@verida/did-client](../modules/verida_did_client.md).[](../modules/verida_did_client._internal_.md).ResolverOptions - -## Table of contents - -### Properties - -- [cache](verida_did_client._internal_.ResolverOptions.md#cache) -- [legacyResolvers](verida_did_client._internal_.ResolverOptions.md#legacyresolvers) - -## Properties - -### cache - -• `Optional` **cache**: `boolean` \| [`DIDCache`](../modules/verida_did_client._internal_.md#didcache) - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:172 - -___ - -### legacyResolvers - -• `Optional` **legacyResolvers**: [`LegacyResolverRegistry`](verida_did_client._internal_.LegacyResolverRegistry.md) - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:173 diff --git a/docs/api/verida-js/interfaces/verida_did_client._internal_.SecureContextEndpoint.md b/docs/api/verida-js/interfaces/verida_did_client._internal_.SecureContextEndpoint.md deleted file mode 100644 index 1f12d80..0000000 --- a/docs/api/verida-js/interfaces/verida_did_client._internal_.SecureContextEndpoint.md +++ /dev/null @@ -1,43 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/did-client](../modules/verida_did_client.md) / [](../modules/verida_did_client._internal_.md) / SecureContextEndpoint - -# Interface: SecureContextEndpoint - -[@verida/did-client](../modules/verida_did_client.md).[](../modules/verida_did_client._internal_.md).SecureContextEndpoint - -## Table of contents - -### Properties - -- [config](verida_did_client._internal_.SecureContextEndpoint.md#config) -- [endpointUri](verida_did_client._internal_.SecureContextEndpoint.md#endpointuri) -- [type](verida_did_client._internal_.SecureContextEndpoint.md#type) - -## Properties - -### config - -• `Optional` **config**: `object` - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:5 - -___ - -### endpointUri - -• **endpointUri**: [`ServiceEndpoint`](../modules/verida_did_client._internal_.md#serviceendpoint)[] - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:4 - -___ - -### type - -• **type**: `string` - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:3 diff --git a/docs/api/verida-js/interfaces/verida_did_client._internal_.SecureContextEndpoints.md b/docs/api/verida-js/interfaces/verida_did_client._internal_.SecureContextEndpoints.md deleted file mode 100644 index 9a0c283..0000000 --- a/docs/api/verida-js/interfaces/verida_did_client._internal_.SecureContextEndpoints.md +++ /dev/null @@ -1,54 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/did-client](../modules/verida_did_client.md) / [](../modules/verida_did_client._internal_.md) / SecureContextEndpoints - -# Interface: SecureContextEndpoints - -[@verida/did-client](../modules/verida_did_client.md).[](../modules/verida_did_client._internal_.md).SecureContextEndpoints - -## Table of contents - -### Properties - -- [database](verida_did_client._internal_.SecureContextEndpoints.md#database) -- [messaging](verida_did_client._internal_.SecureContextEndpoints.md#messaging) -- [notification](verida_did_client._internal_.SecureContextEndpoints.md#notification) -- [storage](verida_did_client._internal_.SecureContextEndpoints.md#storage) - -## Properties - -### database - -• **database**: [`SecureContextEndpoint`](verida_did_client._internal_.SecureContextEndpoint.md) - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:8 - -___ - -### messaging - -• **messaging**: [`SecureContextEndpoint`](verida_did_client._internal_.SecureContextEndpoint.md) - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:9 - -___ - -### notification - -• `Optional` **notification**: [`SecureContextEndpoint`](verida_did_client._internal_.SecureContextEndpoint.md) - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:11 - -___ - -### storage - -• `Optional` **storage**: [`SecureContextEndpoint`](verida_did_client._internal_.SecureContextEndpoint.md) - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:10 diff --git a/docs/api/verida-js/interfaces/verida_did_client._internal_.Service.md b/docs/api/verida-js/interfaces/verida_did_client._internal_.Service.md deleted file mode 100644 index 343055f..0000000 --- a/docs/api/verida-js/interfaces/verida_did_client._internal_.Service.md +++ /dev/null @@ -1,53 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/did-client](../modules/verida_did_client.md) / [](../modules/verida_did_client._internal_.md) / Service - -# Interface: Service - -[@verida/did-client](../modules/verida_did_client.md).[](../modules/verida_did_client._internal_.md).Service - -Represents a Service entry in a [DID document](https://www.w3.org/TR/did-core/#did-document-properties). - -**`see`** [https://www.w3.org/TR/did-core/#services](https://www.w3.org/TR/did-core/#services) - -**`see`** [https://www.w3.org/TR/did-core/#service-properties](https://www.w3.org/TR/did-core/#service-properties) - -## Indexable - -▪ [x: `string`]: `any` - -## Table of contents - -### Properties - -- [id](verida_did_client._internal_.Service.md#id) -- [serviceEndpoint](verida_did_client._internal_.Service.md#serviceendpoint) -- [type](verida_did_client._internal_.Service.md#type) - -## Properties - -### id - -• **id**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:81 - -___ - -### serviceEndpoint - -• **serviceEndpoint**: [`ServiceEndpoint`](../modules/verida_did_client._internal_.md#serviceendpoint) \| [`ServiceEndpoint`](../modules/verida_did_client._internal_.md#serviceendpoint)[] - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:83 - -___ - -### type - -• **type**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:82 diff --git a/docs/api/verida-js/interfaces/verida_did_client._internal_.ServiceEndpoint.md b/docs/api/verida-js/interfaces/verida_did_client._internal_.ServiceEndpoint.md deleted file mode 100644 index 5586e0e..0000000 --- a/docs/api/verida-js/interfaces/verida_did_client._internal_.ServiceEndpoint.md +++ /dev/null @@ -1,54 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/did-client](../modules/verida_did_client.md) / [](../modules/verida_did_client._internal_.md) / ServiceEndpoint - -# Interface: ServiceEndpoint - -[@verida/did-client](../modules/verida_did_client.md).[](../modules/verida_did_client._internal_.md).ServiceEndpoint - -## Table of contents - -### Properties - -- [description](verida_did_client._internal_.ServiceEndpoint.md#description) -- [id](verida_did_client._internal_.ServiceEndpoint.md#id) -- [serviceEndpoint](verida_did_client._internal_.ServiceEndpoint.md#serviceendpoint) -- [type](verida_did_client._internal_.ServiceEndpoint.md#type) - -## Properties - -### description - -• `Optional` **description**: `string` - -#### Defined in - -packages/did-document/node_modules/did-resolver/lib/resolver.d.ts:43 - -___ - -### id - -• **id**: `string` - -#### Defined in - -packages/did-document/node_modules/did-resolver/lib/resolver.d.ts:40 - -___ - -### serviceEndpoint - -• **serviceEndpoint**: `string` - -#### Defined in - -packages/did-document/node_modules/did-resolver/lib/resolver.d.ts:42 - -___ - -### type - -• **type**: `string` - -#### Defined in - -packages/did-document/node_modules/did-resolver/lib/resolver.d.ts:41 diff --git a/docs/api/verida-js/interfaces/verida_did_client._internal_.Transaction.md b/docs/api/verida-js/interfaces/verida_did_client._internal_.Transaction.md deleted file mode 100644 index 3cbf160..0000000 --- a/docs/api/verida-js/interfaces/verida_did_client._internal_.Transaction.md +++ /dev/null @@ -1,192 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/did-client](../modules/verida_did_client.md) / [](../modules/verida_did_client._internal_.md) / Transaction - -# Interface: Transaction - -[@verida/did-client](../modules/verida_did_client.md).[](../modules/verida_did_client._internal_.md).Transaction - -## Hierarchy - -- **`Transaction`** - - ↳ [`TransactionResponse`](verida_did_client._internal_.TransactionResponse.md) - -## Table of contents - -### Properties - -- [accessList](verida_did_client._internal_.Transaction.md#accesslist) -- [chainId](verida_did_client._internal_.Transaction.md#chainid) -- [data](verida_did_client._internal_.Transaction.md#data) -- [from](verida_did_client._internal_.Transaction.md#from) -- [gasLimit](verida_did_client._internal_.Transaction.md#gaslimit) -- [gasPrice](verida_did_client._internal_.Transaction.md#gasprice) -- [hash](verida_did_client._internal_.Transaction.md#hash) -- [maxFeePerGas](verida_did_client._internal_.Transaction.md#maxfeepergas) -- [maxPriorityFeePerGas](verida_did_client._internal_.Transaction.md#maxpriorityfeepergas) -- [nonce](verida_did_client._internal_.Transaction.md#nonce) -- [r](verida_did_client._internal_.Transaction.md#r) -- [s](verida_did_client._internal_.Transaction.md#s) -- [to](verida_did_client._internal_.Transaction.md#to) -- [type](verida_did_client._internal_.Transaction.md#type) -- [v](verida_did_client._internal_.Transaction.md#v) -- [value](verida_did_client._internal_.Transaction.md#value) - -## Properties - -### accessList - -• `Optional` **accessList**: [`AccessList`](../modules/verida_did_client._internal_.md#accesslist) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:40 - -___ - -### chainId - -• **chainId**: `number` - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:35 - -___ - -### data - -• **data**: `string` - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:33 - -___ - -### from - -• `Optional` **from**: `string` - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:29 - -___ - -### gasLimit - -• **gasLimit**: [`BigNumber`](../classes/verida_did_client._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:31 - -___ - -### gasPrice - -• `Optional` **gasPrice**: [`BigNumber`](../classes/verida_did_client._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:32 - -___ - -### hash - -• `Optional` **hash**: `string` - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:27 - -___ - -### maxFeePerGas - -• `Optional` **maxFeePerGas**: [`BigNumber`](../classes/verida_did_client._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:42 - -___ - -### maxPriorityFeePerGas - -• `Optional` **maxPriorityFeePerGas**: [`BigNumber`](../classes/verida_did_client._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:41 - -___ - -### nonce - -• **nonce**: `number` - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:30 - -___ - -### r - -• `Optional` **r**: `string` - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:36 - -___ - -### s - -• `Optional` **s**: `string` - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:37 - -___ - -### to - -• `Optional` **to**: `string` - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:28 - -___ - -### type - -• `Optional` **type**: ``null`` \| `number` - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:39 - -___ - -### v - -• `Optional` **v**: `number` - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:38 - -___ - -### value - -• **value**: [`BigNumber`](../classes/verida_did_client._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:34 diff --git a/docs/api/verida-js/interfaces/verida_did_client._internal_.TransactionReceipt.md b/docs/api/verida-js/interfaces/verida_did_client._internal_.TransactionReceipt.md deleted file mode 100644 index f274cbd..0000000 --- a/docs/api/verida-js/interfaces/verida_did_client._internal_.TransactionReceipt.md +++ /dev/null @@ -1,197 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/did-client](../modules/verida_did_client.md) / [](../modules/verida_did_client._internal_.md) / TransactionReceipt - -# Interface: TransactionReceipt - -[@verida/did-client](../modules/verida_did_client.md).[](../modules/verida_did_client._internal_.md).TransactionReceipt - -## Table of contents - -### Properties - -- [blockHash](verida_did_client._internal_.TransactionReceipt.md#blockhash) -- [blockNumber](verida_did_client._internal_.TransactionReceipt.md#blocknumber) -- [byzantium](verida_did_client._internal_.TransactionReceipt.md#byzantium) -- [confirmations](verida_did_client._internal_.TransactionReceipt.md#confirmations) -- [contractAddress](verida_did_client._internal_.TransactionReceipt.md#contractaddress) -- [cumulativeGasUsed](verida_did_client._internal_.TransactionReceipt.md#cumulativegasused) -- [effectiveGasPrice](verida_did_client._internal_.TransactionReceipt.md#effectivegasprice) -- [from](verida_did_client._internal_.TransactionReceipt.md#from) -- [gasUsed](verida_did_client._internal_.TransactionReceipt.md#gasused) -- [logs](verida_did_client._internal_.TransactionReceipt.md#logs) -- [logsBloom](verida_did_client._internal_.TransactionReceipt.md#logsbloom) -- [root](verida_did_client._internal_.TransactionReceipt.md#root) -- [status](verida_did_client._internal_.TransactionReceipt.md#status) -- [to](verida_did_client._internal_.TransactionReceipt.md#to) -- [transactionHash](verida_did_client._internal_.TransactionReceipt.md#transactionhash) -- [transactionIndex](verida_did_client._internal_.TransactionReceipt.md#transactionindex) -- [type](verida_did_client._internal_.TransactionReceipt.md#type) - -## Properties - -### blockHash - -• **blockHash**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:73 - -___ - -### blockNumber - -• **blockNumber**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:76 - -___ - -### byzantium - -• **byzantium**: `boolean` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:80 - -___ - -### confirmations - -• **confirmations**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:77 - -___ - -### contractAddress - -• **contractAddress**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:68 - -___ - -### cumulativeGasUsed - -• **cumulativeGasUsed**: [`BigNumber`](../classes/verida_did_client._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:78 - -___ - -### effectiveGasPrice - -• **effectiveGasPrice**: [`BigNumber`](../classes/verida_did_client._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:79 - -___ - -### from - -• **from**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:67 - -___ - -### gasUsed - -• **gasUsed**: [`BigNumber`](../classes/verida_did_client._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:71 - -___ - -### logs - -• **logs**: [`Log`](verida_did_client._internal_.Log.md)[] - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:75 - -___ - -### logsBloom - -• **logsBloom**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:72 - -___ - -### root - -• `Optional` **root**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:70 - -___ - -### status - -• `Optional` **status**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:82 - -___ - -### to - -• **to**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:66 - -___ - -### transactionHash - -• **transactionHash**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:74 - -___ - -### transactionIndex - -• **transactionIndex**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:69 - -___ - -### type - -• **type**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:81 diff --git a/docs/api/verida-js/interfaces/verida_did_client._internal_.TransactionResponse.md b/docs/api/verida-js/interfaces/verida_did_client._internal_.TransactionResponse.md deleted file mode 100644 index 7f81923..0000000 --- a/docs/api/verida-js/interfaces/verida_did_client._internal_.TransactionResponse.md +++ /dev/null @@ -1,335 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/did-client](../modules/verida_did_client.md) / [](../modules/verida_did_client._internal_.md) / TransactionResponse - -# Interface: TransactionResponse - -[@verida/did-client](../modules/verida_did_client.md).[](../modules/verida_did_client._internal_.md).TransactionResponse - -## Hierarchy - -- [`Transaction`](verida_did_client._internal_.Transaction.md) - - ↳ **`TransactionResponse`** - -## Table of contents - -### Properties - -- [accessList](verida_did_client._internal_.TransactionResponse.md#accesslist) -- [blockHash](verida_did_client._internal_.TransactionResponse.md#blockhash) -- [blockNumber](verida_did_client._internal_.TransactionResponse.md#blocknumber) -- [chainId](verida_did_client._internal_.TransactionResponse.md#chainid) -- [confirmations](verida_did_client._internal_.TransactionResponse.md#confirmations) -- [data](verida_did_client._internal_.TransactionResponse.md#data) -- [from](verida_did_client._internal_.TransactionResponse.md#from) -- [gasLimit](verida_did_client._internal_.TransactionResponse.md#gaslimit) -- [gasPrice](verida_did_client._internal_.TransactionResponse.md#gasprice) -- [hash](verida_did_client._internal_.TransactionResponse.md#hash) -- [maxFeePerGas](verida_did_client._internal_.TransactionResponse.md#maxfeepergas) -- [maxPriorityFeePerGas](verida_did_client._internal_.TransactionResponse.md#maxpriorityfeepergas) -- [nonce](verida_did_client._internal_.TransactionResponse.md#nonce) -- [r](verida_did_client._internal_.TransactionResponse.md#r) -- [raw](verida_did_client._internal_.TransactionResponse.md#raw) -- [s](verida_did_client._internal_.TransactionResponse.md#s) -- [timestamp](verida_did_client._internal_.TransactionResponse.md#timestamp) -- [to](verida_did_client._internal_.TransactionResponse.md#to) -- [type](verida_did_client._internal_.TransactionResponse.md#type) -- [v](verida_did_client._internal_.TransactionResponse.md#v) -- [value](verida_did_client._internal_.TransactionResponse.md#value) - -### Methods - -- [wait](verida_did_client._internal_.TransactionResponse.md#wait) - -## Properties - -### accessList - -• `Optional` **accessList**: [`AccessList`](../modules/verida_did_client._internal_.md#accesslist) - -#### Inherited from - -[Transaction](verida_did_client._internal_.Transaction.md).[accessList](verida_did_client._internal_.Transaction.md#accesslist) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:40 - -___ - -### blockHash - -• `Optional` **blockHash**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:26 - -___ - -### blockNumber - -• `Optional` **blockNumber**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:25 - -___ - -### chainId - -• **chainId**: `number` - -#### Inherited from - -[Transaction](verida_did_client._internal_.Transaction.md).[chainId](verida_did_client._internal_.Transaction.md#chainid) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:35 - -___ - -### confirmations - -• **confirmations**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:28 - -___ - -### data - -• **data**: `string` - -#### Inherited from - -[Transaction](verida_did_client._internal_.Transaction.md).[data](verida_did_client._internal_.Transaction.md#data) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:33 - -___ - -### from - -• **from**: `string` - -#### Overrides - -[Transaction](verida_did_client._internal_.Transaction.md).[from](verida_did_client._internal_.Transaction.md#from) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:29 - -___ - -### gasLimit - -• **gasLimit**: [`BigNumber`](../classes/verida_did_client._internal_.BigNumber.md) - -#### Inherited from - -[Transaction](verida_did_client._internal_.Transaction.md).[gasLimit](verida_did_client._internal_.Transaction.md#gaslimit) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:31 - -___ - -### gasPrice - -• `Optional` **gasPrice**: [`BigNumber`](../classes/verida_did_client._internal_.BigNumber.md) - -#### Inherited from - -[Transaction](verida_did_client._internal_.Transaction.md).[gasPrice](verida_did_client._internal_.Transaction.md#gasprice) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:32 - -___ - -### hash - -• **hash**: `string` - -#### Overrides - -[Transaction](verida_did_client._internal_.Transaction.md).[hash](verida_did_client._internal_.Transaction.md#hash) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:24 - -___ - -### maxFeePerGas - -• `Optional` **maxFeePerGas**: [`BigNumber`](../classes/verida_did_client._internal_.BigNumber.md) - -#### Inherited from - -[Transaction](verida_did_client._internal_.Transaction.md).[maxFeePerGas](verida_did_client._internal_.Transaction.md#maxfeepergas) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:42 - -___ - -### maxPriorityFeePerGas - -• `Optional` **maxPriorityFeePerGas**: [`BigNumber`](../classes/verida_did_client._internal_.BigNumber.md) - -#### Inherited from - -[Transaction](verida_did_client._internal_.Transaction.md).[maxPriorityFeePerGas](verida_did_client._internal_.Transaction.md#maxpriorityfeepergas) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:41 - -___ - -### nonce - -• **nonce**: `number` - -#### Inherited from - -[Transaction](verida_did_client._internal_.Transaction.md).[nonce](verida_did_client._internal_.Transaction.md#nonce) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:30 - -___ - -### r - -• `Optional` **r**: `string` - -#### Inherited from - -[Transaction](verida_did_client._internal_.Transaction.md).[r](verida_did_client._internal_.Transaction.md#r) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:36 - -___ - -### raw - -• `Optional` **raw**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:30 - -___ - -### s - -• `Optional` **s**: `string` - -#### Inherited from - -[Transaction](verida_did_client._internal_.Transaction.md).[s](verida_did_client._internal_.Transaction.md#s) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:37 - -___ - -### timestamp - -• `Optional` **timestamp**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:27 - -___ - -### to - -• `Optional` **to**: `string` - -#### Inherited from - -[Transaction](verida_did_client._internal_.Transaction.md).[to](verida_did_client._internal_.Transaction.md#to) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:28 - -___ - -### type - -• `Optional` **type**: ``null`` \| `number` - -#### Inherited from - -[Transaction](verida_did_client._internal_.Transaction.md).[type](verida_did_client._internal_.Transaction.md#type) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:39 - -___ - -### v - -• `Optional` **v**: `number` - -#### Inherited from - -[Transaction](verida_did_client._internal_.Transaction.md).[v](verida_did_client._internal_.Transaction.md#v) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:38 - -___ - -### value - -• **value**: [`BigNumber`](../classes/verida_did_client._internal_.BigNumber.md) - -#### Inherited from - -[Transaction](verida_did_client._internal_.Transaction.md).[value](verida_did_client._internal_.Transaction.md#value) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:34 - -## Methods - -### wait - -▸ **wait**(`confirmations?`): `Promise`<[`TransactionReceipt`](verida_did_client._internal_.TransactionReceipt.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `confirmations?` | `number` | - -#### Returns - -`Promise`<[`TransactionReceipt`](verida_did_client._internal_.TransactionReceipt.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:31 diff --git a/docs/api/verida-js/interfaces/verida_did_client._internal_.VdaDidConfigurationOptions.md b/docs/api/verida-js/interfaces/verida_did_client._internal_.VdaDidConfigurationOptions.md deleted file mode 100644 index 836a408..0000000 --- a/docs/api/verida-js/interfaces/verida_did_client._internal_.VdaDidConfigurationOptions.md +++ /dev/null @@ -1,105 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/did-client](../modules/verida_did_client.md) / [](../modules/verida_did_client._internal_.md) / VdaDidConfigurationOptions - -# Interface: VdaDidConfigurationOptions - -[@verida/did-client](../modules/verida_did_client.md).[](../modules/verida_did_client._internal_.md).VdaDidConfigurationOptions - -Interface for VDA-DID instance creation. - -`signKey` or `signer` must be provided - -**`param`** DID - -**`param`** private key of DID's controller. Used to generate signature in transactions to chains - -**`param`** Signing function that accepts a private key and returns a signature in hex format - -**`param`** Target chain name or chain id. - -**`param`** : VDA-DID run mode. Values from vda-did-resolver - -**`param`** Web3 configuration depending on call type. Values from vda-did-resolver - -## Table of contents - -### Properties - -- [callType](verida_did_client._internal_.VdaDidConfigurationOptions.md#calltype) -- [chainNameOrId](verida_did_client._internal_.VdaDidConfigurationOptions.md#chainnameorid) -- [identifier](verida_did_client._internal_.VdaDidConfigurationOptions.md#identifier) -- [signKey](verida_did_client._internal_.VdaDidConfigurationOptions.md#signkey) -- [web3Options](verida_did_client._internal_.VdaDidConfigurationOptions.md#web3options) - -### Methods - -- [signer](verida_did_client._internal_.VdaDidConfigurationOptions.md#signer) - -## Properties - -### callType - -• **callType**: [`Web3CallType`](../modules/verida_did_client._internal_.md#web3calltype) - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:106 - -___ - -### chainNameOrId - -• `Optional` **chainNameOrId**: `string` \| `number` - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:105 - -___ - -### identifier - -• **identifier**: `string` - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:102 - -___ - -### signKey - -• `Optional` **signKey**: `string` - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:103 - -___ - -### web3Options - -• **web3Options**: [`VeridaWeb3ConfigurationOptions`](../modules/verida_did_client._internal_.md#veridaweb3configurationoptions) - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:107 - -## Methods - -### signer - -▸ `Optional` **signer**(`data`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `any` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:104 diff --git a/docs/api/verida-js/interfaces/verida_did_client._internal_.VdaDidEndpointResponse.md b/docs/api/verida-js/interfaces/verida_did_client._internal_.VdaDidEndpointResponse.md deleted file mode 100644 index b39e4fe..0000000 --- a/docs/api/verida-js/interfaces/verida_did_client._internal_.VdaDidEndpointResponse.md +++ /dev/null @@ -1,32 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/did-client](../modules/verida_did_client.md) / [](../modules/verida_did_client._internal_.md) / VdaDidEndpointResponse - -# Interface: VdaDidEndpointResponse - -[@verida/did-client](../modules/verida_did_client.md).[](../modules/verida_did_client._internal_.md).VdaDidEndpointResponse - -## Table of contents - -### Properties - -- [message](verida_did_client._internal_.VdaDidEndpointResponse.md#message) -- [status](verida_did_client._internal_.VdaDidEndpointResponse.md#status) - -## Properties - -### message - -• `Optional` **message**: `string` - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:111 - -___ - -### status - -• **status**: ``"success"`` \| ``"fail"`` - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:110 diff --git a/docs/api/verida-js/interfaces/verida_did_client._internal_.VeridaDocInterface.md b/docs/api/verida-js/interfaces/verida_did_client._internal_.VeridaDocInterface.md deleted file mode 100644 index 7e3dd4e..0000000 --- a/docs/api/verida-js/interfaces/verida_did_client._internal_.VeridaDocInterface.md +++ /dev/null @@ -1,233 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/did-client](../modules/verida_did_client.md) / [](../modules/verida_did_client._internal_.md) / VeridaDocInterface - -# Interface: VeridaDocInterface - -[@verida/did-client](../modules/verida_did_client.md).[](../modules/verida_did_client._internal_.md).VeridaDocInterface - -## Hierarchy - -- [`DIDDocument`](../modules/verida_did_client._internal_.md#diddocument) - - ↳ **`VeridaDocInterface`** - -## Table of contents - -### Properties - -- [@context](verida_did_client._internal_.VeridaDocInterface.md#@context) -- [alsoKnownAs](verida_did_client._internal_.VeridaDocInterface.md#alsoknownas) -- [assertionMethod](verida_did_client._internal_.VeridaDocInterface.md#assertionmethod) -- [authentication](verida_did_client._internal_.VeridaDocInterface.md#authentication) -- [capabilityDelegation](verida_did_client._internal_.VeridaDocInterface.md#capabilitydelegation) -- [capabilityInvocation](verida_did_client._internal_.VeridaDocInterface.md#capabilityinvocation) -- [controller](verida_did_client._internal_.VeridaDocInterface.md#controller) -- [created](verida_did_client._internal_.VeridaDocInterface.md#created) -- [deactivated](verida_did_client._internal_.VeridaDocInterface.md#deactivated) -- [id](verida_did_client._internal_.VeridaDocInterface.md#id) -- [keyAgreement](verida_did_client._internal_.VeridaDocInterface.md#keyagreement) -- [proof](verida_did_client._internal_.VeridaDocInterface.md#proof) -- [publicKey](verida_did_client._internal_.VeridaDocInterface.md#publickey) -- [service](verida_did_client._internal_.VeridaDocInterface.md#service) -- [updated](verida_did_client._internal_.VeridaDocInterface.md#updated) -- [verificationMethod](verida_did_client._internal_.VeridaDocInterface.md#verificationmethod) -- [versionId](verida_did_client._internal_.VeridaDocInterface.md#versionid) - -## Properties - -### @context - -• `Optional` **@context**: `string` \| `string`[] - -#### Inherited from - -DocInterface.@context - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:61 - -___ - -### alsoKnownAs - -• `Optional` **alsoKnownAs**: `string`[] - -#### Inherited from - -DocInterface.alsoKnownAs - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:63 - -___ - -### assertionMethod - -• **assertionMethod**: `undefined` \| (`string` \| [`VerificationMethod`](verida_did_client._internal_.VerificationMethod.md))[] - -#### Inherited from - -DocInterface.assertionMethod - -___ - -### authentication - -• **authentication**: `undefined` \| (`string` \| [`VerificationMethod`](verida_did_client._internal_.VerificationMethod.md))[] - -#### Inherited from - -DocInterface.authentication - -___ - -### capabilityDelegation - -• **capabilityDelegation**: `undefined` \| (`string` \| [`VerificationMethod`](verida_did_client._internal_.VerificationMethod.md))[] - -#### Inherited from - -DocInterface.capabilityDelegation - -___ - -### capabilityInvocation - -• **capabilityInvocation**: `undefined` \| (`string` \| [`VerificationMethod`](verida_did_client._internal_.VerificationMethod.md))[] - -#### Inherited from - -DocInterface.capabilityInvocation - -___ - -### controller - -• `Optional` **controller**: `string` \| `string`[] - -#### Inherited from - -DocInterface.controller - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:64 - -___ - -### created - -• `Optional` **created**: `string` - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:39 - -___ - -### deactivated - -• `Optional` **deactivated**: `string` - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:41 - -___ - -### id - -• **id**: `string` - -#### Inherited from - -DocInterface.id - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:62 - -___ - -### keyAgreement - -• **keyAgreement**: `undefined` \| (`string` \| [`VerificationMethod`](verida_did_client._internal_.VerificationMethod.md))[] - -#### Inherited from - -DocInterface.keyAgreement - -___ - -### proof - -• `Optional` **proof**: [`ProofInterface`](verida_did_client._internal_.ProofInterface.md) - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:42 - -___ - -### publicKey - -• `Optional` **publicKey**: [`VerificationMethod`](verida_did_client._internal_.VerificationMethod.md)[] - -**`deprecated`** - -#### Inherited from - -DocInterface.publicKey - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:70 - -___ - -### service - -• `Optional` **service**: [`Service`](verida_did_client._internal_.Service.md)[] - -#### Inherited from - -DocInterface.service - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:66 - -___ - -### updated - -• `Optional` **updated**: `string` - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:40 - -___ - -### verificationMethod - -• `Optional` **verificationMethod**: [`VerificationMethod`](verida_did_client._internal_.VerificationMethod.md)[] - -#### Inherited from - -DocInterface.verificationMethod - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:65 - -___ - -### versionId - -• **versionId**: `number` - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:38 diff --git a/docs/api/verida-js/interfaces/verida_did_client._internal_.VerificationMethod.md b/docs/api/verida-js/interfaces/verida_did_client._internal_.VerificationMethod.md deleted file mode 100644 index 072cf09..0000000 --- a/docs/api/verida-js/interfaces/verida_did_client._internal_.VerificationMethod.md +++ /dev/null @@ -1,129 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/did-client](../modules/verida_did_client.md) / [](../modules/verida_did_client._internal_.md) / VerificationMethod - -# Interface: VerificationMethod - -[@verida/did-client](../modules/verida_did_client.md).[](../modules/verida_did_client._internal_.md).VerificationMethod - -Represents the properties of a Verification Method listed in a DID document. - -This data type includes public key representations that are no longer present in the spec but are still used by -several DID methods / resolvers and kept for backward compatibility. - -**`see`** [https://www.w3.org/TR/did-core/#verification-methods](https://www.w3.org/TR/did-core/#verification-methods) - -**`see`** [https://www.w3.org/TR/did-core/#verification-method-properties](https://www.w3.org/TR/did-core/#verification-method-properties) - -## Table of contents - -### Properties - -- [blockchainAccountId](verida_did_client._internal_.VerificationMethod.md#blockchainaccountid) -- [controller](verida_did_client._internal_.VerificationMethod.md#controller) -- [ethereumAddress](verida_did_client._internal_.VerificationMethod.md#ethereumaddress) -- [id](verida_did_client._internal_.VerificationMethod.md#id) -- [publicKeyBase58](verida_did_client._internal_.VerificationMethod.md#publickeybase58) -- [publicKeyBase64](verida_did_client._internal_.VerificationMethod.md#publickeybase64) -- [publicKeyHex](verida_did_client._internal_.VerificationMethod.md#publickeyhex) -- [publicKeyJwk](verida_did_client._internal_.VerificationMethod.md#publickeyjwk) -- [publicKeyMultibase](verida_did_client._internal_.VerificationMethod.md#publickeymultibase) -- [type](verida_did_client._internal_.VerificationMethod.md#type) - -## Properties - -### blockchainAccountId - -• `Optional` **blockchainAccountId**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:133 - -___ - -### controller - -• **controller**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:127 - -___ - -### ethereumAddress - -• `Optional` **ethereumAddress**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:134 - -___ - -### id - -• **id**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:125 - -___ - -### publicKeyBase58 - -• `Optional` **publicKeyBase58**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:128 - -___ - -### publicKeyBase64 - -• `Optional` **publicKeyBase64**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:129 - -___ - -### publicKeyHex - -• `Optional` **publicKeyHex**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:131 - -___ - -### publicKeyJwk - -• `Optional` **publicKeyJwk**: [`JsonWebKey`](verida_did_client._internal_.JsonWebKey.md) - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:130 - -___ - -### publicKeyMultibase - -• `Optional` **publicKeyMultibase**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:132 - -___ - -### type - -• **type**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:126 diff --git a/docs/api/verida-js/interfaces/verida_did_client._internal_.Web3GasConfiguration.md b/docs/api/verida-js/interfaces/verida_did_client._internal_.Web3GasConfiguration.md deleted file mode 100644 index a0c3ab3..0000000 --- a/docs/api/verida-js/interfaces/verida_did_client._internal_.Web3GasConfiguration.md +++ /dev/null @@ -1,91 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/did-client](../modules/verida_did_client.md) / [](../modules/verida_did_client._internal_.md) / Web3GasConfiguration - -# Interface: Web3GasConfiguration - -[@verida/did-client](../modules/verida_did_client.md).[](../modules/verida_did_client._internal_.md).Web3GasConfiguration - -Gas configuration - -eip1559Mode - optional - Once this parameter is set, all other parameters are not used. Gas information is pulled from network. - -maxFeePerGas - optional - Used for EIP1559 chains -maxPriorityFeePerGas - optional - Used for EIP1559 chains -gasLimit - optional - Used for non EIP1559 chains -gasPrice - optional - Used for non EIP1559 chains - -## Hierarchy - -- **`Web3GasConfiguration`** - - ↳ [`Web3SelfTransactionConfig`](verida_did_client._internal_.Web3SelfTransactionConfig.md) - -## Table of contents - -### Properties - -- [eip1559Mode](verida_did_client._internal_.Web3GasConfiguration.md#eip1559mode) -- [eip1559gasStationUrl](verida_did_client._internal_.Web3GasConfiguration.md#eip1559gasstationurl) -- [gasLimit](verida_did_client._internal_.Web3GasConfiguration.md#gaslimit) -- [gasPrice](verida_did_client._internal_.Web3GasConfiguration.md#gasprice) -- [maxFeePerGas](verida_did_client._internal_.Web3GasConfiguration.md#maxfeepergas) -- [maxPriorityFeePerGas](verida_did_client._internal_.Web3GasConfiguration.md#maxpriorityfeepergas) - -## Properties - -### eip1559Mode - -• `Optional` **eip1559Mode**: [`EIP1559GasMode`](../modules/verida_did_client._internal_.md#eip1559gasmode) - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:24 - -___ - -### eip1559gasStationUrl - -• `Optional` **eip1559gasStationUrl**: `string` - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:25 - -___ - -### gasLimit - -• `Optional` **gasLimit**: [`BigNumber`](../classes/verida_did_client._internal_.BigNumber.md) - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:28 - -___ - -### gasPrice - -• `Optional` **gasPrice**: [`BigNumber`](../classes/verida_did_client._internal_.BigNumber.md) - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:29 - -___ - -### maxFeePerGas - -• `Optional` **maxFeePerGas**: [`BigNumber`](../classes/verida_did_client._internal_.BigNumber.md) - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:26 - -___ - -### maxPriorityFeePerGas - -• `Optional` **maxPriorityFeePerGas**: [`BigNumber`](../classes/verida_did_client._internal_.BigNumber.md) - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:27 diff --git a/docs/api/verida-js/interfaces/verida_did_client._internal_.Web3GaslessPostConfig.md b/docs/api/verida-js/interfaces/verida_did_client._internal_.Web3GaslessPostConfig.md deleted file mode 100644 index e779aa2..0000000 --- a/docs/api/verida-js/interfaces/verida_did_client._internal_.Web3GaslessPostConfig.md +++ /dev/null @@ -1,37 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/did-client](../modules/verida_did_client.md) / [](../modules/verida_did_client._internal_.md) / Web3GaslessPostConfig - -# Interface: Web3GaslessPostConfig - -[@verida/did-client](../modules/verida_did_client.md).[](../modules/verida_did_client._internal_.md).Web3GaslessPostConfig - -Configuration type for gasless post - -## Indexable - -▪ [key: `string`]: `any` - -## Table of contents - -### Properties - -- [headers](verida_did_client._internal_.Web3GaslessPostConfig.md#headers) - -## Properties - -### headers - -• **headers**: `Object` - -#### Index signature - -▪ [key: `string`]: `any` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `user-agent` | `string` | - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:64 diff --git a/docs/api/verida-js/interfaces/verida_did_client._internal_.Web3GaslessRequestConfig.md b/docs/api/verida-js/interfaces/verida_did_client._internal_.Web3GaslessRequestConfig.md deleted file mode 100644 index e6fad10..0000000 --- a/docs/api/verida-js/interfaces/verida_did_client._internal_.Web3GaslessRequestConfig.md +++ /dev/null @@ -1,37 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/did-client](../modules/verida_did_client.md) / [](../modules/verida_did_client._internal_.md) / Web3GaslessRequestConfig - -# Interface: Web3GaslessRequestConfig - -[@verida/did-client](../modules/verida_did_client.md).[](../modules/verida_did_client._internal_.md).Web3GaslessRequestConfig - -Configuration type for gasless request - -## Indexable - -▪ [key: `string`]: `any` - -## Table of contents - -### Properties - -- [headers](verida_did_client._internal_.Web3GaslessRequestConfig.md#headers) - -## Properties - -### headers - -• **headers**: `Object` - -#### Index signature - -▪ [key: `string`]: `any` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `context-name` | `string` | - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:56 diff --git a/docs/api/verida-js/interfaces/verida_did_client._internal_.Web3MetaTransactionConfig.md b/docs/api/verida-js/interfaces/verida_did_client._internal_.Web3MetaTransactionConfig.md deleted file mode 100644 index 01cdb2f..0000000 --- a/docs/api/verida-js/interfaces/verida_did_client._internal_.Web3MetaTransactionConfig.md +++ /dev/null @@ -1,45 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/did-client](../modules/verida_did_client.md) / [](../modules/verida_did_client._internal_.md) / Web3MetaTransactionConfig - -# Interface: Web3MetaTransactionConfig - -[@verida/did-client](../modules/verida_did_client.md).[](../modules/verida_did_client._internal_.md).Web3MetaTransactionConfig - -Configuration type for gasless mode - -## Table of contents - -### Properties - -- [endpointUrl](verida_did_client._internal_.Web3MetaTransactionConfig.md#endpointurl) -- [postConfig](verida_did_client._internal_.Web3MetaTransactionConfig.md#postconfig) -- [serverConfig](verida_did_client._internal_.Web3MetaTransactionConfig.md#serverconfig) - -## Properties - -### endpointUrl - -• **endpointUrl**: `string` - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:51 - -___ - -### postConfig - -• **postConfig**: [`Web3GaslessPostConfig`](verida_did_client._internal_.Web3GaslessPostConfig.md) - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:50 - -___ - -### serverConfig - -• **serverConfig**: [`Web3GaslessRequestConfig`](verida_did_client._internal_.Web3GaslessRequestConfig.md) - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:49 diff --git a/docs/api/verida-js/interfaces/verida_did_client._internal_.Web3SelfTransactionConfig.md b/docs/api/verida-js/interfaces/verida_did_client._internal_.Web3SelfTransactionConfig.md deleted file mode 100644 index 3eeeaf5..0000000 --- a/docs/api/verida-js/interfaces/verida_did_client._internal_.Web3SelfTransactionConfig.md +++ /dev/null @@ -1,179 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/did-client](../modules/verida_did_client.md) / [](../modules/verida_did_client._internal_.md) / Web3SelfTransactionConfig - -# Interface: Web3SelfTransactionConfig - -[@verida/did-client](../modules/verida_did_client.md).[](../modules/verida_did_client._internal_.md).Web3SelfTransactionConfig - -Configuration type for Web3 mode - -signer - optional - a Signer that sign the blockchain transactions. If a 'signer' is not provided, then 'contract' with an attached signer need to be used to make transactions -provider - optional - a web3 provider. At least one of `signer`,`provider`, or `rpcUrl` is required -rpcUrl - optinal - a JSON-RPC URL that can be used to connect to an ethereum network. At least one of `signer`, `provider`, or `rpcUrl` is required -web3 - optional - Can use provider or web.currentProvider as a provider. - -## Hierarchy - -- [`Web3GasConfiguration`](verida_did_client._internal_.Web3GasConfiguration.md) - - ↳ **`Web3SelfTransactionConfig`** - -## Table of contents - -### Properties - -- [eip1559Mode](verida_did_client._internal_.Web3SelfTransactionConfig.md#eip1559mode) -- [eip1559gasStationUrl](verida_did_client._internal_.Web3SelfTransactionConfig.md#eip1559gasstationurl) -- [gasLimit](verida_did_client._internal_.Web3SelfTransactionConfig.md#gaslimit) -- [gasPrice](verida_did_client._internal_.Web3SelfTransactionConfig.md#gasprice) -- [maxFeePerGas](verida_did_client._internal_.Web3SelfTransactionConfig.md#maxfeepergas) -- [maxPriorityFeePerGas](verida_did_client._internal_.Web3SelfTransactionConfig.md#maxpriorityfeepergas) -- [methodDefaults](verida_did_client._internal_.Web3SelfTransactionConfig.md#methoddefaults) -- [privateKey](verida_did_client._internal_.Web3SelfTransactionConfig.md#privatekey) -- [provider](verida_did_client._internal_.Web3SelfTransactionConfig.md#provider) -- [rpcUrl](verida_did_client._internal_.Web3SelfTransactionConfig.md#rpcurl) -- [signer](verida_did_client._internal_.Web3SelfTransactionConfig.md#signer) -- [web3](verida_did_client._internal_.Web3SelfTransactionConfig.md#web3) - -## Properties - -### eip1559Mode - -• `Optional` **eip1559Mode**: [`EIP1559GasMode`](../modules/verida_did_client._internal_.md#eip1559gasmode) - -#### Inherited from - -[Web3GasConfiguration](verida_did_client._internal_.Web3GasConfiguration.md).[eip1559Mode](verida_did_client._internal_.Web3GasConfiguration.md#eip1559mode) - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:24 - -___ - -### eip1559gasStationUrl - -• `Optional` **eip1559gasStationUrl**: `string` - -#### Inherited from - -[Web3GasConfiguration](verida_did_client._internal_.Web3GasConfiguration.md).[eip1559gasStationUrl](verida_did_client._internal_.Web3GasConfiguration.md#eip1559gasstationurl) - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:25 - -___ - -### gasLimit - -• `Optional` **gasLimit**: [`BigNumber`](../classes/verida_did_client._internal_.BigNumber.md) - -#### Inherited from - -[Web3GasConfiguration](verida_did_client._internal_.Web3GasConfiguration.md).[gasLimit](verida_did_client._internal_.Web3GasConfiguration.md#gaslimit) - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:28 - -___ - -### gasPrice - -• `Optional` **gasPrice**: [`BigNumber`](../classes/verida_did_client._internal_.BigNumber.md) - -#### Inherited from - -[Web3GasConfiguration](verida_did_client._internal_.Web3GasConfiguration.md).[gasPrice](verida_did_client._internal_.Web3GasConfiguration.md#gasprice) - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:29 - -___ - -### maxFeePerGas - -• `Optional` **maxFeePerGas**: [`BigNumber`](../classes/verida_did_client._internal_.BigNumber.md) - -#### Inherited from - -[Web3GasConfiguration](verida_did_client._internal_.Web3GasConfiguration.md).[maxFeePerGas](verida_did_client._internal_.Web3GasConfiguration.md#maxfeepergas) - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:26 - -___ - -### maxPriorityFeePerGas - -• `Optional` **maxPriorityFeePerGas**: [`BigNumber`](../classes/verida_did_client._internal_.BigNumber.md) - -#### Inherited from - -[Web3GasConfiguration](verida_did_client._internal_.Web3GasConfiguration.md).[maxPriorityFeePerGas](verida_did_client._internal_.Web3GasConfiguration.md#maxpriorityfeepergas) - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:27 - -___ - -### methodDefaults - -• `Optional` **methodDefaults**: [`Record`](../modules/verida_did_client._internal_.md#record)<`string`, [`Web3GasConfiguration`](verida_did_client._internal_.Web3GasConfiguration.md)\> - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:45 - -___ - -### privateKey - -• `Optional` **privateKey**: `string` - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:41 - -___ - -### provider - -• `Optional` **provider**: [`Provider`](../classes/verida_did_client._internal_.Provider.md) - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:42 - -___ - -### rpcUrl - -• `Optional` **rpcUrl**: `string` - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:43 - -___ - -### signer - -• `Optional` **signer**: [`Signer`](../classes/verida_did_client._internal_.Signer.md) - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:40 - -___ - -### web3 - -• `Optional` **web3**: `any` - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:44 diff --git a/docs/api/verida-js/interfaces/verida_did_client._internal_.Web3SelfTransactionConfigPart.md b/docs/api/verida-js/interfaces/verida_did_client._internal_.Web3SelfTransactionConfigPart.md deleted file mode 100644 index f07d9ae..0000000 --- a/docs/api/verida-js/interfaces/verida_did_client._internal_.Web3SelfTransactionConfigPart.md +++ /dev/null @@ -1,32 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/did-client](../modules/verida_did_client.md) / [](../modules/verida_did_client._internal_.md) / Web3SelfTransactionConfigPart - -# Interface: Web3SelfTransactionConfigPart - -[@verida/did-client](../modules/verida_did_client.md).[](../modules/verida_did_client._internal_.md).Web3SelfTransactionConfigPart - -## Table of contents - -### Properties - -- [privateKey](verida_did_client._internal_.Web3SelfTransactionConfigPart.md#privatekey) -- [signer](verida_did_client._internal_.Web3SelfTransactionConfigPart.md#signer) - -## Properties - -### privateKey - -• `Optional` **privateKey**: `string` - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:116 - -___ - -### signer - -• `Optional` **signer**: [`Signer`](../classes/verida_did_client._internal_.Signer.md) - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:115 diff --git a/docs/api/verida-js/interfaces/verida_did_client._internal_._Block.md b/docs/api/verida-js/interfaces/verida_did_client._internal_._Block.md deleted file mode 100644 index dc4d609..0000000 --- a/docs/api/verida-js/interfaces/verida_did_client._internal_._Block.md +++ /dev/null @@ -1,150 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/did-client](../modules/verida_did_client.md) / [](../modules/verida_did_client._internal_.md) / \_Block - -# Interface: \_Block - -[@verida/did-client](../modules/verida_did_client.md).[](../modules/verida_did_client._internal_.md)._Block - -## Hierarchy - -- **`_Block`** - - ↳ [`Block`](verida_did_client._internal_.Block.md) - - ↳ [`BlockWithTransactions`](verida_did_client._internal_.BlockWithTransactions.md) - -## Table of contents - -### Properties - -- [\_difficulty](verida_did_client._internal_._Block.md#_difficulty) -- [baseFeePerGas](verida_did_client._internal_._Block.md#basefeepergas) -- [difficulty](verida_did_client._internal_._Block.md#difficulty) -- [extraData](verida_did_client._internal_._Block.md#extradata) -- [gasLimit](verida_did_client._internal_._Block.md#gaslimit) -- [gasUsed](verida_did_client._internal_._Block.md#gasused) -- [hash](verida_did_client._internal_._Block.md#hash) -- [miner](verida_did_client._internal_._Block.md#miner) -- [nonce](verida_did_client._internal_._Block.md#nonce) -- [number](verida_did_client._internal_._Block.md#number) -- [parentHash](verida_did_client._internal_._Block.md#parenthash) -- [timestamp](verida_did_client._internal_._Block.md#timestamp) - -## Properties - -### \_difficulty - -• **\_difficulty**: [`BigNumber`](../classes/verida_did_client._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:41 - -___ - -### baseFeePerGas - -• `Optional` **baseFeePerGas**: ``null`` \| [`BigNumber`](../classes/verida_did_client._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:46 - -___ - -### difficulty - -• **difficulty**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:40 - -___ - -### extraData - -• **extraData**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:45 - -___ - -### gasLimit - -• **gasLimit**: [`BigNumber`](../classes/verida_did_client._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:42 - -___ - -### gasUsed - -• **gasUsed**: [`BigNumber`](../classes/verida_did_client._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:43 - -___ - -### hash - -• **hash**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:35 - -___ - -### miner - -• **miner**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:44 - -___ - -### nonce - -• **nonce**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:39 - -___ - -### number - -• **number**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:37 - -___ - -### parentHash - -• **parentHash**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:36 - -___ - -### timestamp - -• **timestamp**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:38 diff --git a/docs/api/verida-js/interfaces/verida_did_document.Interfaces.DIDDocumentStruct.md b/docs/api/verida-js/interfaces/verida_did_document.Interfaces.DIDDocumentStruct.md deleted file mode 100644 index ef497b2..0000000 --- a/docs/api/verida-js/interfaces/verida_did_document.Interfaces.DIDDocumentStruct.md +++ /dev/null @@ -1,189 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/did-document](../modules/verida_did_document.md) / [Interfaces](../modules/verida_did_document.Interfaces.md) / DIDDocumentStruct - -# Interface: DIDDocumentStruct - -[@verida/did-document](../modules/verida_did_document.md).[Interfaces](../modules/verida_did_document.Interfaces.md).DIDDocumentStruct - -## Hierarchy - -- [`DIDDocument`](../modules/verida_did_document._internal_.md#diddocument) - - ↳ **`DIDDocumentStruct`** - -## Table of contents - -### Properties - -- [@context](verida_did_document.Interfaces.DIDDocumentStruct.md#@context) -- [alsoKnownAs](verida_did_document.Interfaces.DIDDocumentStruct.md#alsoknownas) -- [assertionMethod](verida_did_document.Interfaces.DIDDocumentStruct.md#assertionmethod) -- [authentication](verida_did_document.Interfaces.DIDDocumentStruct.md#authentication) -- [capabilityDelegation](verida_did_document.Interfaces.DIDDocumentStruct.md#capabilitydelegation) -- [capabilityInvocation](verida_did_document.Interfaces.DIDDocumentStruct.md#capabilityinvocation) -- [controller](verida_did_document.Interfaces.DIDDocumentStruct.md#controller) -- [id](verida_did_document.Interfaces.DIDDocumentStruct.md#id) -- [keyAgreement](verida_did_document.Interfaces.DIDDocumentStruct.md#keyagreement) -- [proof](verida_did_document.Interfaces.DIDDocumentStruct.md#proof) -- [publicKey](verida_did_document.Interfaces.DIDDocumentStruct.md#publickey) -- [service](verida_did_document.Interfaces.DIDDocumentStruct.md#service) -- [verificationMethod](verida_did_document.Interfaces.DIDDocumentStruct.md#verificationmethod) - -## Properties - -### @context - -• `Optional` **@context**: `string` \| `string`[] - -#### Inherited from - -DD.@context - -#### Defined in - -packages/did-document/node_modules/did-resolver/lib/resolver.d.ts:26 - -___ - -### alsoKnownAs - -• `Optional` **alsoKnownAs**: `string`[] - -#### Inherited from - -DD.alsoKnownAs - -#### Defined in - -packages/did-document/node_modules/did-resolver/lib/resolver.d.ts:28 - -___ - -### assertionMethod - -• **assertionMethod**: `undefined` \| (`string` \| [`VerificationMethod`](verida_did_document._internal_.VerificationMethod.md))[] - -#### Inherited from - -DD.assertionMethod - -___ - -### authentication - -• **authentication**: `undefined` \| (`string` \| [`VerificationMethod`](verida_did_document._internal_.VerificationMethod.md))[] - -#### Inherited from - -DD.authentication - -___ - -### capabilityDelegation - -• **capabilityDelegation**: `undefined` \| (`string` \| [`VerificationMethod`](verida_did_document._internal_.VerificationMethod.md))[] - -#### Inherited from - -DD.capabilityDelegation - -___ - -### capabilityInvocation - -• **capabilityInvocation**: `undefined` \| (`string` \| [`VerificationMethod`](verida_did_document._internal_.VerificationMethod.md))[] - -#### Inherited from - -DD.capabilityInvocation - -___ - -### controller - -• `Optional` **controller**: `string` \| `string`[] - -#### Inherited from - -DD.controller - -#### Defined in - -packages/did-document/node_modules/did-resolver/lib/resolver.d.ts:29 - -___ - -### id - -• **id**: `string` - -#### Inherited from - -DD.id - -#### Defined in - -packages/did-document/node_modules/did-resolver/lib/resolver.d.ts:27 - -___ - -### keyAgreement - -• **keyAgreement**: `undefined` \| (`string` \| [`VerificationMethod`](verida_did_document._internal_.VerificationMethod.md))[] - -#### Inherited from - -DD.keyAgreement - -___ - -### proof - -• `Optional` **proof**: [`Proof`](verida_did_document.Interfaces.Proof.md) - -#### Defined in - -[packages/did-document/src/interfaces.ts:17](https://github.com/verida/verida-js/blob/c03b336/packages/did-document/src/interfaces.ts#L17) - -___ - -### publicKey - -• `Optional` **publicKey**: [`VerificationMethod`](verida_did_document._internal_.VerificationMethod.md)[] - -**`deprecated`** - -#### Inherited from - -DD.publicKey - -#### Defined in - -packages/did-document/node_modules/did-resolver/lib/resolver.d.ts:35 - -___ - -### service - -• `Optional` **service**: [`ServiceEndpoint`](verida_did_document._internal_.ServiceEndpoint.md)[] - -#### Inherited from - -DD.service - -#### Defined in - -packages/did-document/node_modules/did-resolver/lib/resolver.d.ts:31 - -___ - -### verificationMethod - -• `Optional` **verificationMethod**: [`VerificationMethod`](verida_did_document._internal_.VerificationMethod.md)[] - -#### Inherited from - -DD.verificationMethod - -#### Defined in - -packages/did-document/node_modules/did-resolver/lib/resolver.d.ts:30 diff --git a/docs/api/verida-js/interfaces/verida_did_document.Interfaces.Endpoints.md b/docs/api/verida-js/interfaces/verida_did_document.Interfaces.Endpoints.md deleted file mode 100644 index 11867f5..0000000 --- a/docs/api/verida-js/interfaces/verida_did_document.Interfaces.Endpoints.md +++ /dev/null @@ -1,54 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/did-document](../modules/verida_did_document.md) / [Interfaces](../modules/verida_did_document.Interfaces.md) / Endpoints - -# Interface: Endpoints - -[@verida/did-document](../modules/verida_did_document.md).[Interfaces](../modules/verida_did_document.Interfaces.md).Endpoints - -## Table of contents - -### Properties - -- [database](verida_did_document.Interfaces.Endpoints.md#database) -- [messaging](verida_did_document.Interfaces.Endpoints.md#messaging) -- [notification](verida_did_document.Interfaces.Endpoints.md#notification) -- [storage](verida_did_document.Interfaces.Endpoints.md#storage) - -## Properties - -### database - -• **database**: [`SecureContextEndpoint`](verida_did_document.Interfaces.SecureContextEndpoint.md) - -#### Defined in - -[packages/did-document/src/interfaces.ts:21](https://github.com/verida/verida-js/blob/c03b336/packages/did-document/src/interfaces.ts#L21) - -___ - -### messaging - -• **messaging**: [`SecureContextEndpoint`](verida_did_document.Interfaces.SecureContextEndpoint.md) - -#### Defined in - -[packages/did-document/src/interfaces.ts:22](https://github.com/verida/verida-js/blob/c03b336/packages/did-document/src/interfaces.ts#L22) - -___ - -### notification - -• `Optional` **notification**: [`SecureContextEndpoint`](verida_did_document.Interfaces.SecureContextEndpoint.md) - -#### Defined in - -[packages/did-document/src/interfaces.ts:24](https://github.com/verida/verida-js/blob/c03b336/packages/did-document/src/interfaces.ts#L24) - -___ - -### storage - -• `Optional` **storage**: [`SecureContextEndpoint`](verida_did_document.Interfaces.SecureContextEndpoint.md) - -#### Defined in - -[packages/did-document/src/interfaces.ts:23](https://github.com/verida/verida-js/blob/c03b336/packages/did-document/src/interfaces.ts#L23) diff --git a/docs/api/verida-js/interfaces/verida_did_document.Interfaces.Proof.md b/docs/api/verida-js/interfaces/verida_did_document.Interfaces.Proof.md deleted file mode 100644 index 6db7929..0000000 --- a/docs/api/verida-js/interfaces/verida_did_document.Interfaces.Proof.md +++ /dev/null @@ -1,54 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/did-document](../modules/verida_did_document.md) / [Interfaces](../modules/verida_did_document.Interfaces.md) / Proof - -# Interface: Proof - -[@verida/did-document](../modules/verida_did_document.md).[Interfaces](../modules/verida_did_document.Interfaces.md).Proof - -## Table of contents - -### Properties - -- [proofPurpose](verida_did_document.Interfaces.Proof.md#proofpurpose) -- [proofValue](verida_did_document.Interfaces.Proof.md#proofvalue) -- [type](verida_did_document.Interfaces.Proof.md#type) -- [verificationMethod](verida_did_document.Interfaces.Proof.md#verificationmethod) - -## Properties - -### proofPurpose - -• **proofPurpose**: ``"assertionMethod"`` - -#### Defined in - -[packages/did-document/src/interfaces.ts:12](https://github.com/verida/verida-js/blob/c03b336/packages/did-document/src/interfaces.ts#L12) - -___ - -### proofValue - -• **proofValue**: `string` - -#### Defined in - -[packages/did-document/src/interfaces.ts:13](https://github.com/verida/verida-js/blob/c03b336/packages/did-document/src/interfaces.ts#L13) - -___ - -### type - -• **type**: ``"EcdsaSecp256k1VerificationKey2019"`` - -#### Defined in - -[packages/did-document/src/interfaces.ts:10](https://github.com/verida/verida-js/blob/c03b336/packages/did-document/src/interfaces.ts#L10) - -___ - -### verificationMethod - -• **verificationMethod**: `string` - -#### Defined in - -[packages/did-document/src/interfaces.ts:11](https://github.com/verida/verida-js/blob/c03b336/packages/did-document/src/interfaces.ts#L11) diff --git a/docs/api/verida-js/interfaces/verida_did_document.Interfaces.SecureContextEndpoint.md b/docs/api/verida-js/interfaces/verida_did_document.Interfaces.SecureContextEndpoint.md deleted file mode 100644 index 835854e..0000000 --- a/docs/api/verida-js/interfaces/verida_did_document.Interfaces.SecureContextEndpoint.md +++ /dev/null @@ -1,43 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/did-document](../modules/verida_did_document.md) / [Interfaces](../modules/verida_did_document.Interfaces.md) / SecureContextEndpoint - -# Interface: SecureContextEndpoint - -[@verida/did-document](../modules/verida_did_document.md).[Interfaces](../modules/verida_did_document.Interfaces.md).SecureContextEndpoint - -## Table of contents - -### Properties - -- [config](verida_did_document.Interfaces.SecureContextEndpoint.md#config) -- [endpointUri](verida_did_document.Interfaces.SecureContextEndpoint.md#endpointuri) -- [type](verida_did_document.Interfaces.SecureContextEndpoint.md#type) - -## Properties - -### config - -• `Optional` **config**: `object` - -#### Defined in - -[packages/did-document/src/interfaces.ts:6](https://github.com/verida/verida-js/blob/c03b336/packages/did-document/src/interfaces.ts#L6) - -___ - -### endpointUri - -• **endpointUri**: `string` - -#### Defined in - -[packages/did-document/src/interfaces.ts:5](https://github.com/verida/verida-js/blob/c03b336/packages/did-document/src/interfaces.ts#L5) - -___ - -### type - -• **type**: `string` - -#### Defined in - -[packages/did-document/src/interfaces.ts:4](https://github.com/verida/verida-js/blob/c03b336/packages/did-document/src/interfaces.ts#L4) diff --git a/docs/api/verida-js/interfaces/verida_did_document._internal_.IDIDDocument.md b/docs/api/verida-js/interfaces/verida_did_document._internal_.IDIDDocument.md deleted file mode 100644 index 01db70a..0000000 --- a/docs/api/verida-js/interfaces/verida_did_document._internal_.IDIDDocument.md +++ /dev/null @@ -1,364 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/did-document](../modules/verida_did_document.md) / [](../modules/verida_did_document._internal_.md) / IDIDDocument - -# Interface: IDIDDocument - -[@verida/did-document](../modules/verida_did_document.md).[](../modules/verida_did_document._internal_.md).IDIDDocument - -## Implemented by - -- [`DIDDocument`](../classes/verida_did_document.DIDDocument.md) - -## Table of contents - -### Accessors - -- [id](verida_did_document._internal_.IDIDDocument.md#id) - -### Methods - -- [addContext](verida_did_document._internal_.IDIDDocument.md#addcontext) -- [addContextAsymKey](verida_did_document._internal_.IDIDDocument.md#addcontextasymkey) -- [addContextService](verida_did_document._internal_.IDIDDocument.md#addcontextservice) -- [addContextSignKey](verida_did_document._internal_.IDIDDocument.md#addcontextsignkey) -- [buildTimestamp](verida_did_document._internal_.IDIDDocument.md#buildtimestamp) -- [export](verida_did_document._internal_.IDIDDocument.md#export) -- [getErrors](verida_did_document._internal_.IDIDDocument.md#geterrors) -- [import](verida_did_document._internal_.IDIDDocument.md#import) -- [locateContextProof](verida_did_document._internal_.IDIDDocument.md#locatecontextproof) -- [locateServiceEndpoint](verida_did_document._internal_.IDIDDocument.md#locateserviceendpoint) -- [removeContext](verida_did_document._internal_.IDIDDocument.md#removecontext) -- [setAttributes](verida_did_document._internal_.IDIDDocument.md#setattributes) -- [signProof](verida_did_document._internal_.IDIDDocument.md#signproof) -- [verifyContextSignature](verida_did_document._internal_.IDIDDocument.md#verifycontextsignature) -- [verifyProof](verida_did_document._internal_.IDIDDocument.md#verifyproof) -- [verifySig](verida_did_document._internal_.IDIDDocument.md#verifysig) - -## Accessors - -### id - -• `get` **id**(): `string` - -#### Returns - -`string` - -#### Defined in - -packages/types/dist/IDIDDocument.d.ts:5 - -## Methods - -### addContext - -▸ **addContext**(`contextName`, `keyring`, `privateKey`, `endpoints`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | -| `keyring` | [`IKeyring`](verida_did_document._internal_.IKeyring.md) | -| `privateKey` | `string` | -| `endpoints` | [`SecureContextEndpoints`](verida_did_document._internal_.SecureContextEndpoints.md) | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -packages/types/dist/IDIDDocument.d.ts:7 - -___ - -### addContextAsymKey - -▸ **addContextAsymKey**(`contextHash`, `publicKeyHex`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextHash` | `string` | -| `publicKeyHex` | `string` | - -#### Returns - -`void` - -#### Defined in - -packages/types/dist/IDIDDocument.d.ts:14 - -___ - -### addContextService - -▸ **addContextService**(`contextHash`, `endpointType`, `serviceType`, `endpointUris`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextHash` | `string` | -| `endpointType` | [`SecureContextEndpointType`](../enums/verida_did_document._internal_.SecureContextEndpointType.md) | -| `serviceType` | `string` | -| `endpointUris` | [`ServiceEndpoint`](../modules/verida_did_document._internal_.md#serviceendpoint)[] | - -#### Returns - -`void` - -#### Defined in - -packages/types/dist/IDIDDocument.d.ts:12 - -___ - -### addContextSignKey - -▸ **addContextSignKey**(`contextHash`, `publicKeyHex`, `proof`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextHash` | `string` | -| `publicKeyHex` | `string` | -| `proof` | `string` | - -#### Returns - -`void` - -#### Defined in - -packages/types/dist/IDIDDocument.d.ts:13 - -___ - -### buildTimestamp - -▸ **buildTimestamp**(`date`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `date` | `Date` | - -#### Returns - -`string` - -#### Defined in - -packages/types/dist/IDIDDocument.d.ts:21 - -___ - -### export - -▸ **export**(): [`VeridaDocInterface`](verida_did_document._internal_.VeridaDocInterface.md) - -#### Returns - -[`VeridaDocInterface`](verida_did_document._internal_.VeridaDocInterface.md) - -#### Defined in - -packages/types/dist/IDIDDocument.d.ts:11 - -___ - -### getErrors - -▸ **getErrors**(): `string`[] - -#### Returns - -`string`[] - -#### Defined in - -packages/types/dist/IDIDDocument.d.ts:6 - -___ - -### import - -▸ **import**(`doc`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `doc` | [`VeridaDocInterface`](verida_did_document._internal_.VeridaDocInterface.md) | - -#### Returns - -`void` - -#### Defined in - -packages/types/dist/IDIDDocument.d.ts:10 - -___ - -### locateContextProof - -▸ **locateContextProof**(`contextName`): `undefined` \| `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | - -#### Returns - -`undefined` \| `string` - -#### Defined in - -packages/types/dist/IDIDDocument.d.ts:18 - -___ - -### locateServiceEndpoint - -▸ **locateServiceEndpoint**(`contextName`, `endpointType`): `undefined` \| [`Service`](verida_did_document._internal_.Service.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | -| `endpointType` | [`SecureContextEndpointType`](../enums/verida_did_document._internal_.SecureContextEndpointType.md) | - -#### Returns - -`undefined` \| [`Service`](verida_did_document._internal_.Service.md) - -#### Defined in - -packages/types/dist/IDIDDocument.d.ts:17 - -___ - -### removeContext - -▸ **removeContext**(`contextName`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | - -#### Returns - -`boolean` - -#### Defined in - -packages/types/dist/IDIDDocument.d.ts:8 - -___ - -### setAttributes - -▸ **setAttributes**(`attributes`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `attributes` | [`Record`](../modules/verida_did_document._internal_.md#record)<`string`, `any`\> | - -#### Returns - -`void` - -#### Defined in - -packages/types/dist/IDIDDocument.d.ts:9 - -___ - -### signProof - -▸ **signProof**(`privateKey`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `privateKey` | `string` \| `Uint8Array` | - -#### Returns - -`void` - -#### Defined in - -packages/types/dist/IDIDDocument.d.ts:19 - -___ - -### verifyContextSignature - -▸ **verifyContextSignature**(`data`, `contextName`, `signature`, `contextIsHash`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `any` | -| `contextName` | `string` | -| `signature` | `string` | -| `contextIsHash` | `boolean` | - -#### Returns - -`boolean` - -#### Defined in - -packages/types/dist/IDIDDocument.d.ts:16 - -___ - -### verifyProof - -▸ **verifyProof**(): `boolean` - -#### Returns - -`boolean` - -#### Defined in - -packages/types/dist/IDIDDocument.d.ts:20 - -___ - -### verifySig - -▸ **verifySig**(`data`, `signature`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `any` | -| `signature` | `string` | - -#### Returns - -`boolean` - -#### Defined in - -packages/types/dist/IDIDDocument.d.ts:15 diff --git a/docs/api/verida-js/interfaces/verida_did_document._internal_.IKeyring.md b/docs/api/verida-js/interfaces/verida_did_document._internal_.IKeyring.md deleted file mode 100644 index c72c601..0000000 --- a/docs/api/verida-js/interfaces/verida_did_document._internal_.IKeyring.md +++ /dev/null @@ -1,262 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/did-document](../modules/verida_did_document.md) / [](../modules/verida_did_document._internal_.md) / IKeyring - -# Interface: IKeyring - -[@verida/did-document](../modules/verida_did_document.md).[](../modules/verida_did_document._internal_.md).IKeyring - -## Table of contents - -### Methods - -- [\_init](verida_did_document._internal_.IKeyring.md#_init) -- [asymDecrypt](verida_did_document._internal_.IKeyring.md#asymdecrypt) -- [asymEncrypt](verida_did_document._internal_.IKeyring.md#asymencrypt) -- [buildSharedKeyEnd](verida_did_document._internal_.IKeyring.md#buildsharedkeyend) -- [buildSharedKeyStart](verida_did_document._internal_.IKeyring.md#buildsharedkeystart) -- [getKeys](verida_did_document._internal_.IKeyring.md#getkeys) -- [getSeed](verida_did_document._internal_.IKeyring.md#getseed) -- [getStorageContextKey](verida_did_document._internal_.IKeyring.md#getstoragecontextkey) -- [publicKeys](verida_did_document._internal_.IKeyring.md#publickeys) -- [sign](verida_did_document._internal_.IKeyring.md#sign) -- [symDecrypt](verida_did_document._internal_.IKeyring.md#symdecrypt) -- [symEncrypt](verida_did_document._internal_.IKeyring.md#symencrypt) -- [verifySig](verida_did_document._internal_.IKeyring.md#verifysig) - -## Methods - -### \_init - -▸ **_init**(): `Promise`<`void`\> - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:3 - -___ - -### asymDecrypt - -▸ **asymDecrypt**(`messageWithNonce`, `secretOrSharedKey`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `messageWithNonce` | `string` | -| `secretOrSharedKey` | `Uint8Array` | - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:10 - -___ - -### asymEncrypt - -▸ **asymEncrypt**(`data`, `secretOrSharedKey`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `string` | -| `secretOrSharedKey` | `Uint8Array` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:9 - -___ - -### buildSharedKeyEnd - -▸ **buildSharedKeyEnd**(`publicKey`): `Promise`<`Uint8Array`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `publicKey` | `Uint8Array` | - -#### Returns - -`Promise`<`Uint8Array`\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:12 - -___ - -### buildSharedKeyStart - -▸ **buildSharedKeyStart**(`privateKey`): `Promise`<`Uint8Array`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `privateKey` | `Uint8Array` | - -#### Returns - -`Promise`<`Uint8Array`\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:11 - -___ - -### getKeys - -▸ **getKeys**(): `Promise`<`any`\> - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:2 - -___ - -### getSeed - -▸ **getSeed**(): `string` - -#### Returns - -`string` - -#### Defined in - -packages/types/dist/IKeyring.d.ts:13 - -___ - -### getStorageContextKey - -▸ **getStorageContextKey**(`databaseName`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `databaseName` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:14 - -___ - -### publicKeys - -▸ **publicKeys**(): `Promise`<[`KeyringPublicKeys`](verida_did_document._internal_.KeyringPublicKeys.md)\> - -#### Returns - -`Promise`<[`KeyringPublicKeys`](verida_did_document._internal_.KeyringPublicKeys.md)\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:4 - -___ - -### sign - -▸ **sign**(`data`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `any` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:5 - -___ - -### symDecrypt - -▸ **symDecrypt**(`data`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `string` | - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:8 - -___ - -### symEncrypt - -▸ **symEncrypt**(`data`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:7 - -___ - -### verifySig - -▸ **verifySig**(`data`, `sig`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `string` | -| `sig` | `string` | - -#### Returns - -`Promise`<`boolean`\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:6 diff --git a/docs/api/verida-js/interfaces/verida_did_document._internal_.JsonWebKey.md b/docs/api/verida-js/interfaces/verida_did_document._internal_.JsonWebKey.md deleted file mode 100644 index 20bf3d9..0000000 --- a/docs/api/verida-js/interfaces/verida_did_document._internal_.JsonWebKey.md +++ /dev/null @@ -1,145 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/did-document](../modules/verida_did_document.md) / [](../modules/verida_did_document._internal_.md) / JsonWebKey - -# Interface: JsonWebKey - -[@verida/did-document](../modules/verida_did_document.md).[](../modules/verida_did_document._internal_.md).JsonWebKey - -Encapsulates a JSON web key type that includes only the public properties that -can be used in DID documents. - -The private properties are intentionally omitted to discourage the use -(and accidental disclosure) of private keys in DID documents. - -**`see`** [RFC7517 JsonWebKey (JWK)](https://www.rfc-editor.org/rfc/rfc7517) - -## Hierarchy - -- [`Extensible`](../modules/verida_did_document._internal_.md#extensible) - - ↳ **`JsonWebKey`** - -## Table of contents - -### Properties - -- [alg](verida_did_document._internal_.JsonWebKey.md#alg) -- [crv](verida_did_document._internal_.JsonWebKey.md#crv) -- [e](verida_did_document._internal_.JsonWebKey.md#e) -- [ext](verida_did_document._internal_.JsonWebKey.md#ext) -- [key\_ops](verida_did_document._internal_.JsonWebKey.md#key_ops) -- [kid](verida_did_document._internal_.JsonWebKey.md#kid) -- [kty](verida_did_document._internal_.JsonWebKey.md#kty) -- [n](verida_did_document._internal_.JsonWebKey.md#n) -- [use](verida_did_document._internal_.JsonWebKey.md#use) -- [x](verida_did_document._internal_.JsonWebKey.md#x) -- [y](verida_did_document._internal_.JsonWebKey.md#y) - -## Properties - -### alg - -• `Optional` **alg**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:103 - -___ - -### crv - -• `Optional` **crv**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:104 - -___ - -### e - -• `Optional` **e**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:105 - -___ - -### ext - -• `Optional` **ext**: `boolean` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:106 - -___ - -### key\_ops - -• `Optional` **key\_ops**: `string`[] - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:107 - -___ - -### kid - -• `Optional` **kid**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:108 - -___ - -### kty - -• **kty**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:109 - -___ - -### n - -• `Optional` **n**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:110 - -___ - -### use - -• `Optional` **use**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:111 - -___ - -### x - -• `Optional` **x**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:112 - -___ - -### y - -• `Optional` **y**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:113 diff --git a/docs/api/verida-js/interfaces/verida_did_document._internal_.KeyringPublicKeys.md b/docs/api/verida-js/interfaces/verida_did_document._internal_.KeyringPublicKeys.md deleted file mode 100644 index 141bc85..0000000 --- a/docs/api/verida-js/interfaces/verida_did_document._internal_.KeyringPublicKeys.md +++ /dev/null @@ -1,76 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/did-document](../modules/verida_did_document.md) / [](../modules/verida_did_document._internal_.md) / KeyringPublicKeys - -# Interface: KeyringPublicKeys - -[@verida/did-document](../modules/verida_did_document.md).[](../modules/verida_did_document._internal_.md).KeyringPublicKeys - -## Table of contents - -### Properties - -- [asymPublicKey](verida_did_document._internal_.KeyringPublicKeys.md#asympublickey) -- [asymPublicKeyBase58](verida_did_document._internal_.KeyringPublicKeys.md#asympublickeybase58) -- [asymPublicKeyHex](verida_did_document._internal_.KeyringPublicKeys.md#asympublickeyhex) -- [signPublicKey](verida_did_document._internal_.KeyringPublicKeys.md#signpublickey) -- [signPublicKeyBase58](verida_did_document._internal_.KeyringPublicKeys.md#signpublickeybase58) -- [signPublicKeyHex](verida_did_document._internal_.KeyringPublicKeys.md#signpublickeyhex) - -## Properties - -### asymPublicKey - -• **asymPublicKey**: `Uint8Array` - -#### Defined in - -packages/types/dist/IKeyring.d.ts:17 - -___ - -### asymPublicKeyBase58 - -• **asymPublicKeyBase58**: `string` - -#### Defined in - -packages/types/dist/IKeyring.d.ts:19 - -___ - -### asymPublicKeyHex - -• **asymPublicKeyHex**: `string` - -#### Defined in - -packages/types/dist/IKeyring.d.ts:18 - -___ - -### signPublicKey - -• **signPublicKey**: `Uint8Array` - -#### Defined in - -packages/types/dist/IKeyring.d.ts:20 - -___ - -### signPublicKeyBase58 - -• **signPublicKeyBase58**: `string` - -#### Defined in - -packages/types/dist/IKeyring.d.ts:22 - -___ - -### signPublicKeyHex - -• **signPublicKeyHex**: `string` - -#### Defined in - -packages/types/dist/IKeyring.d.ts:21 diff --git a/docs/api/verida-js/interfaces/verida_did_document._internal_.ProofInterface.md b/docs/api/verida-js/interfaces/verida_did_document._internal_.ProofInterface.md deleted file mode 100644 index 7eaccd6..0000000 --- a/docs/api/verida-js/interfaces/verida_did_document._internal_.ProofInterface.md +++ /dev/null @@ -1,54 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/did-document](../modules/verida_did_document.md) / [](../modules/verida_did_document._internal_.md) / ProofInterface - -# Interface: ProofInterface - -[@verida/did-document](../modules/verida_did_document.md).[](../modules/verida_did_document._internal_.md).ProofInterface - -## Table of contents - -### Properties - -- [proofPurpose](verida_did_document._internal_.ProofInterface.md#proofpurpose) -- [proofValue](verida_did_document._internal_.ProofInterface.md#proofvalue) -- [type](verida_did_document._internal_.ProofInterface.md#type) -- [verificationMethod](verida_did_document._internal_.ProofInterface.md#verificationmethod) - -## Properties - -### proofPurpose - -• **proofPurpose**: `string` - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:34 - -___ - -### proofValue - -• **proofValue**: `string` - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:35 - -___ - -### type - -• **type**: `string` - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:32 - -___ - -### verificationMethod - -• **verificationMethod**: `string` - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:33 diff --git a/docs/api/verida-js/interfaces/verida_did_document._internal_.SecureContextEndpoint.md b/docs/api/verida-js/interfaces/verida_did_document._internal_.SecureContextEndpoint.md deleted file mode 100644 index 88530c2..0000000 --- a/docs/api/verida-js/interfaces/verida_did_document._internal_.SecureContextEndpoint.md +++ /dev/null @@ -1,43 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/did-document](../modules/verida_did_document.md) / [](../modules/verida_did_document._internal_.md) / SecureContextEndpoint - -# Interface: SecureContextEndpoint - -[@verida/did-document](../modules/verida_did_document.md).[](../modules/verida_did_document._internal_.md).SecureContextEndpoint - -## Table of contents - -### Properties - -- [config](verida_did_document._internal_.SecureContextEndpoint.md#config) -- [endpointUri](verida_did_document._internal_.SecureContextEndpoint.md#endpointuri) -- [type](verida_did_document._internal_.SecureContextEndpoint.md#type) - -## Properties - -### config - -• `Optional` **config**: `object` - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:5 - -___ - -### endpointUri - -• **endpointUri**: [`ServiceEndpoint`](../modules/verida_did_document._internal_.md#serviceendpoint)[] - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:4 - -___ - -### type - -• **type**: `string` - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:3 diff --git a/docs/api/verida-js/interfaces/verida_did_document._internal_.SecureContextEndpoints.md b/docs/api/verida-js/interfaces/verida_did_document._internal_.SecureContextEndpoints.md deleted file mode 100644 index 908fe61..0000000 --- a/docs/api/verida-js/interfaces/verida_did_document._internal_.SecureContextEndpoints.md +++ /dev/null @@ -1,54 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/did-document](../modules/verida_did_document.md) / [](../modules/verida_did_document._internal_.md) / SecureContextEndpoints - -# Interface: SecureContextEndpoints - -[@verida/did-document](../modules/verida_did_document.md).[](../modules/verida_did_document._internal_.md).SecureContextEndpoints - -## Table of contents - -### Properties - -- [database](verida_did_document._internal_.SecureContextEndpoints.md#database) -- [messaging](verida_did_document._internal_.SecureContextEndpoints.md#messaging) -- [notification](verida_did_document._internal_.SecureContextEndpoints.md#notification) -- [storage](verida_did_document._internal_.SecureContextEndpoints.md#storage) - -## Properties - -### database - -• **database**: [`SecureContextEndpoint`](verida_did_document._internal_.SecureContextEndpoint.md) - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:8 - -___ - -### messaging - -• **messaging**: [`SecureContextEndpoint`](verida_did_document._internal_.SecureContextEndpoint.md) - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:9 - -___ - -### notification - -• `Optional` **notification**: [`SecureContextEndpoint`](verida_did_document._internal_.SecureContextEndpoint.md) - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:11 - -___ - -### storage - -• `Optional` **storage**: [`SecureContextEndpoint`](verida_did_document._internal_.SecureContextEndpoint.md) - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:10 diff --git a/docs/api/verida-js/interfaces/verida_did_document._internal_.Service.md b/docs/api/verida-js/interfaces/verida_did_document._internal_.Service.md deleted file mode 100644 index ac3bcee..0000000 --- a/docs/api/verida-js/interfaces/verida_did_document._internal_.Service.md +++ /dev/null @@ -1,53 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/did-document](../modules/verida_did_document.md) / [](../modules/verida_did_document._internal_.md) / Service - -# Interface: Service - -[@verida/did-document](../modules/verida_did_document.md).[](../modules/verida_did_document._internal_.md).Service - -Represents a Service entry in a [DID document](https://www.w3.org/TR/did-core/#did-document-properties). - -**`see`** [https://www.w3.org/TR/did-core/#services](https://www.w3.org/TR/did-core/#services) - -**`see`** [https://www.w3.org/TR/did-core/#service-properties](https://www.w3.org/TR/did-core/#service-properties) - -## Indexable - -▪ [x: `string`]: `any` - -## Table of contents - -### Properties - -- [id](verida_did_document._internal_.Service.md#id) -- [serviceEndpoint](verida_did_document._internal_.Service.md#serviceendpoint) -- [type](verida_did_document._internal_.Service.md#type) - -## Properties - -### id - -• **id**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:81 - -___ - -### serviceEndpoint - -• **serviceEndpoint**: [`ServiceEndpoint`](../modules/verida_did_document._internal_.md#serviceendpoint) \| [`ServiceEndpoint`](../modules/verida_did_document._internal_.md#serviceendpoint)[] - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:83 - -___ - -### type - -• **type**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:82 diff --git a/docs/api/verida-js/interfaces/verida_did_document._internal_.ServiceEndpoint.md b/docs/api/verida-js/interfaces/verida_did_document._internal_.ServiceEndpoint.md deleted file mode 100644 index 2380bcd..0000000 --- a/docs/api/verida-js/interfaces/verida_did_document._internal_.ServiceEndpoint.md +++ /dev/null @@ -1,54 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/did-document](../modules/verida_did_document.md) / [](../modules/verida_did_document._internal_.md) / ServiceEndpoint - -# Interface: ServiceEndpoint - -[@verida/did-document](../modules/verida_did_document.md).[](../modules/verida_did_document._internal_.md).ServiceEndpoint - -## Table of contents - -### Properties - -- [description](verida_did_document._internal_.ServiceEndpoint.md#description) -- [id](verida_did_document._internal_.ServiceEndpoint.md#id) -- [serviceEndpoint](verida_did_document._internal_.ServiceEndpoint.md#serviceendpoint) -- [type](verida_did_document._internal_.ServiceEndpoint.md#type) - -## Properties - -### description - -• `Optional` **description**: `string` - -#### Defined in - -packages/did-document/node_modules/did-resolver/lib/resolver.d.ts:43 - -___ - -### id - -• **id**: `string` - -#### Defined in - -packages/did-document/node_modules/did-resolver/lib/resolver.d.ts:40 - -___ - -### serviceEndpoint - -• **serviceEndpoint**: `string` - -#### Defined in - -packages/did-document/node_modules/did-resolver/lib/resolver.d.ts:42 - -___ - -### type - -• **type**: `string` - -#### Defined in - -packages/did-document/node_modules/did-resolver/lib/resolver.d.ts:41 diff --git a/docs/api/verida-js/interfaces/verida_did_document._internal_.VeridaDocInterface.md b/docs/api/verida-js/interfaces/verida_did_document._internal_.VeridaDocInterface.md deleted file mode 100644 index 9e00b51..0000000 --- a/docs/api/verida-js/interfaces/verida_did_document._internal_.VeridaDocInterface.md +++ /dev/null @@ -1,233 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/did-document](../modules/verida_did_document.md) / [](../modules/verida_did_document._internal_.md) / VeridaDocInterface - -# Interface: VeridaDocInterface - -[@verida/did-document](../modules/verida_did_document.md).[](../modules/verida_did_document._internal_.md).VeridaDocInterface - -## Hierarchy - -- [`DIDDocument`](../modules/verida_did_document._internal_.md#diddocument) - - ↳ **`VeridaDocInterface`** - -## Table of contents - -### Properties - -- [@context](verida_did_document._internal_.VeridaDocInterface.md#@context) -- [alsoKnownAs](verida_did_document._internal_.VeridaDocInterface.md#alsoknownas) -- [assertionMethod](verida_did_document._internal_.VeridaDocInterface.md#assertionmethod) -- [authentication](verida_did_document._internal_.VeridaDocInterface.md#authentication) -- [capabilityDelegation](verida_did_document._internal_.VeridaDocInterface.md#capabilitydelegation) -- [capabilityInvocation](verida_did_document._internal_.VeridaDocInterface.md#capabilityinvocation) -- [controller](verida_did_document._internal_.VeridaDocInterface.md#controller) -- [created](verida_did_document._internal_.VeridaDocInterface.md#created) -- [deactivated](verida_did_document._internal_.VeridaDocInterface.md#deactivated) -- [id](verida_did_document._internal_.VeridaDocInterface.md#id) -- [keyAgreement](verida_did_document._internal_.VeridaDocInterface.md#keyagreement) -- [proof](verida_did_document._internal_.VeridaDocInterface.md#proof) -- [publicKey](verida_did_document._internal_.VeridaDocInterface.md#publickey) -- [service](verida_did_document._internal_.VeridaDocInterface.md#service) -- [updated](verida_did_document._internal_.VeridaDocInterface.md#updated) -- [verificationMethod](verida_did_document._internal_.VeridaDocInterface.md#verificationmethod) -- [versionId](verida_did_document._internal_.VeridaDocInterface.md#versionid) - -## Properties - -### @context - -• `Optional` **@context**: `string` \| `string`[] - -#### Inherited from - -DocInterface.@context - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:61 - -___ - -### alsoKnownAs - -• `Optional` **alsoKnownAs**: `string`[] - -#### Inherited from - -DocInterface.alsoKnownAs - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:63 - -___ - -### assertionMethod - -• **assertionMethod**: `undefined` \| (`string` \| [`VerificationMethod`](verida_did_document._internal_.VerificationMethod.md))[] - -#### Inherited from - -DocInterface.assertionMethod - -___ - -### authentication - -• **authentication**: `undefined` \| (`string` \| [`VerificationMethod`](verida_did_document._internal_.VerificationMethod.md))[] - -#### Inherited from - -DocInterface.authentication - -___ - -### capabilityDelegation - -• **capabilityDelegation**: `undefined` \| (`string` \| [`VerificationMethod`](verida_did_document._internal_.VerificationMethod.md))[] - -#### Inherited from - -DocInterface.capabilityDelegation - -___ - -### capabilityInvocation - -• **capabilityInvocation**: `undefined` \| (`string` \| [`VerificationMethod`](verida_did_document._internal_.VerificationMethod.md))[] - -#### Inherited from - -DocInterface.capabilityInvocation - -___ - -### controller - -• `Optional` **controller**: `string` \| `string`[] - -#### Inherited from - -DocInterface.controller - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:64 - -___ - -### created - -• `Optional` **created**: `string` - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:39 - -___ - -### deactivated - -• `Optional` **deactivated**: `string` - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:41 - -___ - -### id - -• **id**: `string` - -#### Inherited from - -DocInterface.id - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:62 - -___ - -### keyAgreement - -• **keyAgreement**: `undefined` \| (`string` \| [`VerificationMethod`](verida_did_document._internal_.VerificationMethod.md))[] - -#### Inherited from - -DocInterface.keyAgreement - -___ - -### proof - -• `Optional` **proof**: [`ProofInterface`](verida_did_document._internal_.ProofInterface.md) - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:42 - -___ - -### publicKey - -• `Optional` **publicKey**: [`VerificationMethod`](verida_did_document._internal_.VerificationMethod.md)[] - -**`deprecated`** - -#### Inherited from - -DocInterface.publicKey - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:70 - -___ - -### service - -• `Optional` **service**: [`Service`](verida_did_document._internal_.Service.md)[] - -#### Inherited from - -DocInterface.service - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:66 - -___ - -### updated - -• `Optional` **updated**: `string` - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:40 - -___ - -### verificationMethod - -• `Optional` **verificationMethod**: [`VerificationMethod`](verida_did_document._internal_.VerificationMethod.md)[] - -#### Inherited from - -DocInterface.verificationMethod - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:65 - -___ - -### versionId - -• **versionId**: `number` - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:38 diff --git a/docs/api/verida-js/interfaces/verida_did_document._internal_.VerificationMethod.md b/docs/api/verida-js/interfaces/verida_did_document._internal_.VerificationMethod.md deleted file mode 100644 index 3a8dfa5..0000000 --- a/docs/api/verida-js/interfaces/verida_did_document._internal_.VerificationMethod.md +++ /dev/null @@ -1,129 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/did-document](../modules/verida_did_document.md) / [](../modules/verida_did_document._internal_.md) / VerificationMethod - -# Interface: VerificationMethod - -[@verida/did-document](../modules/verida_did_document.md).[](../modules/verida_did_document._internal_.md).VerificationMethod - -Represents the properties of a Verification Method listed in a DID document. - -This data type includes public key representations that are no longer present in the spec but are still used by -several DID methods / resolvers and kept for backward compatibility. - -**`see`** [https://www.w3.org/TR/did-core/#verification-methods](https://www.w3.org/TR/did-core/#verification-methods) - -**`see`** [https://www.w3.org/TR/did-core/#verification-method-properties](https://www.w3.org/TR/did-core/#verification-method-properties) - -## Table of contents - -### Properties - -- [blockchainAccountId](verida_did_document._internal_.VerificationMethod.md#blockchainaccountid) -- [controller](verida_did_document._internal_.VerificationMethod.md#controller) -- [ethereumAddress](verida_did_document._internal_.VerificationMethod.md#ethereumaddress) -- [id](verida_did_document._internal_.VerificationMethod.md#id) -- [publicKeyBase58](verida_did_document._internal_.VerificationMethod.md#publickeybase58) -- [publicKeyBase64](verida_did_document._internal_.VerificationMethod.md#publickeybase64) -- [publicKeyHex](verida_did_document._internal_.VerificationMethod.md#publickeyhex) -- [publicKeyJwk](verida_did_document._internal_.VerificationMethod.md#publickeyjwk) -- [publicKeyMultibase](verida_did_document._internal_.VerificationMethod.md#publickeymultibase) -- [type](verida_did_document._internal_.VerificationMethod.md#type) - -## Properties - -### blockchainAccountId - -• `Optional` **blockchainAccountId**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:133 - -___ - -### controller - -• **controller**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:127 - -___ - -### ethereumAddress - -• `Optional` **ethereumAddress**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:134 - -___ - -### id - -• **id**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:125 - -___ - -### publicKeyBase58 - -• `Optional` **publicKeyBase58**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:128 - -___ - -### publicKeyBase64 - -• `Optional` **publicKeyBase64**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:129 - -___ - -### publicKeyHex - -• `Optional` **publicKeyHex**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:131 - -___ - -### publicKeyJwk - -• `Optional` **publicKeyJwk**: [`JsonWebKey`](verida_did_document._internal_.JsonWebKey.md) - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:130 - -___ - -### publicKeyMultibase - -• `Optional` **publicKeyMultibase**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:132 - -___ - -### type - -• **type**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:126 diff --git a/docs/api/verida-js/interfaces/verida_did_resolver._internal_.DIDResolutionOptions.md b/docs/api/verida-js/interfaces/verida_did_resolver._internal_.DIDResolutionOptions.md deleted file mode 100644 index 85d64e5..0000000 --- a/docs/api/verida-js/interfaces/verida_did_resolver._internal_.DIDResolutionOptions.md +++ /dev/null @@ -1,27 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/did-resolver](../modules/verida_did_resolver.md) / [](../modules/verida_did_resolver._internal_.md) / DIDResolutionOptions - -# Interface: DIDResolutionOptions - -[@verida/did-resolver](../modules/verida_did_resolver.md).[](../modules/verida_did_resolver._internal_.md).DIDResolutionOptions - -## Hierarchy - -- [`Extensible`](../modules/verida_did_resolver._internal_.md#extensible) - - ↳ **`DIDResolutionOptions`** - -## Table of contents - -### Properties - -- [accept](verida_did_resolver._internal_.DIDResolutionOptions.md#accept) - -## Properties - -### accept - -• `Optional` **accept**: `string` - -#### Defined in - -packages/did-resolver/node_modules/did-resolver/lib/resolver.d.ts:8 diff --git a/docs/api/verida-js/interfaces/verida_encryption_utils._internal_.BoxKeyPair.md b/docs/api/verida-js/interfaces/verida_encryption_utils._internal_.BoxKeyPair.md deleted file mode 100644 index eb5bce2..0000000 --- a/docs/api/verida-js/interfaces/verida_encryption_utils._internal_.BoxKeyPair.md +++ /dev/null @@ -1,32 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/encryption-utils](../modules/verida_encryption_utils.md) / [](../modules/verida_encryption_utils._internal_.md) / BoxKeyPair - -# Interface: BoxKeyPair - -[@verida/encryption-utils](../modules/verida_encryption_utils.md).[](../modules/verida_encryption_utils._internal_.md).BoxKeyPair - -## Table of contents - -### Properties - -- [publicKey](verida_encryption_utils._internal_.BoxKeyPair.md#publickey) -- [secretKey](verida_encryption_utils._internal_.BoxKeyPair.md#secretkey) - -## Properties - -### publicKey - -• **publicKey**: `Uint8Array` - -#### Defined in - -node_modules/tweetnacl/nacl.d.ts:10 - -___ - -### secretKey - -• **secretKey**: `Uint8Array` - -#### Defined in - -node_modules/tweetnacl/nacl.d.ts:11 diff --git a/docs/api/verida-js/interfaces/verida_helpers.DIDParts.md b/docs/api/verida-js/interfaces/verida_helpers.DIDParts.md deleted file mode 100644 index d877827..0000000 --- a/docs/api/verida-js/interfaces/verida_helpers.DIDParts.md +++ /dev/null @@ -1,32 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/helpers](../modules/verida_helpers.md) / DIDParts - -# Interface: DIDParts - -[@verida/helpers](../modules/verida_helpers.md).DIDParts - -## Table of contents - -### Properties - -- [address](verida_helpers.DIDParts.md#address) -- [network](verida_helpers.DIDParts.md#network) - -## Properties - -### address - -• **address**: `string` - -#### Defined in - -[packages/helpers/src/Utils.ts:178](https://github.com/verida/verida-js/blob/5040472/packages/helpers/src/Utils.ts#L178) - -___ - -### network - -• **network**: `string` - -#### Defined in - -[packages/helpers/src/Utils.ts:177](https://github.com/verida/verida-js/blob/5040472/packages/helpers/src/Utils.ts#L177) diff --git a/docs/api/verida-js/interfaces/verida_helpers._internal_.AccountConfig.md b/docs/api/verida-js/interfaces/verida_helpers._internal_.AccountConfig.md deleted file mode 100644 index 2696926..0000000 --- a/docs/api/verida-js/interfaces/verida_helpers._internal_.AccountConfig.md +++ /dev/null @@ -1,54 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/helpers](../modules/verida_helpers.md) / [](../modules/verida_helpers._internal_.md) / AccountConfig - -# Interface: AccountConfig - -[@verida/helpers](../modules/verida_helpers.md).[](../modules/verida_helpers._internal_.md).AccountConfig - -## Table of contents - -### Properties - -- [defaultDatabaseServer](verida_helpers._internal_.AccountConfig.md#defaultdatabaseserver) -- [defaultMessageServer](verida_helpers._internal_.AccountConfig.md#defaultmessageserver) -- [defaultNotificationServer](verida_helpers._internal_.AccountConfig.md#defaultnotificationserver) -- [defaultStorageServer](verida_helpers._internal_.AccountConfig.md#defaultstorageserver) - -## Properties - -### defaultDatabaseServer - -• **defaultDatabaseServer**: [`SecureContextEndpoint`](verida_helpers._internal_.SecureContextEndpoint.md) - -#### Defined in - -packages/types/dist/AccountInterfaces.d.ts:7 - -___ - -### defaultMessageServer - -• **defaultMessageServer**: [`SecureContextEndpoint`](verida_helpers._internal_.SecureContextEndpoint.md) - -#### Defined in - -packages/types/dist/AccountInterfaces.d.ts:8 - -___ - -### defaultNotificationServer - -• `Optional` **defaultNotificationServer**: [`SecureContextEndpoint`](verida_helpers._internal_.SecureContextEndpoint.md) - -#### Defined in - -packages/types/dist/AccountInterfaces.d.ts:10 - -___ - -### defaultStorageServer - -• `Optional` **defaultStorageServer**: [`SecureContextEndpoint`](verida_helpers._internal_.SecureContextEndpoint.md) - -#### Defined in - -packages/types/dist/AccountInterfaces.d.ts:9 diff --git a/docs/api/verida-js/interfaces/verida_helpers._internal_.AsyncIterableIterator.md b/docs/api/verida-js/interfaces/verida_helpers._internal_.AsyncIterableIterator.md deleted file mode 100644 index f86dc47..0000000 --- a/docs/api/verida-js/interfaces/verida_helpers._internal_.AsyncIterableIterator.md +++ /dev/null @@ -1,112 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/helpers](../modules/verida_helpers.md) / [](../modules/verida_helpers._internal_.md) / AsyncIterableIterator - -# Interface: AsyncIterableIterator - -[@verida/helpers](../modules/verida_helpers.md).[](../modules/verida_helpers._internal_.md).AsyncIterableIterator - -## Type parameters - -| Name | -| :------ | -| `T` | - -## Hierarchy - -- [`AsyncIterator`](verida_helpers._internal_.AsyncIterator.md)<`T`\> - - ↳ **`AsyncIterableIterator`** - -## Table of contents - -### Methods - -- [[asyncIterator]](verida_helpers._internal_.AsyncIterableIterator.md#[asynciterator]) -- [next](verida_helpers._internal_.AsyncIterableIterator.md#next) -- [return](verida_helpers._internal_.AsyncIterableIterator.md#return) -- [throw](verida_helpers._internal_.AsyncIterableIterator.md#throw) - -## Methods - -### [asyncIterator] - -▸ **[asyncIterator]**(): [`AsyncIterableIterator`](verida_helpers._internal_.AsyncIterableIterator.md)<`T`\> - -#### Returns - -[`AsyncIterableIterator`](verida_helpers._internal_.AsyncIterableIterator.md)<`T`\> - -#### Defined in - -node_modules/typescript/lib/lib.es2018.asynciterable.d.ts:44 - -___ - -### next - -▸ **next**(...`args`): `Promise`<[`IteratorResult`](../modules/verida_helpers._internal_.md#iteratorresult)<`T`, `any`\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `...args` | [] \| [`undefined`] | - -#### Returns - -`Promise`<[`IteratorResult`](../modules/verida_helpers._internal_.md#iteratorresult)<`T`, `any`\>\> - -#### Inherited from - -[AsyncIterator](verida_helpers._internal_.AsyncIterator.md).[next](verida_helpers._internal_.AsyncIterator.md#next) - -#### Defined in - -node_modules/typescript/lib/lib.es2018.asynciterable.d.ts:34 - -___ - -### return - -▸ `Optional` **return**(`value?`): `Promise`<[`IteratorResult`](../modules/verida_helpers._internal_.md#iteratorresult)<`T`, `any`\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value?` | `any` | - -#### Returns - -`Promise`<[`IteratorResult`](../modules/verida_helpers._internal_.md#iteratorresult)<`T`, `any`\>\> - -#### Inherited from - -[AsyncIterator](verida_helpers._internal_.AsyncIterator.md).[return](verida_helpers._internal_.AsyncIterator.md#return) - -#### Defined in - -node_modules/typescript/lib/lib.es2018.asynciterable.d.ts:35 - -___ - -### throw - -▸ `Optional` **throw**(`e?`): `Promise`<[`IteratorResult`](../modules/verida_helpers._internal_.md#iteratorresult)<`T`, `any`\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `e?` | `any` | - -#### Returns - -`Promise`<[`IteratorResult`](../modules/verida_helpers._internal_.md#iteratorresult)<`T`, `any`\>\> - -#### Inherited from - -[AsyncIterator](verida_helpers._internal_.AsyncIterator.md).[throw](verida_helpers._internal_.AsyncIterator.md#throw) - -#### Defined in - -node_modules/typescript/lib/lib.es2018.asynciterable.d.ts:36 diff --git a/docs/api/verida-js/interfaces/verida_helpers._internal_.AsyncIterator.md b/docs/api/verida-js/interfaces/verida_helpers._internal_.AsyncIterator.md deleted file mode 100644 index 6a63a7c..0000000 --- a/docs/api/verida-js/interfaces/verida_helpers._internal_.AsyncIterator.md +++ /dev/null @@ -1,87 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/helpers](../modules/verida_helpers.md) / [](../modules/verida_helpers._internal_.md) / AsyncIterator - -# Interface: AsyncIterator - -[@verida/helpers](../modules/verida_helpers.md).[](../modules/verida_helpers._internal_.md).AsyncIterator - -## Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `T` | -| `TReturn` | `any` | -| `TNext` | `undefined` | - -## Hierarchy - -- **`AsyncIterator`** - - ↳ [`AsyncIterableIterator`](verida_helpers._internal_.AsyncIterableIterator.md) - -## Table of contents - -### Methods - -- [next](verida_helpers._internal_.AsyncIterator.md#next) -- [return](verida_helpers._internal_.AsyncIterator.md#return) -- [throw](verida_helpers._internal_.AsyncIterator.md#throw) - -## Methods - -### next - -▸ **next**(...`args`): `Promise`<[`IteratorResult`](../modules/verida_helpers._internal_.md#iteratorresult)<`T`, `TReturn`\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `...args` | [] \| [`TNext`] | - -#### Returns - -`Promise`<[`IteratorResult`](../modules/verida_helpers._internal_.md#iteratorresult)<`T`, `TReturn`\>\> - -#### Defined in - -node_modules/typescript/lib/lib.es2018.asynciterable.d.ts:34 - -___ - -### return - -▸ `Optional` **return**(`value?`): `Promise`<[`IteratorResult`](../modules/verida_helpers._internal_.md#iteratorresult)<`T`, `TReturn`\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value?` | `TReturn` \| [`PromiseLike`](verida_helpers._internal_.PromiseLike.md)<`TReturn`\> | - -#### Returns - -`Promise`<[`IteratorResult`](../modules/verida_helpers._internal_.md#iteratorresult)<`T`, `TReturn`\>\> - -#### Defined in - -node_modules/typescript/lib/lib.es2018.asynciterable.d.ts:35 - -___ - -### throw - -▸ `Optional` **throw**(`e?`): `Promise`<[`IteratorResult`](../modules/verida_helpers._internal_.md#iteratorresult)<`T`, `TReturn`\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `e?` | `any` | - -#### Returns - -`Promise`<[`IteratorResult`](../modules/verida_helpers._internal_.md#iteratorresult)<`T`, `TReturn`\>\> - -#### Defined in - -node_modules/typescript/lib/lib.es2018.asynciterable.d.ts:36 diff --git a/docs/api/verida-js/interfaces/verida_helpers._internal_.AuthContext.md b/docs/api/verida-js/interfaces/verida_helpers._internal_.AuthContext.md deleted file mode 100644 index 5a0154f..0000000 --- a/docs/api/verida-js/interfaces/verida_helpers._internal_.AuthContext.md +++ /dev/null @@ -1,21 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/helpers](../modules/verida_helpers.md) / [](../modules/verida_helpers._internal_.md) / AuthContext - -# Interface: AuthContext - -[@verida/helpers](../modules/verida_helpers.md).[](../modules/verida_helpers._internal_.md).AuthContext - -## Table of contents - -### Properties - -- [publicSigningKey](verida_helpers._internal_.AuthContext.md#publicsigningkey) - -## Properties - -### publicSigningKey - -• **publicSigningKey**: [`SecureContextPublicKey`](verida_helpers._internal_.SecureContextPublicKey.md) - -#### Defined in - -packages/types/dist/AccountInterfaces.d.ts:13 diff --git a/docs/api/verida-js/interfaces/verida_helpers._internal_.AuthTypeConfig.md b/docs/api/verida-js/interfaces/verida_helpers._internal_.AuthTypeConfig.md deleted file mode 100644 index 632e4c2..0000000 --- a/docs/api/verida-js/interfaces/verida_helpers._internal_.AuthTypeConfig.md +++ /dev/null @@ -1,21 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/helpers](../modules/verida_helpers.md) / [](../modules/verida_helpers._internal_.md) / AuthTypeConfig - -# Interface: AuthTypeConfig - -[@verida/helpers](../modules/verida_helpers.md).[](../modules/verida_helpers._internal_.md).AuthTypeConfig - -## Table of contents - -### Properties - -- [force](verida_helpers._internal_.AuthTypeConfig.md#force) - -## Properties - -### force - -• `Optional` **force**: `boolean` - -#### Defined in - -packages/types/dist/AccountInterfaces.d.ts:16 diff --git a/docs/api/verida-js/interfaces/verida_helpers._internal_.ContextCloseOptions.md b/docs/api/verida-js/interfaces/verida_helpers._internal_.ContextCloseOptions.md deleted file mode 100644 index dc9a3d9..0000000 --- a/docs/api/verida-js/interfaces/verida_helpers._internal_.ContextCloseOptions.md +++ /dev/null @@ -1,27 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/helpers](../modules/verida_helpers.md) / [](../modules/verida_helpers._internal_.md) / ContextCloseOptions - -# Interface: ContextCloseOptions - -[@verida/helpers](../modules/verida_helpers.md).[](../modules/verida_helpers._internal_.md).ContextCloseOptions - -## Hierarchy - -- **`ContextCloseOptions`** - - ↳ [`DatabaseCloseOptions`](verida_helpers._internal_.DatabaseCloseOptions.md) - -## Table of contents - -### Properties - -- [clearLocal](verida_helpers._internal_.ContextCloseOptions.md#clearlocal) - -## Properties - -### clearLocal - -• `Optional` **clearLocal**: `boolean` - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:71 diff --git a/docs/api/verida-js/interfaces/verida_helpers._internal_.ContextDatabaseInfo.md b/docs/api/verida-js/interfaces/verida_helpers._internal_.ContextDatabaseInfo.md deleted file mode 100644 index b4d3469..0000000 --- a/docs/api/verida-js/interfaces/verida_helpers._internal_.ContextDatabaseInfo.md +++ /dev/null @@ -1,65 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/helpers](../modules/verida_helpers.md) / [](../modules/verida_helpers._internal_.md) / ContextDatabaseInfo - -# Interface: ContextDatabaseInfo - -[@verida/helpers](../modules/verida_helpers.md).[](../modules/verida_helpers._internal_.md).ContextDatabaseInfo - -## Table of contents - -### Properties - -- [activeEndpoint](verida_helpers._internal_.ContextDatabaseInfo.md#activeendpoint) -- [databases](verida_helpers._internal_.ContextDatabaseInfo.md#databases) -- [endpoints](verida_helpers._internal_.ContextDatabaseInfo.md#endpoints) -- [keys](verida_helpers._internal_.ContextDatabaseInfo.md#keys) -- [name](verida_helpers._internal_.ContextDatabaseInfo.md#name) - -## Properties - -### activeEndpoint - -• `Optional` **activeEndpoint**: `string` - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:136 - -___ - -### databases - -• **databases**: [`Record`](../modules/verida_helpers._internal_.md#record)<`string`, `object`\> - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:138 - -___ - -### endpoints - -• **endpoints**: [`Record`](../modules/verida_helpers._internal_.md#record)<`string`, `object`\> - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:137 - -___ - -### keys - -• **keys**: `any` - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:139 - -___ - -### name - -• **name**: `string` - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:135 diff --git a/docs/api/verida-js/interfaces/verida_helpers._internal_.ContextInfo.md b/docs/api/verida-js/interfaces/verida_helpers._internal_.ContextInfo.md deleted file mode 100644 index 5e3e3f4..0000000 --- a/docs/api/verida-js/interfaces/verida_helpers._internal_.ContextInfo.md +++ /dev/null @@ -1,21 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/helpers](../modules/verida_helpers.md) / [](../modules/verida_helpers._internal_.md) / ContextInfo - -# Interface: ContextInfo - -[@verida/helpers](../modules/verida_helpers.md).[](../modules/verida_helpers._internal_.md).ContextInfo - -## Table of contents - -### Properties - -- [databases](verida_helpers._internal_.ContextInfo.md#databases) - -## Properties - -### databases - -• **databases**: [`ContextDatabaseInfo`](verida_helpers._internal_.ContextDatabaseInfo.md) - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:142 diff --git a/docs/api/verida-js/interfaces/verida_helpers._internal_.DOMEventTarget.md b/docs/api/verida-js/interfaces/verida_helpers._internal_.DOMEventTarget.md deleted file mode 100644 index 523e45f..0000000 --- a/docs/api/verida-js/interfaces/verida_helpers._internal_.DOMEventTarget.md +++ /dev/null @@ -1,34 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/helpers](../modules/verida_helpers.md) / [](../modules/verida_helpers._internal_.md) / DOMEventTarget - -# Interface: DOMEventTarget - -[@verida/helpers](../modules/verida_helpers.md).[](../modules/verida_helpers._internal_.md).DOMEventTarget - -## Table of contents - -### Methods - -- [addEventListener](verida_helpers._internal_.DOMEventTarget.md#addeventlistener) - -## Methods - -### addEventListener - -▸ **addEventListener**(`eventName`, `listener`, `opts?`): `any` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | `string` | -| `listener` | (...`args`: `any`[]) => `void` | -| `opts?` | `Object` | -| `opts.once` | `boolean` | - -#### Returns - -`any` - -#### Defined in - -node_modules/@types/node/events.d.ts:48 diff --git a/docs/api/verida-js/interfaces/verida_helpers._internal_.DatabaseCloseOptions.md b/docs/api/verida-js/interfaces/verida_helpers._internal_.DatabaseCloseOptions.md deleted file mode 100644 index e9544a3..0000000 --- a/docs/api/verida-js/interfaces/verida_helpers._internal_.DatabaseCloseOptions.md +++ /dev/null @@ -1,31 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/helpers](../modules/verida_helpers.md) / [](../modules/verida_helpers._internal_.md) / DatabaseCloseOptions - -# Interface: DatabaseCloseOptions - -[@verida/helpers](../modules/verida_helpers.md).[](../modules/verida_helpers._internal_.md).DatabaseCloseOptions - -## Hierarchy - -- [`ContextCloseOptions`](verida_helpers._internal_.ContextCloseOptions.md) - - ↳ **`DatabaseCloseOptions`** - -## Table of contents - -### Properties - -- [clearLocal](verida_helpers._internal_.DatabaseCloseOptions.md#clearlocal) - -## Properties - -### clearLocal - -• `Optional` **clearLocal**: `boolean` - -#### Inherited from - -[ContextCloseOptions](verida_helpers._internal_.ContextCloseOptions.md).[clearLocal](verida_helpers._internal_.ContextCloseOptions.md#clearlocal) - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:71 diff --git a/docs/api/verida-js/interfaces/verida_helpers._internal_.DatabaseDeleteConfig.md b/docs/api/verida-js/interfaces/verida_helpers._internal_.DatabaseDeleteConfig.md deleted file mode 100644 index 32b5979..0000000 --- a/docs/api/verida-js/interfaces/verida_helpers._internal_.DatabaseDeleteConfig.md +++ /dev/null @@ -1,21 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/helpers](../modules/verida_helpers.md) / [](../modules/verida_helpers._internal_.md) / DatabaseDeleteConfig - -# Interface: DatabaseDeleteConfig - -[@verida/helpers](../modules/verida_helpers.md).[](../modules/verida_helpers._internal_.md).DatabaseDeleteConfig - -## Table of contents - -### Properties - -- [localOnly](verida_helpers._internal_.DatabaseDeleteConfig.md#localonly) - -## Properties - -### localOnly - -• `Optional` **localOnly**: `boolean` - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:68 diff --git a/docs/api/verida-js/interfaces/verida_helpers._internal_.DatabaseOpenConfig.md b/docs/api/verida-js/interfaces/verida_helpers._internal_.DatabaseOpenConfig.md deleted file mode 100644 index 6dc451d..0000000 --- a/docs/api/verida-js/interfaces/verida_helpers._internal_.DatabaseOpenConfig.md +++ /dev/null @@ -1,187 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/helpers](../modules/verida_helpers.md) / [](../modules/verida_helpers._internal_.md) / DatabaseOpenConfig - -# Interface: DatabaseOpenConfig - -[@verida/helpers](../modules/verida_helpers.md).[](../modules/verida_helpers._internal_.md).DatabaseOpenConfig - -Interface for any DatabaseOpenConfig - -## Table of contents - -### Properties - -- [contextName](verida_helpers._internal_.DatabaseOpenConfig.md#contextname) -- [createContext](verida_helpers._internal_.DatabaseOpenConfig.md#createcontext) -- [did](verida_helpers._internal_.DatabaseOpenConfig.md#did) -- [encryptionKey](verida_helpers._internal_.DatabaseOpenConfig.md#encryptionkey) -- [endpoints](verida_helpers._internal_.DatabaseOpenConfig.md#endpoints) -- [ignoreCache](verida_helpers._internal_.DatabaseOpenConfig.md#ignorecache) -- [isOwner](verida_helpers._internal_.DatabaseOpenConfig.md#isowner) -- [permissions](verida_helpers._internal_.DatabaseOpenConfig.md#permissions) -- [readOnly](verida_helpers._internal_.DatabaseOpenConfig.md#readonly) -- [saveDatabase](verida_helpers._internal_.DatabaseOpenConfig.md#savedatabase) -- [signingContext](verida_helpers._internal_.DatabaseOpenConfig.md#signingcontext) -- [token](verida_helpers._internal_.DatabaseOpenConfig.md#token) -- [verifyEncryptionKey](verida_helpers._internal_.DatabaseOpenConfig.md#verifyencryptionkey) - -## Properties - -### contextName - -• `Optional` **contextName**: `string` - -Optionally specify an external context to open - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:53 - -___ - -### createContext - -• `Optional` **createContext**: `boolean` - -Create an application context if it doesn't already exist for the connected account. - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:49 - -___ - -### did - -• `Optional` **did**: `string` - -Specify the DID that owns the database. - -This ensures the Verida client connects to the correct database server hosting the data for the specified `did`. - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:17 - -___ - -### encryptionKey - -• `Optional` **encryptionKey**: `Buffer` - -An optional encryption key to use for encrypting / decrypting data. - -This encryption key will not apply if the database is marked as `public`. - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:45 - -___ - -### endpoints - -• `Optional` **endpoints**: `string` \| `string`[] - -Specify an array of possible database connection strings to use when opening the database. - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:21 - -___ - -### ignoreCache - -• `Optional` **ignoreCache**: `boolean` - -Ignore any cached instance already created - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:61 - -___ - -### isOwner - -• `Optional` **isOwner**: `boolean` - -Boolean indicating if it's expected the current connected account is the owner of this database. - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:39 - -___ - -### permissions - -• `Optional` **permissions**: [`DatabasePermissionsConfig`](verida_helpers._internal_.DatabasePermissionsConfig.md) - -Specify the permissions to use when opening this database. - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:11 - -___ - -### readOnly - -• `Optional` **readOnly**: `boolean` - -Open the database in read-only mode. - -This is useful when opening a database owned by an external `did` where the current authenticated account has no write access. - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:35 - -___ - -### saveDatabase - -• `Optional` **saveDatabase**: `boolean` - -Save this database into the user's master list of opened databases. - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:29 - -___ - -### signingContext - -• `Optional` **signingContext**: [`IContext`](verida_helpers._internal_.IContext.md) - -Optionally specify the context used to sign data - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:57 - -___ - -### token - -• `Optional` **token**: `string` - -Specify a JWT token to use when opening the database. - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:25 - -___ - -### verifyEncryptionKey - -• `Optional` **verifyEncryptionKey**: `boolean` - -Verify the encryption key is correct when opening the database - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:65 diff --git a/docs/api/verida-js/interfaces/verida_helpers._internal_.DatabasePermissionsConfig.md b/docs/api/verida-js/interfaces/verida_helpers._internal_.DatabasePermissionsConfig.md deleted file mode 100644 index b34231d..0000000 --- a/docs/api/verida-js/interfaces/verida_helpers._internal_.DatabasePermissionsConfig.md +++ /dev/null @@ -1,56 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/helpers](../modules/verida_helpers.md) / [](../modules/verida_helpers._internal_.md) / DatabasePermissionsConfig - -# Interface: DatabasePermissionsConfig - -[@verida/helpers](../modules/verida_helpers.md).[](../modules/verida_helpers._internal_.md).DatabasePermissionsConfig - -Interface for any PermissionsConfig - -## Table of contents - -### Properties - -- [read](verida_helpers._internal_.DatabasePermissionsConfig.md#read) -- [readList](verida_helpers._internal_.DatabasePermissionsConfig.md#readlist) -- [write](verida_helpers._internal_.DatabasePermissionsConfig.md#write) -- [writeList](verida_helpers._internal_.DatabasePermissionsConfig.md#writelist) - -## Properties - -### read - -• **read**: [`DatabasePermissionOptionsEnum`](../enums/verida_helpers._internal_.DatabasePermissionOptionsEnum.md) - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:110 - -___ - -### readList - -• `Optional` **readList**: `string`[] - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:112 - -___ - -### write - -• **write**: [`DatabasePermissionOptionsEnum`](../enums/verida_helpers._internal_.DatabasePermissionOptionsEnum.md) - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:111 - -___ - -### writeList - -• `Optional` **writeList**: `string`[] - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:113 diff --git a/docs/api/verida-js/interfaces/verida_helpers._internal_.DatastoreOpenConfig.md b/docs/api/verida-js/interfaces/verida_helpers._internal_.DatastoreOpenConfig.md deleted file mode 100644 index 4491141..0000000 --- a/docs/api/verida-js/interfaces/verida_helpers._internal_.DatastoreOpenConfig.md +++ /dev/null @@ -1,111 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/helpers](../modules/verida_helpers.md) / [](../modules/verida_helpers._internal_.md) / DatastoreOpenConfig - -# Interface: DatastoreOpenConfig - -[@verida/helpers](../modules/verida_helpers.md).[](../modules/verida_helpers._internal_.md).DatastoreOpenConfig - -Interface for any DatastoreOpenConfig - -## Table of contents - -### Properties - -- [contextName](verida_helpers._internal_.DatastoreOpenConfig.md#contextname) -- [createContext](verida_helpers._internal_.DatastoreOpenConfig.md#createcontext) -- [databaseName](verida_helpers._internal_.DatastoreOpenConfig.md#databasename) -- [did](verida_helpers._internal_.DatastoreOpenConfig.md#did) -- [encryptionKey](verida_helpers._internal_.DatastoreOpenConfig.md#encryptionkey) -- [external](verida_helpers._internal_.DatastoreOpenConfig.md#external) -- [permissions](verida_helpers._internal_.DatastoreOpenConfig.md#permissions) -- [readOnly](verida_helpers._internal_.DatastoreOpenConfig.md#readonly) -- [saveDatabase](verida_helpers._internal_.DatastoreOpenConfig.md#savedatabase) - -## Properties - -### contextName - -• `Optional` **contextName**: `string` - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:87 - -___ - -### createContext - -• `Optional` **createContext**: `boolean` - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:85 - -___ - -### databaseName - -• `Optional` **databaseName**: `string` - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:84 - -___ - -### did - -• `Optional` **did**: `string` - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:80 - -___ - -### encryptionKey - -• `Optional` **encryptionKey**: `string` - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:83 - -___ - -### external - -• `Optional` **external**: `boolean` - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:86 - -___ - -### permissions - -• `Optional` **permissions**: [`DatabasePermissionsConfig`](verida_helpers._internal_.DatabasePermissionsConfig.md) - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:79 - -___ - -### readOnly - -• `Optional` **readOnly**: `boolean` - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:82 - -___ - -### saveDatabase - -• `Optional` **saveDatabase**: `boolean` - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:81 diff --git a/docs/api/verida-js/interfaces/verida_helpers._internal_.DbRegistryEntry.md b/docs/api/verida-js/interfaces/verida_helpers._internal_.DbRegistryEntry.md deleted file mode 100644 index e04caf1..0000000 --- a/docs/api/verida-js/interfaces/verida_helpers._internal_.DbRegistryEntry.md +++ /dev/null @@ -1,100 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/helpers](../modules/verida_helpers.md) / [](../modules/verida_helpers._internal_.md) / DbRegistryEntry - -# Interface: DbRegistryEntry - -[@verida/helpers](../modules/verida_helpers.md).[](../modules/verida_helpers._internal_.md).DbRegistryEntry - -Interface for DbRegistryEntry - -## Table of contents - -### Properties - -- [contextName](verida_helpers._internal_.DbRegistryEntry.md#contextname) -- [dbHash](verida_helpers._internal_.DbRegistryEntry.md#dbhash) -- [dbName](verida_helpers._internal_.DbRegistryEntry.md#dbname) -- [did](verida_helpers._internal_.DbRegistryEntry.md#did) -- [encryptionKey](verida_helpers._internal_.DbRegistryEntry.md#encryptionkey) -- [endpoint](verida_helpers._internal_.DbRegistryEntry.md#endpoint) -- [endpointType](verida_helpers._internal_.DbRegistryEntry.md#endpointtype) -- [permissions](verida_helpers._internal_.DbRegistryEntry.md#permissions) - -## Properties - -### contextName - -• **contextName**: `string` - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:159 - -___ - -### dbHash - -• **dbHash**: `string` - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:155 - -___ - -### dbName - -• **dbName**: `string` - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:156 - -___ - -### did - -• **did**: `string` - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:158 - -___ - -### encryptionKey - -• `Optional` **encryptionKey**: [`DbRegistryEntryEncryptionKey`](verida_helpers._internal_.DbRegistryEntryEncryptionKey.md) - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:161 - -___ - -### endpoint - -• **endpoint**: `string` - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:162 - -___ - -### endpointType - -• **endpointType**: `string` - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:157 - -___ - -### permissions - -• **permissions**: [`DatabasePermissionsConfig`](verida_helpers._internal_.DatabasePermissionsConfig.md) - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:160 diff --git a/docs/api/verida-js/interfaces/verida_helpers._internal_.DbRegistryEntryEncryptionKey.md b/docs/api/verida-js/interfaces/verida_helpers._internal_.DbRegistryEntryEncryptionKey.md deleted file mode 100644 index c810b19..0000000 --- a/docs/api/verida-js/interfaces/verida_helpers._internal_.DbRegistryEntryEncryptionKey.md +++ /dev/null @@ -1,34 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/helpers](../modules/verida_helpers.md) / [](../modules/verida_helpers._internal_.md) / DbRegistryEntryEncryptionKey - -# Interface: DbRegistryEntryEncryptionKey - -[@verida/helpers](../modules/verida_helpers.md).[](../modules/verida_helpers._internal_.md).DbRegistryEntryEncryptionKey - -Interface for DbRegistryEntryEncryptionKey - -## Table of contents - -### Properties - -- [key](verida_helpers._internal_.DbRegistryEntryEncryptionKey.md#key) -- [type](verida_helpers._internal_.DbRegistryEntryEncryptionKey.md#type) - -## Properties - -### key - -• **key**: `string` - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:148 - -___ - -### type - -• **type**: `string` - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:149 diff --git a/docs/api/verida-js/interfaces/verida_helpers._internal_.EndpointUsage.md b/docs/api/verida-js/interfaces/verida_helpers._internal_.EndpointUsage.md deleted file mode 100644 index 3db2fdf..0000000 --- a/docs/api/verida-js/interfaces/verida_helpers._internal_.EndpointUsage.md +++ /dev/null @@ -1,43 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/helpers](../modules/verida_helpers.md) / [](../modules/verida_helpers._internal_.md) / EndpointUsage - -# Interface: EndpointUsage - -[@verida/helpers](../modules/verida_helpers.md).[](../modules/verida_helpers._internal_.md).EndpointUsage - -## Table of contents - -### Properties - -- [bytes](verida_helpers._internal_.EndpointUsage.md#bytes) -- [databases](verida_helpers._internal_.EndpointUsage.md#databases) -- [storageLimit](verida_helpers._internal_.EndpointUsage.md#storagelimit) - -## Properties - -### bytes - -• **bytes**: `number` - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:131 - -___ - -### databases - -• **databases**: `number` - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:130 - -___ - -### storageLimit - -• **storageLimit**: `number` - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:132 diff --git a/docs/api/verida-js/interfaces/verida_helpers._internal_.EventEmitter.Abortable.md b/docs/api/verida-js/interfaces/verida_helpers._internal_.EventEmitter.Abortable.md deleted file mode 100644 index 7918652..0000000 --- a/docs/api/verida-js/interfaces/verida_helpers._internal_.EventEmitter.Abortable.md +++ /dev/null @@ -1,23 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/helpers](../modules/verida_helpers.md) / [](../modules/verida_helpers._internal_.md) / [EventEmitter](../modules/verida_helpers._internal_.EventEmitter.md) / Abortable - -# Interface: Abortable - -[](../modules/verida_helpers._internal_.md).[EventEmitter](../modules/verida_helpers._internal_.EventEmitter.md).Abortable - -## Table of contents - -### Properties - -- [signal](verida_helpers._internal_.EventEmitter.Abortable.md#signal) - -## Properties - -### signal - -• `Optional` **signal**: `AbortSignal` - -When provided the corresponding `AbortController` can be used to cancel an asynchronous action. - -#### Defined in - -node_modules/@types/node/events.d.ts:289 diff --git a/docs/api/verida-js/interfaces/verida_helpers._internal_.EventEmitterOptions.md b/docs/api/verida-js/interfaces/verida_helpers._internal_.EventEmitterOptions.md deleted file mode 100644 index 24331b5..0000000 --- a/docs/api/verida-js/interfaces/verida_helpers._internal_.EventEmitterOptions.md +++ /dev/null @@ -1,23 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/helpers](../modules/verida_helpers.md) / [](../modules/verida_helpers._internal_.md) / EventEmitterOptions - -# Interface: EventEmitterOptions - -[@verida/helpers](../modules/verida_helpers.md).[](../modules/verida_helpers._internal_.md).EventEmitterOptions - -## Table of contents - -### Properties - -- [captureRejections](verida_helpers._internal_.EventEmitterOptions.md#capturerejections) - -## Properties - -### captureRejections - -• `Optional` **captureRejections**: `boolean` - -Enables automatic capturing of promise rejection. - -#### Defined in - -node_modules/@types/node/events.d.ts:42 diff --git a/docs/api/verida-js/interfaces/verida_helpers._internal_.FetchUriParams.md b/docs/api/verida-js/interfaces/verida_helpers._internal_.FetchUriParams.md deleted file mode 100644 index 4421bcd..0000000 --- a/docs/api/verida-js/interfaces/verida_helpers._internal_.FetchUriParams.md +++ /dev/null @@ -1,76 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/helpers](../modules/verida_helpers.md) / [](../modules/verida_helpers._internal_.md) / FetchUriParams - -# Interface: FetchUriParams - -[@verida/helpers](../modules/verida_helpers.md).[](../modules/verida_helpers._internal_.md).FetchUriParams - -## Table of contents - -### Properties - -- [contextName](verida_helpers._internal_.FetchUriParams.md#contextname) -- [dbName](verida_helpers._internal_.FetchUriParams.md#dbname) -- [deepAttributes](verida_helpers._internal_.FetchUriParams.md#deepattributes) -- [did](verida_helpers._internal_.FetchUriParams.md#did) -- [query](verida_helpers._internal_.FetchUriParams.md#query) -- [recordId](verida_helpers._internal_.FetchUriParams.md#recordid) - -## Properties - -### contextName - -• **contextName**: `string` - -#### Defined in - -packages/types/dist/NetworkInterfaces.d.ts:80 - -___ - -### dbName - -• **dbName**: `string` - -#### Defined in - -packages/types/dist/NetworkInterfaces.d.ts:81 - -___ - -### deepAttributes - -• **deepAttributes**: `string`[] - -#### Defined in - -packages/types/dist/NetworkInterfaces.d.ts:83 - -___ - -### did - -• **did**: `string` - -#### Defined in - -packages/types/dist/NetworkInterfaces.d.ts:79 - -___ - -### query - -• **query**: `any` - -#### Defined in - -packages/types/dist/NetworkInterfaces.d.ts:84 - -___ - -### recordId - -• **recordId**: `string` - -#### Defined in - -packages/types/dist/NetworkInterfaces.d.ts:82 diff --git a/docs/api/verida-js/interfaces/verida_helpers._internal_.IAccount.md b/docs/api/verida-js/interfaces/verida_helpers._internal_.IAccount.md deleted file mode 100644 index 52e127d..0000000 --- a/docs/api/verida-js/interfaces/verida_helpers._internal_.IAccount.md +++ /dev/null @@ -1,266 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/helpers](../modules/verida_helpers.md) / [](../modules/verida_helpers._internal_.md) / IAccount - -# Interface: IAccount - -[@verida/helpers](../modules/verida_helpers.md).[](../modules/verida_helpers._internal_.md).IAccount - -## Table of contents - -### Methods - -- [createDidJwt](verida_helpers._internal_.IAccount.md#createdidjwt) -- [did](verida_helpers._internal_.IAccount.md#did) -- [disconnect](verida_helpers._internal_.IAccount.md#disconnect) -- [disconnectDevice](verida_helpers._internal_.IAccount.md#disconnectdevice) -- [getAuthContext](verida_helpers._internal_.IAccount.md#getauthcontext) -- [keyring](verida_helpers._internal_.IAccount.md#keyring) -- [linkStorage](verida_helpers._internal_.IAccount.md#linkstorage) -- [linkStorageContextService](verida_helpers._internal_.IAccount.md#linkstoragecontextservice) -- [setAccountConfig](verida_helpers._internal_.IAccount.md#setaccountconfig) -- [sign](verida_helpers._internal_.IAccount.md#sign) -- [storageConfig](verida_helpers._internal_.IAccount.md#storageconfig) -- [unlinkStorage](verida_helpers._internal_.IAccount.md#unlinkstorage) - -## Methods - -### createDidJwt - -▸ **createDidJwt**(`contextName`, `data`, `config`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | -| `data` | `object` | -| `config` | `any` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -packages/types/dist/IAccount.d.ts:13 - -___ - -### did - -▸ **did**(): `Promise`<`string`\> - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -packages/types/dist/IAccount.d.ts:7 - -___ - -### disconnect - -▸ **disconnect**(`contextName?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName?` | `string` | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -packages/types/dist/IAccount.d.ts:14 - -___ - -### disconnectDevice - -▸ **disconnectDevice**(`contextName`, `deviceId`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | -| `deviceId` | `string` | - -#### Returns - -`Promise`<`boolean`\> - -#### Defined in - -packages/types/dist/IAccount.d.ts:16 - -___ - -### getAuthContext - -▸ **getAuthContext**(`contextName`, `contextConfig`, `authConfig?`, `authType?`): `Promise`<[`AuthContext`](verida_helpers._internal_.AuthContext.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | -| `contextConfig` | [`SecureContextConfig`](verida_helpers._internal_.SecureContextConfig.md) | -| `authConfig?` | [`AuthTypeConfig`](verida_helpers._internal_.AuthTypeConfig.md) | -| `authType?` | `string` | - -#### Returns - -`Promise`<[`AuthContext`](verida_helpers._internal_.AuthContext.md)\> - -#### Defined in - -packages/types/dist/IAccount.d.ts:15 - -___ - -### keyring - -▸ **keyring**(`contextName`): `Promise`<[`IKeyring`](verida_helpers._internal_.IKeyring.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | - -#### Returns - -`Promise`<[`IKeyring`](verida_helpers._internal_.IKeyring.md)\> - -#### Defined in - -packages/types/dist/IAccount.d.ts:5 - -___ - -### linkStorage - -▸ **linkStorage**(`storageConfig`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `storageConfig` | [`SecureContextConfig`](verida_helpers._internal_.SecureContextConfig.md) | - -#### Returns - -`Promise`<`boolean`\> - -#### Defined in - -packages/types/dist/IAccount.d.ts:8 - -___ - -### linkStorageContextService - -▸ **linkStorageContextService**(`contextName`, `endpointType`, `serverType`, `endpointUris`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | -| `endpointType` | `string` | -| `serverType` | `string` | -| `endpointUris` | `string`[] | - -#### Returns - -`Promise`<`boolean`\> - -#### Defined in - -packages/types/dist/IAccount.d.ts:11 - -___ - -### setAccountConfig - -▸ **setAccountConfig**(`accountConfig`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `accountConfig` | [`AccountConfig`](verida_helpers._internal_.AccountConfig.md) | - -#### Returns - -`void` - -#### Defined in - -packages/types/dist/IAccount.d.ts:12 - -___ - -### sign - -▸ **sign**(`input`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `input` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -packages/types/dist/IAccount.d.ts:6 - -___ - -### storageConfig - -▸ **storageConfig**(`contextName`, `forceCreate`): `Promise`<`undefined` \| [`SecureContextConfig`](verida_helpers._internal_.SecureContextConfig.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | -| `forceCreate` | `boolean` | - -#### Returns - -`Promise`<`undefined` \| [`SecureContextConfig`](verida_helpers._internal_.SecureContextConfig.md)\> - -#### Defined in - -packages/types/dist/IAccount.d.ts:10 - -___ - -### unlinkStorage - -▸ **unlinkStorage**(`contextName`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | - -#### Returns - -`Promise`<`boolean`\> - -#### Defined in - -packages/types/dist/IAccount.d.ts:9 diff --git a/docs/api/verida-js/interfaces/verida_helpers._internal_.IClient.md b/docs/api/verida-js/interfaces/verida_helpers._internal_.IClient.md deleted file mode 100644 index 2279863..0000000 --- a/docs/api/verida-js/interfaces/verida_helpers._internal_.IClient.md +++ /dev/null @@ -1,179 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/helpers](../modules/verida_helpers.md) / [](../modules/verida_helpers._internal_.md) / IClient - -# Interface: IClient - -[@verida/helpers](../modules/verida_helpers.md).[](../modules/verida_helpers._internal_.md).IClient - -## Table of contents - -### Methods - -- [connect](verida_helpers._internal_.IClient.md#connect) -- [getContextConfig](verida_helpers._internal_.IClient.md#getcontextconfig) -- [getSchema](verida_helpers._internal_.IClient.md#getschema) -- [getValidDataSignatures](verida_helpers._internal_.IClient.md#getvaliddatasignatures) -- [isConnected](verida_helpers._internal_.IClient.md#isconnected) -- [openContext](verida_helpers._internal_.IClient.md#opencontext) -- [openExternalContext](verida_helpers._internal_.IClient.md#openexternalcontext) -- [openPublicProfile](verida_helpers._internal_.IClient.md#openpublicprofile) - -## Methods - -### connect - -▸ **connect**(`account`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `account` | [`IAccount`](verida_helpers._internal_.IAccount.md) | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -packages/types/dist/IClient.d.ts:7 - -___ - -### getContextConfig - -▸ **getContextConfig**(`did`, `contextName`): `Promise`<`undefined` \| [`SecureContextConfig`](verida_helpers._internal_.SecureContextConfig.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did` | `string` | -| `contextName` | `string` | - -#### Returns - -`Promise`<`undefined` \| [`SecureContextConfig`](verida_helpers._internal_.SecureContextConfig.md)\> - -#### Defined in - -packages/types/dist/IClient.d.ts:11 - -___ - -### getSchema - -▸ **getSchema**(`schemaUri`): `Promise`<[`ISchema`](verida_helpers._internal_.ISchema.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schemaUri` | `string` | - -#### Returns - -`Promise`<[`ISchema`](verida_helpers._internal_.ISchema.md)\> - -#### Defined in - -packages/types/dist/IClient.d.ts:14 - -___ - -### getValidDataSignatures - -▸ **getValidDataSignatures**(`data`, `did?`): `Promise`<`string`[]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `any` | -| `did?` | `string` | - -#### Returns - -`Promise`<`string`[]\> - -#### Defined in - -packages/types/dist/IClient.d.ts:13 - -___ - -### isConnected - -▸ **isConnected**(): `void` - -#### Returns - -`void` - -#### Defined in - -packages/types/dist/IClient.d.ts:8 - -___ - -### openContext - -▸ **openContext**(`contextName`, `forceCreate`): `Promise`<`undefined` \| [`IContext`](verida_helpers._internal_.IContext.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | -| `forceCreate` | `boolean` | - -#### Returns - -`Promise`<`undefined` \| [`IContext`](verida_helpers._internal_.IContext.md)\> - -#### Defined in - -packages/types/dist/IClient.d.ts:9 - -___ - -### openExternalContext - -▸ **openExternalContext**(`contextName`, `did`): `Promise`<[`IContext`](verida_helpers._internal_.IContext.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | -| `did` | `string` | - -#### Returns - -`Promise`<[`IContext`](verida_helpers._internal_.IContext.md)\> - -#### Defined in - -packages/types/dist/IClient.d.ts:10 - -___ - -### openPublicProfile - -▸ **openPublicProfile**(`did`, `contextName`, `profileName`, `fallbackContext`): `Promise`<`undefined` \| [`IProfile`](verida_helpers._internal_.IProfile.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did` | `string` | -| `contextName` | `string` | -| `profileName` | `string` | -| `fallbackContext` | ``null`` \| `string` | - -#### Returns - -`Promise`<`undefined` \| [`IProfile`](verida_helpers._internal_.IProfile.md)\> - -#### Defined in - -packages/types/dist/IClient.d.ts:12 diff --git a/docs/api/verida-js/interfaces/verida_helpers._internal_.IContext.md b/docs/api/verida-js/interfaces/verida_helpers._internal_.IContext.md deleted file mode 100644 index df1ab31..0000000 --- a/docs/api/verida-js/interfaces/verida_helpers._internal_.IContext.md +++ /dev/null @@ -1,402 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/helpers](../modules/verida_helpers.md) / [](../modules/verida_helpers._internal_.md) / IContext - -# Interface: IContext - -[@verida/helpers](../modules/verida_helpers.md).[](../modules/verida_helpers._internal_.md).IContext - -## Table of contents - -### Methods - -- [addEndpoint](verida_helpers._internal_.IContext.md#addendpoint) -- [clearDatabaseCache](verida_helpers._internal_.IContext.md#cleardatabasecache) -- [close](verida_helpers._internal_.IContext.md#close) -- [disconnect](verida_helpers._internal_.IContext.md#disconnect) -- [getAccount](verida_helpers._internal_.IContext.md#getaccount) -- [getAuthContext](verida_helpers._internal_.IContext.md#getauthcontext) -- [getClient](verida_helpers._internal_.IContext.md#getclient) -- [getContextConfig](verida_helpers._internal_.IContext.md#getcontextconfig) -- [getContextName](verida_helpers._internal_.IContext.md#getcontextname) -- [getDatabaseEngine](verida_helpers._internal_.IContext.md#getdatabaseengine) -- [getDbRegistry](verida_helpers._internal_.IContext.md#getdbregistry) -- [getDidContextManager](verida_helpers._internal_.IContext.md#getdidcontextmanager) -- [getMessaging](verida_helpers._internal_.IContext.md#getmessaging) -- [getNotification](verida_helpers._internal_.IContext.md#getnotification) -- [info](verida_helpers._internal_.IContext.md#info) -- [openDatabase](verida_helpers._internal_.IContext.md#opendatabase) -- [openDatastore](verida_helpers._internal_.IContext.md#opendatastore) -- [openExternalDatabase](verida_helpers._internal_.IContext.md#openexternaldatabase) -- [openExternalDatastore](verida_helpers._internal_.IContext.md#openexternaldatastore) -- [openProfile](verida_helpers._internal_.IContext.md#openprofile) - -## Methods - -### addEndpoint - -▸ **addEndpoint**(`engineType`, `endpointUri`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `engineType` | [`ContextEngineType`](../enums/verida_helpers._internal_.ContextEngineType.md) | -| `endpointUri` | `string` | - -#### Returns - -`void` - -#### Defined in - -packages/types/dist/IContext.d.ts:32 - -___ - -### clearDatabaseCache - -▸ **clearDatabaseCache**(`did`, `databaseName`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did` | `string` | -| `databaseName` | `string` | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -packages/types/dist/IContext.d.ts:34 - -___ - -### close - -▸ **close**(`options?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options?` | [`ContextCloseOptions`](verida_helpers._internal_.ContextCloseOptions.md) | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -packages/types/dist/IContext.d.ts:33 - -___ - -### disconnect - -▸ **disconnect**(): `Promise`<`boolean`\> - -#### Returns - -`Promise`<`boolean`\> - -#### Defined in - -packages/types/dist/IContext.d.ts:20 - -___ - -### getAccount - -▸ **getAccount**(): [`IAccount`](verida_helpers._internal_.IAccount.md) - -#### Returns - -[`IAccount`](verida_helpers._internal_.IAccount.md) - -#### Defined in - -packages/types/dist/IContext.d.ts:17 - -___ - -### getAuthContext - -▸ **getAuthContext**(`authConfig?`, `authType?`): `Promise`<[`AuthContext`](verida_helpers._internal_.AuthContext.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `authConfig?` | [`AuthTypeConfig`](verida_helpers._internal_.AuthTypeConfig.md) | -| `authType?` | `string` | - -#### Returns - -`Promise`<[`AuthContext`](verida_helpers._internal_.AuthContext.md)\> - -#### Defined in - -packages/types/dist/IContext.d.ts:31 - -___ - -### getClient - -▸ **getClient**(): [`IClient`](verida_helpers._internal_.IClient.md) - -#### Returns - -[`IClient`](verida_helpers._internal_.IClient.md) - -#### Defined in - -packages/types/dist/IContext.d.ts:19 - -___ - -### getContextConfig - -▸ **getContextConfig**(`did?`, `forceCreate?`, `customContextName?`): `Promise`<[`SecureContextConfig`](verida_helpers._internal_.SecureContextConfig.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did?` | `string` | -| `forceCreate?` | `boolean` | -| `customContextName?` | `string` | - -#### Returns - -`Promise`<[`SecureContextConfig`](verida_helpers._internal_.SecureContextConfig.md)\> - -#### Defined in - -packages/types/dist/IContext.d.ts:15 - -___ - -### getContextName - -▸ **getContextName**(): `string` - -#### Returns - -`string` - -#### Defined in - -packages/types/dist/IContext.d.ts:16 - -___ - -### getDatabaseEngine - -▸ **getDatabaseEngine**(`did`, `createContext?`): `Promise`<[`IStorageEngine`](verida_helpers._internal_.IStorageEngine.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did` | `string` | -| `createContext?` | `boolean` | - -#### Returns - -`Promise`<[`IStorageEngine`](verida_helpers._internal_.IStorageEngine.md)\> - -#### Defined in - -packages/types/dist/IContext.d.ts:21 - -___ - -### getDbRegistry - -▸ **getDbRegistry**(): [`IDbRegistry`](verida_helpers._internal_.IDbRegistry.md) - -#### Returns - -[`IDbRegistry`](verida_helpers._internal_.IDbRegistry.md) - -#### Defined in - -packages/types/dist/IContext.d.ts:29 - -___ - -### getDidContextManager - -▸ **getDidContextManager**(): [`IDIDContextManager`](verida_helpers._internal_.IDIDContextManager.md) - -#### Returns - -[`IDIDContextManager`](verida_helpers._internal_.IDIDContextManager.md) - -#### Defined in - -packages/types/dist/IContext.d.ts:18 - -___ - -### getMessaging - -▸ **getMessaging**(`messageConfig`): `Promise`<[`IMessaging`](verida_helpers._internal_.IMessaging.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `messageConfig` | [`MessagesConfig`](verida_helpers._internal_.MessagesConfig.md) | - -#### Returns - -`Promise`<[`IMessaging`](verida_helpers._internal_.IMessaging.md)\> - -#### Defined in - -packages/types/dist/IContext.d.ts:22 - -___ - -### getNotification - -▸ **getNotification**(`did`, `contextName`): `Promise`<`undefined` \| [`INotification`](verida_helpers._internal_.INotification.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did` | `string` | -| `contextName` | `string` | - -#### Returns - -`Promise`<`undefined` \| [`INotification`](verida_helpers._internal_.INotification.md)\> - -#### Defined in - -packages/types/dist/IContext.d.ts:23 - -___ - -### info - -▸ **info**(): `Promise`<[`ContextInfo`](verida_helpers._internal_.ContextInfo.md)\> - -#### Returns - -`Promise`<[`ContextInfo`](verida_helpers._internal_.ContextInfo.md)\> - -#### Defined in - -packages/types/dist/IContext.d.ts:30 - -___ - -### openDatabase - -▸ **openDatabase**(`databaseName`, `config?`): `Promise`<[`IDatabase`](verida_helpers._internal_.IDatabase.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `databaseName` | `string` | -| `config?` | [`DatabaseOpenConfig`](verida_helpers._internal_.DatabaseOpenConfig.md) | - -#### Returns - -`Promise`<[`IDatabase`](verida_helpers._internal_.IDatabase.md)\> - -#### Defined in - -packages/types/dist/IContext.d.ts:25 - -___ - -### openDatastore - -▸ **openDatastore**(`schemaUri`, `config?`): `Promise`<[`IDatastore`](verida_helpers._internal_.IDatastore.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schemaUri` | `string` | -| `config?` | [`DatastoreOpenConfig`](verida_helpers._internal_.DatastoreOpenConfig.md) | - -#### Returns - -`Promise`<[`IDatastore`](verida_helpers._internal_.IDatastore.md)\> - -#### Defined in - -packages/types/dist/IContext.d.ts:27 - -___ - -### openExternalDatabase - -▸ **openExternalDatabase**(`databaseName`, `did`, `config?`): `Promise`<[`IDatabase`](verida_helpers._internal_.IDatabase.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `databaseName` | `string` | -| `did` | `string` | -| `config?` | [`DatabaseOpenConfig`](verida_helpers._internal_.DatabaseOpenConfig.md) | - -#### Returns - -`Promise`<[`IDatabase`](verida_helpers._internal_.IDatabase.md)\> - -#### Defined in - -packages/types/dist/IContext.d.ts:26 - -___ - -### openExternalDatastore - -▸ **openExternalDatastore**(`schemaUri`, `did`, `options?`): `Promise`<[`IDatastore`](verida_helpers._internal_.IDatastore.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schemaUri` | `string` | -| `did` | `string` | -| `options?` | [`DatastoreOpenConfig`](verida_helpers._internal_.DatastoreOpenConfig.md) | - -#### Returns - -`Promise`<[`IDatastore`](verida_helpers._internal_.IDatastore.md)\> - -#### Defined in - -packages/types/dist/IContext.d.ts:28 - -___ - -### openProfile - -▸ **openProfile**(`profileName?`, `did?`): `Promise`<`undefined` \| [`IProfile`](verida_helpers._internal_.IProfile.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `profileName?` | `string` | -| `did?` | `string` | - -#### Returns - -`Promise`<`undefined` \| [`IProfile`](verida_helpers._internal_.IProfile.md)\> - -#### Defined in - -packages/types/dist/IContext.d.ts:24 diff --git a/docs/api/verida-js/interfaces/verida_helpers._internal_.IDIDContextManager.md b/docs/api/verida-js/interfaces/verida_helpers._internal_.IDIDContextManager.md deleted file mode 100644 index 45295d7..0000000 --- a/docs/api/verida-js/interfaces/verida_helpers._internal_.IDIDContextManager.md +++ /dev/null @@ -1,145 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/helpers](../modules/verida_helpers.md) / [](../modules/verida_helpers._internal_.md) / IDIDContextManager - -# Interface: IDIDContextManager - -[@verida/helpers](../modules/verida_helpers.md).[](../modules/verida_helpers._internal_.md).IDIDContextManager - -## Table of contents - -### Methods - -- [getContextDatabaseServer](verida_helpers._internal_.IDIDContextManager.md#getcontextdatabaseserver) -- [getContextMessageServer](verida_helpers._internal_.IDIDContextManager.md#getcontextmessageserver) -- [getContextStorageServer](verida_helpers._internal_.IDIDContextManager.md#getcontextstorageserver) -- [getDIDContextConfig](verida_helpers._internal_.IDIDContextManager.md#getdidcontextconfig) -- [getDIDContextHashConfig](verida_helpers._internal_.IDIDContextManager.md#getdidcontexthashconfig) -- [setAccount](verida_helpers._internal_.IDIDContextManager.md#setaccount) - -## Methods - -### getContextDatabaseServer - -▸ **getContextDatabaseServer**(`did`, `contextName`, `forceCreate`): `Promise`<[`SecureContextEndpoint`](verida_helpers._internal_.SecureContextEndpoint.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did` | `string` | -| `contextName` | `string` | -| `forceCreate` | `boolean` | - -#### Returns - -`Promise`<[`SecureContextEndpoint`](verida_helpers._internal_.SecureContextEndpoint.md)\> - -#### Defined in - -packages/types/dist/IDIDContextManager.d.ts:6 - -___ - -### getContextMessageServer - -▸ **getContextMessageServer**(`did`, `contextName`, `forceCreate`): `Promise`<[`SecureContextEndpoint`](verida_helpers._internal_.SecureContextEndpoint.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did` | `string` | -| `contextName` | `string` | -| `forceCreate` | `boolean` | - -#### Returns - -`Promise`<[`SecureContextEndpoint`](verida_helpers._internal_.SecureContextEndpoint.md)\> - -#### Defined in - -packages/types/dist/IDIDContextManager.d.ts:8 - -___ - -### getContextStorageServer - -▸ **getContextStorageServer**(`did`, `contextName`, `forceCreate`): `Promise`<[`SecureContextEndpoint`](verida_helpers._internal_.SecureContextEndpoint.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did` | `string` | -| `contextName` | `string` | -| `forceCreate` | `boolean` | - -#### Returns - -`Promise`<[`SecureContextEndpoint`](verida_helpers._internal_.SecureContextEndpoint.md)\> - -#### Defined in - -packages/types/dist/IDIDContextManager.d.ts:7 - -___ - -### getDIDContextConfig - -▸ **getDIDContextConfig**(`did`, `contextName`, `forceCreate?`): `Promise`<[`SecureContextConfig`](verida_helpers._internal_.SecureContextConfig.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did` | `string` | -| `contextName` | `string` | -| `forceCreate?` | `boolean` | - -#### Returns - -`Promise`<[`SecureContextConfig`](verida_helpers._internal_.SecureContextConfig.md)\> - -#### Defined in - -packages/types/dist/IDIDContextManager.d.ts:10 - -___ - -### getDIDContextHashConfig - -▸ **getDIDContextHashConfig**(`did`, `contextHash`): `Promise`<[`SecureContextConfig`](verida_helpers._internal_.SecureContextConfig.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did` | `string` | -| `contextHash` | `string` | - -#### Returns - -`Promise`<[`SecureContextConfig`](verida_helpers._internal_.SecureContextConfig.md)\> - -#### Defined in - -packages/types/dist/IDIDContextManager.d.ts:9 - -___ - -### setAccount - -▸ **setAccount**(`account`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `account` | [`IAccount`](verida_helpers._internal_.IAccount.md) | - -#### Returns - -`void` - -#### Defined in - -packages/types/dist/IDIDContextManager.d.ts:5 diff --git a/docs/api/verida-js/interfaces/verida_helpers._internal_.IDatabase.md b/docs/api/verida-js/interfaces/verida_helpers._internal_.IDatabase.md deleted file mode 100644 index acceb66..0000000 --- a/docs/api/verida-js/interfaces/verida_helpers._internal_.IDatabase.md +++ /dev/null @@ -1,261 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/helpers](../modules/verida_helpers.md) / [](../modules/verida_helpers._internal_.md) / IDatabase - -# Interface: IDatabase - -[@verida/helpers](../modules/verida_helpers.md).[](../modules/verida_helpers._internal_.md).IDatabase - -Interface for any database returned from a storage engine - -## Table of contents - -### Methods - -- [changes](verida_helpers._internal_.IDatabase.md#changes) -- [close](verida_helpers._internal_.IDatabase.md#close) -- [delete](verida_helpers._internal_.IDatabase.md#delete) -- [deleteAll](verida_helpers._internal_.IDatabase.md#deleteall) -- [destroy](verida_helpers._internal_.IDatabase.md#destroy) -- [get](verida_helpers._internal_.IDatabase.md#get) -- [getDb](verida_helpers._internal_.IDatabase.md#getdb) -- [getMany](verida_helpers._internal_.IDatabase.md#getmany) -- [info](verida_helpers._internal_.IDatabase.md#info) -- [registryEntry](verida_helpers._internal_.IDatabase.md#registryentry) -- [save](verida_helpers._internal_.IDatabase.md#save) -- [updateUsers](verida_helpers._internal_.IDatabase.md#updateusers) -- [usage](verida_helpers._internal_.IDatabase.md#usage) - -## Methods - -### changes - -▸ **changes**(`cb`, `options?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `cb` | `Function` | -| `options?` | `any` | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -packages/types/dist/IDatabase.d.ts:11 - -___ - -### close - -▸ **close**(`options?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options?` | [`DatabaseCloseOptions`](verida_helpers._internal_.DatabaseCloseOptions.md) | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -packages/types/dist/IDatabase.d.ts:16 - -___ - -### delete - -▸ **delete**(`doc`, `options?`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `doc` | `any` | -| `options?` | `any` | - -#### Returns - -`Promise`<`boolean`\> - -#### Defined in - -packages/types/dist/IDatabase.d.ts:9 - -___ - -### deleteAll - -▸ **deleteAll**(): `Promise`<`void`\> - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -packages/types/dist/IDatabase.d.ts:10 - -___ - -### destroy - -▸ **destroy**(`options?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options?` | [`DatabaseDeleteConfig`](verida_helpers._internal_.DatabaseDeleteConfig.md) | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -packages/types/dist/IDatabase.d.ts:17 - -___ - -### get - -▸ **get**(`docId`, `options?`): `Promise`<`undefined` \| `object`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `docId` | `any` | -| `options?` | `any` | - -#### Returns - -`Promise`<`undefined` \| `object`\> - -#### Defined in - -packages/types/dist/IDatabase.d.ts:8 - -___ - -### getDb - -▸ **getDb**(): `Promise`<`any`\> - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -packages/types/dist/IDatabase.d.ts:13 - -___ - -### getMany - -▸ **getMany**(`filter?`, `options?`): `Promise`<`object`[]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `filter?` | `any` | -| `options?` | `any` | - -#### Returns - -`Promise`<`object`[]\> - -#### Defined in - -packages/types/dist/IDatabase.d.ts:7 - -___ - -### info - -▸ **info**(): `Promise`<`any`\> - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -packages/types/dist/IDatabase.d.ts:14 - -___ - -### registryEntry - -▸ **registryEntry**(): `Promise`<[`DbRegistryEntry`](verida_helpers._internal_.DbRegistryEntry.md)\> - -#### Returns - -`Promise`<[`DbRegistryEntry`](verida_helpers._internal_.DbRegistryEntry.md)\> - -#### Defined in - -packages/types/dist/IDatabase.d.ts:15 - -___ - -### save - -▸ **save**(`data`, `options?`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `any` | -| `options?` | `any` | - -#### Returns - -`Promise`<`boolean`\> - -#### Defined in - -packages/types/dist/IDatabase.d.ts:6 - -___ - -### updateUsers - -▸ **updateUsers**(`readList`, `writeList`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `readList` | `string`[] | -| `writeList` | `string`[] | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -packages/types/dist/IDatabase.d.ts:12 - -___ - -### usage - -▸ **usage**(): `Promise`<[`EndpointUsage`](verida_helpers._internal_.EndpointUsage.md)\> - -#### Returns - -`Promise`<[`EndpointUsage`](verida_helpers._internal_.EndpointUsage.md)\> - -#### Defined in - -packages/types/dist/IDatabase.d.ts:18 diff --git a/docs/api/verida-js/interfaces/verida_helpers._internal_.IDatastore.md b/docs/api/verida-js/interfaces/verida_helpers._internal_.IDatastore.md deleted file mode 100644 index e7dfc9c..0000000 --- a/docs/api/verida-js/interfaces/verida_helpers._internal_.IDatastore.md +++ /dev/null @@ -1,249 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/helpers](../modules/verida_helpers.md) / [](../modules/verida_helpers._internal_.md) / IDatastore - -# Interface: IDatastore - -[@verida/helpers](../modules/verida_helpers.md).[](../modules/verida_helpers._internal_.md).IDatastore - -## Table of contents - -### Properties - -- [errors](verida_helpers._internal_.IDatastore.md#errors) - -### Methods - -- [changes](verida_helpers._internal_.IDatastore.md#changes) -- [close](verida_helpers._internal_.IDatastore.md#close) -- [delete](verida_helpers._internal_.IDatastore.md#delete) -- [deleteAll](verida_helpers._internal_.IDatastore.md#deleteall) -- [ensureIndexes](verida_helpers._internal_.IDatastore.md#ensureindexes) -- [get](verida_helpers._internal_.IDatastore.md#get) -- [getDb](verida_helpers._internal_.IDatastore.md#getdb) -- [getMany](verida_helpers._internal_.IDatastore.md#getmany) -- [getOne](verida_helpers._internal_.IDatastore.md#getone) -- [save](verida_helpers._internal_.IDatastore.md#save) -- [updateUsers](verida_helpers._internal_.IDatastore.md#updateusers) - -## Properties - -### errors - -• **errors**: `any` - -#### Defined in - -packages/types/dist/IDatastore.d.ts:4 - -## Methods - -### changes - -▸ **changes**(`cb`, `options`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `cb` | `any` | -| `options` | `any` | - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -packages/types/dist/IDatastore.d.ts:12 - -___ - -### close - -▸ **close**(`options?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options?` | [`DatabaseCloseOptions`](verida_helpers._internal_.DatabaseCloseOptions.md) | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -packages/types/dist/IDatastore.d.ts:15 - -___ - -### delete - -▸ **delete**(`docId`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `docId` | `string` | - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -packages/types/dist/IDatastore.d.ts:9 - -___ - -### deleteAll - -▸ **deleteAll**(): `Promise`<`void`\> - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -packages/types/dist/IDatastore.d.ts:10 - -___ - -### ensureIndexes - -▸ **ensureIndexes**(`indexes`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `indexes` | `any` | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -packages/types/dist/IDatastore.d.ts:13 - -___ - -### get - -▸ **get**(`key`, `options`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `key` | `string` | -| `options` | `any` | - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -packages/types/dist/IDatastore.d.ts:8 - -___ - -### getDb - -▸ **getDb**(): `Promise`<[`IDatabase`](verida_helpers._internal_.IDatabase.md)\> - -#### Returns - -`Promise`<[`IDatabase`](verida_helpers._internal_.IDatabase.md)\> - -#### Defined in - -packages/types/dist/IDatastore.d.ts:11 - -___ - -### getMany - -▸ **getMany**(`customFilter?`, `options?`): `Promise`<`object`[]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `customFilter?` | `any` | -| `options?` | `any` | - -#### Returns - -`Promise`<`object`[]\> - -#### Defined in - -packages/types/dist/IDatastore.d.ts:6 - -___ - -### getOne - -▸ **getOne**(`customFilter?`, `options?`): `Promise`<`undefined` \| `object`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `customFilter?` | `any` | -| `options?` | `any` | - -#### Returns - -`Promise`<`undefined` \| `object`\> - -#### Defined in - -packages/types/dist/IDatastore.d.ts:7 - -___ - -### save - -▸ **save**(`data`, `options`): `Promise`<`boolean` \| `object`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `any` | -| `options` | `any` | - -#### Returns - -`Promise`<`boolean` \| `object`\> - -#### Defined in - -packages/types/dist/IDatastore.d.ts:5 - -___ - -### updateUsers - -▸ **updateUsers**(`readList`, `writeList`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `readList` | `string`[] | -| `writeList` | `string`[] | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -packages/types/dist/IDatastore.d.ts:14 diff --git a/docs/api/verida-js/interfaces/verida_helpers._internal_.IDbRegistry.md b/docs/api/verida-js/interfaces/verida_helpers._internal_.IDbRegistry.md deleted file mode 100644 index 9bcde6e..0000000 --- a/docs/api/verida-js/interfaces/verida_helpers._internal_.IDbRegistry.md +++ /dev/null @@ -1,115 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/helpers](../modules/verida_helpers.md) / [](../modules/verida_helpers._internal_.md) / IDbRegistry - -# Interface: IDbRegistry - -[@verida/helpers](../modules/verida_helpers.md).[](../modules/verida_helpers._internal_.md).IDbRegistry - -## Table of contents - -### Methods - -- [get](verida_helpers._internal_.IDbRegistry.md#get) -- [getMany](verida_helpers._internal_.IDbRegistry.md#getmany) -- [init](verida_helpers._internal_.IDbRegistry.md#init) -- [removeDb](verida_helpers._internal_.IDbRegistry.md#removedb) -- [saveDb](verida_helpers._internal_.IDbRegistry.md#savedb) - -## Methods - -### get - -▸ **get**(`dbName`, `did`, `contextName`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `dbName` | `string` | -| `did` | `string` | -| `contextName` | `string` | - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -packages/types/dist/IDbRegistry.d.ts:6 - -___ - -### getMany - -▸ **getMany**(`filter`, `options`): `Promise`<`any`[]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `filter` | `any` | -| `options` | `any` | - -#### Returns - -`Promise`<`any`[]\> - -#### Defined in - -packages/types/dist/IDbRegistry.d.ts:5 - -___ - -### init - -▸ **init**(): `Promise`<`void`\> - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -packages/types/dist/IDbRegistry.d.ts:7 - -___ - -### removeDb - -▸ **removeDb**(`databaseName`, `did`, `contextName`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `databaseName` | `string` | -| `did` | `string` | -| `contextName` | `string` | - -#### Returns - -`Promise`<`boolean`\> - -#### Defined in - -packages/types/dist/IDbRegistry.d.ts:4 - -___ - -### saveDb - -▸ **saveDb**(`database`, `checkPermissions`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `database` | [`IDatabase`](verida_helpers._internal_.IDatabase.md) | -| `checkPermissions` | `boolean` | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -packages/types/dist/IDbRegistry.d.ts:3 diff --git a/docs/api/verida-js/interfaces/verida_helpers._internal_.IKeyring.md b/docs/api/verida-js/interfaces/verida_helpers._internal_.IKeyring.md deleted file mode 100644 index c1006e7..0000000 --- a/docs/api/verida-js/interfaces/verida_helpers._internal_.IKeyring.md +++ /dev/null @@ -1,262 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/helpers](../modules/verida_helpers.md) / [](../modules/verida_helpers._internal_.md) / IKeyring - -# Interface: IKeyring - -[@verida/helpers](../modules/verida_helpers.md).[](../modules/verida_helpers._internal_.md).IKeyring - -## Table of contents - -### Methods - -- [\_init](verida_helpers._internal_.IKeyring.md#_init) -- [asymDecrypt](verida_helpers._internal_.IKeyring.md#asymdecrypt) -- [asymEncrypt](verida_helpers._internal_.IKeyring.md#asymencrypt) -- [buildSharedKeyEnd](verida_helpers._internal_.IKeyring.md#buildsharedkeyend) -- [buildSharedKeyStart](verida_helpers._internal_.IKeyring.md#buildsharedkeystart) -- [getKeys](verida_helpers._internal_.IKeyring.md#getkeys) -- [getSeed](verida_helpers._internal_.IKeyring.md#getseed) -- [getStorageContextKey](verida_helpers._internal_.IKeyring.md#getstoragecontextkey) -- [publicKeys](verida_helpers._internal_.IKeyring.md#publickeys) -- [sign](verida_helpers._internal_.IKeyring.md#sign) -- [symDecrypt](verida_helpers._internal_.IKeyring.md#symdecrypt) -- [symEncrypt](verida_helpers._internal_.IKeyring.md#symencrypt) -- [verifySig](verida_helpers._internal_.IKeyring.md#verifysig) - -## Methods - -### \_init - -▸ **_init**(): `Promise`<`void`\> - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:3 - -___ - -### asymDecrypt - -▸ **asymDecrypt**(`messageWithNonce`, `secretOrSharedKey`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `messageWithNonce` | `string` | -| `secretOrSharedKey` | `Uint8Array` | - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:10 - -___ - -### asymEncrypt - -▸ **asymEncrypt**(`data`, `secretOrSharedKey`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `string` | -| `secretOrSharedKey` | `Uint8Array` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:9 - -___ - -### buildSharedKeyEnd - -▸ **buildSharedKeyEnd**(`publicKey`): `Promise`<`Uint8Array`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `publicKey` | `Uint8Array` | - -#### Returns - -`Promise`<`Uint8Array`\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:12 - -___ - -### buildSharedKeyStart - -▸ **buildSharedKeyStart**(`privateKey`): `Promise`<`Uint8Array`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `privateKey` | `Uint8Array` | - -#### Returns - -`Promise`<`Uint8Array`\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:11 - -___ - -### getKeys - -▸ **getKeys**(): `Promise`<`any`\> - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:2 - -___ - -### getSeed - -▸ **getSeed**(): `string` - -#### Returns - -`string` - -#### Defined in - -packages/types/dist/IKeyring.d.ts:13 - -___ - -### getStorageContextKey - -▸ **getStorageContextKey**(`databaseName`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `databaseName` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:14 - -___ - -### publicKeys - -▸ **publicKeys**(): `Promise`<[`KeyringPublicKeys`](verida_helpers._internal_.KeyringPublicKeys.md)\> - -#### Returns - -`Promise`<[`KeyringPublicKeys`](verida_helpers._internal_.KeyringPublicKeys.md)\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:4 - -___ - -### sign - -▸ **sign**(`data`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `any` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:5 - -___ - -### symDecrypt - -▸ **symDecrypt**(`data`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `string` | - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:8 - -___ - -### symEncrypt - -▸ **symEncrypt**(`data`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:7 - -___ - -### verifySig - -▸ **verifySig**(`data`, `sig`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `string` | -| `sig` | `string` | - -#### Returns - -`Promise`<`boolean`\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:6 diff --git a/docs/api/verida-js/interfaces/verida_helpers._internal_.IMessaging.md b/docs/api/verida-js/interfaces/verida_helpers._internal_.IMessaging.md deleted file mode 100644 index c307ae8..0000000 --- a/docs/api/verida-js/interfaces/verida_helpers._internal_.IMessaging.md +++ /dev/null @@ -1,180 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/helpers](../modules/verida_helpers.md) / [](../modules/verida_helpers._internal_.md) / IMessaging - -# Interface: IMessaging - -[@verida/helpers](../modules/verida_helpers.md).[](../modules/verida_helpers._internal_.md).IMessaging - -Interface Messaging - -## Table of contents - -### Methods - -- [connectAccount](verida_helpers._internal_.IMessaging.md#connectaccount) -- [getInbox](verida_helpers._internal_.IMessaging.md#getinbox) -- [getMessages](verida_helpers._internal_.IMessaging.md#getmessages) -- [init](verida_helpers._internal_.IMessaging.md#init) -- [offMessage](verida_helpers._internal_.IMessaging.md#offmessage) -- [onMessage](verida_helpers._internal_.IMessaging.md#onmessage) -- [send](verida_helpers._internal_.IMessaging.md#send) - -## Methods - -### connectAccount - -▸ **connectAccount**(`account`): `Promise`<`void`\> - -Connect an account to this messaging instance. - -Used internally. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `account` | [`IAccount`](verida_helpers._internal_.IAccount.md) | Account | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -packages/types/dist/IMessaging.d.ts:62 - -___ - -### getInbox - -▸ **getInbox**(): `Promise`<`any`\> - -Get the underlying inbox instance specific for the message storage type. - -#### Returns - -`Promise`<`any`\> - -any Currently returns a `Datastore` instance. - -#### Defined in - -packages/types/dist/IMessaging.d.ts:54 - -___ - -### getMessages - -▸ **getMessages**(`filter?`, `options?`): `Promise`<`any`\> - -Get messages from this inbox. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `filter?` | `object` | object An optional datastore filter | -| `options?` | `any` | object An optional list of datastore options | - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -packages/types/dist/IMessaging.d.ts:48 - -___ - -### init - -▸ **init**(): `Promise`<`void`\> - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -packages/types/dist/IMessaging.d.ts:9 - -___ - -### offMessage - -▸ **offMessage**(`callback`): `Promise`<`void`\> - -Unregister a callback to fire when a new message is received - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `callback` | `any` | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -packages/types/dist/IMessaging.d.ts:41 - -___ - -### onMessage - -▸ **onMessage**(`callback`): `Promise`<[`EventEmitter`](../classes/verida_helpers._internal_.EventEmitter-1.md)\> - -Register a callback to fire when a new message is received from another DID or application. - -Usage: - -``` -// configure the listener -const callback = (msg) => { console.log(msg) } -const emitter = messaging.onMessage(callback) -``` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `callback` | `any` | - -#### Returns - -`Promise`<[`EventEmitter`](../classes/verida_helpers._internal_.EventEmitter-1.md)\> - -Returns an event emitter - -#### Defined in - -packages/types/dist/IMessaging.d.ts:35 - -___ - -### send - -▸ **send**(`did`, `type`, `data`, `message`, `config`): `Promise`<``null`` \| `object`\> - -Send a message to another DID on the network. - -**`todo:`** Link to documentation - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `did` | `string` | string DID to receive the message | -| `type` | `string` | string Type of inbox message (See https://github.com/verida/schemas/tree/master/schemas/inbox/type). ie: `dataSend` | -| `data` | `object` | object Data to send. Structure of data will depend on the inbox message type. | -| `message` | `string` | string A human readable message that will be displayed to the user upon receipt of the message. Similar to an email subject. | -| `config` | [`MessageSendConfig`](verida_helpers._internal_.MessageSendConfig.md) | object Optional configuration. | - -#### Returns - -`Promise`<``null`` \| `object`\> - -#### Defined in - -packages/types/dist/IMessaging.d.ts:21 diff --git a/docs/api/verida-js/interfaces/verida_helpers._internal_.INotification.md b/docs/api/verida-js/interfaces/verida_helpers._internal_.INotification.md deleted file mode 100644 index 43842a1..0000000 --- a/docs/api/verida-js/interfaces/verida_helpers._internal_.INotification.md +++ /dev/null @@ -1,71 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/helpers](../modules/verida_helpers.md) / [](../modules/verida_helpers._internal_.md) / INotification - -# Interface: INotification - -[@verida/helpers](../modules/verida_helpers.md).[](../modules/verida_helpers._internal_.md).INotification - -Interface for notifications - -## Table of contents - -### Methods - -- [getErrors](verida_helpers._internal_.INotification.md#geterrors) -- [init](verida_helpers._internal_.INotification.md#init) -- [ping](verida_helpers._internal_.INotification.md#ping) - -## Methods - -### getErrors - -▸ **getErrors**(): `string`[] - -#### Returns - -`string`[] - -#### Defined in - -packages/types/dist/INotification.d.ts:16 - -___ - -### init - -▸ **init**(): `Promise`<`void`\> - -Initialize notifications for the connected user - -(ie; connect to a notification server) - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -packages/types/dist/INotification.d.ts:10 - -___ - -### ping - -▸ **ping**(`recipientContextName`, `didToNotify`): `Promise`<`boolean`\> - -Ping a notification server to fetch new messages -TODO: Change this - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `recipientContextName` | `string` | -| `didToNotify` | `any` | - -#### Returns - -`Promise`<`boolean`\> - -#### Defined in - -packages/types/dist/INotification.d.ts:15 diff --git a/docs/api/verida-js/interfaces/verida_helpers._internal_.IProfile.md b/docs/api/verida-js/interfaces/verida_helpers._internal_.IProfile.md deleted file mode 100644 index 5b47534..0000000 --- a/docs/api/verida-js/interfaces/verida_helpers._internal_.IProfile.md +++ /dev/null @@ -1,140 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/helpers](../modules/verida_helpers.md) / [](../modules/verida_helpers._internal_.md) / IProfile - -# Interface: IProfile - -[@verida/helpers](../modules/verida_helpers.md).[](../modules/verida_helpers._internal_.md).IProfile - -## Table of contents - -### Methods - -- [delete](verida_helpers._internal_.IProfile.md#delete) -- [get](verida_helpers._internal_.IProfile.md#get) -- [getMany](verida_helpers._internal_.IProfile.md#getmany) -- [listen](verida_helpers._internal_.IProfile.md#listen) -- [set](verida_helpers._internal_.IProfile.md#set) -- [setMany](verida_helpers._internal_.IProfile.md#setmany) - -## Methods - -### delete - -▸ **delete**(`key`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `key` | `string` | - -#### Returns - -`Promise`<`boolean`\> - -#### Defined in - -packages/types/dist/IProfile.d.ts:7 - -___ - -### get - -▸ **get**(`key`, `options?`, `extended?`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `key` | `string` | -| `options?` | `any` | -| `extended?` | `boolean` | - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -packages/types/dist/IProfile.d.ts:6 - -___ - -### getMany - -▸ **getMany**(`filter`, `options`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `filter` | `any` | -| `options` | `any` | - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -packages/types/dist/IProfile.d.ts:8 - -___ - -### listen - -▸ **listen**(`callback`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `callback` | `any` | - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -packages/types/dist/IProfile.d.ts:11 - -___ - -### set - -▸ **set**(`key`, `value`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `key` | `string` | -| `value` | `any` | - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -packages/types/dist/IProfile.d.ts:9 - -___ - -### setMany - -▸ **setMany**(`data`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `any` | - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -packages/types/dist/IProfile.d.ts:10 diff --git a/docs/api/verida-js/interfaces/verida_helpers._internal_.ISchema.md b/docs/api/verida-js/interfaces/verida_helpers._internal_.ISchema.md deleted file mode 100644 index e8f161e..0000000 --- a/docs/api/verida-js/interfaces/verida_helpers._internal_.ISchema.md +++ /dev/null @@ -1,90 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/helpers](../modules/verida_helpers.md) / [](../modules/verida_helpers._internal_.md) / ISchema - -# Interface: ISchema - -[@verida/helpers](../modules/verida_helpers.md).[](../modules/verida_helpers._internal_.md).ISchema - -## Table of contents - -### Properties - -- [errors](verida_helpers._internal_.ISchema.md#errors) - -### Methods - -- [getAppearance](verida_helpers._internal_.ISchema.md#getappearance) -- [getSchemaJson](verida_helpers._internal_.ISchema.md#getschemajson) -- [getSpecification](verida_helpers._internal_.ISchema.md#getspecification) -- [validate](verida_helpers._internal_.ISchema.md#validate) - -## Properties - -### errors - -• **errors**: `string`[] - -#### Defined in - -packages/types/dist/ISchema.d.ts:2 - -## Methods - -### getAppearance - -▸ **getAppearance**(): `Promise`<`any`\> - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -packages/types/dist/ISchema.d.ts:6 - -___ - -### getSchemaJson - -▸ **getSchemaJson**(): `Promise`<`object`\> - -#### Returns - -`Promise`<`object`\> - -#### Defined in - -packages/types/dist/ISchema.d.ts:5 - -___ - -### getSpecification - -▸ **getSpecification**(): `Promise`<`any`\> - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -packages/types/dist/ISchema.d.ts:3 - -___ - -### validate - -▸ **validate**(`data`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `any` | - -#### Returns - -`Promise`<`boolean`\> - -#### Defined in - -packages/types/dist/ISchema.d.ts:4 diff --git a/docs/api/verida-js/interfaces/verida_helpers._internal_.IStorageEngine.md b/docs/api/verida-js/interfaces/verida_helpers._internal_.IStorageEngine.md deleted file mode 100644 index 88d4f87..0000000 --- a/docs/api/verida-js/interfaces/verida_helpers._internal_.IStorageEngine.md +++ /dev/null @@ -1,211 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/helpers](../modules/verida_helpers.md) / [](../modules/verida_helpers._internal_.md) / IStorageEngine - -# Interface: IStorageEngine - -[@verida/helpers](../modules/verida_helpers.md).[](../modules/verida_helpers._internal_.md).IStorageEngine - -**`emits`** EndpointUnavailable - -## Table of contents - -### Methods - -- [addEndpoint](verida_helpers._internal_.IStorageEngine.md#addendpoint) -- [connectAccount](verida_helpers._internal_.IStorageEngine.md#connectaccount) -- [deleteDatabase](verida_helpers._internal_.IStorageEngine.md#deletedatabase) -- [getAccount](verida_helpers._internal_.IStorageEngine.md#getaccount) -- [getContextConfig](verida_helpers._internal_.IStorageEngine.md#getcontextconfig) -- [getDbRegistry](verida_helpers._internal_.IStorageEngine.md#getdbregistry) -- [getKeyring](verida_helpers._internal_.IStorageEngine.md#getkeyring) -- [info](verida_helpers._internal_.IStorageEngine.md#info) -- [logout](verida_helpers._internal_.IStorageEngine.md#logout) -- [openDatabase](verida_helpers._internal_.IStorageEngine.md#opendatabase) -- [openDatastore](verida_helpers._internal_.IStorageEngine.md#opendatastore) - -## Methods - -### addEndpoint - -▸ **addEndpoint**(`context`, `uri`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `context` | [`IContext`](verida_helpers._internal_.IContext.md) | -| `uri` | `string` | - -#### Returns - -`Promise`<`boolean`\> - -#### Defined in - -packages/types/dist/IStorageEngine.d.ts:22 - -___ - -### connectAccount - -▸ **connectAccount**(`account`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `account` | [`IAccount`](verida_helpers._internal_.IAccount.md) | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -packages/types/dist/IStorageEngine.d.ts:16 - -___ - -### deleteDatabase - -▸ **deleteDatabase**(`databaseName`, `config?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `databaseName` | `string` | -| `config?` | [`DatabaseDeleteConfig`](verida_helpers._internal_.DatabaseDeleteConfig.md) | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -packages/types/dist/IStorageEngine.d.ts:20 - -___ - -### getAccount - -▸ **getAccount**(): [`IAccount`](verida_helpers._internal_.IAccount.md) - -#### Returns - -[`IAccount`](verida_helpers._internal_.IAccount.md) - -#### Defined in - -packages/types/dist/IStorageEngine.d.ts:15 - -___ - -### getContextConfig - -▸ **getContextConfig**(): [`SecureContextConfig`](verida_helpers._internal_.SecureContextConfig.md) - -#### Returns - -[`SecureContextConfig`](verida_helpers._internal_.SecureContextConfig.md) - -#### Defined in - -packages/types/dist/IStorageEngine.d.ts:14 - -___ - -### getDbRegistry - -▸ **getDbRegistry**(): [`IDbRegistry`](verida_helpers._internal_.IDbRegistry.md) - -#### Returns - -[`IDbRegistry`](verida_helpers._internal_.IDbRegistry.md) - -#### Defined in - -packages/types/dist/IStorageEngine.d.ts:17 - -___ - -### getKeyring - -▸ **getKeyring**(): [`IKeyring`](verida_helpers._internal_.IKeyring.md) - -#### Returns - -[`IKeyring`](verida_helpers._internal_.IKeyring.md) - -#### Defined in - -packages/types/dist/IStorageEngine.d.ts:13 - -___ - -### info - -▸ **info**(): `Promise`<[`ContextDatabaseInfo`](verida_helpers._internal_.ContextDatabaseInfo.md)\> - -#### Returns - -`Promise`<[`ContextDatabaseInfo`](verida_helpers._internal_.ContextDatabaseInfo.md)\> - -#### Defined in - -packages/types/dist/IStorageEngine.d.ts:23 - -___ - -### logout - -▸ **logout**(): `void` - -#### Returns - -`void` - -#### Defined in - -packages/types/dist/IStorageEngine.d.ts:21 - -___ - -### openDatabase - -▸ **openDatabase**(`databaseName`, `config`): `Promise`<[`IDatabase`](verida_helpers._internal_.IDatabase.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `databaseName` | `string` | -| `config` | [`DatabaseOpenConfig`](verida_helpers._internal_.DatabaseOpenConfig.md) | - -#### Returns - -`Promise`<[`IDatabase`](verida_helpers._internal_.IDatabase.md)\> - -#### Defined in - -packages/types/dist/IStorageEngine.d.ts:18 - -___ - -### openDatastore - -▸ **openDatastore**(`schemaName`, `config`): `Promise`<[`IDatastore`](verida_helpers._internal_.IDatastore.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schemaName` | `string` | -| `config` | [`DatastoreOpenConfig`](verida_helpers._internal_.DatastoreOpenConfig.md) | - -#### Returns - -`Promise`<[`IDatastore`](verida_helpers._internal_.IDatastore.md)\> - -#### Defined in - -packages/types/dist/IStorageEngine.d.ts:19 diff --git a/docs/api/verida-js/interfaces/verida_helpers._internal_.IteratorReturnResult.md b/docs/api/verida-js/interfaces/verida_helpers._internal_.IteratorReturnResult.md deleted file mode 100644 index 1d457e1..0000000 --- a/docs/api/verida-js/interfaces/verida_helpers._internal_.IteratorReturnResult.md +++ /dev/null @@ -1,38 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/helpers](../modules/verida_helpers.md) / [](../modules/verida_helpers._internal_.md) / IteratorReturnResult - -# Interface: IteratorReturnResult - -[@verida/helpers](../modules/verida_helpers.md).[](../modules/verida_helpers._internal_.md).IteratorReturnResult - -## Type parameters - -| Name | -| :------ | -| `TReturn` | - -## Table of contents - -### Properties - -- [done](verida_helpers._internal_.IteratorReturnResult.md#done) -- [value](verida_helpers._internal_.IteratorReturnResult.md#value) - -## Properties - -### done - -• **done**: ``true`` - -#### Defined in - -node_modules/typescript/lib/lib.es2015.iterable.d.ts:37 - -___ - -### value - -• **value**: `TReturn` - -#### Defined in - -node_modules/typescript/lib/lib.es2015.iterable.d.ts:38 diff --git a/docs/api/verida-js/interfaces/verida_helpers._internal_.IteratorYieldResult.md b/docs/api/verida-js/interfaces/verida_helpers._internal_.IteratorYieldResult.md deleted file mode 100644 index cb78154..0000000 --- a/docs/api/verida-js/interfaces/verida_helpers._internal_.IteratorYieldResult.md +++ /dev/null @@ -1,38 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/helpers](../modules/verida_helpers.md) / [](../modules/verida_helpers._internal_.md) / IteratorYieldResult - -# Interface: IteratorYieldResult - -[@verida/helpers](../modules/verida_helpers.md).[](../modules/verida_helpers._internal_.md).IteratorYieldResult - -## Type parameters - -| Name | -| :------ | -| `TYield` | - -## Table of contents - -### Properties - -- [done](verida_helpers._internal_.IteratorYieldResult.md#done) -- [value](verida_helpers._internal_.IteratorYieldResult.md#value) - -## Properties - -### done - -• `Optional` **done**: ``false`` - -#### Defined in - -node_modules/typescript/lib/lib.es2015.iterable.d.ts:32 - -___ - -### value - -• **value**: `TYield` - -#### Defined in - -node_modules/typescript/lib/lib.es2015.iterable.d.ts:33 diff --git a/docs/api/verida-js/interfaces/verida_helpers._internal_.KeyringPublicKeys.md b/docs/api/verida-js/interfaces/verida_helpers._internal_.KeyringPublicKeys.md deleted file mode 100644 index 3d279ae..0000000 --- a/docs/api/verida-js/interfaces/verida_helpers._internal_.KeyringPublicKeys.md +++ /dev/null @@ -1,76 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/helpers](../modules/verida_helpers.md) / [](../modules/verida_helpers._internal_.md) / KeyringPublicKeys - -# Interface: KeyringPublicKeys - -[@verida/helpers](../modules/verida_helpers.md).[](../modules/verida_helpers._internal_.md).KeyringPublicKeys - -## Table of contents - -### Properties - -- [asymPublicKey](verida_helpers._internal_.KeyringPublicKeys.md#asympublickey) -- [asymPublicKeyBase58](verida_helpers._internal_.KeyringPublicKeys.md#asympublickeybase58) -- [asymPublicKeyHex](verida_helpers._internal_.KeyringPublicKeys.md#asympublickeyhex) -- [signPublicKey](verida_helpers._internal_.KeyringPublicKeys.md#signpublickey) -- [signPublicKeyBase58](verida_helpers._internal_.KeyringPublicKeys.md#signpublickeybase58) -- [signPublicKeyHex](verida_helpers._internal_.KeyringPublicKeys.md#signpublickeyhex) - -## Properties - -### asymPublicKey - -• **asymPublicKey**: `Uint8Array` - -#### Defined in - -packages/types/dist/IKeyring.d.ts:17 - -___ - -### asymPublicKeyBase58 - -• **asymPublicKeyBase58**: `string` - -#### Defined in - -packages/types/dist/IKeyring.d.ts:19 - -___ - -### asymPublicKeyHex - -• **asymPublicKeyHex**: `string` - -#### Defined in - -packages/types/dist/IKeyring.d.ts:18 - -___ - -### signPublicKey - -• **signPublicKey**: `Uint8Array` - -#### Defined in - -packages/types/dist/IKeyring.d.ts:20 - -___ - -### signPublicKeyBase58 - -• **signPublicKeyBase58**: `string` - -#### Defined in - -packages/types/dist/IKeyring.d.ts:22 - -___ - -### signPublicKeyHex - -• **signPublicKeyHex**: `string` - -#### Defined in - -packages/types/dist/IKeyring.d.ts:21 diff --git a/docs/api/verida-js/interfaces/verida_helpers._internal_.MessageSendConfig.md b/docs/api/verida-js/interfaces/verida_helpers._internal_.MessageSendConfig.md deleted file mode 100644 index d306760..0000000 --- a/docs/api/verida-js/interfaces/verida_helpers._internal_.MessageSendConfig.md +++ /dev/null @@ -1,56 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/helpers](../modules/verida_helpers.md) / [](../modules/verida_helpers._internal_.md) / MessageSendConfig - -# Interface: MessageSendConfig - -[@verida/helpers](../modules/verida_helpers.md).[](../modules/verida_helpers._internal_.md).MessageSendConfig - -Interface for any MessageSendConfig - -## Table of contents - -### Properties - -- [did](verida_helpers._internal_.MessageSendConfig.md#did) -- [expiry](verida_helpers._internal_.MessageSendConfig.md#expiry) -- [openUrl](verida_helpers._internal_.MessageSendConfig.md#openurl) -- [recipientContextName](verida_helpers._internal_.MessageSendConfig.md#recipientcontextname) - -## Properties - -### did - -• **did**: `string` - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:124 - -___ - -### expiry - -• `Optional` **expiry**: [`Number`](../modules/verida_helpers._internal_.md#number) - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:125 - -___ - -### openUrl - -• `Optional` **openUrl**: `string` - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:127 - -___ - -### recipientContextName - -• `Optional` **recipientContextName**: `string` - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:126 diff --git a/docs/api/verida-js/interfaces/verida_helpers._internal_.MessagesConfig.md b/docs/api/verida-js/interfaces/verida_helpers._internal_.MessagesConfig.md deleted file mode 100644 index 264ee79..0000000 --- a/docs/api/verida-js/interfaces/verida_helpers._internal_.MessagesConfig.md +++ /dev/null @@ -1,23 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/helpers](../modules/verida_helpers.md) / [](../modules/verida_helpers._internal_.md) / MessagesConfig - -# Interface: MessagesConfig - -[@verida/helpers](../modules/verida_helpers.md).[](../modules/verida_helpers._internal_.md).MessagesConfig - -Interface for any MessagesConfig - -## Table of contents - -### Properties - -- [maxItems](verida_helpers._internal_.MessagesConfig.md#maxitems) - -## Properties - -### maxItems - -• `Optional` **maxItems**: [`Number`](../modules/verida_helpers._internal_.md#number) - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:93 diff --git a/docs/api/verida-js/interfaces/verida_helpers._internal_.NodeEventTarget.md b/docs/api/verida-js/interfaces/verida_helpers._internal_.NodeEventTarget.md deleted file mode 100644 index 7b2e9fe..0000000 --- a/docs/api/verida-js/interfaces/verida_helpers._internal_.NodeEventTarget.md +++ /dev/null @@ -1,32 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/helpers](../modules/verida_helpers.md) / [](../modules/verida_helpers._internal_.md) / NodeEventTarget - -# Interface: NodeEventTarget - -[@verida/helpers](../modules/verida_helpers.md).[](../modules/verida_helpers._internal_.md).NodeEventTarget - -## Table of contents - -### Methods - -- [once](verida_helpers._internal_.NodeEventTarget.md#once) - -## Methods - -### once - -▸ **once**(`eventName`, `listener`): [`NodeEventTarget`](verida_helpers._internal_.NodeEventTarget.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | `string` \| `symbol` | -| `listener` | (...`args`: `any`[]) => `void` | - -#### Returns - -[`NodeEventTarget`](verida_helpers._internal_.NodeEventTarget.md) - -#### Defined in - -node_modules/@types/node/events.d.ts:45 diff --git a/docs/api/verida-js/interfaces/verida_helpers._internal_.Number.md b/docs/api/verida-js/interfaces/verida_helpers._internal_.Number.md deleted file mode 100644 index 3731bfe..0000000 --- a/docs/api/verida-js/interfaces/verida_helpers._internal_.Number.md +++ /dev/null @@ -1,143 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/helpers](../modules/verida_helpers.md) / [](../modules/verida_helpers._internal_.md) / Number - -# Interface: Number - -[@verida/helpers](../modules/verida_helpers.md).[](../modules/verida_helpers._internal_.md).Number - -## Table of contents - -### Methods - -- [toExponential](verida_helpers._internal_.Number.md#toexponential) -- [toFixed](verida_helpers._internal_.Number.md#tofixed) -- [toLocaleString](verida_helpers._internal_.Number.md#tolocalestring) -- [toPrecision](verida_helpers._internal_.Number.md#toprecision) -- [toString](verida_helpers._internal_.Number.md#tostring) -- [valueOf](verida_helpers._internal_.Number.md#valueof) - -## Methods - -### toExponential - -▸ **toExponential**(`fractionDigits?`): `string` - -Returns a string containing a number represented in exponential notation. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `fractionDigits?` | `number` | Number of digits after the decimal point. Must be in the range 0 - 20, inclusive. | - -#### Returns - -`string` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:559 - -___ - -### toFixed - -▸ **toFixed**(`fractionDigits?`): `string` - -Returns a string representing a number in fixed-point notation. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `fractionDigits?` | `number` | Number of digits after the decimal point. Must be in the range 0 - 20, inclusive. | - -#### Returns - -`string` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:553 - -___ - -### toLocaleString - -▸ **toLocaleString**(`locales?`, `options?`): `string` - -Converts a number to a string by using the current or specified locale. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `locales?` | `string` \| `string`[] | A locale string or array of locale strings that contain one or more language or locale tags. If you include more than one locale string, list them in descending order of priority so that the first entry is the preferred locale. If you omit this parameter, the default locale of the JavaScript runtime is used. | -| `options?` | `NumberFormatOptions` | An object that contains one or more properties that specify comparison options. | - -#### Returns - -`string` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:4412 - -___ - -### toPrecision - -▸ **toPrecision**(`precision?`): `string` - -Returns a string containing a number represented either in exponential or fixed-point notation with a specified number of digits. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `precision?` | `number` | Number of significant digits. Must be in the range 1 - 21, inclusive. | - -#### Returns - -`string` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:565 - -___ - -### toString - -▸ **toString**(`radix?`): `string` - -Returns a string representation of an object. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `radix?` | `number` | Specifies a radix for converting numeric values to strings. This value is only used for numbers. | - -#### Returns - -`string` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:547 - -___ - -### valueOf - -▸ **valueOf**(): `number` - -Returns the primitive value of the specified object. - -#### Returns - -`number` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:568 diff --git a/docs/api/verida-js/interfaces/verida_helpers._internal_.PromiseLike.md b/docs/api/verida-js/interfaces/verida_helpers._internal_.PromiseLike.md deleted file mode 100644 index 730249c..0000000 --- a/docs/api/verida-js/interfaces/verida_helpers._internal_.PromiseLike.md +++ /dev/null @@ -1,49 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/helpers](../modules/verida_helpers.md) / [](../modules/verida_helpers._internal_.md) / PromiseLike - -# Interface: PromiseLike - -[@verida/helpers](../modules/verida_helpers.md).[](../modules/verida_helpers._internal_.md).PromiseLike - -## Type parameters - -| Name | -| :------ | -| `T` | - -## Table of contents - -### Methods - -- [then](verida_helpers._internal_.PromiseLike.md#then) - -## Methods - -### then - -▸ **then**<`TResult1`, `TResult2`\>(`onfulfilled?`, `onrejected?`): [`PromiseLike`](verida_helpers._internal_.PromiseLike.md)<`TResult1` \| `TResult2`\> - -Attaches callbacks for the resolution and/or rejection of the Promise. - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `TResult1` | `T` | -| `TResult2` | `never` | - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `onfulfilled?` | ``null`` \| (`value`: `T`) => `TResult1` \| [`PromiseLike`](verida_helpers._internal_.PromiseLike.md)<`TResult1`\> | The callback to execute when the Promise is resolved. | -| `onrejected?` | ``null`` \| (`reason`: `any`) => `TResult2` \| [`PromiseLike`](verida_helpers._internal_.PromiseLike.md)<`TResult2`\> | The callback to execute when the Promise is rejected. | - -#### Returns - -[`PromiseLike`](verida_helpers._internal_.PromiseLike.md)<`TResult1` \| `TResult2`\> - -A Promise for the completion of which ever callback is executed. - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1440 diff --git a/docs/api/verida-js/interfaces/verida_helpers._internal_.SecureContextConfig.md b/docs/api/verida-js/interfaces/verida_helpers._internal_.SecureContextConfig.md deleted file mode 100644 index d37692a..0000000 --- a/docs/api/verida-js/interfaces/verida_helpers._internal_.SecureContextConfig.md +++ /dev/null @@ -1,43 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/helpers](../modules/verida_helpers.md) / [](../modules/verida_helpers._internal_.md) / SecureContextConfig - -# Interface: SecureContextConfig - -[@verida/helpers](../modules/verida_helpers.md).[](../modules/verida_helpers._internal_.md).SecureContextConfig - -## Table of contents - -### Properties - -- [id](verida_helpers._internal_.SecureContextConfig.md#id) -- [publicKeys](verida_helpers._internal_.SecureContextConfig.md#publickeys) -- [services](verida_helpers._internal_.SecureContextConfig.md#services) - -## Properties - -### id - -• **id**: `string` - -#### Defined in - -packages/types/dist/StorageLinkInterfaces.d.ts:17 - -___ - -### publicKeys - -• **publicKeys**: [`SecureStorageContextPublicKeys`](verida_helpers._internal_.SecureStorageContextPublicKeys.md) - -#### Defined in - -packages/types/dist/StorageLinkInterfaces.d.ts:18 - -___ - -### services - -• **services**: [`SecureContextServices`](verida_helpers._internal_.SecureContextServices.md) - -#### Defined in - -packages/types/dist/StorageLinkInterfaces.d.ts:19 diff --git a/docs/api/verida-js/interfaces/verida_helpers._internal_.SecureContextEndpoint.md b/docs/api/verida-js/interfaces/verida_helpers._internal_.SecureContextEndpoint.md deleted file mode 100644 index eda2169..0000000 --- a/docs/api/verida-js/interfaces/verida_helpers._internal_.SecureContextEndpoint.md +++ /dev/null @@ -1,43 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/helpers](../modules/verida_helpers.md) / [](../modules/verida_helpers._internal_.md) / SecureContextEndpoint - -# Interface: SecureContextEndpoint - -[@verida/helpers](../modules/verida_helpers.md).[](../modules/verida_helpers._internal_.md).SecureContextEndpoint - -## Table of contents - -### Properties - -- [config](verida_helpers._internal_.SecureContextEndpoint.md#config) -- [endpointUri](verida_helpers._internal_.SecureContextEndpoint.md#endpointuri) -- [type](verida_helpers._internal_.SecureContextEndpoint.md#type) - -## Properties - -### config - -• `Optional` **config**: `object` - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:5 - -___ - -### endpointUri - -• **endpointUri**: [`ServiceEndpoint`](../modules/verida_helpers._internal_.md#serviceendpoint)[] - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:4 - -___ - -### type - -• **type**: `string` - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:3 diff --git a/docs/api/verida-js/interfaces/verida_helpers._internal_.SecureContextPublicKey.md b/docs/api/verida-js/interfaces/verida_helpers._internal_.SecureContextPublicKey.md deleted file mode 100644 index 0770e36..0000000 --- a/docs/api/verida-js/interfaces/verida_helpers._internal_.SecureContextPublicKey.md +++ /dev/null @@ -1,32 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/helpers](../modules/verida_helpers.md) / [](../modules/verida_helpers._internal_.md) / SecureContextPublicKey - -# Interface: SecureContextPublicKey - -[@verida/helpers](../modules/verida_helpers.md).[](../modules/verida_helpers._internal_.md).SecureContextPublicKey - -## Table of contents - -### Properties - -- [publicKeyHex](verida_helpers._internal_.SecureContextPublicKey.md#publickeyhex) -- [type](verida_helpers._internal_.SecureContextPublicKey.md#type) - -## Properties - -### publicKeyHex - -• **publicKeyHex**: `string` - -#### Defined in - -packages/types/dist/StorageLinkInterfaces.d.ts:4 - -___ - -### type - -• **type**: `string` - -#### Defined in - -packages/types/dist/StorageLinkInterfaces.d.ts:3 diff --git a/docs/api/verida-js/interfaces/verida_helpers._internal_.SecureContextServices.md b/docs/api/verida-js/interfaces/verida_helpers._internal_.SecureContextServices.md deleted file mode 100644 index ad71c1d..0000000 --- a/docs/api/verida-js/interfaces/verida_helpers._internal_.SecureContextServices.md +++ /dev/null @@ -1,54 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/helpers](../modules/verida_helpers.md) / [](../modules/verida_helpers._internal_.md) / SecureContextServices - -# Interface: SecureContextServices - -[@verida/helpers](../modules/verida_helpers.md).[](../modules/verida_helpers._internal_.md).SecureContextServices - -## Table of contents - -### Properties - -- [databaseServer](verida_helpers._internal_.SecureContextServices.md#databaseserver) -- [messageServer](verida_helpers._internal_.SecureContextServices.md#messageserver) -- [notificationServer](verida_helpers._internal_.SecureContextServices.md#notificationserver) -- [storageServer](verida_helpers._internal_.SecureContextServices.md#storageserver) - -## Properties - -### databaseServer - -• **databaseServer**: [`SecureContextEndpoint`](verida_helpers._internal_.SecureContextEndpoint.md) - -#### Defined in - -packages/types/dist/StorageLinkInterfaces.d.ts:11 - -___ - -### messageServer - -• **messageServer**: [`SecureContextEndpoint`](verida_helpers._internal_.SecureContextEndpoint.md) - -#### Defined in - -packages/types/dist/StorageLinkInterfaces.d.ts:12 - -___ - -### notificationServer - -• `Optional` **notificationServer**: [`SecureContextEndpoint`](verida_helpers._internal_.SecureContextEndpoint.md) - -#### Defined in - -packages/types/dist/StorageLinkInterfaces.d.ts:14 - -___ - -### storageServer - -• `Optional` **storageServer**: [`SecureContextEndpoint`](verida_helpers._internal_.SecureContextEndpoint.md) - -#### Defined in - -packages/types/dist/StorageLinkInterfaces.d.ts:13 diff --git a/docs/api/verida-js/interfaces/verida_helpers._internal_.SecureStorageContextPublicKeys.md b/docs/api/verida-js/interfaces/verida_helpers._internal_.SecureStorageContextPublicKeys.md deleted file mode 100644 index d010476..0000000 --- a/docs/api/verida-js/interfaces/verida_helpers._internal_.SecureStorageContextPublicKeys.md +++ /dev/null @@ -1,32 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/helpers](../modules/verida_helpers.md) / [](../modules/verida_helpers._internal_.md) / SecureStorageContextPublicKeys - -# Interface: SecureStorageContextPublicKeys - -[@verida/helpers](../modules/verida_helpers.md).[](../modules/verida_helpers._internal_.md).SecureStorageContextPublicKeys - -## Table of contents - -### Properties - -- [asymKey](verida_helpers._internal_.SecureStorageContextPublicKeys.md#asymkey) -- [signKey](verida_helpers._internal_.SecureStorageContextPublicKeys.md#signkey) - -## Properties - -### asymKey - -• **asymKey**: [`SecureContextPublicKey`](verida_helpers._internal_.SecureContextPublicKey.md) - -#### Defined in - -packages/types/dist/StorageLinkInterfaces.d.ts:7 - -___ - -### signKey - -• **signKey**: [`SecureContextPublicKey`](verida_helpers._internal_.SecureContextPublicKey.md) - -#### Defined in - -packages/types/dist/StorageLinkInterfaces.d.ts:8 diff --git a/docs/api/verida-js/interfaces/verida_helpers._internal_.StaticEventEmitterOptions.md b/docs/api/verida-js/interfaces/verida_helpers._internal_.StaticEventEmitterOptions.md deleted file mode 100644 index cba53e0..0000000 --- a/docs/api/verida-js/interfaces/verida_helpers._internal_.StaticEventEmitterOptions.md +++ /dev/null @@ -1,21 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/helpers](../modules/verida_helpers.md) / [](../modules/verida_helpers._internal_.md) / StaticEventEmitterOptions - -# Interface: StaticEventEmitterOptions - -[@verida/helpers](../modules/verida_helpers.md).[](../modules/verida_helpers._internal_.md).StaticEventEmitterOptions - -## Table of contents - -### Properties - -- [signal](verida_helpers._internal_.StaticEventEmitterOptions.md#signal) - -## Properties - -### signal - -• `Optional` **signal**: `AbortSignal` - -#### Defined in - -node_modules/@types/node/events.d.ts:57 diff --git a/docs/api/verida-js/interfaces/verida_keyring._internal_.BoxKeyPair.md b/docs/api/verida-js/interfaces/verida_keyring._internal_.BoxKeyPair.md deleted file mode 100644 index c7c079e..0000000 --- a/docs/api/verida-js/interfaces/verida_keyring._internal_.BoxKeyPair.md +++ /dev/null @@ -1,32 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/keyring](../modules/verida_keyring.md) / [](../modules/verida_keyring._internal_.md) / BoxKeyPair - -# Interface: BoxKeyPair - -[@verida/keyring](../modules/verida_keyring.md).[](../modules/verida_keyring._internal_.md).BoxKeyPair - -## Table of contents - -### Properties - -- [publicKey](verida_keyring._internal_.BoxKeyPair.md#publickey) -- [secretKey](verida_keyring._internal_.BoxKeyPair.md#secretkey) - -## Properties - -### publicKey - -• **publicKey**: `Uint8Array` - -#### Defined in - -node_modules/tweetnacl/nacl.d.ts:10 - -___ - -### secretKey - -• **secretKey**: `Uint8Array` - -#### Defined in - -node_modules/tweetnacl/nacl.d.ts:11 diff --git a/docs/api/verida-js/interfaces/verida_keyring._internal_.IKeyring.md b/docs/api/verida-js/interfaces/verida_keyring._internal_.IKeyring.md deleted file mode 100644 index 5e5a36b..0000000 --- a/docs/api/verida-js/interfaces/verida_keyring._internal_.IKeyring.md +++ /dev/null @@ -1,266 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/keyring](../modules/verida_keyring.md) / [](../modules/verida_keyring._internal_.md) / IKeyring - -# Interface: IKeyring - -[@verida/keyring](../modules/verida_keyring.md).[](../modules/verida_keyring._internal_.md).IKeyring - -## Implemented by - -- [`Keyring`](../classes/verida_keyring.Keyring.md) - -## Table of contents - -### Methods - -- [\_init](verida_keyring._internal_.IKeyring.md#_init) -- [asymDecrypt](verida_keyring._internal_.IKeyring.md#asymdecrypt) -- [asymEncrypt](verida_keyring._internal_.IKeyring.md#asymencrypt) -- [buildSharedKeyEnd](verida_keyring._internal_.IKeyring.md#buildsharedkeyend) -- [buildSharedKeyStart](verida_keyring._internal_.IKeyring.md#buildsharedkeystart) -- [getKeys](verida_keyring._internal_.IKeyring.md#getkeys) -- [getSeed](verida_keyring._internal_.IKeyring.md#getseed) -- [getStorageContextKey](verida_keyring._internal_.IKeyring.md#getstoragecontextkey) -- [publicKeys](verida_keyring._internal_.IKeyring.md#publickeys) -- [sign](verida_keyring._internal_.IKeyring.md#sign) -- [symDecrypt](verida_keyring._internal_.IKeyring.md#symdecrypt) -- [symEncrypt](verida_keyring._internal_.IKeyring.md#symencrypt) -- [verifySig](verida_keyring._internal_.IKeyring.md#verifysig) - -## Methods - -### \_init - -▸ **_init**(): `Promise`<`void`\> - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:3 - -___ - -### asymDecrypt - -▸ **asymDecrypt**(`messageWithNonce`, `secretOrSharedKey`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `messageWithNonce` | `string` | -| `secretOrSharedKey` | `Uint8Array` | - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:10 - -___ - -### asymEncrypt - -▸ **asymEncrypt**(`data`, `secretOrSharedKey`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `string` | -| `secretOrSharedKey` | `Uint8Array` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:9 - -___ - -### buildSharedKeyEnd - -▸ **buildSharedKeyEnd**(`publicKey`): `Promise`<`Uint8Array`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `publicKey` | `Uint8Array` | - -#### Returns - -`Promise`<`Uint8Array`\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:12 - -___ - -### buildSharedKeyStart - -▸ **buildSharedKeyStart**(`privateKey`): `Promise`<`Uint8Array`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `privateKey` | `Uint8Array` | - -#### Returns - -`Promise`<`Uint8Array`\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:11 - -___ - -### getKeys - -▸ **getKeys**(): `Promise`<`any`\> - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:2 - -___ - -### getSeed - -▸ **getSeed**(): `string` - -#### Returns - -`string` - -#### Defined in - -packages/types/dist/IKeyring.d.ts:13 - -___ - -### getStorageContextKey - -▸ **getStorageContextKey**(`databaseName`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `databaseName` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:14 - -___ - -### publicKeys - -▸ **publicKeys**(): `Promise`<[`KeyringPublicKeys`](verida_keyring._internal_.KeyringPublicKeys.md)\> - -#### Returns - -`Promise`<[`KeyringPublicKeys`](verida_keyring._internal_.KeyringPublicKeys.md)\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:4 - -___ - -### sign - -▸ **sign**(`data`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `any` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:5 - -___ - -### symDecrypt - -▸ **symDecrypt**(`data`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `string` | - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:8 - -___ - -### symEncrypt - -▸ **symEncrypt**(`data`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:7 - -___ - -### verifySig - -▸ **verifySig**(`data`, `sig`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `string` | -| `sig` | `string` | - -#### Returns - -`Promise`<`boolean`\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:6 diff --git a/docs/api/verida-js/interfaces/verida_keyring._internal_.KeyringPublicKeys.md b/docs/api/verida-js/interfaces/verida_keyring._internal_.KeyringPublicKeys.md deleted file mode 100644 index 01f2e95..0000000 --- a/docs/api/verida-js/interfaces/verida_keyring._internal_.KeyringPublicKeys.md +++ /dev/null @@ -1,76 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/keyring](../modules/verida_keyring.md) / [](../modules/verida_keyring._internal_.md) / KeyringPublicKeys - -# Interface: KeyringPublicKeys - -[@verida/keyring](../modules/verida_keyring.md).[](../modules/verida_keyring._internal_.md).KeyringPublicKeys - -## Table of contents - -### Properties - -- [asymPublicKey](verida_keyring._internal_.KeyringPublicKeys.md#asympublickey) -- [asymPublicKeyBase58](verida_keyring._internal_.KeyringPublicKeys.md#asympublickeybase58) -- [asymPublicKeyHex](verida_keyring._internal_.KeyringPublicKeys.md#asympublickeyhex) -- [signPublicKey](verida_keyring._internal_.KeyringPublicKeys.md#signpublickey) -- [signPublicKeyBase58](verida_keyring._internal_.KeyringPublicKeys.md#signpublickeybase58) -- [signPublicKeyHex](verida_keyring._internal_.KeyringPublicKeys.md#signpublickeyhex) - -## Properties - -### asymPublicKey - -• **asymPublicKey**: `Uint8Array` - -#### Defined in - -packages/types/dist/IKeyring.d.ts:17 - -___ - -### asymPublicKeyBase58 - -• **asymPublicKeyBase58**: `string` - -#### Defined in - -packages/types/dist/IKeyring.d.ts:19 - -___ - -### asymPublicKeyHex - -• **asymPublicKeyHex**: `string` - -#### Defined in - -packages/types/dist/IKeyring.d.ts:18 - -___ - -### signPublicKey - -• **signPublicKey**: `Uint8Array` - -#### Defined in - -packages/types/dist/IKeyring.d.ts:20 - -___ - -### signPublicKeyBase58 - -• **signPublicKeyBase58**: `string` - -#### Defined in - -packages/types/dist/IKeyring.d.ts:22 - -___ - -### signPublicKeyHex - -• **signPublicKeyHex**: `string` - -#### Defined in - -packages/types/dist/IKeyring.d.ts:21 diff --git a/docs/api/verida-js/interfaces/verida_keyring._internal_.SignKeyPair.md b/docs/api/verida-js/interfaces/verida_keyring._internal_.SignKeyPair.md deleted file mode 100644 index 2d7f08a..0000000 --- a/docs/api/verida-js/interfaces/verida_keyring._internal_.SignKeyPair.md +++ /dev/null @@ -1,32 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/keyring](../modules/verida_keyring.md) / [](../modules/verida_keyring._internal_.md) / SignKeyPair - -# Interface: SignKeyPair - -[@verida/keyring](../modules/verida_keyring.md).[](../modules/verida_keyring._internal_.md).SignKeyPair - -## Table of contents - -### Properties - -- [publicKey](verida_keyring._internal_.SignKeyPair.md#publickey) -- [secretKey](verida_keyring._internal_.SignKeyPair.md#secretkey) - -## Properties - -### publicKey - -• **publicKey**: `Uint8Array` - -#### Defined in - -node_modules/tweetnacl/nacl.d.ts:15 - -___ - -### secretKey - -• **secretKey**: `Uint8Array` - -#### Defined in - -node_modules/tweetnacl/nacl.d.ts:16 diff --git a/docs/api/verida-js/interfaces/verida_storage_link.Interfaces.SecureContextConfig.md b/docs/api/verida-js/interfaces/verida_storage_link.Interfaces.SecureContextConfig.md deleted file mode 100644 index d09314b..0000000 --- a/docs/api/verida-js/interfaces/verida_storage_link.Interfaces.SecureContextConfig.md +++ /dev/null @@ -1,43 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/storage-link](../modules/verida_storage_link.md) / [Interfaces](../modules/verida_storage_link.Interfaces.md) / SecureContextConfig - -# Interface: SecureContextConfig - -[@verida/storage-link](../modules/verida_storage_link.md).[Interfaces](../modules/verida_storage_link.Interfaces.md).SecureContextConfig - -## Table of contents - -### Properties - -- [id](verida_storage_link.Interfaces.SecureContextConfig.md#id) -- [publicKeys](verida_storage_link.Interfaces.SecureContextConfig.md#publickeys) -- [services](verida_storage_link.Interfaces.SecureContextConfig.md#services) - -## Properties - -### id - -• **id**: `string` - -#### Defined in - -[packages/storage-link/src/interfaces.ts:26](https://github.com/verida/verida-js/blob/c03b336/packages/storage-link/src/interfaces.ts#L26) - -___ - -### publicKeys - -• **publicKeys**: [`SecureStorageContextPublicKeys`](verida_storage_link.Interfaces.SecureStorageContextPublicKeys.md) - -#### Defined in - -[packages/storage-link/src/interfaces.ts:27](https://github.com/verida/verida-js/blob/c03b336/packages/storage-link/src/interfaces.ts#L27) - -___ - -### services - -• **services**: [`SecureContextServices`](verida_storage_link.Interfaces.SecureContextServices.md) - -#### Defined in - -[packages/storage-link/src/interfaces.ts:28](https://github.com/verida/verida-js/blob/c03b336/packages/storage-link/src/interfaces.ts#L28) diff --git a/docs/api/verida-js/interfaces/verida_storage_link.Interfaces.SecureContextEndpoint.md b/docs/api/verida-js/interfaces/verida_storage_link.Interfaces.SecureContextEndpoint.md deleted file mode 100644 index 79b427a..0000000 --- a/docs/api/verida-js/interfaces/verida_storage_link.Interfaces.SecureContextEndpoint.md +++ /dev/null @@ -1,43 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/storage-link](../modules/verida_storage_link.md) / [Interfaces](../modules/verida_storage_link.Interfaces.md) / SecureContextEndpoint - -# Interface: SecureContextEndpoint - -[@verida/storage-link](../modules/verida_storage_link.md).[Interfaces](../modules/verida_storage_link.Interfaces.md).SecureContextEndpoint - -## Table of contents - -### Properties - -- [config](verida_storage_link.Interfaces.SecureContextEndpoint.md#config) -- [endpointUri](verida_storage_link.Interfaces.SecureContextEndpoint.md#endpointuri) -- [type](verida_storage_link.Interfaces.SecureContextEndpoint.md#type) - -## Properties - -### config - -• `Optional` **config**: `object` - -#### Defined in - -[packages/storage-link/src/interfaces.ts:15](https://github.com/verida/verida-js/blob/c03b336/packages/storage-link/src/interfaces.ts#L15) - -___ - -### endpointUri - -• **endpointUri**: `string` - -#### Defined in - -[packages/storage-link/src/interfaces.ts:14](https://github.com/verida/verida-js/blob/c03b336/packages/storage-link/src/interfaces.ts#L14) - -___ - -### type - -• **type**: `string` - -#### Defined in - -[packages/storage-link/src/interfaces.ts:13](https://github.com/verida/verida-js/blob/c03b336/packages/storage-link/src/interfaces.ts#L13) diff --git a/docs/api/verida-js/interfaces/verida_storage_link.Interfaces.SecureContextPublicKey.md b/docs/api/verida-js/interfaces/verida_storage_link.Interfaces.SecureContextPublicKey.md deleted file mode 100644 index 7e281ea..0000000 --- a/docs/api/verida-js/interfaces/verida_storage_link.Interfaces.SecureContextPublicKey.md +++ /dev/null @@ -1,32 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/storage-link](../modules/verida_storage_link.md) / [Interfaces](../modules/verida_storage_link.Interfaces.md) / SecureContextPublicKey - -# Interface: SecureContextPublicKey - -[@verida/storage-link](../modules/verida_storage_link.md).[Interfaces](../modules/verida_storage_link.Interfaces.md).SecureContextPublicKey - -## Table of contents - -### Properties - -- [publicKeyHex](verida_storage_link.Interfaces.SecureContextPublicKey.md#publickeyhex) -- [type](verida_storage_link.Interfaces.SecureContextPublicKey.md#type) - -## Properties - -### publicKeyHex - -• **publicKeyHex**: `string` - -#### Defined in - -[packages/storage-link/src/interfaces.ts:4](https://github.com/verida/verida-js/blob/c03b336/packages/storage-link/src/interfaces.ts#L4) - -___ - -### type - -• **type**: `string` - -#### Defined in - -[packages/storage-link/src/interfaces.ts:3](https://github.com/verida/verida-js/blob/c03b336/packages/storage-link/src/interfaces.ts#L3) diff --git a/docs/api/verida-js/interfaces/verida_storage_link.Interfaces.SecureContextServices.md b/docs/api/verida-js/interfaces/verida_storage_link.Interfaces.SecureContextServices.md deleted file mode 100644 index ab5c377..0000000 --- a/docs/api/verida-js/interfaces/verida_storage_link.Interfaces.SecureContextServices.md +++ /dev/null @@ -1,54 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/storage-link](../modules/verida_storage_link.md) / [Interfaces](../modules/verida_storage_link.Interfaces.md) / SecureContextServices - -# Interface: SecureContextServices - -[@verida/storage-link](../modules/verida_storage_link.md).[Interfaces](../modules/verida_storage_link.Interfaces.md).SecureContextServices - -## Table of contents - -### Properties - -- [databaseServer](verida_storage_link.Interfaces.SecureContextServices.md#databaseserver) -- [messageServer](verida_storage_link.Interfaces.SecureContextServices.md#messageserver) -- [notificationServer](verida_storage_link.Interfaces.SecureContextServices.md#notificationserver) -- [storageServer](verida_storage_link.Interfaces.SecureContextServices.md#storageserver) - -## Properties - -### databaseServer - -• **databaseServer**: [`SecureContextEndpoint`](verida_storage_link.Interfaces.SecureContextEndpoint.md) - -#### Defined in - -[packages/storage-link/src/interfaces.ts:19](https://github.com/verida/verida-js/blob/c03b336/packages/storage-link/src/interfaces.ts#L19) - -___ - -### messageServer - -• **messageServer**: [`SecureContextEndpoint`](verida_storage_link.Interfaces.SecureContextEndpoint.md) - -#### Defined in - -[packages/storage-link/src/interfaces.ts:20](https://github.com/verida/verida-js/blob/c03b336/packages/storage-link/src/interfaces.ts#L20) - -___ - -### notificationServer - -• `Optional` **notificationServer**: [`SecureContextEndpoint`](verida_storage_link.Interfaces.SecureContextEndpoint.md) - -#### Defined in - -[packages/storage-link/src/interfaces.ts:22](https://github.com/verida/verida-js/blob/c03b336/packages/storage-link/src/interfaces.ts#L22) - -___ - -### storageServer - -• `Optional` **storageServer**: [`SecureContextEndpoint`](verida_storage_link.Interfaces.SecureContextEndpoint.md) - -#### Defined in - -[packages/storage-link/src/interfaces.ts:21](https://github.com/verida/verida-js/blob/c03b336/packages/storage-link/src/interfaces.ts#L21) diff --git a/docs/api/verida-js/interfaces/verida_storage_link.Interfaces.SecureStorageContextPublicKeys.md b/docs/api/verida-js/interfaces/verida_storage_link.Interfaces.SecureStorageContextPublicKeys.md deleted file mode 100644 index 17a4ade..0000000 --- a/docs/api/verida-js/interfaces/verida_storage_link.Interfaces.SecureStorageContextPublicKeys.md +++ /dev/null @@ -1,32 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/storage-link](../modules/verida_storage_link.md) / [Interfaces](../modules/verida_storage_link.Interfaces.md) / SecureStorageContextPublicKeys - -# Interface: SecureStorageContextPublicKeys - -[@verida/storage-link](../modules/verida_storage_link.md).[Interfaces](../modules/verida_storage_link.Interfaces.md).SecureStorageContextPublicKeys - -## Table of contents - -### Properties - -- [asymKey](verida_storage_link.Interfaces.SecureStorageContextPublicKeys.md#asymkey) -- [signKey](verida_storage_link.Interfaces.SecureStorageContextPublicKeys.md#signkey) - -## Properties - -### asymKey - -• **asymKey**: [`SecureContextPublicKey`](verida_storage_link.Interfaces.SecureContextPublicKey.md) - -#### Defined in - -[packages/storage-link/src/interfaces.ts:8](https://github.com/verida/verida-js/blob/c03b336/packages/storage-link/src/interfaces.ts#L8) - -___ - -### signKey - -• **signKey**: [`SecureContextPublicKey`](verida_storage_link.Interfaces.SecureContextPublicKey.md) - -#### Defined in - -[packages/storage-link/src/interfaces.ts:9](https://github.com/verida/verida-js/blob/c03b336/packages/storage-link/src/interfaces.ts#L9) diff --git a/docs/api/verida-js/interfaces/verida_storage_link._internal_.ArrayLike.md b/docs/api/verida-js/interfaces/verida_storage_link._internal_.ArrayLike.md deleted file mode 100644 index bf46ab3..0000000 --- a/docs/api/verida-js/interfaces/verida_storage_link._internal_.ArrayLike.md +++ /dev/null @@ -1,31 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/storage-link](../modules/verida_storage_link.md) / [](../modules/verida_storage_link._internal_.md) / ArrayLike - -# Interface: ArrayLike - -[@verida/storage-link](../modules/verida_storage_link.md).[](../modules/verida_storage_link._internal_.md).ArrayLike - -## Type parameters - -| Name | -| :------ | -| `T` | - -## Indexable - -▪ [n: `number`]: `T` - -## Table of contents - -### Properties - -- [length](verida_storage_link._internal_.ArrayLike.md#length) - -## Properties - -### length - -• `Readonly` **length**: `number` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1464 diff --git a/docs/api/verida-js/interfaces/verida_storage_link._internal_.Block.md b/docs/api/verida-js/interfaces/verida_storage_link._internal_.Block.md deleted file mode 100644 index 1e01964..0000000 --- a/docs/api/verida-js/interfaces/verida_storage_link._internal_.Block.md +++ /dev/null @@ -1,207 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/storage-link](../modules/verida_storage_link.md) / [](../modules/verida_storage_link._internal_.md) / Block - -# Interface: Block - -[@verida/storage-link](../modules/verida_storage_link.md).[](../modules/verida_storage_link._internal_.md).Block - -## Hierarchy - -- [`_Block`](verida_storage_link._internal_._Block.md) - - ↳ **`Block`** - -## Table of contents - -### Properties - -- [\_difficulty](verida_storage_link._internal_.Block.md#_difficulty) -- [baseFeePerGas](verida_storage_link._internal_.Block.md#basefeepergas) -- [difficulty](verida_storage_link._internal_.Block.md#difficulty) -- [extraData](verida_storage_link._internal_.Block.md#extradata) -- [gasLimit](verida_storage_link._internal_.Block.md#gaslimit) -- [gasUsed](verida_storage_link._internal_.Block.md#gasused) -- [hash](verida_storage_link._internal_.Block.md#hash) -- [miner](verida_storage_link._internal_.Block.md#miner) -- [nonce](verida_storage_link._internal_.Block.md#nonce) -- [number](verida_storage_link._internal_.Block.md#number) -- [parentHash](verida_storage_link._internal_.Block.md#parenthash) -- [timestamp](verida_storage_link._internal_.Block.md#timestamp) -- [transactions](verida_storage_link._internal_.Block.md#transactions) - -## Properties - -### \_difficulty - -• **\_difficulty**: [`BigNumber`](../classes/verida_storage_link._internal_.BigNumber.md) - -#### Inherited from - -[_Block](verida_storage_link._internal_._Block.md).[_difficulty](verida_storage_link._internal_._Block.md#_difficulty) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:41 - -___ - -### baseFeePerGas - -• `Optional` **baseFeePerGas**: ``null`` \| [`BigNumber`](../classes/verida_storage_link._internal_.BigNumber.md) - -#### Inherited from - -[_Block](verida_storage_link._internal_._Block.md).[baseFeePerGas](verida_storage_link._internal_._Block.md#basefeepergas) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:46 - -___ - -### difficulty - -• **difficulty**: `number` - -#### Inherited from - -[_Block](verida_storage_link._internal_._Block.md).[difficulty](verida_storage_link._internal_._Block.md#difficulty) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:40 - -___ - -### extraData - -• **extraData**: `string` - -#### Inherited from - -[_Block](verida_storage_link._internal_._Block.md).[extraData](verida_storage_link._internal_._Block.md#extradata) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:45 - -___ - -### gasLimit - -• **gasLimit**: [`BigNumber`](../classes/verida_storage_link._internal_.BigNumber.md) - -#### Inherited from - -[_Block](verida_storage_link._internal_._Block.md).[gasLimit](verida_storage_link._internal_._Block.md#gaslimit) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:42 - -___ - -### gasUsed - -• **gasUsed**: [`BigNumber`](../classes/verida_storage_link._internal_.BigNumber.md) - -#### Inherited from - -[_Block](verida_storage_link._internal_._Block.md).[gasUsed](verida_storage_link._internal_._Block.md#gasused) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:43 - -___ - -### hash - -• **hash**: `string` - -#### Inherited from - -[_Block](verida_storage_link._internal_._Block.md).[hash](verida_storage_link._internal_._Block.md#hash) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:35 - -___ - -### miner - -• **miner**: `string` - -#### Inherited from - -[_Block](verida_storage_link._internal_._Block.md).[miner](verida_storage_link._internal_._Block.md#miner) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:44 - -___ - -### nonce - -• **nonce**: `string` - -#### Inherited from - -[_Block](verida_storage_link._internal_._Block.md).[nonce](verida_storage_link._internal_._Block.md#nonce) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:39 - -___ - -### number - -• **number**: `number` - -#### Inherited from - -[_Block](verida_storage_link._internal_._Block.md).[number](verida_storage_link._internal_._Block.md#number) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:37 - -___ - -### parentHash - -• **parentHash**: `string` - -#### Inherited from - -[_Block](verida_storage_link._internal_._Block.md).[parentHash](verida_storage_link._internal_._Block.md#parenthash) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:36 - -___ - -### timestamp - -• **timestamp**: `number` - -#### Inherited from - -[_Block](verida_storage_link._internal_._Block.md).[timestamp](verida_storage_link._internal_._Block.md#timestamp) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:38 - -___ - -### transactions - -• **transactions**: `string`[] - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:49 diff --git a/docs/api/verida-js/interfaces/verida_storage_link._internal_.BlockWithTransactions.md b/docs/api/verida-js/interfaces/verida_storage_link._internal_.BlockWithTransactions.md deleted file mode 100644 index 8dcc232..0000000 --- a/docs/api/verida-js/interfaces/verida_storage_link._internal_.BlockWithTransactions.md +++ /dev/null @@ -1,207 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/storage-link](../modules/verida_storage_link.md) / [](../modules/verida_storage_link._internal_.md) / BlockWithTransactions - -# Interface: BlockWithTransactions - -[@verida/storage-link](../modules/verida_storage_link.md).[](../modules/verida_storage_link._internal_.md).BlockWithTransactions - -## Hierarchy - -- [`_Block`](verida_storage_link._internal_._Block.md) - - ↳ **`BlockWithTransactions`** - -## Table of contents - -### Properties - -- [\_difficulty](verida_storage_link._internal_.BlockWithTransactions.md#_difficulty) -- [baseFeePerGas](verida_storage_link._internal_.BlockWithTransactions.md#basefeepergas) -- [difficulty](verida_storage_link._internal_.BlockWithTransactions.md#difficulty) -- [extraData](verida_storage_link._internal_.BlockWithTransactions.md#extradata) -- [gasLimit](verida_storage_link._internal_.BlockWithTransactions.md#gaslimit) -- [gasUsed](verida_storage_link._internal_.BlockWithTransactions.md#gasused) -- [hash](verida_storage_link._internal_.BlockWithTransactions.md#hash) -- [miner](verida_storage_link._internal_.BlockWithTransactions.md#miner) -- [nonce](verida_storage_link._internal_.BlockWithTransactions.md#nonce) -- [number](verida_storage_link._internal_.BlockWithTransactions.md#number) -- [parentHash](verida_storage_link._internal_.BlockWithTransactions.md#parenthash) -- [timestamp](verida_storage_link._internal_.BlockWithTransactions.md#timestamp) -- [transactions](verida_storage_link._internal_.BlockWithTransactions.md#transactions) - -## Properties - -### \_difficulty - -• **\_difficulty**: [`BigNumber`](../classes/verida_storage_link._internal_.BigNumber.md) - -#### Inherited from - -[_Block](verida_storage_link._internal_._Block.md).[_difficulty](verida_storage_link._internal_._Block.md#_difficulty) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:41 - -___ - -### baseFeePerGas - -• `Optional` **baseFeePerGas**: ``null`` \| [`BigNumber`](../classes/verida_storage_link._internal_.BigNumber.md) - -#### Inherited from - -[_Block](verida_storage_link._internal_._Block.md).[baseFeePerGas](verida_storage_link._internal_._Block.md#basefeepergas) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:46 - -___ - -### difficulty - -• **difficulty**: `number` - -#### Inherited from - -[_Block](verida_storage_link._internal_._Block.md).[difficulty](verida_storage_link._internal_._Block.md#difficulty) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:40 - -___ - -### extraData - -• **extraData**: `string` - -#### Inherited from - -[_Block](verida_storage_link._internal_._Block.md).[extraData](verida_storage_link._internal_._Block.md#extradata) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:45 - -___ - -### gasLimit - -• **gasLimit**: [`BigNumber`](../classes/verida_storage_link._internal_.BigNumber.md) - -#### Inherited from - -[_Block](verida_storage_link._internal_._Block.md).[gasLimit](verida_storage_link._internal_._Block.md#gaslimit) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:42 - -___ - -### gasUsed - -• **gasUsed**: [`BigNumber`](../classes/verida_storage_link._internal_.BigNumber.md) - -#### Inherited from - -[_Block](verida_storage_link._internal_._Block.md).[gasUsed](verida_storage_link._internal_._Block.md#gasused) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:43 - -___ - -### hash - -• **hash**: `string` - -#### Inherited from - -[_Block](verida_storage_link._internal_._Block.md).[hash](verida_storage_link._internal_._Block.md#hash) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:35 - -___ - -### miner - -• **miner**: `string` - -#### Inherited from - -[_Block](verida_storage_link._internal_._Block.md).[miner](verida_storage_link._internal_._Block.md#miner) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:44 - -___ - -### nonce - -• **nonce**: `string` - -#### Inherited from - -[_Block](verida_storage_link._internal_._Block.md).[nonce](verida_storage_link._internal_._Block.md#nonce) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:39 - -___ - -### number - -• **number**: `number` - -#### Inherited from - -[_Block](verida_storage_link._internal_._Block.md).[number](verida_storage_link._internal_._Block.md#number) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:37 - -___ - -### parentHash - -• **parentHash**: `string` - -#### Inherited from - -[_Block](verida_storage_link._internal_._Block.md).[parentHash](verida_storage_link._internal_._Block.md#parenthash) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:36 - -___ - -### timestamp - -• **timestamp**: `number` - -#### Inherited from - -[_Block](verida_storage_link._internal_._Block.md).[timestamp](verida_storage_link._internal_._Block.md#timestamp) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:38 - -___ - -### transactions - -• **transactions**: [`TransactionResponse`](verida_storage_link._internal_.TransactionResponse.md)[] - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:52 diff --git a/docs/api/verida-js/interfaces/verida_storage_link._internal_.BoxKeyPair.md b/docs/api/verida-js/interfaces/verida_storage_link._internal_.BoxKeyPair.md deleted file mode 100644 index 260c028..0000000 --- a/docs/api/verida-js/interfaces/verida_storage_link._internal_.BoxKeyPair.md +++ /dev/null @@ -1,32 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/storage-link](../modules/verida_storage_link.md) / [](../modules/verida_storage_link._internal_.md) / BoxKeyPair - -# Interface: BoxKeyPair - -[@verida/storage-link](../modules/verida_storage_link.md).[](../modules/verida_storage_link._internal_.md).BoxKeyPair - -## Table of contents - -### Properties - -- [publicKey](verida_storage_link._internal_.BoxKeyPair.md#publickey) -- [secretKey](verida_storage_link._internal_.BoxKeyPair.md#secretkey) - -## Properties - -### publicKey - -• **publicKey**: `Uint8Array` - -#### Defined in - -node_modules/tweetnacl/nacl.d.ts:10 - -___ - -### secretKey - -• **secretKey**: `Uint8Array` - -#### Defined in - -node_modules/tweetnacl/nacl.d.ts:11 diff --git a/docs/api/verida-js/interfaces/verida_storage_link._internal_.DIDClientConfig.md b/docs/api/verida-js/interfaces/verida_storage_link._internal_.DIDClientConfig.md deleted file mode 100644 index 3daab22..0000000 --- a/docs/api/verida-js/interfaces/verida_storage_link._internal_.DIDClientConfig.md +++ /dev/null @@ -1,43 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/storage-link](../modules/verida_storage_link.md) / [](../modules/verida_storage_link._internal_.md) / DIDClientConfig - -# Interface: DIDClientConfig - -[@verida/storage-link](../modules/verida_storage_link.md).[](../modules/verida_storage_link._internal_.md).DIDClientConfig - -## Table of contents - -### Properties - -- [network](verida_storage_link._internal_.DIDClientConfig.md#network) -- [rpcUrl](verida_storage_link._internal_.DIDClientConfig.md#rpcurl) -- [timeout](verida_storage_link._internal_.DIDClientConfig.md#timeout) - -## Properties - -### network - -• **network**: [`EnvironmentType`](../enums/verida_storage_link._internal_.EnvironmentType.md) - -#### Defined in - -packages/types/dist/NetworkInterfaces.d.ts:21 - -___ - -### rpcUrl - -• `Optional` **rpcUrl**: `string` - -#### Defined in - -packages/types/dist/NetworkInterfaces.d.ts:22 - -___ - -### timeout - -• `Optional` **timeout**: `number` - -#### Defined in - -packages/types/dist/NetworkInterfaces.d.ts:23 diff --git a/docs/api/verida-js/interfaces/verida_storage_link._internal_.DIDDocumentStruct.md b/docs/api/verida-js/interfaces/verida_storage_link._internal_.DIDDocumentStruct.md deleted file mode 100644 index ead1549..0000000 --- a/docs/api/verida-js/interfaces/verida_storage_link._internal_.DIDDocumentStruct.md +++ /dev/null @@ -1,189 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/storage-link](../modules/verida_storage_link.md) / [](../modules/verida_storage_link._internal_.md) / DIDDocumentStruct - -# Interface: DIDDocumentStruct - -[@verida/storage-link](../modules/verida_storage_link.md).[](../modules/verida_storage_link._internal_.md).DIDDocumentStruct - -## Hierarchy - -- [`DIDDocument`](../modules/verida_storage_link._internal_.md#diddocument) - - ↳ **`DIDDocumentStruct`** - -## Table of contents - -### Properties - -- [@context](verida_storage_link._internal_.DIDDocumentStruct.md#@context) -- [alsoKnownAs](verida_storage_link._internal_.DIDDocumentStruct.md#alsoknownas) -- [assertionMethod](verida_storage_link._internal_.DIDDocumentStruct.md#assertionmethod) -- [authentication](verida_storage_link._internal_.DIDDocumentStruct.md#authentication) -- [capabilityDelegation](verida_storage_link._internal_.DIDDocumentStruct.md#capabilitydelegation) -- [capabilityInvocation](verida_storage_link._internal_.DIDDocumentStruct.md#capabilityinvocation) -- [controller](verida_storage_link._internal_.DIDDocumentStruct.md#controller) -- [id](verida_storage_link._internal_.DIDDocumentStruct.md#id) -- [keyAgreement](verida_storage_link._internal_.DIDDocumentStruct.md#keyagreement) -- [proof](verida_storage_link._internal_.DIDDocumentStruct.md#proof) -- [publicKey](verida_storage_link._internal_.DIDDocumentStruct.md#publickey) -- [service](verida_storage_link._internal_.DIDDocumentStruct.md#service) -- [verificationMethod](verida_storage_link._internal_.DIDDocumentStruct.md#verificationmethod) - -## Properties - -### @context - -• `Optional` **@context**: `string` \| `string`[] - -#### Inherited from - -DD.@context - -#### Defined in - -packages/did-document/node_modules/did-resolver/lib/resolver.d.ts:26 - -___ - -### alsoKnownAs - -• `Optional` **alsoKnownAs**: `string`[] - -#### Inherited from - -DD.alsoKnownAs - -#### Defined in - -packages/did-document/node_modules/did-resolver/lib/resolver.d.ts:28 - -___ - -### assertionMethod - -• **assertionMethod**: `undefined` \| (`string` \| [`VerificationMethod`](verida_storage_link._internal_.VerificationMethod.md))[] - -#### Inherited from - -DD.assertionMethod - -___ - -### authentication - -• **authentication**: `undefined` \| (`string` \| [`VerificationMethod`](verida_storage_link._internal_.VerificationMethod.md))[] - -#### Inherited from - -DD.authentication - -___ - -### capabilityDelegation - -• **capabilityDelegation**: `undefined` \| (`string` \| [`VerificationMethod`](verida_storage_link._internal_.VerificationMethod.md))[] - -#### Inherited from - -DD.capabilityDelegation - -___ - -### capabilityInvocation - -• **capabilityInvocation**: `undefined` \| (`string` \| [`VerificationMethod`](verida_storage_link._internal_.VerificationMethod.md))[] - -#### Inherited from - -DD.capabilityInvocation - -___ - -### controller - -• `Optional` **controller**: `string` \| `string`[] - -#### Inherited from - -DD.controller - -#### Defined in - -packages/did-document/node_modules/did-resolver/lib/resolver.d.ts:29 - -___ - -### id - -• **id**: `string` - -#### Inherited from - -DD.id - -#### Defined in - -packages/did-document/node_modules/did-resolver/lib/resolver.d.ts:27 - -___ - -### keyAgreement - -• **keyAgreement**: `undefined` \| (`string` \| [`VerificationMethod`](verida_storage_link._internal_.VerificationMethod.md))[] - -#### Inherited from - -DD.keyAgreement - -___ - -### proof - -• `Optional` **proof**: [`Proof`](verida_storage_link._internal_.Proof.md) - -#### Defined in - -packages/did-document/dist/interfaces.d.ts:14 - -___ - -### publicKey - -• `Optional` **publicKey**: [`VerificationMethod`](verida_storage_link._internal_.VerificationMethod.md)[] - -**`deprecated`** - -#### Inherited from - -DD.publicKey - -#### Defined in - -packages/did-document/node_modules/did-resolver/lib/resolver.d.ts:35 - -___ - -### service - -• `Optional` **service**: [`ServiceEndpoint`](verida_storage_link._internal_.ServiceEndpoint.md)[] - -#### Inherited from - -DD.service - -#### Defined in - -packages/did-document/node_modules/did-resolver/lib/resolver.d.ts:31 - -___ - -### verificationMethod - -• `Optional` **verificationMethod**: [`VerificationMethod`](verida_storage_link._internal_.VerificationMethod.md)[] - -#### Inherited from - -DD.verificationMethod - -#### Defined in - -packages/did-document/node_modules/did-resolver/lib/resolver.d.ts:30 diff --git a/docs/api/verida-js/interfaces/verida_storage_link._internal_.Endpoints.md b/docs/api/verida-js/interfaces/verida_storage_link._internal_.Endpoints.md deleted file mode 100644 index 601dce6..0000000 --- a/docs/api/verida-js/interfaces/verida_storage_link._internal_.Endpoints.md +++ /dev/null @@ -1,54 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/storage-link](../modules/verida_storage_link.md) / [](../modules/verida_storage_link._internal_.md) / Endpoints - -# Interface: Endpoints - -[@verida/storage-link](../modules/verida_storage_link.md).[](../modules/verida_storage_link._internal_.md).Endpoints - -## Table of contents - -### Properties - -- [database](verida_storage_link._internal_.Endpoints.md#database) -- [messaging](verida_storage_link._internal_.Endpoints.md#messaging) -- [notification](verida_storage_link._internal_.Endpoints.md#notification) -- [storage](verida_storage_link._internal_.Endpoints.md#storage) - -## Properties - -### database - -• **database**: [`SecureContextEndpoint`](verida_storage_link._internal_.SecureContextEndpoint.md) - -#### Defined in - -packages/did-document/dist/interfaces.d.ts:17 - -___ - -### messaging - -• **messaging**: [`SecureContextEndpoint`](verida_storage_link._internal_.SecureContextEndpoint.md) - -#### Defined in - -packages/did-document/dist/interfaces.d.ts:18 - -___ - -### notification - -• `Optional` **notification**: [`SecureContextEndpoint`](verida_storage_link._internal_.SecureContextEndpoint.md) - -#### Defined in - -packages/did-document/dist/interfaces.d.ts:20 - -___ - -### storage - -• `Optional` **storage**: [`SecureContextEndpoint`](verida_storage_link._internal_.SecureContextEndpoint.md) - -#### Defined in - -packages/did-document/dist/interfaces.d.ts:19 diff --git a/docs/api/verida-js/interfaces/verida_storage_link._internal_.EventFilter.md b/docs/api/verida-js/interfaces/verida_storage_link._internal_.EventFilter.md deleted file mode 100644 index 6d12755..0000000 --- a/docs/api/verida-js/interfaces/verida_storage_link._internal_.EventFilter.md +++ /dev/null @@ -1,38 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/storage-link](../modules/verida_storage_link.md) / [](../modules/verida_storage_link._internal_.md) / EventFilter - -# Interface: EventFilter - -[@verida/storage-link](../modules/verida_storage_link.md).[](../modules/verida_storage_link._internal_.md).EventFilter - -## Hierarchy - -- **`EventFilter`** - - ↳ [`Filter`](verida_storage_link._internal_.Filter.md) - -## Table of contents - -### Properties - -- [address](verida_storage_link._internal_.EventFilter.md#address) -- [topics](verida_storage_link._internal_.EventFilter.md#topics) - -## Properties - -### address - -• `Optional` **address**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:91 - -___ - -### topics - -• `Optional` **topics**: (``null`` \| `string` \| `string`[])[] - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:92 diff --git a/docs/api/verida-js/interfaces/verida_storage_link._internal_.FeeData.md b/docs/api/verida-js/interfaces/verida_storage_link._internal_.FeeData.md deleted file mode 100644 index 08a0dc4..0000000 --- a/docs/api/verida-js/interfaces/verida_storage_link._internal_.FeeData.md +++ /dev/null @@ -1,54 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/storage-link](../modules/verida_storage_link.md) / [](../modules/verida_storage_link._internal_.md) / FeeData - -# Interface: FeeData - -[@verida/storage-link](../modules/verida_storage_link.md).[](../modules/verida_storage_link._internal_.md).FeeData - -## Table of contents - -### Properties - -- [gasPrice](verida_storage_link._internal_.FeeData.md#gasprice) -- [lastBaseFeePerGas](verida_storage_link._internal_.FeeData.md#lastbasefeepergas) -- [maxFeePerGas](verida_storage_link._internal_.FeeData.md#maxfeepergas) -- [maxPriorityFeePerGas](verida_storage_link._internal_.FeeData.md#maxpriorityfeepergas) - -## Properties - -### gasPrice - -• **gasPrice**: ``null`` \| [`BigNumber`](../classes/verida_storage_link._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:88 - -___ - -### lastBaseFeePerGas - -• **lastBaseFeePerGas**: ``null`` \| [`BigNumber`](../classes/verida_storage_link._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:85 - -___ - -### maxFeePerGas - -• **maxFeePerGas**: ``null`` \| [`BigNumber`](../classes/verida_storage_link._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:86 - -___ - -### maxPriorityFeePerGas - -• **maxPriorityFeePerGas**: ``null`` \| [`BigNumber`](../classes/verida_storage_link._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:87 diff --git a/docs/api/verida-js/interfaces/verida_storage_link._internal_.Filter.md b/docs/api/verida-js/interfaces/verida_storage_link._internal_.Filter.md deleted file mode 100644 index 522019a..0000000 --- a/docs/api/verida-js/interfaces/verida_storage_link._internal_.Filter.md +++ /dev/null @@ -1,68 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/storage-link](../modules/verida_storage_link.md) / [](../modules/verida_storage_link._internal_.md) / Filter - -# Interface: Filter - -[@verida/storage-link](../modules/verida_storage_link.md).[](../modules/verida_storage_link._internal_.md).Filter - -## Hierarchy - -- [`EventFilter`](verida_storage_link._internal_.EventFilter.md) - - ↳ **`Filter`** - -## Table of contents - -### Properties - -- [address](verida_storage_link._internal_.Filter.md#address) -- [fromBlock](verida_storage_link._internal_.Filter.md#fromblock) -- [toBlock](verida_storage_link._internal_.Filter.md#toblock) -- [topics](verida_storage_link._internal_.Filter.md#topics) - -## Properties - -### address - -• `Optional` **address**: `string` - -#### Inherited from - -[EventFilter](verida_storage_link._internal_.EventFilter.md).[address](verida_storage_link._internal_.EventFilter.md#address) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:91 - -___ - -### fromBlock - -• `Optional` **fromBlock**: [`BlockTag`](../modules/verida_storage_link._internal_.md#blocktag) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:95 - -___ - -### toBlock - -• `Optional` **toBlock**: [`BlockTag`](../modules/verida_storage_link._internal_.md#blocktag) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:96 - -___ - -### topics - -• `Optional` **topics**: (``null`` \| `string` \| `string`[])[] - -#### Inherited from - -[EventFilter](verida_storage_link._internal_.EventFilter.md).[topics](verida_storage_link._internal_.EventFilter.md#topics) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:92 diff --git a/docs/api/verida-js/interfaces/verida_storage_link._internal_.Hexable.md b/docs/api/verida-js/interfaces/verida_storage_link._internal_.Hexable.md deleted file mode 100644 index c122915..0000000 --- a/docs/api/verida-js/interfaces/verida_storage_link._internal_.Hexable.md +++ /dev/null @@ -1,29 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/storage-link](../modules/verida_storage_link.md) / [](../modules/verida_storage_link._internal_.md) / Hexable - -# Interface: Hexable - -[@verida/storage-link](../modules/verida_storage_link.md).[](../modules/verida_storage_link._internal_.md).Hexable - -## Implemented by - -- [`BigNumber`](../classes/verida_storage_link._internal_.BigNumber.md) - -## Table of contents - -### Methods - -- [toHexString](verida_storage_link._internal_.Hexable.md#tohexstring) - -## Methods - -### toHexString - -▸ **toHexString**(): `string` - -#### Returns - -`string` - -#### Defined in - -node_modules/@ethersproject/bytes/lib/index.d.ts:8 diff --git a/docs/api/verida-js/interfaces/verida_storage_link._internal_.IDIDClient.md b/docs/api/verida-js/interfaces/verida_storage_link._internal_.IDIDClient.md deleted file mode 100644 index f89c8d8..0000000 --- a/docs/api/verida-js/interfaces/verida_storage_link._internal_.IDIDClient.md +++ /dev/null @@ -1,155 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/storage-link](../modules/verida_storage_link.md) / [](../modules/verida_storage_link._internal_.md) / IDIDClient - -# Interface: IDIDClient - -[@verida/storage-link](../modules/verida_storage_link.md).[](../modules/verida_storage_link._internal_.md).IDIDClient - -## Implemented by - -- [`DIDClient`](../classes/verida_storage_link._internal_.DIDClient.md) - -## Table of contents - -### Methods - -- [authenticate](verida_storage_link._internal_.IDIDClient.md#authenticate) -- [authenticated](verida_storage_link._internal_.IDIDClient.md#authenticated) -- [get](verida_storage_link._internal_.IDIDClient.md#get) -- [getDid](verida_storage_link._internal_.IDIDClient.md#getdid) -- [getLastEndpointErrors](verida_storage_link._internal_.IDIDClient.md#getlastendpointerrors) -- [getPublicKey](verida_storage_link._internal_.IDIDClient.md#getpublickey) -- [getRpcUrl](verida_storage_link._internal_.IDIDClient.md#getrpcurl) -- [save](verida_storage_link._internal_.IDIDClient.md#save) - -## Methods - -### authenticate - -▸ **authenticate**(`veridaPrivateKey`, `callType`, `web3Config`, `defaultEndpoints`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `veridaPrivateKey` | `string` | -| `callType` | [`Web3CallType`](../modules/verida_storage_link._internal_.md#web3calltype) | -| `web3Config` | [`Web3SelfTransactionConfigPart`](verida_storage_link._internal_.Web3SelfTransactionConfigPart.md) \| [`Web3MetaTransactionConfig`](verida_storage_link._internal_.Web3MetaTransactionConfig.md) | -| `defaultEndpoints` | `string`[] | - -#### Returns - -`void` - -#### Defined in - -packages/types/dist/IDIDClient.d.ts:4 - -___ - -### authenticated - -▸ **authenticated**(): `boolean` - -#### Returns - -`boolean` - -#### Defined in - -packages/types/dist/IDIDClient.d.ts:5 - -___ - -### get - -▸ **get**(`did`): `Promise`<[`IDIDDocument`](verida_storage_link._internal_.IDIDDocument.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did` | `string` | - -#### Returns - -`Promise`<[`IDIDDocument`](verida_storage_link._internal_.IDIDDocument.md)\> - -#### Defined in - -packages/types/dist/IDIDClient.d.ts:10 - -___ - -### getDid - -▸ **getDid**(): `undefined` \| `string` - -#### Returns - -`undefined` \| `string` - -#### Defined in - -packages/types/dist/IDIDClient.d.ts:6 - -___ - -### getLastEndpointErrors - -▸ **getLastEndpointErrors**(): [`VdaDidEndpointResponses`](../modules/verida_storage_link._internal_.md#vdadidendpointresponses) - -#### Returns - -[`VdaDidEndpointResponses`](../modules/verida_storage_link._internal_.md#vdadidendpointresponses) - -#### Defined in - -packages/types/dist/IDIDClient.d.ts:9 - -___ - -### getPublicKey - -▸ **getPublicKey**(): `undefined` \| `string` - -#### Returns - -`undefined` \| `string` - -#### Defined in - -packages/types/dist/IDIDClient.d.ts:7 - -___ - -### getRpcUrl - -▸ **getRpcUrl**(): `string` - -#### Returns - -`string` - -#### Defined in - -packages/types/dist/IDIDClient.d.ts:11 - -___ - -### save - -▸ **save**(`document`): `Promise`<[`VdaDidEndpointResponses`](../modules/verida_storage_link._internal_.md#vdadidendpointresponses)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `document` | [`IDIDDocument`](verida_storage_link._internal_.IDIDDocument.md) | - -#### Returns - -`Promise`<[`VdaDidEndpointResponses`](../modules/verida_storage_link._internal_.md#vdadidendpointresponses)\> - -#### Defined in - -packages/types/dist/IDIDClient.d.ts:8 diff --git a/docs/api/verida-js/interfaces/verida_storage_link._internal_.IDIDDocument.md b/docs/api/verida-js/interfaces/verida_storage_link._internal_.IDIDDocument.md deleted file mode 100644 index 8a9b78e..0000000 --- a/docs/api/verida-js/interfaces/verida_storage_link._internal_.IDIDDocument.md +++ /dev/null @@ -1,364 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/storage-link](../modules/verida_storage_link.md) / [](../modules/verida_storage_link._internal_.md) / IDIDDocument - -# Interface: IDIDDocument - -[@verida/storage-link](../modules/verida_storage_link.md).[](../modules/verida_storage_link._internal_.md).IDIDDocument - -## Implemented by - -- [`default`](../classes/verida_storage_link._internal_.default.md) - -## Table of contents - -### Accessors - -- [id](verida_storage_link._internal_.IDIDDocument.md#id) - -### Methods - -- [addContext](verida_storage_link._internal_.IDIDDocument.md#addcontext) -- [addContextAsymKey](verida_storage_link._internal_.IDIDDocument.md#addcontextasymkey) -- [addContextService](verida_storage_link._internal_.IDIDDocument.md#addcontextservice) -- [addContextSignKey](verida_storage_link._internal_.IDIDDocument.md#addcontextsignkey) -- [buildTimestamp](verida_storage_link._internal_.IDIDDocument.md#buildtimestamp) -- [export](verida_storage_link._internal_.IDIDDocument.md#export) -- [getErrors](verida_storage_link._internal_.IDIDDocument.md#geterrors) -- [import](verida_storage_link._internal_.IDIDDocument.md#import) -- [locateContextProof](verida_storage_link._internal_.IDIDDocument.md#locatecontextproof) -- [locateServiceEndpoint](verida_storage_link._internal_.IDIDDocument.md#locateserviceendpoint) -- [removeContext](verida_storage_link._internal_.IDIDDocument.md#removecontext) -- [setAttributes](verida_storage_link._internal_.IDIDDocument.md#setattributes) -- [signProof](verida_storage_link._internal_.IDIDDocument.md#signproof) -- [verifyContextSignature](verida_storage_link._internal_.IDIDDocument.md#verifycontextsignature) -- [verifyProof](verida_storage_link._internal_.IDIDDocument.md#verifyproof) -- [verifySig](verida_storage_link._internal_.IDIDDocument.md#verifysig) - -## Accessors - -### id - -• `get` **id**(): `string` - -#### Returns - -`string` - -#### Defined in - -packages/types/dist/IDIDDocument.d.ts:5 - -## Methods - -### addContext - -▸ **addContext**(`contextName`, `keyring`, `privateKey`, `endpoints`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | -| `keyring` | [`IKeyring`](verida_storage_link._internal_.IKeyring.md) | -| `privateKey` | `string` | -| `endpoints` | [`SecureContextEndpoints`](verida_storage_link._internal_.SecureContextEndpoints.md) | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -packages/types/dist/IDIDDocument.d.ts:7 - -___ - -### addContextAsymKey - -▸ **addContextAsymKey**(`contextHash`, `publicKeyHex`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextHash` | `string` | -| `publicKeyHex` | `string` | - -#### Returns - -`void` - -#### Defined in - -packages/types/dist/IDIDDocument.d.ts:14 - -___ - -### addContextService - -▸ **addContextService**(`contextHash`, `endpointType`, `serviceType`, `endpointUris`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextHash` | `string` | -| `endpointType` | [`SecureContextEndpointType`](../enums/verida_storage_link._internal_.SecureContextEndpointType.md) | -| `serviceType` | `string` | -| `endpointUris` | [`ServiceEndpoint`](../modules/verida_storage_link._internal_.md#serviceendpoint)[] | - -#### Returns - -`void` - -#### Defined in - -packages/types/dist/IDIDDocument.d.ts:12 - -___ - -### addContextSignKey - -▸ **addContextSignKey**(`contextHash`, `publicKeyHex`, `proof`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextHash` | `string` | -| `publicKeyHex` | `string` | -| `proof` | `string` | - -#### Returns - -`void` - -#### Defined in - -packages/types/dist/IDIDDocument.d.ts:13 - -___ - -### buildTimestamp - -▸ **buildTimestamp**(`date`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `date` | `Date` | - -#### Returns - -`string` - -#### Defined in - -packages/types/dist/IDIDDocument.d.ts:21 - -___ - -### export - -▸ **export**(): [`VeridaDocInterface`](verida_storage_link._internal_.VeridaDocInterface.md) - -#### Returns - -[`VeridaDocInterface`](verida_storage_link._internal_.VeridaDocInterface.md) - -#### Defined in - -packages/types/dist/IDIDDocument.d.ts:11 - -___ - -### getErrors - -▸ **getErrors**(): `string`[] - -#### Returns - -`string`[] - -#### Defined in - -packages/types/dist/IDIDDocument.d.ts:6 - -___ - -### import - -▸ **import**(`doc`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `doc` | [`VeridaDocInterface`](verida_storage_link._internal_.VeridaDocInterface.md) | - -#### Returns - -`void` - -#### Defined in - -packages/types/dist/IDIDDocument.d.ts:10 - -___ - -### locateContextProof - -▸ **locateContextProof**(`contextName`): `undefined` \| `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | - -#### Returns - -`undefined` \| `string` - -#### Defined in - -packages/types/dist/IDIDDocument.d.ts:18 - -___ - -### locateServiceEndpoint - -▸ **locateServiceEndpoint**(`contextName`, `endpointType`): `undefined` \| [`Service`](verida_storage_link._internal_.Service.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | -| `endpointType` | [`SecureContextEndpointType`](../enums/verida_storage_link._internal_.SecureContextEndpointType.md) | - -#### Returns - -`undefined` \| [`Service`](verida_storage_link._internal_.Service.md) - -#### Defined in - -packages/types/dist/IDIDDocument.d.ts:17 - -___ - -### removeContext - -▸ **removeContext**(`contextName`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | - -#### Returns - -`boolean` - -#### Defined in - -packages/types/dist/IDIDDocument.d.ts:8 - -___ - -### setAttributes - -▸ **setAttributes**(`attributes`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `attributes` | [`Record`](../modules/verida_storage_link._internal_.md#record)<`string`, `any`\> | - -#### Returns - -`void` - -#### Defined in - -packages/types/dist/IDIDDocument.d.ts:9 - -___ - -### signProof - -▸ **signProof**(`privateKey`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `privateKey` | `string` \| `Uint8Array` | - -#### Returns - -`void` - -#### Defined in - -packages/types/dist/IDIDDocument.d.ts:19 - -___ - -### verifyContextSignature - -▸ **verifyContextSignature**(`data`, `contextName`, `signature`, `contextIsHash`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `any` | -| `contextName` | `string` | -| `signature` | `string` | -| `contextIsHash` | `boolean` | - -#### Returns - -`boolean` - -#### Defined in - -packages/types/dist/IDIDDocument.d.ts:16 - -___ - -### verifyProof - -▸ **verifyProof**(): `boolean` - -#### Returns - -`boolean` - -#### Defined in - -packages/types/dist/IDIDDocument.d.ts:20 - -___ - -### verifySig - -▸ **verifySig**(`data`, `signature`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `any` | -| `signature` | `string` | - -#### Returns - -`boolean` - -#### Defined in - -packages/types/dist/IDIDDocument.d.ts:15 diff --git a/docs/api/verida-js/interfaces/verida_storage_link._internal_.IKeyring.md b/docs/api/verida-js/interfaces/verida_storage_link._internal_.IKeyring.md deleted file mode 100644 index 1c62eda..0000000 --- a/docs/api/verida-js/interfaces/verida_storage_link._internal_.IKeyring.md +++ /dev/null @@ -1,262 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/storage-link](../modules/verida_storage_link.md) / [](../modules/verida_storage_link._internal_.md) / IKeyring - -# Interface: IKeyring - -[@verida/storage-link](../modules/verida_storage_link.md).[](../modules/verida_storage_link._internal_.md).IKeyring - -## Table of contents - -### Methods - -- [\_init](verida_storage_link._internal_.IKeyring.md#_init) -- [asymDecrypt](verida_storage_link._internal_.IKeyring.md#asymdecrypt) -- [asymEncrypt](verida_storage_link._internal_.IKeyring.md#asymencrypt) -- [buildSharedKeyEnd](verida_storage_link._internal_.IKeyring.md#buildsharedkeyend) -- [buildSharedKeyStart](verida_storage_link._internal_.IKeyring.md#buildsharedkeystart) -- [getKeys](verida_storage_link._internal_.IKeyring.md#getkeys) -- [getSeed](verida_storage_link._internal_.IKeyring.md#getseed) -- [getStorageContextKey](verida_storage_link._internal_.IKeyring.md#getstoragecontextkey) -- [publicKeys](verida_storage_link._internal_.IKeyring.md#publickeys) -- [sign](verida_storage_link._internal_.IKeyring.md#sign) -- [symDecrypt](verida_storage_link._internal_.IKeyring.md#symdecrypt) -- [symEncrypt](verida_storage_link._internal_.IKeyring.md#symencrypt) -- [verifySig](verida_storage_link._internal_.IKeyring.md#verifysig) - -## Methods - -### \_init - -▸ **_init**(): `Promise`<`void`\> - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:3 - -___ - -### asymDecrypt - -▸ **asymDecrypt**(`messageWithNonce`, `secretOrSharedKey`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `messageWithNonce` | `string` | -| `secretOrSharedKey` | `Uint8Array` | - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:10 - -___ - -### asymEncrypt - -▸ **asymEncrypt**(`data`, `secretOrSharedKey`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `string` | -| `secretOrSharedKey` | `Uint8Array` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:9 - -___ - -### buildSharedKeyEnd - -▸ **buildSharedKeyEnd**(`publicKey`): `Promise`<`Uint8Array`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `publicKey` | `Uint8Array` | - -#### Returns - -`Promise`<`Uint8Array`\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:12 - -___ - -### buildSharedKeyStart - -▸ **buildSharedKeyStart**(`privateKey`): `Promise`<`Uint8Array`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `privateKey` | `Uint8Array` | - -#### Returns - -`Promise`<`Uint8Array`\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:11 - -___ - -### getKeys - -▸ **getKeys**(): `Promise`<`any`\> - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:2 - -___ - -### getSeed - -▸ **getSeed**(): `string` - -#### Returns - -`string` - -#### Defined in - -packages/types/dist/IKeyring.d.ts:13 - -___ - -### getStorageContextKey - -▸ **getStorageContextKey**(`databaseName`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `databaseName` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:14 - -___ - -### publicKeys - -▸ **publicKeys**(): `Promise`<[`KeyringPublicKeys`](verida_storage_link._internal_.KeyringPublicKeys.md)\> - -#### Returns - -`Promise`<[`KeyringPublicKeys`](verida_storage_link._internal_.KeyringPublicKeys.md)\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:4 - -___ - -### sign - -▸ **sign**(`data`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `any` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:5 - -___ - -### symDecrypt - -▸ **symDecrypt**(`data`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `string` | - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:8 - -___ - -### symEncrypt - -▸ **symEncrypt**(`data`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:7 - -___ - -### verifySig - -▸ **verifySig**(`data`, `sig`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `string` | -| `sig` | `string` | - -#### Returns - -`Promise`<`boolean`\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:6 diff --git a/docs/api/verida-js/interfaces/verida_storage_link._internal_.JsonWebKey.md b/docs/api/verida-js/interfaces/verida_storage_link._internal_.JsonWebKey.md deleted file mode 100644 index 534f27c..0000000 --- a/docs/api/verida-js/interfaces/verida_storage_link._internal_.JsonWebKey.md +++ /dev/null @@ -1,145 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/storage-link](../modules/verida_storage_link.md) / [](../modules/verida_storage_link._internal_.md) / JsonWebKey - -# Interface: JsonWebKey - -[@verida/storage-link](../modules/verida_storage_link.md).[](../modules/verida_storage_link._internal_.md).JsonWebKey - -Encapsulates a JSON web key type that includes only the public properties that -can be used in DID documents. - -The private properties are intentionally omitted to discourage the use -(and accidental disclosure) of private keys in DID documents. - -**`see`** [RFC7517 JsonWebKey (JWK)](https://www.rfc-editor.org/rfc/rfc7517) - -## Hierarchy - -- [`Extensible`](../modules/verida_storage_link._internal_.md#extensible) - - ↳ **`JsonWebKey`** - -## Table of contents - -### Properties - -- [alg](verida_storage_link._internal_.JsonWebKey.md#alg) -- [crv](verida_storage_link._internal_.JsonWebKey.md#crv) -- [e](verida_storage_link._internal_.JsonWebKey.md#e) -- [ext](verida_storage_link._internal_.JsonWebKey.md#ext) -- [key\_ops](verida_storage_link._internal_.JsonWebKey.md#key_ops) -- [kid](verida_storage_link._internal_.JsonWebKey.md#kid) -- [kty](verida_storage_link._internal_.JsonWebKey.md#kty) -- [n](verida_storage_link._internal_.JsonWebKey.md#n) -- [use](verida_storage_link._internal_.JsonWebKey.md#use) -- [x](verida_storage_link._internal_.JsonWebKey.md#x) -- [y](verida_storage_link._internal_.JsonWebKey.md#y) - -## Properties - -### alg - -• `Optional` **alg**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:103 - -___ - -### crv - -• `Optional` **crv**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:104 - -___ - -### e - -• `Optional` **e**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:105 - -___ - -### ext - -• `Optional` **ext**: `boolean` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:106 - -___ - -### key\_ops - -• `Optional` **key\_ops**: `string`[] - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:107 - -___ - -### kid - -• `Optional` **kid**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:108 - -___ - -### kty - -• **kty**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:109 - -___ - -### n - -• `Optional` **n**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:110 - -___ - -### use - -• `Optional` **use**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:111 - -___ - -### x - -• `Optional` **x**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:112 - -___ - -### y - -• `Optional` **y**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:113 diff --git a/docs/api/verida-js/interfaces/verida_storage_link._internal_.KeyringPublicKeys.md b/docs/api/verida-js/interfaces/verida_storage_link._internal_.KeyringPublicKeys.md deleted file mode 100644 index 79f04d0..0000000 --- a/docs/api/verida-js/interfaces/verida_storage_link._internal_.KeyringPublicKeys.md +++ /dev/null @@ -1,76 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/storage-link](../modules/verida_storage_link.md) / [](../modules/verida_storage_link._internal_.md) / KeyringPublicKeys - -# Interface: KeyringPublicKeys - -[@verida/storage-link](../modules/verida_storage_link.md).[](../modules/verida_storage_link._internal_.md).KeyringPublicKeys - -## Table of contents - -### Properties - -- [asymPublicKey](verida_storage_link._internal_.KeyringPublicKeys.md#asympublickey) -- [asymPublicKeyBase58](verida_storage_link._internal_.KeyringPublicKeys.md#asympublickeybase58) -- [asymPublicKeyHex](verida_storage_link._internal_.KeyringPublicKeys.md#asympublickeyhex) -- [signPublicKey](verida_storage_link._internal_.KeyringPublicKeys.md#signpublickey) -- [signPublicKeyBase58](verida_storage_link._internal_.KeyringPublicKeys.md#signpublickeybase58) -- [signPublicKeyHex](verida_storage_link._internal_.KeyringPublicKeys.md#signpublickeyhex) - -## Properties - -### asymPublicKey - -• **asymPublicKey**: `Uint8Array` - -#### Defined in - -packages/types/dist/IKeyring.d.ts:17 - -___ - -### asymPublicKeyBase58 - -• **asymPublicKeyBase58**: `string` - -#### Defined in - -packages/types/dist/IKeyring.d.ts:19 - -___ - -### asymPublicKeyHex - -• **asymPublicKeyHex**: `string` - -#### Defined in - -packages/types/dist/IKeyring.d.ts:18 - -___ - -### signPublicKey - -• **signPublicKey**: `Uint8Array` - -#### Defined in - -packages/types/dist/IKeyring.d.ts:20 - -___ - -### signPublicKeyBase58 - -• **signPublicKeyBase58**: `string` - -#### Defined in - -packages/types/dist/IKeyring.d.ts:22 - -___ - -### signPublicKeyHex - -• **signPublicKeyHex**: `string` - -#### Defined in - -packages/types/dist/IKeyring.d.ts:21 diff --git a/docs/api/verida-js/interfaces/verida_storage_link._internal_.Log.md b/docs/api/verida-js/interfaces/verida_storage_link._internal_.Log.md deleted file mode 100644 index 759d5cc..0000000 --- a/docs/api/verida-js/interfaces/verida_storage_link._internal_.Log.md +++ /dev/null @@ -1,109 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/storage-link](../modules/verida_storage_link.md) / [](../modules/verida_storage_link._internal_.md) / Log - -# Interface: Log - -[@verida/storage-link](../modules/verida_storage_link.md).[](../modules/verida_storage_link._internal_.md).Log - -## Table of contents - -### Properties - -- [address](verida_storage_link._internal_.Log.md#address) -- [blockHash](verida_storage_link._internal_.Log.md#blockhash) -- [blockNumber](verida_storage_link._internal_.Log.md#blocknumber) -- [data](verida_storage_link._internal_.Log.md#data) -- [logIndex](verida_storage_link._internal_.Log.md#logindex) -- [removed](verida_storage_link._internal_.Log.md#removed) -- [topics](verida_storage_link._internal_.Log.md#topics) -- [transactionHash](verida_storage_link._internal_.Log.md#transactionhash) -- [transactionIndex](verida_storage_link._internal_.Log.md#transactionindex) - -## Properties - -### address - -• **address**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:59 - -___ - -### blockHash - -• **blockHash**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:56 - -___ - -### blockNumber - -• **blockNumber**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:55 - -___ - -### data - -• **data**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:60 - -___ - -### logIndex - -• **logIndex**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:63 - -___ - -### removed - -• **removed**: `boolean` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:58 - -___ - -### topics - -• **topics**: `string`[] - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:61 - -___ - -### transactionHash - -• **transactionHash**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:62 - -___ - -### transactionIndex - -• **transactionIndex**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:57 diff --git a/docs/api/verida-js/interfaces/verida_storage_link._internal_.OnceBlockable.md b/docs/api/verida-js/interfaces/verida_storage_link._internal_.OnceBlockable.md deleted file mode 100644 index 7d5d669..0000000 --- a/docs/api/verida-js/interfaces/verida_storage_link._internal_.OnceBlockable.md +++ /dev/null @@ -1,36 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/storage-link](../modules/verida_storage_link.md) / [](../modules/verida_storage_link._internal_.md) / OnceBlockable - -# Interface: OnceBlockable - -[@verida/storage-link](../modules/verida_storage_link.md).[](../modules/verida_storage_link._internal_.md).OnceBlockable - -## Implemented by - -- [`Provider`](../classes/verida_storage_link._internal_.Provider.md) - -## Table of contents - -### Methods - -- [once](verida_storage_link._internal_.OnceBlockable.md#once) - -## Methods - -### once - -▸ **once**(`eventName`, `handler`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | ``"block"`` | -| `handler` | () => `void` | - -#### Returns - -`void` - -#### Defined in - -node_modules/@ethersproject/web/lib/index.d.ts:19 diff --git a/docs/api/verida-js/interfaces/verida_storage_link._internal_.Proof.md b/docs/api/verida-js/interfaces/verida_storage_link._internal_.Proof.md deleted file mode 100644 index 3cb7d5d..0000000 --- a/docs/api/verida-js/interfaces/verida_storage_link._internal_.Proof.md +++ /dev/null @@ -1,54 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/storage-link](../modules/verida_storage_link.md) / [](../modules/verida_storage_link._internal_.md) / Proof - -# Interface: Proof - -[@verida/storage-link](../modules/verida_storage_link.md).[](../modules/verida_storage_link._internal_.md).Proof - -## Table of contents - -### Properties - -- [proofPurpose](verida_storage_link._internal_.Proof.md#proofpurpose) -- [proofValue](verida_storage_link._internal_.Proof.md#proofvalue) -- [type](verida_storage_link._internal_.Proof.md#type) -- [verificationMethod](verida_storage_link._internal_.Proof.md#verificationmethod) - -## Properties - -### proofPurpose - -• **proofPurpose**: ``"assertionMethod"`` - -#### Defined in - -packages/did-document/dist/interfaces.d.ts:10 - -___ - -### proofValue - -• **proofValue**: `string` - -#### Defined in - -packages/did-document/dist/interfaces.d.ts:11 - -___ - -### type - -• **type**: ``"EcdsaSecp256k1VerificationKey2019"`` - -#### Defined in - -packages/did-document/dist/interfaces.d.ts:8 - -___ - -### verificationMethod - -• **verificationMethod**: `string` - -#### Defined in - -packages/did-document/dist/interfaces.d.ts:9 diff --git a/docs/api/verida-js/interfaces/verida_storage_link._internal_.ProofInterface.md b/docs/api/verida-js/interfaces/verida_storage_link._internal_.ProofInterface.md deleted file mode 100644 index 4db47b0..0000000 --- a/docs/api/verida-js/interfaces/verida_storage_link._internal_.ProofInterface.md +++ /dev/null @@ -1,54 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/storage-link](../modules/verida_storage_link.md) / [](../modules/verida_storage_link._internal_.md) / ProofInterface - -# Interface: ProofInterface - -[@verida/storage-link](../modules/verida_storage_link.md).[](../modules/verida_storage_link._internal_.md).ProofInterface - -## Table of contents - -### Properties - -- [proofPurpose](verida_storage_link._internal_.ProofInterface.md#proofpurpose) -- [proofValue](verida_storage_link._internal_.ProofInterface.md#proofvalue) -- [type](verida_storage_link._internal_.ProofInterface.md#type) -- [verificationMethod](verida_storage_link._internal_.ProofInterface.md#verificationmethod) - -## Properties - -### proofPurpose - -• **proofPurpose**: `string` - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:34 - -___ - -### proofValue - -• **proofValue**: `string` - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:35 - -___ - -### type - -• **type**: `string` - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:32 - -___ - -### verificationMethod - -• **verificationMethod**: `string` - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:33 diff --git a/docs/api/verida-js/interfaces/verida_storage_link._internal_.SecureContextConfig.md b/docs/api/verida-js/interfaces/verida_storage_link._internal_.SecureContextConfig.md deleted file mode 100644 index 715a1a7..0000000 --- a/docs/api/verida-js/interfaces/verida_storage_link._internal_.SecureContextConfig.md +++ /dev/null @@ -1,43 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/storage-link](../modules/verida_storage_link.md) / [](../modules/verida_storage_link._internal_.md) / SecureContextConfig - -# Interface: SecureContextConfig - -[@verida/storage-link](../modules/verida_storage_link.md).[](../modules/verida_storage_link._internal_.md).SecureContextConfig - -## Table of contents - -### Properties - -- [id](verida_storage_link._internal_.SecureContextConfig.md#id) -- [publicKeys](verida_storage_link._internal_.SecureContextConfig.md#publickeys) -- [services](verida_storage_link._internal_.SecureContextConfig.md#services) - -## Properties - -### id - -• **id**: `string` - -#### Defined in - -packages/types/dist/StorageLinkInterfaces.d.ts:17 - -___ - -### publicKeys - -• **publicKeys**: [`SecureStorageContextPublicKeys`](verida_storage_link._internal_.SecureStorageContextPublicKeys.md) - -#### Defined in - -packages/types/dist/StorageLinkInterfaces.d.ts:18 - -___ - -### services - -• **services**: [`SecureContextServices`](verida_storage_link._internal_.SecureContextServices.md) - -#### Defined in - -packages/types/dist/StorageLinkInterfaces.d.ts:19 diff --git a/docs/api/verida-js/interfaces/verida_storage_link._internal_.SecureContextEndpoint.md b/docs/api/verida-js/interfaces/verida_storage_link._internal_.SecureContextEndpoint.md deleted file mode 100644 index c797afa..0000000 --- a/docs/api/verida-js/interfaces/verida_storage_link._internal_.SecureContextEndpoint.md +++ /dev/null @@ -1,43 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/storage-link](../modules/verida_storage_link.md) / [](../modules/verida_storage_link._internal_.md) / SecureContextEndpoint - -# Interface: SecureContextEndpoint - -[@verida/storage-link](../modules/verida_storage_link.md).[](../modules/verida_storage_link._internal_.md).SecureContextEndpoint - -## Table of contents - -### Properties - -- [config](verida_storage_link._internal_.SecureContextEndpoint.md#config) -- [endpointUri](verida_storage_link._internal_.SecureContextEndpoint.md#endpointuri) -- [type](verida_storage_link._internal_.SecureContextEndpoint.md#type) - -## Properties - -### config - -• `Optional` **config**: `object` - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:5 - -___ - -### endpointUri - -• **endpointUri**: [`ServiceEndpoint`](../modules/verida_storage_link._internal_.md#serviceendpoint)[] - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:4 - -___ - -### type - -• **type**: `string` - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:3 diff --git a/docs/api/verida-js/interfaces/verida_storage_link._internal_.SecureContextEndpoints.md b/docs/api/verida-js/interfaces/verida_storage_link._internal_.SecureContextEndpoints.md deleted file mode 100644 index 6ff24e7..0000000 --- a/docs/api/verida-js/interfaces/verida_storage_link._internal_.SecureContextEndpoints.md +++ /dev/null @@ -1,54 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/storage-link](../modules/verida_storage_link.md) / [](../modules/verida_storage_link._internal_.md) / SecureContextEndpoints - -# Interface: SecureContextEndpoints - -[@verida/storage-link](../modules/verida_storage_link.md).[](../modules/verida_storage_link._internal_.md).SecureContextEndpoints - -## Table of contents - -### Properties - -- [database](verida_storage_link._internal_.SecureContextEndpoints.md#database) -- [messaging](verida_storage_link._internal_.SecureContextEndpoints.md#messaging) -- [notification](verida_storage_link._internal_.SecureContextEndpoints.md#notification) -- [storage](verida_storage_link._internal_.SecureContextEndpoints.md#storage) - -## Properties - -### database - -• **database**: [`SecureContextEndpoint`](verida_storage_link._internal_.SecureContextEndpoint.md) - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:8 - -___ - -### messaging - -• **messaging**: [`SecureContextEndpoint`](verida_storage_link._internal_.SecureContextEndpoint.md) - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:9 - -___ - -### notification - -• `Optional` **notification**: [`SecureContextEndpoint`](verida_storage_link._internal_.SecureContextEndpoint.md) - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:11 - -___ - -### storage - -• `Optional` **storage**: [`SecureContextEndpoint`](verida_storage_link._internal_.SecureContextEndpoint.md) - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:10 diff --git a/docs/api/verida-js/interfaces/verida_storage_link._internal_.SecureContextPublicKey.md b/docs/api/verida-js/interfaces/verida_storage_link._internal_.SecureContextPublicKey.md deleted file mode 100644 index d00209f..0000000 --- a/docs/api/verida-js/interfaces/verida_storage_link._internal_.SecureContextPublicKey.md +++ /dev/null @@ -1,32 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/storage-link](../modules/verida_storage_link.md) / [](../modules/verida_storage_link._internal_.md) / SecureContextPublicKey - -# Interface: SecureContextPublicKey - -[@verida/storage-link](../modules/verida_storage_link.md).[](../modules/verida_storage_link._internal_.md).SecureContextPublicKey - -## Table of contents - -### Properties - -- [publicKeyHex](verida_storage_link._internal_.SecureContextPublicKey.md#publickeyhex) -- [type](verida_storage_link._internal_.SecureContextPublicKey.md#type) - -## Properties - -### publicKeyHex - -• **publicKeyHex**: `string` - -#### Defined in - -packages/types/dist/StorageLinkInterfaces.d.ts:4 - -___ - -### type - -• **type**: `string` - -#### Defined in - -packages/types/dist/StorageLinkInterfaces.d.ts:3 diff --git a/docs/api/verida-js/interfaces/verida_storage_link._internal_.SecureContextServices.md b/docs/api/verida-js/interfaces/verida_storage_link._internal_.SecureContextServices.md deleted file mode 100644 index bc7ed3f..0000000 --- a/docs/api/verida-js/interfaces/verida_storage_link._internal_.SecureContextServices.md +++ /dev/null @@ -1,54 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/storage-link](../modules/verida_storage_link.md) / [](../modules/verida_storage_link._internal_.md) / SecureContextServices - -# Interface: SecureContextServices - -[@verida/storage-link](../modules/verida_storage_link.md).[](../modules/verida_storage_link._internal_.md).SecureContextServices - -## Table of contents - -### Properties - -- [databaseServer](verida_storage_link._internal_.SecureContextServices.md#databaseserver) -- [messageServer](verida_storage_link._internal_.SecureContextServices.md#messageserver) -- [notificationServer](verida_storage_link._internal_.SecureContextServices.md#notificationserver) -- [storageServer](verida_storage_link._internal_.SecureContextServices.md#storageserver) - -## Properties - -### databaseServer - -• **databaseServer**: [`SecureContextEndpoint`](verida_storage_link._internal_.SecureContextEndpoint.md) - -#### Defined in - -packages/types/dist/StorageLinkInterfaces.d.ts:11 - -___ - -### messageServer - -• **messageServer**: [`SecureContextEndpoint`](verida_storage_link._internal_.SecureContextEndpoint.md) - -#### Defined in - -packages/types/dist/StorageLinkInterfaces.d.ts:12 - -___ - -### notificationServer - -• `Optional` **notificationServer**: [`SecureContextEndpoint`](verida_storage_link._internal_.SecureContextEndpoint.md) - -#### Defined in - -packages/types/dist/StorageLinkInterfaces.d.ts:14 - -___ - -### storageServer - -• `Optional` **storageServer**: [`SecureContextEndpoint`](verida_storage_link._internal_.SecureContextEndpoint.md) - -#### Defined in - -packages/types/dist/StorageLinkInterfaces.d.ts:13 diff --git a/docs/api/verida-js/interfaces/verida_storage_link._internal_.SecureStorageContextPublicKeys.md b/docs/api/verida-js/interfaces/verida_storage_link._internal_.SecureStorageContextPublicKeys.md deleted file mode 100644 index e0b22bd..0000000 --- a/docs/api/verida-js/interfaces/verida_storage_link._internal_.SecureStorageContextPublicKeys.md +++ /dev/null @@ -1,32 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/storage-link](../modules/verida_storage_link.md) / [](../modules/verida_storage_link._internal_.md) / SecureStorageContextPublicKeys - -# Interface: SecureStorageContextPublicKeys - -[@verida/storage-link](../modules/verida_storage_link.md).[](../modules/verida_storage_link._internal_.md).SecureStorageContextPublicKeys - -## Table of contents - -### Properties - -- [asymKey](verida_storage_link._internal_.SecureStorageContextPublicKeys.md#asymkey) -- [signKey](verida_storage_link._internal_.SecureStorageContextPublicKeys.md#signkey) - -## Properties - -### asymKey - -• **asymKey**: [`SecureContextPublicKey`](verida_storage_link._internal_.SecureContextPublicKey.md) - -#### Defined in - -packages/types/dist/StorageLinkInterfaces.d.ts:7 - -___ - -### signKey - -• **signKey**: [`SecureContextPublicKey`](verida_storage_link._internal_.SecureContextPublicKey.md) - -#### Defined in - -packages/types/dist/StorageLinkInterfaces.d.ts:8 diff --git a/docs/api/verida-js/interfaces/verida_storage_link._internal_.Service.md b/docs/api/verida-js/interfaces/verida_storage_link._internal_.Service.md deleted file mode 100644 index 4bb7879..0000000 --- a/docs/api/verida-js/interfaces/verida_storage_link._internal_.Service.md +++ /dev/null @@ -1,53 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/storage-link](../modules/verida_storage_link.md) / [](../modules/verida_storage_link._internal_.md) / Service - -# Interface: Service - -[@verida/storage-link](../modules/verida_storage_link.md).[](../modules/verida_storage_link._internal_.md).Service - -Represents a Service entry in a [DID document](https://www.w3.org/TR/did-core/#did-document-properties). - -**`see`** [https://www.w3.org/TR/did-core/#services](https://www.w3.org/TR/did-core/#services) - -**`see`** [https://www.w3.org/TR/did-core/#service-properties](https://www.w3.org/TR/did-core/#service-properties) - -## Indexable - -▪ [x: `string`]: `any` - -## Table of contents - -### Properties - -- [id](verida_storage_link._internal_.Service.md#id) -- [serviceEndpoint](verida_storage_link._internal_.Service.md#serviceendpoint) -- [type](verida_storage_link._internal_.Service.md#type) - -## Properties - -### id - -• **id**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:81 - -___ - -### serviceEndpoint - -• **serviceEndpoint**: [`ServiceEndpoint`](../modules/verida_storage_link._internal_.md#serviceendpoint) \| [`ServiceEndpoint`](../modules/verida_storage_link._internal_.md#serviceendpoint)[] - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:83 - -___ - -### type - -• **type**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:82 diff --git a/docs/api/verida-js/interfaces/verida_storage_link._internal_.ServiceEndpoint.md b/docs/api/verida-js/interfaces/verida_storage_link._internal_.ServiceEndpoint.md deleted file mode 100644 index e86552d..0000000 --- a/docs/api/verida-js/interfaces/verida_storage_link._internal_.ServiceEndpoint.md +++ /dev/null @@ -1,54 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/storage-link](../modules/verida_storage_link.md) / [](../modules/verida_storage_link._internal_.md) / ServiceEndpoint - -# Interface: ServiceEndpoint - -[@verida/storage-link](../modules/verida_storage_link.md).[](../modules/verida_storage_link._internal_.md).ServiceEndpoint - -## Table of contents - -### Properties - -- [description](verida_storage_link._internal_.ServiceEndpoint.md#description) -- [id](verida_storage_link._internal_.ServiceEndpoint.md#id) -- [serviceEndpoint](verida_storage_link._internal_.ServiceEndpoint.md#serviceendpoint) -- [type](verida_storage_link._internal_.ServiceEndpoint.md#type) - -## Properties - -### description - -• `Optional` **description**: `string` - -#### Defined in - -packages/did-document/node_modules/did-resolver/lib/resolver.d.ts:43 - -___ - -### id - -• **id**: `string` - -#### Defined in - -packages/did-document/node_modules/did-resolver/lib/resolver.d.ts:40 - -___ - -### serviceEndpoint - -• **serviceEndpoint**: `string` - -#### Defined in - -packages/did-document/node_modules/did-resolver/lib/resolver.d.ts:42 - -___ - -### type - -• **type**: `string` - -#### Defined in - -packages/did-document/node_modules/did-resolver/lib/resolver.d.ts:41 diff --git a/docs/api/verida-js/interfaces/verida_storage_link._internal_.SignKeyPair.md b/docs/api/verida-js/interfaces/verida_storage_link._internal_.SignKeyPair.md deleted file mode 100644 index 4aa30b2..0000000 --- a/docs/api/verida-js/interfaces/verida_storage_link._internal_.SignKeyPair.md +++ /dev/null @@ -1,32 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/storage-link](../modules/verida_storage_link.md) / [](../modules/verida_storage_link._internal_.md) / SignKeyPair - -# Interface: SignKeyPair - -[@verida/storage-link](../modules/verida_storage_link.md).[](../modules/verida_storage_link._internal_.md).SignKeyPair - -## Table of contents - -### Properties - -- [publicKey](verida_storage_link._internal_.SignKeyPair.md#publickey) -- [secretKey](verida_storage_link._internal_.SignKeyPair.md#secretkey) - -## Properties - -### publicKey - -• **publicKey**: `Uint8Array` - -#### Defined in - -node_modules/tweetnacl/nacl.d.ts:15 - -___ - -### secretKey - -• **secretKey**: `Uint8Array` - -#### Defined in - -node_modules/tweetnacl/nacl.d.ts:16 diff --git a/docs/api/verida-js/interfaces/verida_storage_link._internal_.Transaction.md b/docs/api/verida-js/interfaces/verida_storage_link._internal_.Transaction.md deleted file mode 100644 index d996a76..0000000 --- a/docs/api/verida-js/interfaces/verida_storage_link._internal_.Transaction.md +++ /dev/null @@ -1,192 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/storage-link](../modules/verida_storage_link.md) / [](../modules/verida_storage_link._internal_.md) / Transaction - -# Interface: Transaction - -[@verida/storage-link](../modules/verida_storage_link.md).[](../modules/verida_storage_link._internal_.md).Transaction - -## Hierarchy - -- **`Transaction`** - - ↳ [`TransactionResponse`](verida_storage_link._internal_.TransactionResponse.md) - -## Table of contents - -### Properties - -- [accessList](verida_storage_link._internal_.Transaction.md#accesslist) -- [chainId](verida_storage_link._internal_.Transaction.md#chainid) -- [data](verida_storage_link._internal_.Transaction.md#data) -- [from](verida_storage_link._internal_.Transaction.md#from) -- [gasLimit](verida_storage_link._internal_.Transaction.md#gaslimit) -- [gasPrice](verida_storage_link._internal_.Transaction.md#gasprice) -- [hash](verida_storage_link._internal_.Transaction.md#hash) -- [maxFeePerGas](verida_storage_link._internal_.Transaction.md#maxfeepergas) -- [maxPriorityFeePerGas](verida_storage_link._internal_.Transaction.md#maxpriorityfeepergas) -- [nonce](verida_storage_link._internal_.Transaction.md#nonce) -- [r](verida_storage_link._internal_.Transaction.md#r) -- [s](verida_storage_link._internal_.Transaction.md#s) -- [to](verida_storage_link._internal_.Transaction.md#to) -- [type](verida_storage_link._internal_.Transaction.md#type) -- [v](verida_storage_link._internal_.Transaction.md#v) -- [value](verida_storage_link._internal_.Transaction.md#value) - -## Properties - -### accessList - -• `Optional` **accessList**: [`AccessList`](../modules/verida_storage_link._internal_.md#accesslist) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:40 - -___ - -### chainId - -• **chainId**: `number` - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:35 - -___ - -### data - -• **data**: `string` - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:33 - -___ - -### from - -• `Optional` **from**: `string` - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:29 - -___ - -### gasLimit - -• **gasLimit**: [`BigNumber`](../classes/verida_storage_link._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:31 - -___ - -### gasPrice - -• `Optional` **gasPrice**: [`BigNumber`](../classes/verida_storage_link._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:32 - -___ - -### hash - -• `Optional` **hash**: `string` - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:27 - -___ - -### maxFeePerGas - -• `Optional` **maxFeePerGas**: [`BigNumber`](../classes/verida_storage_link._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:42 - -___ - -### maxPriorityFeePerGas - -• `Optional` **maxPriorityFeePerGas**: [`BigNumber`](../classes/verida_storage_link._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:41 - -___ - -### nonce - -• **nonce**: `number` - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:30 - -___ - -### r - -• `Optional` **r**: `string` - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:36 - -___ - -### s - -• `Optional` **s**: `string` - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:37 - -___ - -### to - -• `Optional` **to**: `string` - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:28 - -___ - -### type - -• `Optional` **type**: ``null`` \| `number` - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:39 - -___ - -### v - -• `Optional` **v**: `number` - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:38 - -___ - -### value - -• **value**: [`BigNumber`](../classes/verida_storage_link._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:34 diff --git a/docs/api/verida-js/interfaces/verida_storage_link._internal_.TransactionReceipt.md b/docs/api/verida-js/interfaces/verida_storage_link._internal_.TransactionReceipt.md deleted file mode 100644 index fa08ad1..0000000 --- a/docs/api/verida-js/interfaces/verida_storage_link._internal_.TransactionReceipt.md +++ /dev/null @@ -1,197 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/storage-link](../modules/verida_storage_link.md) / [](../modules/verida_storage_link._internal_.md) / TransactionReceipt - -# Interface: TransactionReceipt - -[@verida/storage-link](../modules/verida_storage_link.md).[](../modules/verida_storage_link._internal_.md).TransactionReceipt - -## Table of contents - -### Properties - -- [blockHash](verida_storage_link._internal_.TransactionReceipt.md#blockhash) -- [blockNumber](verida_storage_link._internal_.TransactionReceipt.md#blocknumber) -- [byzantium](verida_storage_link._internal_.TransactionReceipt.md#byzantium) -- [confirmations](verida_storage_link._internal_.TransactionReceipt.md#confirmations) -- [contractAddress](verida_storage_link._internal_.TransactionReceipt.md#contractaddress) -- [cumulativeGasUsed](verida_storage_link._internal_.TransactionReceipt.md#cumulativegasused) -- [effectiveGasPrice](verida_storage_link._internal_.TransactionReceipt.md#effectivegasprice) -- [from](verida_storage_link._internal_.TransactionReceipt.md#from) -- [gasUsed](verida_storage_link._internal_.TransactionReceipt.md#gasused) -- [logs](verida_storage_link._internal_.TransactionReceipt.md#logs) -- [logsBloom](verida_storage_link._internal_.TransactionReceipt.md#logsbloom) -- [root](verida_storage_link._internal_.TransactionReceipt.md#root) -- [status](verida_storage_link._internal_.TransactionReceipt.md#status) -- [to](verida_storage_link._internal_.TransactionReceipt.md#to) -- [transactionHash](verida_storage_link._internal_.TransactionReceipt.md#transactionhash) -- [transactionIndex](verida_storage_link._internal_.TransactionReceipt.md#transactionindex) -- [type](verida_storage_link._internal_.TransactionReceipt.md#type) - -## Properties - -### blockHash - -• **blockHash**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:73 - -___ - -### blockNumber - -• **blockNumber**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:76 - -___ - -### byzantium - -• **byzantium**: `boolean` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:80 - -___ - -### confirmations - -• **confirmations**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:77 - -___ - -### contractAddress - -• **contractAddress**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:68 - -___ - -### cumulativeGasUsed - -• **cumulativeGasUsed**: [`BigNumber`](../classes/verida_storage_link._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:78 - -___ - -### effectiveGasPrice - -• **effectiveGasPrice**: [`BigNumber`](../classes/verida_storage_link._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:79 - -___ - -### from - -• **from**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:67 - -___ - -### gasUsed - -• **gasUsed**: [`BigNumber`](../classes/verida_storage_link._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:71 - -___ - -### logs - -• **logs**: [`Log`](verida_storage_link._internal_.Log.md)[] - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:75 - -___ - -### logsBloom - -• **logsBloom**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:72 - -___ - -### root - -• `Optional` **root**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:70 - -___ - -### status - -• `Optional` **status**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:82 - -___ - -### to - -• **to**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:66 - -___ - -### transactionHash - -• **transactionHash**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:74 - -___ - -### transactionIndex - -• **transactionIndex**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:69 - -___ - -### type - -• **type**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:81 diff --git a/docs/api/verida-js/interfaces/verida_storage_link._internal_.TransactionResponse.md b/docs/api/verida-js/interfaces/verida_storage_link._internal_.TransactionResponse.md deleted file mode 100644 index 91979f7..0000000 --- a/docs/api/verida-js/interfaces/verida_storage_link._internal_.TransactionResponse.md +++ /dev/null @@ -1,335 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/storage-link](../modules/verida_storage_link.md) / [](../modules/verida_storage_link._internal_.md) / TransactionResponse - -# Interface: TransactionResponse - -[@verida/storage-link](../modules/verida_storage_link.md).[](../modules/verida_storage_link._internal_.md).TransactionResponse - -## Hierarchy - -- [`Transaction`](verida_storage_link._internal_.Transaction.md) - - ↳ **`TransactionResponse`** - -## Table of contents - -### Properties - -- [accessList](verida_storage_link._internal_.TransactionResponse.md#accesslist) -- [blockHash](verida_storage_link._internal_.TransactionResponse.md#blockhash) -- [blockNumber](verida_storage_link._internal_.TransactionResponse.md#blocknumber) -- [chainId](verida_storage_link._internal_.TransactionResponse.md#chainid) -- [confirmations](verida_storage_link._internal_.TransactionResponse.md#confirmations) -- [data](verida_storage_link._internal_.TransactionResponse.md#data) -- [from](verida_storage_link._internal_.TransactionResponse.md#from) -- [gasLimit](verida_storage_link._internal_.TransactionResponse.md#gaslimit) -- [gasPrice](verida_storage_link._internal_.TransactionResponse.md#gasprice) -- [hash](verida_storage_link._internal_.TransactionResponse.md#hash) -- [maxFeePerGas](verida_storage_link._internal_.TransactionResponse.md#maxfeepergas) -- [maxPriorityFeePerGas](verida_storage_link._internal_.TransactionResponse.md#maxpriorityfeepergas) -- [nonce](verida_storage_link._internal_.TransactionResponse.md#nonce) -- [r](verida_storage_link._internal_.TransactionResponse.md#r) -- [raw](verida_storage_link._internal_.TransactionResponse.md#raw) -- [s](verida_storage_link._internal_.TransactionResponse.md#s) -- [timestamp](verida_storage_link._internal_.TransactionResponse.md#timestamp) -- [to](verida_storage_link._internal_.TransactionResponse.md#to) -- [type](verida_storage_link._internal_.TransactionResponse.md#type) -- [v](verida_storage_link._internal_.TransactionResponse.md#v) -- [value](verida_storage_link._internal_.TransactionResponse.md#value) - -### Methods - -- [wait](verida_storage_link._internal_.TransactionResponse.md#wait) - -## Properties - -### accessList - -• `Optional` **accessList**: [`AccessList`](../modules/verida_storage_link._internal_.md#accesslist) - -#### Inherited from - -[Transaction](verida_storage_link._internal_.Transaction.md).[accessList](verida_storage_link._internal_.Transaction.md#accesslist) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:40 - -___ - -### blockHash - -• `Optional` **blockHash**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:26 - -___ - -### blockNumber - -• `Optional` **blockNumber**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:25 - -___ - -### chainId - -• **chainId**: `number` - -#### Inherited from - -[Transaction](verida_storage_link._internal_.Transaction.md).[chainId](verida_storage_link._internal_.Transaction.md#chainid) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:35 - -___ - -### confirmations - -• **confirmations**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:28 - -___ - -### data - -• **data**: `string` - -#### Inherited from - -[Transaction](verida_storage_link._internal_.Transaction.md).[data](verida_storage_link._internal_.Transaction.md#data) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:33 - -___ - -### from - -• **from**: `string` - -#### Overrides - -[Transaction](verida_storage_link._internal_.Transaction.md).[from](verida_storage_link._internal_.Transaction.md#from) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:29 - -___ - -### gasLimit - -• **gasLimit**: [`BigNumber`](../classes/verida_storage_link._internal_.BigNumber.md) - -#### Inherited from - -[Transaction](verida_storage_link._internal_.Transaction.md).[gasLimit](verida_storage_link._internal_.Transaction.md#gaslimit) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:31 - -___ - -### gasPrice - -• `Optional` **gasPrice**: [`BigNumber`](../classes/verida_storage_link._internal_.BigNumber.md) - -#### Inherited from - -[Transaction](verida_storage_link._internal_.Transaction.md).[gasPrice](verida_storage_link._internal_.Transaction.md#gasprice) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:32 - -___ - -### hash - -• **hash**: `string` - -#### Overrides - -[Transaction](verida_storage_link._internal_.Transaction.md).[hash](verida_storage_link._internal_.Transaction.md#hash) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:24 - -___ - -### maxFeePerGas - -• `Optional` **maxFeePerGas**: [`BigNumber`](../classes/verida_storage_link._internal_.BigNumber.md) - -#### Inherited from - -[Transaction](verida_storage_link._internal_.Transaction.md).[maxFeePerGas](verida_storage_link._internal_.Transaction.md#maxfeepergas) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:42 - -___ - -### maxPriorityFeePerGas - -• `Optional` **maxPriorityFeePerGas**: [`BigNumber`](../classes/verida_storage_link._internal_.BigNumber.md) - -#### Inherited from - -[Transaction](verida_storage_link._internal_.Transaction.md).[maxPriorityFeePerGas](verida_storage_link._internal_.Transaction.md#maxpriorityfeepergas) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:41 - -___ - -### nonce - -• **nonce**: `number` - -#### Inherited from - -[Transaction](verida_storage_link._internal_.Transaction.md).[nonce](verida_storage_link._internal_.Transaction.md#nonce) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:30 - -___ - -### r - -• `Optional` **r**: `string` - -#### Inherited from - -[Transaction](verida_storage_link._internal_.Transaction.md).[r](verida_storage_link._internal_.Transaction.md#r) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:36 - -___ - -### raw - -• `Optional` **raw**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:30 - -___ - -### s - -• `Optional` **s**: `string` - -#### Inherited from - -[Transaction](verida_storage_link._internal_.Transaction.md).[s](verida_storage_link._internal_.Transaction.md#s) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:37 - -___ - -### timestamp - -• `Optional` **timestamp**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:27 - -___ - -### to - -• `Optional` **to**: `string` - -#### Inherited from - -[Transaction](verida_storage_link._internal_.Transaction.md).[to](verida_storage_link._internal_.Transaction.md#to) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:28 - -___ - -### type - -• `Optional` **type**: ``null`` \| `number` - -#### Inherited from - -[Transaction](verida_storage_link._internal_.Transaction.md).[type](verida_storage_link._internal_.Transaction.md#type) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:39 - -___ - -### v - -• `Optional` **v**: `number` - -#### Inherited from - -[Transaction](verida_storage_link._internal_.Transaction.md).[v](verida_storage_link._internal_.Transaction.md#v) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:38 - -___ - -### value - -• **value**: [`BigNumber`](../classes/verida_storage_link._internal_.BigNumber.md) - -#### Inherited from - -[Transaction](verida_storage_link._internal_.Transaction.md).[value](verida_storage_link._internal_.Transaction.md#value) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:34 - -## Methods - -### wait - -▸ **wait**(`confirmations?`): `Promise`<[`TransactionReceipt`](verida_storage_link._internal_.TransactionReceipt.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `confirmations?` | `number` | - -#### Returns - -`Promise`<[`TransactionReceipt`](verida_storage_link._internal_.TransactionReceipt.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:31 diff --git a/docs/api/verida-js/interfaces/verida_storage_link._internal_.VdaDidEndpointResponse.md b/docs/api/verida-js/interfaces/verida_storage_link._internal_.VdaDidEndpointResponse.md deleted file mode 100644 index bdb8cfc..0000000 --- a/docs/api/verida-js/interfaces/verida_storage_link._internal_.VdaDidEndpointResponse.md +++ /dev/null @@ -1,32 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/storage-link](../modules/verida_storage_link.md) / [](../modules/verida_storage_link._internal_.md) / VdaDidEndpointResponse - -# Interface: VdaDidEndpointResponse - -[@verida/storage-link](../modules/verida_storage_link.md).[](../modules/verida_storage_link._internal_.md).VdaDidEndpointResponse - -## Table of contents - -### Properties - -- [message](verida_storage_link._internal_.VdaDidEndpointResponse.md#message) -- [status](verida_storage_link._internal_.VdaDidEndpointResponse.md#status) - -## Properties - -### message - -• `Optional` **message**: `string` - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:111 - -___ - -### status - -• **status**: ``"success"`` \| ``"fail"`` - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:110 diff --git a/docs/api/verida-js/interfaces/verida_storage_link._internal_.VeridaDocInterface.md b/docs/api/verida-js/interfaces/verida_storage_link._internal_.VeridaDocInterface.md deleted file mode 100644 index feebc8f..0000000 --- a/docs/api/verida-js/interfaces/verida_storage_link._internal_.VeridaDocInterface.md +++ /dev/null @@ -1,233 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/storage-link](../modules/verida_storage_link.md) / [](../modules/verida_storage_link._internal_.md) / VeridaDocInterface - -# Interface: VeridaDocInterface - -[@verida/storage-link](../modules/verida_storage_link.md).[](../modules/verida_storage_link._internal_.md).VeridaDocInterface - -## Hierarchy - -- [`DIDDocument`](../modules/verida_storage_link._internal_.md#diddocument) - - ↳ **`VeridaDocInterface`** - -## Table of contents - -### Properties - -- [@context](verida_storage_link._internal_.VeridaDocInterface.md#@context) -- [alsoKnownAs](verida_storage_link._internal_.VeridaDocInterface.md#alsoknownas) -- [assertionMethod](verida_storage_link._internal_.VeridaDocInterface.md#assertionmethod) -- [authentication](verida_storage_link._internal_.VeridaDocInterface.md#authentication) -- [capabilityDelegation](verida_storage_link._internal_.VeridaDocInterface.md#capabilitydelegation) -- [capabilityInvocation](verida_storage_link._internal_.VeridaDocInterface.md#capabilityinvocation) -- [controller](verida_storage_link._internal_.VeridaDocInterface.md#controller) -- [created](verida_storage_link._internal_.VeridaDocInterface.md#created) -- [deactivated](verida_storage_link._internal_.VeridaDocInterface.md#deactivated) -- [id](verida_storage_link._internal_.VeridaDocInterface.md#id) -- [keyAgreement](verida_storage_link._internal_.VeridaDocInterface.md#keyagreement) -- [proof](verida_storage_link._internal_.VeridaDocInterface.md#proof) -- [publicKey](verida_storage_link._internal_.VeridaDocInterface.md#publickey) -- [service](verida_storage_link._internal_.VeridaDocInterface.md#service) -- [updated](verida_storage_link._internal_.VeridaDocInterface.md#updated) -- [verificationMethod](verida_storage_link._internal_.VeridaDocInterface.md#verificationmethod) -- [versionId](verida_storage_link._internal_.VeridaDocInterface.md#versionid) - -## Properties - -### @context - -• `Optional` **@context**: `string` \| `string`[] - -#### Inherited from - -DocInterface.@context - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:61 - -___ - -### alsoKnownAs - -• `Optional` **alsoKnownAs**: `string`[] - -#### Inherited from - -DocInterface.alsoKnownAs - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:63 - -___ - -### assertionMethod - -• **assertionMethod**: `undefined` \| (`string` \| [`VerificationMethod`](verida_storage_link._internal_.VerificationMethod.md))[] - -#### Inherited from - -DocInterface.assertionMethod - -___ - -### authentication - -• **authentication**: `undefined` \| (`string` \| [`VerificationMethod`](verida_storage_link._internal_.VerificationMethod.md))[] - -#### Inherited from - -DocInterface.authentication - -___ - -### capabilityDelegation - -• **capabilityDelegation**: `undefined` \| (`string` \| [`VerificationMethod`](verida_storage_link._internal_.VerificationMethod.md))[] - -#### Inherited from - -DocInterface.capabilityDelegation - -___ - -### capabilityInvocation - -• **capabilityInvocation**: `undefined` \| (`string` \| [`VerificationMethod`](verida_storage_link._internal_.VerificationMethod.md))[] - -#### Inherited from - -DocInterface.capabilityInvocation - -___ - -### controller - -• `Optional` **controller**: `string` \| `string`[] - -#### Inherited from - -DocInterface.controller - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:64 - -___ - -### created - -• `Optional` **created**: `string` - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:39 - -___ - -### deactivated - -• `Optional` **deactivated**: `string` - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:41 - -___ - -### id - -• **id**: `string` - -#### Inherited from - -DocInterface.id - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:62 - -___ - -### keyAgreement - -• **keyAgreement**: `undefined` \| (`string` \| [`VerificationMethod`](verida_storage_link._internal_.VerificationMethod.md))[] - -#### Inherited from - -DocInterface.keyAgreement - -___ - -### proof - -• `Optional` **proof**: [`ProofInterface`](verida_storage_link._internal_.ProofInterface.md) - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:42 - -___ - -### publicKey - -• `Optional` **publicKey**: [`VerificationMethod`](verida_storage_link._internal_.VerificationMethod.md)[] - -**`deprecated`** - -#### Inherited from - -DocInterface.publicKey - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:70 - -___ - -### service - -• `Optional` **service**: [`Service`](verida_storage_link._internal_.Service.md)[] - -#### Inherited from - -DocInterface.service - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:66 - -___ - -### updated - -• `Optional` **updated**: `string` - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:40 - -___ - -### verificationMethod - -• `Optional` **verificationMethod**: [`VerificationMethod`](verida_storage_link._internal_.VerificationMethod.md)[] - -#### Inherited from - -DocInterface.verificationMethod - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:65 - -___ - -### versionId - -• **versionId**: `number` - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:38 diff --git a/docs/api/verida-js/interfaces/verida_storage_link._internal_.VerificationMethod.md b/docs/api/verida-js/interfaces/verida_storage_link._internal_.VerificationMethod.md deleted file mode 100644 index 2535d27..0000000 --- a/docs/api/verida-js/interfaces/verida_storage_link._internal_.VerificationMethod.md +++ /dev/null @@ -1,129 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/storage-link](../modules/verida_storage_link.md) / [](../modules/verida_storage_link._internal_.md) / VerificationMethod - -# Interface: VerificationMethod - -[@verida/storage-link](../modules/verida_storage_link.md).[](../modules/verida_storage_link._internal_.md).VerificationMethod - -Represents the properties of a Verification Method listed in a DID document. - -This data type includes public key representations that are no longer present in the spec but are still used by -several DID methods / resolvers and kept for backward compatibility. - -**`see`** [https://www.w3.org/TR/did-core/#verification-methods](https://www.w3.org/TR/did-core/#verification-methods) - -**`see`** [https://www.w3.org/TR/did-core/#verification-method-properties](https://www.w3.org/TR/did-core/#verification-method-properties) - -## Table of contents - -### Properties - -- [blockchainAccountId](verida_storage_link._internal_.VerificationMethod.md#blockchainaccountid) -- [controller](verida_storage_link._internal_.VerificationMethod.md#controller) -- [ethereumAddress](verida_storage_link._internal_.VerificationMethod.md#ethereumaddress) -- [id](verida_storage_link._internal_.VerificationMethod.md#id) -- [publicKeyBase58](verida_storage_link._internal_.VerificationMethod.md#publickeybase58) -- [publicKeyBase64](verida_storage_link._internal_.VerificationMethod.md#publickeybase64) -- [publicKeyHex](verida_storage_link._internal_.VerificationMethod.md#publickeyhex) -- [publicKeyJwk](verida_storage_link._internal_.VerificationMethod.md#publickeyjwk) -- [publicKeyMultibase](verida_storage_link._internal_.VerificationMethod.md#publickeymultibase) -- [type](verida_storage_link._internal_.VerificationMethod.md#type) - -## Properties - -### blockchainAccountId - -• `Optional` **blockchainAccountId**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:133 - -___ - -### controller - -• **controller**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:127 - -___ - -### ethereumAddress - -• `Optional` **ethereumAddress**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:134 - -___ - -### id - -• **id**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:125 - -___ - -### publicKeyBase58 - -• `Optional` **publicKeyBase58**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:128 - -___ - -### publicKeyBase64 - -• `Optional` **publicKeyBase64**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:129 - -___ - -### publicKeyHex - -• `Optional` **publicKeyHex**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:131 - -___ - -### publicKeyJwk - -• `Optional` **publicKeyJwk**: [`JsonWebKey`](verida_storage_link._internal_.JsonWebKey.md) - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:130 - -___ - -### publicKeyMultibase - -• `Optional` **publicKeyMultibase**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:132 - -___ - -### type - -• **type**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:126 diff --git a/docs/api/verida-js/interfaces/verida_storage_link._internal_.Web3GaslessPostConfig.md b/docs/api/verida-js/interfaces/verida_storage_link._internal_.Web3GaslessPostConfig.md deleted file mode 100644 index 00157b0..0000000 --- a/docs/api/verida-js/interfaces/verida_storage_link._internal_.Web3GaslessPostConfig.md +++ /dev/null @@ -1,37 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/storage-link](../modules/verida_storage_link.md) / [](../modules/verida_storage_link._internal_.md) / Web3GaslessPostConfig - -# Interface: Web3GaslessPostConfig - -[@verida/storage-link](../modules/verida_storage_link.md).[](../modules/verida_storage_link._internal_.md).Web3GaslessPostConfig - -Configuration type for gasless post - -## Indexable - -▪ [key: `string`]: `any` - -## Table of contents - -### Properties - -- [headers](verida_storage_link._internal_.Web3GaslessPostConfig.md#headers) - -## Properties - -### headers - -• **headers**: `Object` - -#### Index signature - -▪ [key: `string`]: `any` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `user-agent` | `string` | - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:64 diff --git a/docs/api/verida-js/interfaces/verida_storage_link._internal_.Web3GaslessRequestConfig.md b/docs/api/verida-js/interfaces/verida_storage_link._internal_.Web3GaslessRequestConfig.md deleted file mode 100644 index f0e6bf5..0000000 --- a/docs/api/verida-js/interfaces/verida_storage_link._internal_.Web3GaslessRequestConfig.md +++ /dev/null @@ -1,37 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/storage-link](../modules/verida_storage_link.md) / [](../modules/verida_storage_link._internal_.md) / Web3GaslessRequestConfig - -# Interface: Web3GaslessRequestConfig - -[@verida/storage-link](../modules/verida_storage_link.md).[](../modules/verida_storage_link._internal_.md).Web3GaslessRequestConfig - -Configuration type for gasless request - -## Indexable - -▪ [key: `string`]: `any` - -## Table of contents - -### Properties - -- [headers](verida_storage_link._internal_.Web3GaslessRequestConfig.md#headers) - -## Properties - -### headers - -• **headers**: `Object` - -#### Index signature - -▪ [key: `string`]: `any` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `context-name` | `string` | - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:56 diff --git a/docs/api/verida-js/interfaces/verida_storage_link._internal_.Web3MetaTransactionConfig.md b/docs/api/verida-js/interfaces/verida_storage_link._internal_.Web3MetaTransactionConfig.md deleted file mode 100644 index 68d90bf..0000000 --- a/docs/api/verida-js/interfaces/verida_storage_link._internal_.Web3MetaTransactionConfig.md +++ /dev/null @@ -1,45 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/storage-link](../modules/verida_storage_link.md) / [](../modules/verida_storage_link._internal_.md) / Web3MetaTransactionConfig - -# Interface: Web3MetaTransactionConfig - -[@verida/storage-link](../modules/verida_storage_link.md).[](../modules/verida_storage_link._internal_.md).Web3MetaTransactionConfig - -Configuration type for gasless mode - -## Table of contents - -### Properties - -- [endpointUrl](verida_storage_link._internal_.Web3MetaTransactionConfig.md#endpointurl) -- [postConfig](verida_storage_link._internal_.Web3MetaTransactionConfig.md#postconfig) -- [serverConfig](verida_storage_link._internal_.Web3MetaTransactionConfig.md#serverconfig) - -## Properties - -### endpointUrl - -• **endpointUrl**: `string` - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:51 - -___ - -### postConfig - -• **postConfig**: [`Web3GaslessPostConfig`](verida_storage_link._internal_.Web3GaslessPostConfig.md) - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:50 - -___ - -### serverConfig - -• **serverConfig**: [`Web3GaslessRequestConfig`](verida_storage_link._internal_.Web3GaslessRequestConfig.md) - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:49 diff --git a/docs/api/verida-js/interfaces/verida_storage_link._internal_.Web3SelfTransactionConfigPart.md b/docs/api/verida-js/interfaces/verida_storage_link._internal_.Web3SelfTransactionConfigPart.md deleted file mode 100644 index 3e91358..0000000 --- a/docs/api/verida-js/interfaces/verida_storage_link._internal_.Web3SelfTransactionConfigPart.md +++ /dev/null @@ -1,32 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/storage-link](../modules/verida_storage_link.md) / [](../modules/verida_storage_link._internal_.md) / Web3SelfTransactionConfigPart - -# Interface: Web3SelfTransactionConfigPart - -[@verida/storage-link](../modules/verida_storage_link.md).[](../modules/verida_storage_link._internal_.md).Web3SelfTransactionConfigPart - -## Table of contents - -### Properties - -- [privateKey](verida_storage_link._internal_.Web3SelfTransactionConfigPart.md#privatekey) -- [signer](verida_storage_link._internal_.Web3SelfTransactionConfigPart.md#signer) - -## Properties - -### privateKey - -• `Optional` **privateKey**: `string` - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:116 - -___ - -### signer - -• `Optional` **signer**: [`Signer`](../classes/verida_storage_link._internal_.Signer.md) - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:115 diff --git a/docs/api/verida-js/interfaces/verida_storage_link._internal_._Block.md b/docs/api/verida-js/interfaces/verida_storage_link._internal_._Block.md deleted file mode 100644 index 8d6679d..0000000 --- a/docs/api/verida-js/interfaces/verida_storage_link._internal_._Block.md +++ /dev/null @@ -1,150 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/storage-link](../modules/verida_storage_link.md) / [](../modules/verida_storage_link._internal_.md) / \_Block - -# Interface: \_Block - -[@verida/storage-link](../modules/verida_storage_link.md).[](../modules/verida_storage_link._internal_.md)._Block - -## Hierarchy - -- **`_Block`** - - ↳ [`Block`](verida_storage_link._internal_.Block.md) - - ↳ [`BlockWithTransactions`](verida_storage_link._internal_.BlockWithTransactions.md) - -## Table of contents - -### Properties - -- [\_difficulty](verida_storage_link._internal_._Block.md#_difficulty) -- [baseFeePerGas](verida_storage_link._internal_._Block.md#basefeepergas) -- [difficulty](verida_storage_link._internal_._Block.md#difficulty) -- [extraData](verida_storage_link._internal_._Block.md#extradata) -- [gasLimit](verida_storage_link._internal_._Block.md#gaslimit) -- [gasUsed](verida_storage_link._internal_._Block.md#gasused) -- [hash](verida_storage_link._internal_._Block.md#hash) -- [miner](verida_storage_link._internal_._Block.md#miner) -- [nonce](verida_storage_link._internal_._Block.md#nonce) -- [number](verida_storage_link._internal_._Block.md#number) -- [parentHash](verida_storage_link._internal_._Block.md#parenthash) -- [timestamp](verida_storage_link._internal_._Block.md#timestamp) - -## Properties - -### \_difficulty - -• **\_difficulty**: [`BigNumber`](../classes/verida_storage_link._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:41 - -___ - -### baseFeePerGas - -• `Optional` **baseFeePerGas**: ``null`` \| [`BigNumber`](../classes/verida_storage_link._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:46 - -___ - -### difficulty - -• **difficulty**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:40 - -___ - -### extraData - -• **extraData**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:45 - -___ - -### gasLimit - -• **gasLimit**: [`BigNumber`](../classes/verida_storage_link._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:42 - -___ - -### gasUsed - -• **gasUsed**: [`BigNumber`](../classes/verida_storage_link._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:43 - -___ - -### hash - -• **hash**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:35 - -___ - -### miner - -• **miner**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:44 - -___ - -### nonce - -• **nonce**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:39 - -___ - -### number - -• **number**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:37 - -___ - -### parentHash - -• **parentHash**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:36 - -___ - -### timestamp - -• **timestamp**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:38 diff --git a/docs/api/verida-js/interfaces/verida_types.AccountConfig.md b/docs/api/verida-js/interfaces/verida_types.AccountConfig.md deleted file mode 100644 index 5d3ae51..0000000 --- a/docs/api/verida-js/interfaces/verida_types.AccountConfig.md +++ /dev/null @@ -1,54 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/types](../modules/verida_types.md) / AccountConfig - -# Interface: AccountConfig - -[@verida/types](../modules/verida_types.md).AccountConfig - -## Table of contents - -### Properties - -- [defaultDatabaseServer](verida_types.AccountConfig.md#defaultdatabaseserver) -- [defaultMessageServer](verida_types.AccountConfig.md#defaultmessageserver) -- [defaultNotificationServer](verida_types.AccountConfig.md#defaultnotificationserver) -- [defaultStorageServer](verida_types.AccountConfig.md#defaultstorageserver) - -## Properties - -### defaultDatabaseServer - -• **defaultDatabaseServer**: [`SecureContextEndpoint`](verida_types.SecureContextEndpoint.md) - -#### Defined in - -[packages/types/src/AccountInterfaces.ts:8](https://github.com/verida/verida-js/blob/5040472/packages/types/src/AccountInterfaces.ts#L8) - -___ - -### defaultMessageServer - -• **defaultMessageServer**: [`SecureContextEndpoint`](verida_types.SecureContextEndpoint.md) - -#### Defined in - -[packages/types/src/AccountInterfaces.ts:9](https://github.com/verida/verida-js/blob/5040472/packages/types/src/AccountInterfaces.ts#L9) - -___ - -### defaultNotificationServer - -• `Optional` **defaultNotificationServer**: [`SecureContextEndpoint`](verida_types.SecureContextEndpoint.md) - -#### Defined in - -[packages/types/src/AccountInterfaces.ts:11](https://github.com/verida/verida-js/blob/5040472/packages/types/src/AccountInterfaces.ts#L11) - -___ - -### defaultStorageServer - -• `Optional` **defaultStorageServer**: [`SecureContextEndpoint`](verida_types.SecureContextEndpoint.md) - -#### Defined in - -[packages/types/src/AccountInterfaces.ts:10](https://github.com/verida/verida-js/blob/5040472/packages/types/src/AccountInterfaces.ts#L10) diff --git a/docs/api/verida-js/interfaces/verida_types.AccountNodeConfig.md b/docs/api/verida-js/interfaces/verida_types.AccountNodeConfig.md deleted file mode 100644 index 4717750..0000000 --- a/docs/api/verida-js/interfaces/verida_types.AccountNodeConfig.md +++ /dev/null @@ -1,65 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/types](../modules/verida_types.md) / AccountNodeConfig - -# Interface: AccountNodeConfig - -[@verida/types](../modules/verida_types.md).AccountNodeConfig - -## Table of contents - -### Properties - -- [countryCode](verida_types.AccountNodeConfig.md#countrycode) -- [didClientConfig](verida_types.AccountNodeConfig.md#didclientconfig) -- [environment](verida_types.AccountNodeConfig.md#environment) -- [options](verida_types.AccountNodeConfig.md#options) -- [privateKey](verida_types.AccountNodeConfig.md#privatekey) - -## Properties - -### countryCode - -• `Optional` **countryCode**: `string` - -#### Defined in - -[packages/types/src/AccountInterfaces.ts:47](https://github.com/verida/verida-js/blob/5040472/packages/types/src/AccountInterfaces.ts#L47) - -___ - -### didClientConfig - -• **didClientConfig**: [`AccountNodeDIDClientConfig`](verida_types.AccountNodeDIDClientConfig.md) - -#### Defined in - -[packages/types/src/AccountInterfaces.ts:45](https://github.com/verida/verida-js/blob/5040472/packages/types/src/AccountInterfaces.ts#L45) - -___ - -### environment - -• **environment**: [`EnvironmentType`](../enums/verida_types.EnvironmentType.md) - -#### Defined in - -[packages/types/src/AccountInterfaces.ts:44](https://github.com/verida/verida-js/blob/5040472/packages/types/src/AccountInterfaces.ts#L44) - -___ - -### options - -• `Optional` **options**: `any` - -#### Defined in - -[packages/types/src/AccountInterfaces.ts:46](https://github.com/verida/verida-js/blob/5040472/packages/types/src/AccountInterfaces.ts#L46) - -___ - -### privateKey - -• **privateKey**: `string` - -#### Defined in - -[packages/types/src/AccountInterfaces.ts:43](https://github.com/verida/verida-js/blob/5040472/packages/types/src/AccountInterfaces.ts#L43) diff --git a/docs/api/verida-js/interfaces/verida_types.AccountNodeDIDClientConfig.md b/docs/api/verida-js/interfaces/verida_types.AccountNodeDIDClientConfig.md deleted file mode 100644 index a8aab5e..0000000 --- a/docs/api/verida-js/interfaces/verida_types.AccountNodeDIDClientConfig.md +++ /dev/null @@ -1,82 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/types](../modules/verida_types.md) / AccountNodeDIDClientConfig - -# Interface: AccountNodeDIDClientConfig - -[@verida/types](../modules/verida_types.md).AccountNodeDIDClientConfig - -Client configuration required for AccountNode that will support creating a DID -on chain, if required - -## Hierarchy - -- [`Omit`](../modules/verida_types._internal_.md#omit)<[`DIDClientConfig`](verida_types.DIDClientConfig.md), ``"network"``\> - - ↳ **`AccountNodeDIDClientConfig`** - -## Table of contents - -### Properties - -- [callType](verida_types.AccountNodeDIDClientConfig.md#calltype) -- [didEndpoints](verida_types.AccountNodeDIDClientConfig.md#didendpoints) -- [rpcUrl](verida_types.AccountNodeDIDClientConfig.md#rpcurl) -- [timeout](verida_types.AccountNodeDIDClientConfig.md#timeout) -- [web3Config](verida_types.AccountNodeDIDClientConfig.md#web3config) - -## Properties - -### callType - -• **callType**: [`Web3CallType`](../modules/verida_types.md#web3calltype) - -#### Defined in - -[packages/types/src/AccountInterfaces.ts:55](https://github.com/verida/verida-js/blob/5040472/packages/types/src/AccountInterfaces.ts#L55) - -___ - -### didEndpoints - -• `Optional` **didEndpoints**: `string`[] - -#### Defined in - -[packages/types/src/AccountInterfaces.ts:57](https://github.com/verida/verida-js/blob/5040472/packages/types/src/AccountInterfaces.ts#L57) - -___ - -### rpcUrl - -• `Optional` **rpcUrl**: `string` - -#### Inherited from - -Omit.rpcUrl - -#### Defined in - -[packages/types/src/NetworkInterfaces.ts:26](https://github.com/verida/verida-js/blob/5040472/packages/types/src/NetworkInterfaces.ts#L26) - -___ - -### timeout - -• `Optional` **timeout**: `number` - -#### Inherited from - -Omit.timeout - -#### Defined in - -[packages/types/src/NetworkInterfaces.ts:27](https://github.com/verida/verida-js/blob/5040472/packages/types/src/NetworkInterfaces.ts#L27) - -___ - -### web3Config - -• **web3Config**: [`Web3SelfTransactionConfig`](verida_types.Web3SelfTransactionConfig.md) \| [`Web3MetaTransactionConfig`](verida_types.Web3MetaTransactionConfig.md) - -#### Defined in - -[packages/types/src/AccountInterfaces.ts:56](https://github.com/verida/verida-js/blob/5040472/packages/types/src/AccountInterfaces.ts#L56) diff --git a/docs/api/verida-js/interfaces/verida_types.AccountVaultConfig.md b/docs/api/verida-js/interfaces/verida_types.AccountVaultConfig.md deleted file mode 100644 index 6aa13d3..0000000 --- a/docs/api/verida-js/interfaces/verida_types.AccountVaultConfig.md +++ /dev/null @@ -1,126 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/types](../modules/verida_types.md) / AccountVaultConfig - -# Interface: AccountVaultConfig - -[@verida/types](../modules/verida_types.md).AccountVaultConfig - -## Table of contents - -### Properties - -- [canvasId](verida_types.AccountVaultConfig.md#canvasid) -- [deeplinkId](verida_types.AccountVaultConfig.md#deeplinkid) -- [environment](verida_types.AccountVaultConfig.md#environment) -- [loginUri](verida_types.AccountVaultConfig.md#loginuri) -- [request](verida_types.AccountVaultConfig.md#request) -- [schemeUri](verida_types.AccountVaultConfig.md#schemeuri) -- [serverUri](verida_types.AccountVaultConfig.md#serveruri) - -### Methods - -- [callback](verida_types.AccountVaultConfig.md#callback) -- [callbackRejected](verida_types.AccountVaultConfig.md#callbackrejected) - -## Properties - -### canvasId - -• `Optional` **canvasId**: `string` - -#### Defined in - -[packages/types/src/AccountInterfaces.ts:80](https://github.com/verida/verida-js/blob/5040472/packages/types/src/AccountInterfaces.ts#L80) - -___ - -### deeplinkId - -• `Optional` **deeplinkId**: `string` - -#### Defined in - -[packages/types/src/AccountInterfaces.ts:82](https://github.com/verida/verida-js/blob/5040472/packages/types/src/AccountInterfaces.ts#L82) - -___ - -### environment - -• `Optional` **environment**: [`EnvironmentType`](../enums/verida_types.EnvironmentType.md) - -#### Defined in - -[packages/types/src/AccountInterfaces.ts:84](https://github.com/verida/verida-js/blob/5040472/packages/types/src/AccountInterfaces.ts#L84) - -___ - -### loginUri - -• `Optional` **loginUri**: `string` - -#### Defined in - -[packages/types/src/AccountInterfaces.ts:79](https://github.com/verida/verida-js/blob/5040472/packages/types/src/AccountInterfaces.ts#L79) - -___ - -### request - -• `Optional` **request**: [`AccountVaultRequest`](verida_types.AccountVaultRequest.md) - -#### Defined in - -[packages/types/src/AccountInterfaces.ts:83](https://github.com/verida/verida-js/blob/5040472/packages/types/src/AccountInterfaces.ts#L83) - -___ - -### schemeUri - -• `Optional` **schemeUri**: `string` - -#### Defined in - -[packages/types/src/AccountInterfaces.ts:81](https://github.com/verida/verida-js/blob/5040472/packages/types/src/AccountInterfaces.ts#L81) - -___ - -### serverUri - -• `Optional` **serverUri**: `string` - -#### Defined in - -[packages/types/src/AccountInterfaces.ts:78](https://github.com/verida/verida-js/blob/5040472/packages/types/src/AccountInterfaces.ts#L78) - -## Methods - -### callback - -▸ `Optional` **callback**(`response`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `response` | [`AuthResponse`](verida_types.AuthResponse.md) | - -#### Returns - -`void` - -#### Defined in - -[packages/types/src/AccountInterfaces.ts:85](https://github.com/verida/verida-js/blob/5040472/packages/types/src/AccountInterfaces.ts#L85) - -___ - -### callbackRejected - -▸ `Optional` **callbackRejected**(): `void` - -#### Returns - -`void` - -#### Defined in - -[packages/types/src/AccountInterfaces.ts:86](https://github.com/verida/verida-js/blob/5040472/packages/types/src/AccountInterfaces.ts#L86) diff --git a/docs/api/verida-js/interfaces/verida_types.AccountVaultRequest.md b/docs/api/verida-js/interfaces/verida_types.AccountVaultRequest.md deleted file mode 100644 index 6fd3e5c..0000000 --- a/docs/api/verida-js/interfaces/verida_types.AccountVaultRequest.md +++ /dev/null @@ -1,62 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/types](../modules/verida_types.md) / AccountVaultRequest - -# Interface: AccountVaultRequest - -[@verida/types](../modules/verida_types.md).AccountVaultRequest - -## Table of contents - -### Properties - -- [logoUrl](verida_types.AccountVaultRequest.md#logourl) -- [openUrl](verida_types.AccountVaultRequest.md#openurl) -- [userAgent](verida_types.AccountVaultRequest.md#useragent) -- [walletConnect](verida_types.AccountVaultRequest.md#walletconnect) - -## Properties - -### logoUrl - -• `Optional` **logoUrl**: `string` - -#### Defined in - -[packages/types/src/AccountInterfaces.ts:67](https://github.com/verida/verida-js/blob/5040472/packages/types/src/AccountInterfaces.ts#L67) - -___ - -### openUrl - -• `Optional` **openUrl**: `string` - -#### Defined in - -[packages/types/src/AccountInterfaces.ts:68](https://github.com/verida/verida-js/blob/5040472/packages/types/src/AccountInterfaces.ts#L68) - -___ - -### userAgent - -• `Optional` **userAgent**: `string` - -#### Defined in - -[packages/types/src/AccountInterfaces.ts:74](https://github.com/verida/verida-js/blob/5040472/packages/types/src/AccountInterfaces.ts#L74) - -___ - -### walletConnect - -• `Optional` **walletConnect**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `chainId` | `string` | -| `uri` | `string` | -| `version` | `number` | - -#### Defined in - -[packages/types/src/AccountInterfaces.ts:69](https://github.com/verida/verida-js/blob/5040472/packages/types/src/AccountInterfaces.ts#L69) diff --git a/docs/api/verida-js/interfaces/verida_types.AuthClientConfig.md b/docs/api/verida-js/interfaces/verida_types.AuthClientConfig.md deleted file mode 100644 index 7805144..0000000 --- a/docs/api/verida-js/interfaces/verida_types.AuthClientConfig.md +++ /dev/null @@ -1,126 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/types](../modules/verida_types.md) / AuthClientConfig - -# Interface: AuthClientConfig - -[@verida/types](../modules/verida_types.md).AuthClientConfig - -## Table of contents - -### Properties - -- [appName](verida_types.AuthClientConfig.md#appname) -- [canvasId](verida_types.AuthClientConfig.md#canvasid) -- [deeplinkId](verida_types.AuthClientConfig.md#deeplinkid) -- [loginUri](verida_types.AuthClientConfig.md#loginuri) -- [request](verida_types.AuthClientConfig.md#request) -- [schemeUri](verida_types.AuthClientConfig.md#schemeuri) -- [serverUri](verida_types.AuthClientConfig.md#serveruri) - -### Methods - -- [callback](verida_types.AuthClientConfig.md#callback) -- [callbackRejected](verida_types.AuthClientConfig.md#callbackrejected) - -## Properties - -### appName - -• **appName**: `string` - -#### Defined in - -[packages/types/src/AccountInterfaces.ts:90](https://github.com/verida/verida-js/blob/5040472/packages/types/src/AccountInterfaces.ts#L90) - -___ - -### canvasId - -• `Optional` **canvasId**: `string` - -#### Defined in - -[packages/types/src/AccountInterfaces.ts:93](https://github.com/verida/verida-js/blob/5040472/packages/types/src/AccountInterfaces.ts#L93) - -___ - -### deeplinkId - -• `Optional` **deeplinkId**: `string` - -#### Defined in - -[packages/types/src/AccountInterfaces.ts:95](https://github.com/verida/verida-js/blob/5040472/packages/types/src/AccountInterfaces.ts#L95) - -___ - -### loginUri - -• `Optional` **loginUri**: `string` - -#### Defined in - -[packages/types/src/AccountInterfaces.ts:92](https://github.com/verida/verida-js/blob/5040472/packages/types/src/AccountInterfaces.ts#L92) - -___ - -### request - -• `Optional` **request**: [`AccountVaultRequest`](verida_types.AccountVaultRequest.md) - -#### Defined in - -[packages/types/src/AccountInterfaces.ts:96](https://github.com/verida/verida-js/blob/5040472/packages/types/src/AccountInterfaces.ts#L96) - -___ - -### schemeUri - -• `Optional` **schemeUri**: `string` - -#### Defined in - -[packages/types/src/AccountInterfaces.ts:94](https://github.com/verida/verida-js/blob/5040472/packages/types/src/AccountInterfaces.ts#L94) - -___ - -### serverUri - -• **serverUri**: `string` - -#### Defined in - -[packages/types/src/AccountInterfaces.ts:91](https://github.com/verida/verida-js/blob/5040472/packages/types/src/AccountInterfaces.ts#L91) - -## Methods - -### callback - -▸ **callback**(`response`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `response` | [`AuthResponse`](verida_types.AuthResponse.md) | - -#### Returns - -`void` - -#### Defined in - -[packages/types/src/AccountInterfaces.ts:97](https://github.com/verida/verida-js/blob/5040472/packages/types/src/AccountInterfaces.ts#L97) - -___ - -### callbackRejected - -▸ `Optional` **callbackRejected**(): `void` - -#### Returns - -`void` - -#### Defined in - -[packages/types/src/AccountInterfaces.ts:98](https://github.com/verida/verida-js/blob/5040472/packages/types/src/AccountInterfaces.ts#L98) diff --git a/docs/api/verida-js/interfaces/verida_types.AuthContext.md b/docs/api/verida-js/interfaces/verida_types.AuthContext.md deleted file mode 100644 index b821842..0000000 --- a/docs/api/verida-js/interfaces/verida_types.AuthContext.md +++ /dev/null @@ -1,27 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/types](../modules/verida_types.md) / AuthContext - -# Interface: AuthContext - -[@verida/types](../modules/verida_types.md).AuthContext - -## Hierarchy - -- **`AuthContext`** - - ↳ [`VeridaDatabaseAuthContext`](verida_types.VeridaDatabaseAuthContext.md) - -## Table of contents - -### Properties - -- [publicSigningKey](verida_types.AuthContext.md#publicsigningkey) - -## Properties - -### publicSigningKey - -• **publicSigningKey**: [`SecureContextPublicKey`](verida_types.SecureContextPublicKey.md) - -#### Defined in - -[packages/types/src/AccountInterfaces.ts:15](https://github.com/verida/verida-js/blob/5040472/packages/types/src/AccountInterfaces.ts#L15) diff --git a/docs/api/verida-js/interfaces/verida_types.AuthResponse.md b/docs/api/verida-js/interfaces/verida_types.AuthResponse.md deleted file mode 100644 index e3cbd79..0000000 --- a/docs/api/verida-js/interfaces/verida_types.AuthResponse.md +++ /dev/null @@ -1,43 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/types](../modules/verida_types.md) / AuthResponse - -# Interface: AuthResponse - -[@verida/types](../modules/verida_types.md).AuthResponse - -## Table of contents - -### Properties - -- [message](verida_types.AuthResponse.md#message) -- [success](verida_types.AuthResponse.md#success) -- [type](verida_types.AuthResponse.md#type) - -## Properties - -### message - -• **message**: `string` - -#### Defined in - -[packages/types/src/AccountInterfaces.ts:104](https://github.com/verida/verida-js/blob/5040472/packages/types/src/AccountInterfaces.ts#L104) - -___ - -### success - -• **success**: `boolean` - -#### Defined in - -[packages/types/src/AccountInterfaces.ts:103](https://github.com/verida/verida-js/blob/5040472/packages/types/src/AccountInterfaces.ts#L103) - -___ - -### type - -• **type**: `string` - -#### Defined in - -[packages/types/src/AccountInterfaces.ts:102](https://github.com/verida/verida-js/blob/5040472/packages/types/src/AccountInterfaces.ts#L102) diff --git a/docs/api/verida-js/interfaces/verida_types.AuthTypeConfig.md b/docs/api/verida-js/interfaces/verida_types.AuthTypeConfig.md deleted file mode 100644 index 784f423..0000000 --- a/docs/api/verida-js/interfaces/verida_types.AuthTypeConfig.md +++ /dev/null @@ -1,27 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/types](../modules/verida_types.md) / AuthTypeConfig - -# Interface: AuthTypeConfig - -[@verida/types](../modules/verida_types.md).AuthTypeConfig - -## Hierarchy - -- **`AuthTypeConfig`** - - ↳ [`VeridaDatabaseAuthTypeConfig`](verida_types.VeridaDatabaseAuthTypeConfig.md) - -## Table of contents - -### Properties - -- [force](verida_types.AuthTypeConfig.md#force) - -## Properties - -### force - -• `Optional` **force**: `boolean` - -#### Defined in - -[packages/types/src/AccountInterfaces.ts:19](https://github.com/verida/verida-js/blob/5040472/packages/types/src/AccountInterfaces.ts#L19) diff --git a/docs/api/verida-js/interfaces/verida_types.ClientConfig.md b/docs/api/verida-js/interfaces/verida_types.ClientConfig.md deleted file mode 100644 index a5dba4f..0000000 --- a/docs/api/verida-js/interfaces/verida_types.ClientConfig.md +++ /dev/null @@ -1,64 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/types](../modules/verida_types.md) / ClientConfig - -# Interface: ClientConfig - -[@verida/types](../modules/verida_types.md).ClientConfig - -Interface for ClientConfig - -## Table of contents - -### Properties - -- [didClientConfig](verida_types.ClientConfig.md#didclientconfig) -- [environment](verida_types.ClientConfig.md#environment) -- [schemaPaths](verida_types.ClientConfig.md#schemapaths) -- [vaultAppName](verida_types.ClientConfig.md#vaultappname) - -## Properties - -### didClientConfig - -• `Optional` **didClientConfig**: [`DIDClientConfig`](verida_types.DIDClientConfig.md) - -#### Defined in - -[packages/types/src/NetworkInterfaces.ts:46](https://github.com/verida/verida-js/blob/5040472/packages/types/src/NetworkInterfaces.ts#L46) - -___ - -### environment - -• `Optional` **environment**: [`EnvironmentType`](../enums/verida_types.EnvironmentType.md) - -Environment to load by default. - -Environment configuration can still be overridden by config items. - -#### Defined in - -[packages/types/src/NetworkInterfaces.ts:44](https://github.com/verida/verida-js/blob/5040472/packages/types/src/NetworkInterfaces.ts#L44) - -___ - -### schemaPaths - -• `Optional` **schemaPaths**: `object` - -Specify custom schema paths (typically for local development). - -#### Defined in - -[packages/types/src/NetworkInterfaces.ts:51](https://github.com/verida/verida-js/blob/5040472/packages/types/src/NetworkInterfaces.ts#L51) - -___ - -### vaultAppName - -• `Optional` **vaultAppName**: `string` - -Specify client's App name. - -#### Defined in - -[packages/types/src/NetworkInterfaces.ts:37](https://github.com/verida/verida-js/blob/5040472/packages/types/src/NetworkInterfaces.ts#L37) diff --git a/docs/api/verida-js/interfaces/verida_types.ContextCloseOptions.md b/docs/api/verida-js/interfaces/verida_types.ContextCloseOptions.md deleted file mode 100644 index 30ece3e..0000000 --- a/docs/api/verida-js/interfaces/verida_types.ContextCloseOptions.md +++ /dev/null @@ -1,27 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/types](../modules/verida_types.md) / ContextCloseOptions - -# Interface: ContextCloseOptions - -[@verida/types](../modules/verida_types.md).ContextCloseOptions - -## Hierarchy - -- **`ContextCloseOptions`** - - ↳ [`DatabaseCloseOptions`](verida_types.DatabaseCloseOptions.md) - -## Table of contents - -### Properties - -- [clearLocal](verida_types.ContextCloseOptions.md#clearlocal) - -## Properties - -### clearLocal - -• `Optional` **clearLocal**: `boolean` - -#### Defined in - -[packages/types/src/ContextInterfaces.ts:86](https://github.com/verida/verida-js/blob/5040472/packages/types/src/ContextInterfaces.ts#L86) diff --git a/docs/api/verida-js/interfaces/verida_types.ContextConfig.md b/docs/api/verida-js/interfaces/verida_types.ContextConfig.md deleted file mode 100644 index af0d6c5..0000000 --- a/docs/api/verida-js/interfaces/verida_types.ContextConfig.md +++ /dev/null @@ -1,34 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/types](../modules/verida_types.md) / ContextConfig - -# Interface: ContextConfig - -[@verida/types](../modules/verida_types.md).ContextConfig - -Interface for ContextConfig - -## Table of contents - -### Properties - -- [forceCreate](verida_types.ContextConfig.md#forcecreate) -- [name](verida_types.ContextConfig.md#name) - -## Properties - -### forceCreate - -• `Optional` **forceCreate**: `boolean` - -#### Defined in - -[packages/types/src/NetworkInterfaces.ts:59](https://github.com/verida/verida-js/blob/5040472/packages/types/src/NetworkInterfaces.ts#L59) - -___ - -### name - -• **name**: `string` - -#### Defined in - -[packages/types/src/NetworkInterfaces.ts:58](https://github.com/verida/verida-js/blob/5040472/packages/types/src/NetworkInterfaces.ts#L58) diff --git a/docs/api/verida-js/interfaces/verida_types.ContextDatabaseInfo.md b/docs/api/verida-js/interfaces/verida_types.ContextDatabaseInfo.md deleted file mode 100644 index 65bf002..0000000 --- a/docs/api/verida-js/interfaces/verida_types.ContextDatabaseInfo.md +++ /dev/null @@ -1,65 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/types](../modules/verida_types.md) / ContextDatabaseInfo - -# Interface: ContextDatabaseInfo - -[@verida/types](../modules/verida_types.md).ContextDatabaseInfo - -## Table of contents - -### Properties - -- [activeEndpoint](verida_types.ContextDatabaseInfo.md#activeendpoint) -- [databases](verida_types.ContextDatabaseInfo.md#databases) -- [endpoints](verida_types.ContextDatabaseInfo.md#endpoints) -- [keys](verida_types.ContextDatabaseInfo.md#keys) -- [name](verida_types.ContextDatabaseInfo.md#name) - -## Properties - -### activeEndpoint - -• `Optional` **activeEndpoint**: `string` - -#### Defined in - -[packages/types/src/ContextInterfaces.ts:163](https://github.com/verida/verida-js/blob/5040472/packages/types/src/ContextInterfaces.ts#L163) - -___ - -### databases - -• **databases**: [`Record`](../modules/verida_types._internal_.md#record)<`string`, `object`\> - -#### Defined in - -[packages/types/src/ContextInterfaces.ts:165](https://github.com/verida/verida-js/blob/5040472/packages/types/src/ContextInterfaces.ts#L165) - -___ - -### endpoints - -• **endpoints**: [`Record`](../modules/verida_types._internal_.md#record)<`string`, `object`\> - -#### Defined in - -[packages/types/src/ContextInterfaces.ts:164](https://github.com/verida/verida-js/blob/5040472/packages/types/src/ContextInterfaces.ts#L164) - -___ - -### keys - -• **keys**: `any` - -#### Defined in - -[packages/types/src/ContextInterfaces.ts:166](https://github.com/verida/verida-js/blob/5040472/packages/types/src/ContextInterfaces.ts#L166) - -___ - -### name - -• **name**: `string` - -#### Defined in - -[packages/types/src/ContextInterfaces.ts:162](https://github.com/verida/verida-js/blob/5040472/packages/types/src/ContextInterfaces.ts#L162) diff --git a/docs/api/verida-js/interfaces/verida_types.ContextInfo.md b/docs/api/verida-js/interfaces/verida_types.ContextInfo.md deleted file mode 100644 index e7e2854..0000000 --- a/docs/api/verida-js/interfaces/verida_types.ContextInfo.md +++ /dev/null @@ -1,21 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/types](../modules/verida_types.md) / ContextInfo - -# Interface: ContextInfo - -[@verida/types](../modules/verida_types.md).ContextInfo - -## Table of contents - -### Properties - -- [databases](verida_types.ContextInfo.md#databases) - -## Properties - -### databases - -• **databases**: [`ContextDatabaseInfo`](verida_types.ContextDatabaseInfo.md) - -#### Defined in - -[packages/types/src/ContextInterfaces.ts:170](https://github.com/verida/verida-js/blob/5040472/packages/types/src/ContextInterfaces.ts#L170) diff --git a/docs/api/verida-js/interfaces/verida_types.DIDClientConfig.md b/docs/api/verida-js/interfaces/verida_types.DIDClientConfig.md deleted file mode 100644 index b714f36..0000000 --- a/docs/api/verida-js/interfaces/verida_types.DIDClientConfig.md +++ /dev/null @@ -1,43 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/types](../modules/verida_types.md) / DIDClientConfig - -# Interface: DIDClientConfig - -[@verida/types](../modules/verida_types.md).DIDClientConfig - -## Table of contents - -### Properties - -- [network](verida_types.DIDClientConfig.md#network) -- [rpcUrl](verida_types.DIDClientConfig.md#rpcurl) -- [timeout](verida_types.DIDClientConfig.md#timeout) - -## Properties - -### network - -• **network**: [`EnvironmentType`](../enums/verida_types.EnvironmentType.md) - -#### Defined in - -[packages/types/src/NetworkInterfaces.ts:25](https://github.com/verida/verida-js/blob/5040472/packages/types/src/NetworkInterfaces.ts#L25) - -___ - -### rpcUrl - -• `Optional` **rpcUrl**: `string` - -#### Defined in - -[packages/types/src/NetworkInterfaces.ts:26](https://github.com/verida/verida-js/blob/5040472/packages/types/src/NetworkInterfaces.ts#L26) - -___ - -### timeout - -• `Optional` **timeout**: `number` - -#### Defined in - -[packages/types/src/NetworkInterfaces.ts:27](https://github.com/verida/verida-js/blob/5040472/packages/types/src/NetworkInterfaces.ts#L27) diff --git a/docs/api/verida-js/interfaces/verida_types.DIDContextConfigs.md b/docs/api/verida-js/interfaces/verida_types.DIDContextConfigs.md deleted file mode 100644 index f3521ac..0000000 --- a/docs/api/verida-js/interfaces/verida_types.DIDContextConfigs.md +++ /dev/null @@ -1,13 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/types](../modules/verida_types.md) / DIDContextConfigs - -# Interface: DIDContextConfigs - -[@verida/types](../modules/verida_types.md).DIDContextConfigs - -Interface for DIDContextConfigs -key = contextName -value = SecureStorageContextConfig - -## Indexable - -▪ [key: `string`]: [`SecureContextConfig`](verida_types.SecureContextConfig.md) diff --git a/docs/api/verida-js/interfaces/verida_types.DIDDocumentComparisonResult.md b/docs/api/verida-js/interfaces/verida_types.DIDDocumentComparisonResult.md deleted file mode 100644 index 68387d0..0000000 --- a/docs/api/verida-js/interfaces/verida_types.DIDDocumentComparisonResult.md +++ /dev/null @@ -1,43 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/types](../modules/verida_types.md) / DIDDocumentComparisonResult - -# Interface: DIDDocumentComparisonResult - -[@verida/types](../modules/verida_types.md).DIDDocumentComparisonResult - -## Table of contents - -### Properties - -- [add](verida_types.DIDDocumentComparisonResult.md#add) -- [controller](verida_types.DIDDocumentComparisonResult.md#controller) -- [remove](verida_types.DIDDocumentComparisonResult.md#remove) - -## Properties - -### add - -• **add**: [`DIDDocument`](../modules/verida_types._internal_.md#diddocument) - -#### Defined in - -[packages/types/src/DocumentInterfaces.ts:26](https://github.com/verida/verida-js/blob/5040472/packages/types/src/DocumentInterfaces.ts#L26) - -___ - -### controller - -• `Optional` **controller**: `string` \| `string`[] - -#### Defined in - -[packages/types/src/DocumentInterfaces.ts:25](https://github.com/verida/verida-js/blob/5040472/packages/types/src/DocumentInterfaces.ts#L25) - -___ - -### remove - -• **remove**: [`DIDDocument`](../modules/verida_types._internal_.md#diddocument) - -#### Defined in - -[packages/types/src/DocumentInterfaces.ts:27](https://github.com/verida/verida-js/blob/5040472/packages/types/src/DocumentInterfaces.ts#L27) diff --git a/docs/api/verida-js/interfaces/verida_types.DatabaseCloseOptions.md b/docs/api/verida-js/interfaces/verida_types.DatabaseCloseOptions.md deleted file mode 100644 index 1503e2b..0000000 --- a/docs/api/verida-js/interfaces/verida_types.DatabaseCloseOptions.md +++ /dev/null @@ -1,31 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/types](../modules/verida_types.md) / DatabaseCloseOptions - -# Interface: DatabaseCloseOptions - -[@verida/types](../modules/verida_types.md).DatabaseCloseOptions - -## Hierarchy - -- [`ContextCloseOptions`](verida_types.ContextCloseOptions.md) - - ↳ **`DatabaseCloseOptions`** - -## Table of contents - -### Properties - -- [clearLocal](verida_types.DatabaseCloseOptions.md#clearlocal) - -## Properties - -### clearLocal - -• `Optional` **clearLocal**: `boolean` - -#### Inherited from - -[ContextCloseOptions](verida_types.ContextCloseOptions.md).[clearLocal](verida_types.ContextCloseOptions.md#clearlocal) - -#### Defined in - -[packages/types/src/ContextInterfaces.ts:86](https://github.com/verida/verida-js/blob/5040472/packages/types/src/ContextInterfaces.ts#L86) diff --git a/docs/api/verida-js/interfaces/verida_types.DatabaseDeleteConfig.md b/docs/api/verida-js/interfaces/verida_types.DatabaseDeleteConfig.md deleted file mode 100644 index 7f29000..0000000 --- a/docs/api/verida-js/interfaces/verida_types.DatabaseDeleteConfig.md +++ /dev/null @@ -1,21 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/types](../modules/verida_types.md) / DatabaseDeleteConfig - -# Interface: DatabaseDeleteConfig - -[@verida/types](../modules/verida_types.md).DatabaseDeleteConfig - -## Table of contents - -### Properties - -- [localOnly](verida_types.DatabaseDeleteConfig.md#localonly) - -## Properties - -### localOnly - -• `Optional` **localOnly**: `boolean` - -#### Defined in - -[packages/types/src/ContextInterfaces.ts:81](https://github.com/verida/verida-js/blob/5040472/packages/types/src/ContextInterfaces.ts#L81) diff --git a/docs/api/verida-js/interfaces/verida_types.DatabaseEngines.md b/docs/api/verida-js/interfaces/verida_types.DatabaseEngines.md deleted file mode 100644 index e7322b9..0000000 --- a/docs/api/verida-js/interfaces/verida_types.DatabaseEngines.md +++ /dev/null @@ -1,11 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/types](../modules/verida_types.md) / DatabaseEngines - -# Interface: DatabaseEngines - -[@verida/types](../modules/verida_types.md).DatabaseEngines - -Interface for any DatabaseEngines - -## Indexable - -▪ [key: `string`]: [`IStorageEngine`](verida_types.IStorageEngine.md) diff --git a/docs/api/verida-js/interfaces/verida_types.DatabaseOpenConfig.md b/docs/api/verida-js/interfaces/verida_types.DatabaseOpenConfig.md deleted file mode 100644 index 1ddb7a1..0000000 --- a/docs/api/verida-js/interfaces/verida_types.DatabaseOpenConfig.md +++ /dev/null @@ -1,187 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/types](../modules/verida_types.md) / DatabaseOpenConfig - -# Interface: DatabaseOpenConfig - -[@verida/types](../modules/verida_types.md).DatabaseOpenConfig - -Interface for any DatabaseOpenConfig - -## Table of contents - -### Properties - -- [contextName](verida_types.DatabaseOpenConfig.md#contextname) -- [createContext](verida_types.DatabaseOpenConfig.md#createcontext) -- [did](verida_types.DatabaseOpenConfig.md#did) -- [encryptionKey](verida_types.DatabaseOpenConfig.md#encryptionkey) -- [endpoints](verida_types.DatabaseOpenConfig.md#endpoints) -- [ignoreCache](verida_types.DatabaseOpenConfig.md#ignorecache) -- [isOwner](verida_types.DatabaseOpenConfig.md#isowner) -- [permissions](verida_types.DatabaseOpenConfig.md#permissions) -- [readOnly](verida_types.DatabaseOpenConfig.md#readonly) -- [saveDatabase](verida_types.DatabaseOpenConfig.md#savedatabase) -- [signingContext](verida_types.DatabaseOpenConfig.md#signingcontext) -- [token](verida_types.DatabaseOpenConfig.md#token) -- [verifyEncryptionKey](verida_types.DatabaseOpenConfig.md#verifyencryptionkey) - -## Properties - -### contextName - -• `Optional` **contextName**: `string` - -Optionally specify an external context to open - -#### Defined in - -[packages/types/src/ContextInterfaces.ts:61](https://github.com/verida/verida-js/blob/5040472/packages/types/src/ContextInterfaces.ts#L61) - -___ - -### createContext - -• `Optional` **createContext**: `boolean` - -Create an application context if it doesn't already exist for the connected account. - -#### Defined in - -[packages/types/src/ContextInterfaces.ts:56](https://github.com/verida/verida-js/blob/5040472/packages/types/src/ContextInterfaces.ts#L56) - -___ - -### did - -• `Optional` **did**: `string` - -Specify the DID that owns the database. - -This ensures the Verida client connects to the correct database server hosting the data for the specified `did`. - -#### Defined in - -[packages/types/src/ContextInterfaces.ts:17](https://github.com/verida/verida-js/blob/5040472/packages/types/src/ContextInterfaces.ts#L17) - -___ - -### encryptionKey - -• `Optional` **encryptionKey**: `Buffer` - -An optional encryption key to use for encrypting / decrypting data. - -This encryption key will not apply if the database is marked as `public`. - -#### Defined in - -[packages/types/src/ContextInterfaces.ts:51](https://github.com/verida/verida-js/blob/5040472/packages/types/src/ContextInterfaces.ts#L51) - -___ - -### endpoints - -• `Optional` **endpoints**: `string` \| `string`[] - -Specify an array of possible database connection strings to use when opening the database. - -#### Defined in - -[packages/types/src/ContextInterfaces.ts:22](https://github.com/verida/verida-js/blob/5040472/packages/types/src/ContextInterfaces.ts#L22) - -___ - -### ignoreCache - -• `Optional` **ignoreCache**: `boolean` - -Ignore any cached instance already created - -#### Defined in - -[packages/types/src/ContextInterfaces.ts:71](https://github.com/verida/verida-js/blob/5040472/packages/types/src/ContextInterfaces.ts#L71) - -___ - -### isOwner - -• `Optional` **isOwner**: `boolean` - -Boolean indicating if it's expected the current connected account is the owner of this database. - -#### Defined in - -[packages/types/src/ContextInterfaces.ts:44](https://github.com/verida/verida-js/blob/5040472/packages/types/src/ContextInterfaces.ts#L44) - -___ - -### permissions - -• `Optional` **permissions**: [`DatabasePermissionsConfig`](verida_types.DatabasePermissionsConfig.md) - -Specify the permissions to use when opening this database. - -#### Defined in - -[packages/types/src/ContextInterfaces.ts:10](https://github.com/verida/verida-js/blob/5040472/packages/types/src/ContextInterfaces.ts#L10) - -___ - -### readOnly - -• `Optional` **readOnly**: `boolean` - -Open the database in read-only mode. - -This is useful when opening a database owned by an external `did` where the current authenticated account has no write access. - -#### Defined in - -[packages/types/src/ContextInterfaces.ts:39](https://github.com/verida/verida-js/blob/5040472/packages/types/src/ContextInterfaces.ts#L39) - -___ - -### saveDatabase - -• `Optional` **saveDatabase**: `boolean` - -Save this database into the user's master list of opened databases. - -#### Defined in - -[packages/types/src/ContextInterfaces.ts:32](https://github.com/verida/verida-js/blob/5040472/packages/types/src/ContextInterfaces.ts#L32) - -___ - -### signingContext - -• `Optional` **signingContext**: [`IContext`](verida_types.IContext.md) - -Optionally specify the context used to sign data - -#### Defined in - -[packages/types/src/ContextInterfaces.ts:66](https://github.com/verida/verida-js/blob/5040472/packages/types/src/ContextInterfaces.ts#L66) - -___ - -### token - -• `Optional` **token**: `string` - -Specify a JWT token to use when opening the database. - -#### Defined in - -[packages/types/src/ContextInterfaces.ts:27](https://github.com/verida/verida-js/blob/5040472/packages/types/src/ContextInterfaces.ts#L27) - -___ - -### verifyEncryptionKey - -• `Optional` **verifyEncryptionKey**: `boolean` - -Verify the encryption key is correct when opening the database - -#### Defined in - -[packages/types/src/ContextInterfaces.ts:76](https://github.com/verida/verida-js/blob/5040472/packages/types/src/ContextInterfaces.ts#L76) diff --git a/docs/api/verida-js/interfaces/verida_types.DatabasePermissionsConfig.md b/docs/api/verida-js/interfaces/verida_types.DatabasePermissionsConfig.md deleted file mode 100644 index c021131..0000000 --- a/docs/api/verida-js/interfaces/verida_types.DatabasePermissionsConfig.md +++ /dev/null @@ -1,56 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/types](../modules/verida_types.md) / DatabasePermissionsConfig - -# Interface: DatabasePermissionsConfig - -[@verida/types](../modules/verida_types.md).DatabasePermissionsConfig - -Interface for any PermissionsConfig - -## Table of contents - -### Properties - -- [read](verida_types.DatabasePermissionsConfig.md#read) -- [readList](verida_types.DatabasePermissionsConfig.md#readlist) -- [write](verida_types.DatabasePermissionsConfig.md#write) -- [writeList](verida_types.DatabasePermissionsConfig.md#writelist) - -## Properties - -### read - -• **read**: [`DatabasePermissionOptionsEnum`](../enums/verida_types.DatabasePermissionOptionsEnum.md) - -#### Defined in - -[packages/types/src/ContextInterfaces.ts:133](https://github.com/verida/verida-js/blob/5040472/packages/types/src/ContextInterfaces.ts#L133) - -___ - -### readList - -• `Optional` **readList**: `string`[] - -#### Defined in - -[packages/types/src/ContextInterfaces.ts:135](https://github.com/verida/verida-js/blob/5040472/packages/types/src/ContextInterfaces.ts#L135) - -___ - -### write - -• **write**: [`DatabasePermissionOptionsEnum`](../enums/verida_types.DatabasePermissionOptionsEnum.md) - -#### Defined in - -[packages/types/src/ContextInterfaces.ts:134](https://github.com/verida/verida-js/blob/5040472/packages/types/src/ContextInterfaces.ts#L134) - -___ - -### writeList - -• `Optional` **writeList**: `string`[] - -#### Defined in - -[packages/types/src/ContextInterfaces.ts:136](https://github.com/verida/verida-js/blob/5040472/packages/types/src/ContextInterfaces.ts#L136) diff --git a/docs/api/verida-js/interfaces/verida_types.DatastoreOpenConfig.md b/docs/api/verida-js/interfaces/verida_types.DatastoreOpenConfig.md deleted file mode 100644 index fd6212d..0000000 --- a/docs/api/verida-js/interfaces/verida_types.DatastoreOpenConfig.md +++ /dev/null @@ -1,111 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/types](../modules/verida_types.md) / DatastoreOpenConfig - -# Interface: DatastoreOpenConfig - -[@verida/types](../modules/verida_types.md).DatastoreOpenConfig - -Interface for any DatastoreOpenConfig - -## Table of contents - -### Properties - -- [contextName](verida_types.DatastoreOpenConfig.md#contextname) -- [createContext](verida_types.DatastoreOpenConfig.md#createcontext) -- [databaseName](verida_types.DatastoreOpenConfig.md#databasename) -- [did](verida_types.DatastoreOpenConfig.md#did) -- [encryptionKey](verida_types.DatastoreOpenConfig.md#encryptionkey) -- [external](verida_types.DatastoreOpenConfig.md#external) -- [permissions](verida_types.DatastoreOpenConfig.md#permissions) -- [readOnly](verida_types.DatastoreOpenConfig.md#readonly) -- [saveDatabase](verida_types.DatastoreOpenConfig.md#savedatabase) - -## Properties - -### contextName - -• `Optional` **contextName**: `string` - -#### Defined in - -[packages/types/src/ContextInterfaces.ts:106](https://github.com/verida/verida-js/blob/5040472/packages/types/src/ContextInterfaces.ts#L106) - -___ - -### createContext - -• `Optional` **createContext**: `boolean` - -#### Defined in - -[packages/types/src/ContextInterfaces.ts:104](https://github.com/verida/verida-js/blob/5040472/packages/types/src/ContextInterfaces.ts#L104) - -___ - -### databaseName - -• `Optional` **databaseName**: `string` - -#### Defined in - -[packages/types/src/ContextInterfaces.ts:103](https://github.com/verida/verida-js/blob/5040472/packages/types/src/ContextInterfaces.ts#L103) - -___ - -### did - -• `Optional` **did**: `string` - -#### Defined in - -[packages/types/src/ContextInterfaces.ts:99](https://github.com/verida/verida-js/blob/5040472/packages/types/src/ContextInterfaces.ts#L99) - -___ - -### encryptionKey - -• `Optional` **encryptionKey**: `string` - -#### Defined in - -[packages/types/src/ContextInterfaces.ts:102](https://github.com/verida/verida-js/blob/5040472/packages/types/src/ContextInterfaces.ts#L102) - -___ - -### external - -• `Optional` **external**: `boolean` - -#### Defined in - -[packages/types/src/ContextInterfaces.ts:105](https://github.com/verida/verida-js/blob/5040472/packages/types/src/ContextInterfaces.ts#L105) - -___ - -### permissions - -• `Optional` **permissions**: [`DatabasePermissionsConfig`](verida_types.DatabasePermissionsConfig.md) - -#### Defined in - -[packages/types/src/ContextInterfaces.ts:98](https://github.com/verida/verida-js/blob/5040472/packages/types/src/ContextInterfaces.ts#L98) - -___ - -### readOnly - -• `Optional` **readOnly**: `boolean` - -#### Defined in - -[packages/types/src/ContextInterfaces.ts:101](https://github.com/verida/verida-js/blob/5040472/packages/types/src/ContextInterfaces.ts#L101) - -___ - -### saveDatabase - -• `Optional` **saveDatabase**: `boolean` - -#### Defined in - -[packages/types/src/ContextInterfaces.ts:100](https://github.com/verida/verida-js/blob/5040472/packages/types/src/ContextInterfaces.ts#L100) diff --git a/docs/api/verida-js/interfaces/verida_types.DbRegistryEntry.md b/docs/api/verida-js/interfaces/verida_types.DbRegistryEntry.md deleted file mode 100644 index 13a1593..0000000 --- a/docs/api/verida-js/interfaces/verida_types.DbRegistryEntry.md +++ /dev/null @@ -1,100 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/types](../modules/verida_types.md) / DbRegistryEntry - -# Interface: DbRegistryEntry - -[@verida/types](../modules/verida_types.md).DbRegistryEntry - -Interface for DbRegistryEntry - -## Table of contents - -### Properties - -- [contextName](verida_types.DbRegistryEntry.md#contextname) -- [dbHash](verida_types.DbRegistryEntry.md#dbhash) -- [dbName](verida_types.DbRegistryEntry.md#dbname) -- [did](verida_types.DbRegistryEntry.md#did) -- [encryptionKey](verida_types.DbRegistryEntry.md#encryptionkey) -- [endpoint](verida_types.DbRegistryEntry.md#endpoint) -- [endpointType](verida_types.DbRegistryEntry.md#endpointtype) -- [permissions](verida_types.DbRegistryEntry.md#permissions) - -## Properties - -### contextName - -• **contextName**: `string` - -#### Defined in - -[packages/types/src/ContextInterfaces.ts:189](https://github.com/verida/verida-js/blob/5040472/packages/types/src/ContextInterfaces.ts#L189) - -___ - -### dbHash - -• **dbHash**: `string` - -#### Defined in - -[packages/types/src/ContextInterfaces.ts:185](https://github.com/verida/verida-js/blob/5040472/packages/types/src/ContextInterfaces.ts#L185) - -___ - -### dbName - -• **dbName**: `string` - -#### Defined in - -[packages/types/src/ContextInterfaces.ts:186](https://github.com/verida/verida-js/blob/5040472/packages/types/src/ContextInterfaces.ts#L186) - -___ - -### did - -• **did**: `string` - -#### Defined in - -[packages/types/src/ContextInterfaces.ts:188](https://github.com/verida/verida-js/blob/5040472/packages/types/src/ContextInterfaces.ts#L188) - -___ - -### encryptionKey - -• `Optional` **encryptionKey**: [`DbRegistryEntryEncryptionKey`](verida_types.DbRegistryEntryEncryptionKey.md) - -#### Defined in - -[packages/types/src/ContextInterfaces.ts:191](https://github.com/verida/verida-js/blob/5040472/packages/types/src/ContextInterfaces.ts#L191) - -___ - -### endpoint - -• **endpoint**: `string` - -#### Defined in - -[packages/types/src/ContextInterfaces.ts:192](https://github.com/verida/verida-js/blob/5040472/packages/types/src/ContextInterfaces.ts#L192) - -___ - -### endpointType - -• **endpointType**: `string` - -#### Defined in - -[packages/types/src/ContextInterfaces.ts:187](https://github.com/verida/verida-js/blob/5040472/packages/types/src/ContextInterfaces.ts#L187) - -___ - -### permissions - -• **permissions**: [`DatabasePermissionsConfig`](verida_types.DatabasePermissionsConfig.md) - -#### Defined in - -[packages/types/src/ContextInterfaces.ts:190](https://github.com/verida/verida-js/blob/5040472/packages/types/src/ContextInterfaces.ts#L190) diff --git a/docs/api/verida-js/interfaces/verida_types.DbRegistryEntryEncryptionKey.md b/docs/api/verida-js/interfaces/verida_types.DbRegistryEntryEncryptionKey.md deleted file mode 100644 index 51db8b3..0000000 --- a/docs/api/verida-js/interfaces/verida_types.DbRegistryEntryEncryptionKey.md +++ /dev/null @@ -1,34 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/types](../modules/verida_types.md) / DbRegistryEntryEncryptionKey - -# Interface: DbRegistryEntryEncryptionKey - -[@verida/types](../modules/verida_types.md).DbRegistryEntryEncryptionKey - -Interface for DbRegistryEntryEncryptionKey - -## Table of contents - -### Properties - -- [key](verida_types.DbRegistryEntryEncryptionKey.md#key) -- [type](verida_types.DbRegistryEntryEncryptionKey.md#type) - -## Properties - -### key - -• **key**: `string` - -#### Defined in - -[packages/types/src/ContextInterfaces.ts:177](https://github.com/verida/verida-js/blob/5040472/packages/types/src/ContextInterfaces.ts#L177) - -___ - -### type - -• **type**: `string` - -#### Defined in - -[packages/types/src/ContextInterfaces.ts:178](https://github.com/verida/verida-js/blob/5040472/packages/types/src/ContextInterfaces.ts#L178) diff --git a/docs/api/verida-js/interfaces/verida_types.DefaultClientConfig.md b/docs/api/verida-js/interfaces/verida_types.DefaultClientConfig.md deleted file mode 100644 index 18d8b30..0000000 --- a/docs/api/verida-js/interfaces/verida_types.DefaultClientConfig.md +++ /dev/null @@ -1,94 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/types](../modules/verida_types.md) / DefaultClientConfig - -# Interface: DefaultClientConfig - -[@verida/types](../modules/verida_types.md).DefaultClientConfig - -## Hierarchy - -- [`DefaultEnvironmentConfig`](verida_types.DefaultEnvironmentConfig.md) - - ↳ **`DefaultClientConfig`** - -## Table of contents - -### Properties - -- [defaultDatabaseServerUrl](verida_types.DefaultClientConfig.md#defaultdatabaseserverurl) -- [defaultMessageServerUrl](verida_types.DefaultClientConfig.md#defaultmessageserverurl) -- [environment](verida_types.DefaultClientConfig.md#environment) -- [environments](verida_types.DefaultClientConfig.md#environments) -- [schemaPaths](verida_types.DefaultClientConfig.md#schemapaths) -- [vaultAppName](verida_types.DefaultClientConfig.md#vaultappname) - -## Properties - -### defaultDatabaseServerUrl - -• `Optional` **defaultDatabaseServerUrl**: `string` - -#### Inherited from - -[DefaultEnvironmentConfig](verida_types.DefaultEnvironmentConfig.md).[defaultDatabaseServerUrl](verida_types.DefaultEnvironmentConfig.md#defaultdatabaseserverurl) - -#### Defined in - -[packages/types/src/NetworkInterfaces.ts:13](https://github.com/verida/verida-js/blob/5040472/packages/types/src/NetworkInterfaces.ts#L13) - -___ - -### defaultMessageServerUrl - -• `Optional` **defaultMessageServerUrl**: `string` - -#### Inherited from - -[DefaultEnvironmentConfig](verida_types.DefaultEnvironmentConfig.md).[defaultMessageServerUrl](verida_types.DefaultEnvironmentConfig.md#defaultmessageserverurl) - -#### Defined in - -[packages/types/src/NetworkInterfaces.ts:14](https://github.com/verida/verida-js/blob/5040472/packages/types/src/NetworkInterfaces.ts#L14) - -___ - -### environment - -• **environment**: [`EnvironmentType`](../enums/verida_types.EnvironmentType.md) - -#### Defined in - -[packages/types/src/NetworkInterfaces.ts:19](https://github.com/verida/verida-js/blob/5040472/packages/types/src/NetworkInterfaces.ts#L19) - -___ - -### environments - -• **environments**: [`Record`](../modules/verida_types._internal_.md#record)<`string`, [`DefaultEnvironmentConfig`](verida_types.DefaultEnvironmentConfig.md)\> - -#### Defined in - -[packages/types/src/NetworkInterfaces.ts:20](https://github.com/verida/verida-js/blob/5040472/packages/types/src/NetworkInterfaces.ts#L20) - -___ - -### schemaPaths - -• `Optional` **schemaPaths**: [`Record`](../modules/verida_types._internal_.md#record)<`string`, `string`\> - -#### Inherited from - -[DefaultEnvironmentConfig](verida_types.DefaultEnvironmentConfig.md).[schemaPaths](verida_types.DefaultEnvironmentConfig.md#schemapaths) - -#### Defined in - -[packages/types/src/NetworkInterfaces.ts:15](https://github.com/verida/verida-js/blob/5040472/packages/types/src/NetworkInterfaces.ts#L15) - -___ - -### vaultAppName - -• **vaultAppName**: `string` - -#### Defined in - -[packages/types/src/NetworkInterfaces.ts:21](https://github.com/verida/verida-js/blob/5040472/packages/types/src/NetworkInterfaces.ts#L21) diff --git a/docs/api/verida-js/interfaces/verida_types.DefaultEnvironmentConfig.md b/docs/api/verida-js/interfaces/verida_types.DefaultEnvironmentConfig.md deleted file mode 100644 index bf74806..0000000 --- a/docs/api/verida-js/interfaces/verida_types.DefaultEnvironmentConfig.md +++ /dev/null @@ -1,49 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/types](../modules/verida_types.md) / DefaultEnvironmentConfig - -# Interface: DefaultEnvironmentConfig - -[@verida/types](../modules/verida_types.md).DefaultEnvironmentConfig - -## Hierarchy - -- **`DefaultEnvironmentConfig`** - - ↳ [`DefaultClientConfig`](verida_types.DefaultClientConfig.md) - -## Table of contents - -### Properties - -- [defaultDatabaseServerUrl](verida_types.DefaultEnvironmentConfig.md#defaultdatabaseserverurl) -- [defaultMessageServerUrl](verida_types.DefaultEnvironmentConfig.md#defaultmessageserverurl) -- [schemaPaths](verida_types.DefaultEnvironmentConfig.md#schemapaths) - -## Properties - -### defaultDatabaseServerUrl - -• `Optional` **defaultDatabaseServerUrl**: `string` - -#### Defined in - -[packages/types/src/NetworkInterfaces.ts:13](https://github.com/verida/verida-js/blob/5040472/packages/types/src/NetworkInterfaces.ts#L13) - -___ - -### defaultMessageServerUrl - -• `Optional` **defaultMessageServerUrl**: `string` - -#### Defined in - -[packages/types/src/NetworkInterfaces.ts:14](https://github.com/verida/verida-js/blob/5040472/packages/types/src/NetworkInterfaces.ts#L14) - -___ - -### schemaPaths - -• `Optional` **schemaPaths**: [`Record`](../modules/verida_types._internal_.md#record)<`string`, `string`\> - -#### Defined in - -[packages/types/src/NetworkInterfaces.ts:15](https://github.com/verida/verida-js/blob/5040472/packages/types/src/NetworkInterfaces.ts#L15) diff --git a/docs/api/verida-js/interfaces/verida_types.EndpointUsage.md b/docs/api/verida-js/interfaces/verida_types.EndpointUsage.md deleted file mode 100644 index 797f1a0..0000000 --- a/docs/api/verida-js/interfaces/verida_types.EndpointUsage.md +++ /dev/null @@ -1,43 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/types](../modules/verida_types.md) / EndpointUsage - -# Interface: EndpointUsage - -[@verida/types](../modules/verida_types.md).EndpointUsage - -## Table of contents - -### Properties - -- [bytes](verida_types.EndpointUsage.md#bytes) -- [databases](verida_types.EndpointUsage.md#databases) -- [storageLimit](verida_types.EndpointUsage.md#storagelimit) - -## Properties - -### bytes - -• **bytes**: `number` - -#### Defined in - -[packages/types/src/ContextInterfaces.ts:157](https://github.com/verida/verida-js/blob/5040472/packages/types/src/ContextInterfaces.ts#L157) - -___ - -### databases - -• **databases**: `number` - -#### Defined in - -[packages/types/src/ContextInterfaces.ts:156](https://github.com/verida/verida-js/blob/5040472/packages/types/src/ContextInterfaces.ts#L156) - -___ - -### storageLimit - -• **storageLimit**: `number` - -#### Defined in - -[packages/types/src/ContextInterfaces.ts:158](https://github.com/verida/verida-js/blob/5040472/packages/types/src/ContextInterfaces.ts#L158) diff --git a/docs/api/verida-js/interfaces/verida_types.FetchUriParams.md b/docs/api/verida-js/interfaces/verida_types.FetchUriParams.md deleted file mode 100644 index bcec22d..0000000 --- a/docs/api/verida-js/interfaces/verida_types.FetchUriParams.md +++ /dev/null @@ -1,76 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/types](../modules/verida_types.md) / FetchUriParams - -# Interface: FetchUriParams - -[@verida/types](../modules/verida_types.md).FetchUriParams - -## Table of contents - -### Properties - -- [contextName](verida_types.FetchUriParams.md#contextname) -- [dbName](verida_types.FetchUriParams.md#dbname) -- [deepAttributes](verida_types.FetchUriParams.md#deepattributes) -- [did](verida_types.FetchUriParams.md#did) -- [query](verida_types.FetchUriParams.md#query) -- [recordId](verida_types.FetchUriParams.md#recordid) - -## Properties - -### contextName - -• **contextName**: `string` - -#### Defined in - -[packages/types/src/NetworkInterfaces.ts:94](https://github.com/verida/verida-js/blob/5040472/packages/types/src/NetworkInterfaces.ts#L94) - -___ - -### dbName - -• **dbName**: `string` - -#### Defined in - -[packages/types/src/NetworkInterfaces.ts:95](https://github.com/verida/verida-js/blob/5040472/packages/types/src/NetworkInterfaces.ts#L95) - -___ - -### deepAttributes - -• **deepAttributes**: `string`[] - -#### Defined in - -[packages/types/src/NetworkInterfaces.ts:97](https://github.com/verida/verida-js/blob/5040472/packages/types/src/NetworkInterfaces.ts#L97) - -___ - -### did - -• **did**: `string` - -#### Defined in - -[packages/types/src/NetworkInterfaces.ts:93](https://github.com/verida/verida-js/blob/5040472/packages/types/src/NetworkInterfaces.ts#L93) - -___ - -### query - -• **query**: `any` - -#### Defined in - -[packages/types/src/NetworkInterfaces.ts:98](https://github.com/verida/verida-js/blob/5040472/packages/types/src/NetworkInterfaces.ts#L98) - -___ - -### recordId - -• **recordId**: `string` - -#### Defined in - -[packages/types/src/NetworkInterfaces.ts:96](https://github.com/verida/verida-js/blob/5040472/packages/types/src/NetworkInterfaces.ts#L96) diff --git a/docs/api/verida-js/interfaces/verida_types.IAccount.md b/docs/api/verida-js/interfaces/verida_types.IAccount.md deleted file mode 100644 index fe543fc..0000000 --- a/docs/api/verida-js/interfaces/verida_types.IAccount.md +++ /dev/null @@ -1,266 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/types](../modules/verida_types.md) / IAccount - -# Interface: IAccount - -[@verida/types](../modules/verida_types.md).IAccount - -## Table of contents - -### Methods - -- [createDidJwt](verida_types.IAccount.md#createdidjwt) -- [did](verida_types.IAccount.md#did) -- [disconnect](verida_types.IAccount.md#disconnect) -- [disconnectDevice](verida_types.IAccount.md#disconnectdevice) -- [getAuthContext](verida_types.IAccount.md#getauthcontext) -- [keyring](verida_types.IAccount.md#keyring) -- [linkStorage](verida_types.IAccount.md#linkstorage) -- [linkStorageContextService](verida_types.IAccount.md#linkstoragecontextservice) -- [setAccountConfig](verida_types.IAccount.md#setaccountconfig) -- [sign](verida_types.IAccount.md#sign) -- [storageConfig](verida_types.IAccount.md#storageconfig) -- [unlinkStorage](verida_types.IAccount.md#unlinkstorage) - -## Methods - -### createDidJwt - -▸ **createDidJwt**(`contextName`, `data`, `config`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | -| `data` | `object` | -| `config` | `any` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -[packages/types/src/IAccount.ts:24](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IAccount.ts#L24) - -___ - -### did - -▸ **did**(): `Promise`<`string`\> - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -[packages/types/src/IAccount.ts:12](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IAccount.ts#L12) - -___ - -### disconnect - -▸ **disconnect**(`contextName?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName?` | `string` | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -[packages/types/src/IAccount.ts:26](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IAccount.ts#L26) - -___ - -### disconnectDevice - -▸ **disconnectDevice**(`contextName`, `deviceId`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | -| `deviceId` | `string` | - -#### Returns - -`Promise`<`boolean`\> - -#### Defined in - -[packages/types/src/IAccount.ts:30](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IAccount.ts#L30) - -___ - -### getAuthContext - -▸ **getAuthContext**(`contextName`, `contextConfig`, `authConfig?`, `authType?`): `Promise`<[`AuthContext`](verida_types.AuthContext.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | -| `contextConfig` | [`SecureContextConfig`](verida_types.SecureContextConfig.md) | -| `authConfig?` | [`AuthTypeConfig`](verida_types.AuthTypeConfig.md) | -| `authType?` | `string` | - -#### Returns - -`Promise`<[`AuthContext`](verida_types.AuthContext.md)\> - -#### Defined in - -[packages/types/src/IAccount.ts:28](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IAccount.ts#L28) - -___ - -### keyring - -▸ **keyring**(`contextName`): `Promise`<[`IKeyring`](verida_types.IKeyring.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | - -#### Returns - -`Promise`<[`IKeyring`](verida_types.IKeyring.md)\> - -#### Defined in - -[packages/types/src/IAccount.ts:8](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IAccount.ts#L8) - -___ - -### linkStorage - -▸ **linkStorage**(`storageConfig`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `storageConfig` | [`SecureContextConfig`](verida_types.SecureContextConfig.md) | - -#### Returns - -`Promise`<`boolean`\> - -#### Defined in - -[packages/types/src/IAccount.ts:14](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IAccount.ts#L14) - -___ - -### linkStorageContextService - -▸ **linkStorageContextService**(`contextName`, `endpointType`, `serverType`, `endpointUris`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | -| `endpointType` | `string` | -| `serverType` | `string` | -| `endpointUris` | `string`[] | - -#### Returns - -`Promise`<`boolean`\> - -#### Defined in - -[packages/types/src/IAccount.ts:20](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IAccount.ts#L20) - -___ - -### setAccountConfig - -▸ **setAccountConfig**(`accountConfig`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `accountConfig` | [`AccountConfig`](verida_types.AccountConfig.md) | - -#### Returns - -`void` - -#### Defined in - -[packages/types/src/IAccount.ts:22](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IAccount.ts#L22) - -___ - -### sign - -▸ **sign**(`input`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `input` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -[packages/types/src/IAccount.ts:10](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IAccount.ts#L10) - -___ - -### storageConfig - -▸ **storageConfig**(`contextName`, `forceCreate`): `Promise`<`undefined` \| [`SecureContextConfig`](verida_types.SecureContextConfig.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | -| `forceCreate` | `boolean` | - -#### Returns - -`Promise`<`undefined` \| [`SecureContextConfig`](verida_types.SecureContextConfig.md)\> - -#### Defined in - -[packages/types/src/IAccount.ts:18](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IAccount.ts#L18) - -___ - -### unlinkStorage - -▸ **unlinkStorage**(`contextName`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | - -#### Returns - -`Promise`<`boolean`\> - -#### Defined in - -[packages/types/src/IAccount.ts:16](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IAccount.ts#L16) diff --git a/docs/api/verida-js/interfaces/verida_types.IAuthType.md b/docs/api/verida-js/interfaces/verida_types.IAuthType.md deleted file mode 100644 index 2242d95..0000000 --- a/docs/api/verida-js/interfaces/verida_types.IAuthType.md +++ /dev/null @@ -1,73 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/types](../modules/verida_types.md) / IAuthType - -# Interface: IAuthType - -[@verida/types](../modules/verida_types.md).IAuthType - -## Table of contents - -### Methods - -- [disconnectDevice](verida_types.IAuthType.md#disconnectdevice) -- [getAuthContext](verida_types.IAuthType.md#getauthcontext) -- [setAuthContext](verida_types.IAuthType.md#setauthcontext) - -## Methods - -### disconnectDevice - -▸ **disconnectDevice**(`deviceId`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `deviceId` | `string` | - -#### Returns - -`Promise`<`boolean`\> - -#### Defined in - -[packages/types/src/IAuthType.ts:8](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IAuthType.ts#L8) - -___ - -### getAuthContext - -▸ **getAuthContext**(`config`): `Promise`<[`AuthContext`](verida_types.AuthContext.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | [`AuthTypeConfig`](verida_types.AuthTypeConfig.md) | - -#### Returns - -`Promise`<[`AuthContext`](verida_types.AuthContext.md)\> - -#### Defined in - -[packages/types/src/IAuthType.ts:4](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IAuthType.ts#L4) - -___ - -### setAuthContext - -▸ **setAuthContext**(`contextAuth`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextAuth` | [`AuthContext`](verida_types.AuthContext.md) | - -#### Returns - -`void` - -#### Defined in - -[packages/types/src/IAuthType.ts:6](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IAuthType.ts#L6) diff --git a/docs/api/verida-js/interfaces/verida_types.IClient.md b/docs/api/verida-js/interfaces/verida_types.IClient.md deleted file mode 100644 index f7de36e..0000000 --- a/docs/api/verida-js/interfaces/verida_types.IClient.md +++ /dev/null @@ -1,179 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/types](../modules/verida_types.md) / IClient - -# Interface: IClient - -[@verida/types](../modules/verida_types.md).IClient - -## Table of contents - -### Methods - -- [connect](verida_types.IClient.md#connect) -- [getContextConfig](verida_types.IClient.md#getcontextconfig) -- [getSchema](verida_types.IClient.md#getschema) -- [getValidDataSignatures](verida_types.IClient.md#getvaliddatasignatures) -- [isConnected](verida_types.IClient.md#isconnected) -- [openContext](verida_types.IClient.md#opencontext) -- [openExternalContext](verida_types.IClient.md#openexternalcontext) -- [openPublicProfile](verida_types.IClient.md#openpublicprofile) - -## Methods - -### connect - -▸ **connect**(`account`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `account` | [`IAccount`](verida_types.IAccount.md) | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -[packages/types/src/IClient.ts:8](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IClient.ts#L8) - -___ - -### getContextConfig - -▸ **getContextConfig**(`did`, `contextName`): `Promise`<`undefined` \| [`SecureContextConfig`](verida_types.SecureContextConfig.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did` | `string` | -| `contextName` | `string` | - -#### Returns - -`Promise`<`undefined` \| [`SecureContextConfig`](verida_types.SecureContextConfig.md)\> - -#### Defined in - -[packages/types/src/IClient.ts:19](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IClient.ts#L19) - -___ - -### getSchema - -▸ **getSchema**(`schemaUri`): `Promise`<[`ISchema`](verida_types.ISchema.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schemaUri` | `string` | - -#### Returns - -`Promise`<[`ISchema`](verida_types.ISchema.md)\> - -#### Defined in - -[packages/types/src/IClient.ts:36](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IClient.ts#L36) - -___ - -### getValidDataSignatures - -▸ **getValidDataSignatures**(`data`, `did?`): `Promise`<`string`[]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `any` | -| `did?` | `string` | - -#### Returns - -`Promise`<`string`[]\> - -#### Defined in - -[packages/types/src/IClient.ts:31](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IClient.ts#L31) - -___ - -### isConnected - -▸ **isConnected**(): `void` - -#### Returns - -`void` - -#### Defined in - -[packages/types/src/IClient.ts:10](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IClient.ts#L10) - -___ - -### openContext - -▸ **openContext**(`contextName`, `forceCreate`): `Promise`<`undefined` \| [`IContext`](verida_types.IContext.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | -| `forceCreate` | `boolean` | - -#### Returns - -`Promise`<`undefined` \| [`IContext`](verida_types.IContext.md)\> - -#### Defined in - -[packages/types/src/IClient.ts:12](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IClient.ts#L12) - -___ - -### openExternalContext - -▸ **openExternalContext**(`contextName`, `did`): `Promise`<[`IContext`](verida_types.IContext.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | -| `did` | `string` | - -#### Returns - -`Promise`<[`IContext`](verida_types.IContext.md)\> - -#### Defined in - -[packages/types/src/IClient.ts:17](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IClient.ts#L17) - -___ - -### openPublicProfile - -▸ **openPublicProfile**(`did`, `contextName`, `profileName`, `fallbackContext`): `Promise`<`undefined` \| [`IProfile`](verida_types.IProfile.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did` | `string` | -| `contextName` | `string` | -| `profileName` | `string` | -| `fallbackContext` | ``null`` \| `string` | - -#### Returns - -`Promise`<`undefined` \| [`IProfile`](verida_types.IProfile.md)\> - -#### Defined in - -[packages/types/src/IClient.ts:24](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IClient.ts#L24) diff --git a/docs/api/verida-js/interfaces/verida_types.IContext.md b/docs/api/verida-js/interfaces/verida_types.IContext.md deleted file mode 100644 index 4a0702c..0000000 --- a/docs/api/verida-js/interfaces/verida_types.IContext.md +++ /dev/null @@ -1,402 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/types](../modules/verida_types.md) / IContext - -# Interface: IContext - -[@verida/types](../modules/verida_types.md).IContext - -## Table of contents - -### Methods - -- [addEndpoint](verida_types.IContext.md#addendpoint) -- [clearDatabaseCache](verida_types.IContext.md#cleardatabasecache) -- [close](verida_types.IContext.md#close) -- [disconnect](verida_types.IContext.md#disconnect) -- [getAccount](verida_types.IContext.md#getaccount) -- [getAuthContext](verida_types.IContext.md#getauthcontext) -- [getClient](verida_types.IContext.md#getclient) -- [getContextConfig](verida_types.IContext.md#getcontextconfig) -- [getContextName](verida_types.IContext.md#getcontextname) -- [getDatabaseEngine](verida_types.IContext.md#getdatabaseengine) -- [getDbRegistry](verida_types.IContext.md#getdbregistry) -- [getDidContextManager](verida_types.IContext.md#getdidcontextmanager) -- [getMessaging](verida_types.IContext.md#getmessaging) -- [getNotification](verida_types.IContext.md#getnotification) -- [info](verida_types.IContext.md#info) -- [openDatabase](verida_types.IContext.md#opendatabase) -- [openDatastore](verida_types.IContext.md#opendatastore) -- [openExternalDatabase](verida_types.IContext.md#openexternaldatabase) -- [openExternalDatastore](verida_types.IContext.md#openexternaldatastore) -- [openProfile](verida_types.IContext.md#openprofile) - -## Methods - -### addEndpoint - -▸ **addEndpoint**(`engineType`, `endpointUri`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `engineType` | [`ContextEngineType`](../enums/verida_types.ContextEngineType.md) | -| `endpointUri` | `string` | - -#### Returns - -`void` - -#### Defined in - -[packages/types/src/IContext.ts:77](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IContext.ts#L77) - -___ - -### clearDatabaseCache - -▸ **clearDatabaseCache**(`did`, `databaseName`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did` | `string` | -| `databaseName` | `string` | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -[packages/types/src/IContext.ts:81](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IContext.ts#L81) - -___ - -### close - -▸ **close**(`options?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options?` | [`ContextCloseOptions`](verida_types.ContextCloseOptions.md) | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -[packages/types/src/IContext.ts:79](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IContext.ts#L79) - -___ - -### disconnect - -▸ **disconnect**(): `Promise`<`boolean`\> - -#### Returns - -`Promise`<`boolean`\> - -#### Defined in - -[packages/types/src/IContext.ts:30](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IContext.ts#L30) - -___ - -### getAccount - -▸ **getAccount**(): [`IAccount`](verida_types.IAccount.md) - -#### Returns - -[`IAccount`](verida_types.IAccount.md) - -#### Defined in - -[packages/types/src/IContext.ts:24](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IContext.ts#L24) - -___ - -### getAuthContext - -▸ **getAuthContext**(`authConfig?`, `authType?`): `Promise`<[`AuthContext`](verida_types.AuthContext.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `authConfig?` | [`AuthTypeConfig`](verida_types.AuthTypeConfig.md) | -| `authType?` | `string` | - -#### Returns - -`Promise`<[`AuthContext`](verida_types.AuthContext.md)\> - -#### Defined in - -[packages/types/src/IContext.ts:75](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IContext.ts#L75) - -___ - -### getClient - -▸ **getClient**(): [`IClient`](verida_types.IClient.md) - -#### Returns - -[`IClient`](verida_types.IClient.md) - -#### Defined in - -[packages/types/src/IContext.ts:28](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IContext.ts#L28) - -___ - -### getContextConfig - -▸ **getContextConfig**(`did?`, `forceCreate?`, `customContextName?`): `Promise`<[`SecureContextConfig`](verida_types.SecureContextConfig.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did?` | `string` | -| `forceCreate?` | `boolean` | -| `customContextName?` | `string` | - -#### Returns - -`Promise`<[`SecureContextConfig`](verida_types.SecureContextConfig.md)\> - -#### Defined in - -[packages/types/src/IContext.ts:16](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IContext.ts#L16) - -___ - -### getContextName - -▸ **getContextName**(): `string` - -#### Returns - -`string` - -#### Defined in - -[packages/types/src/IContext.ts:22](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IContext.ts#L22) - -___ - -### getDatabaseEngine - -▸ **getDatabaseEngine**(`did`, `createContext?`): `Promise`<[`IStorageEngine`](verida_types.IStorageEngine.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did` | `string` | -| `createContext?` | `boolean` | - -#### Returns - -`Promise`<[`IStorageEngine`](verida_types.IStorageEngine.md)\> - -#### Defined in - -[packages/types/src/IContext.ts:32](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IContext.ts#L32) - -___ - -### getDbRegistry - -▸ **getDbRegistry**(): [`IDbRegistry`](verida_types.IDbRegistry.md) - -#### Returns - -[`IDbRegistry`](verida_types.IDbRegistry.md) - -#### Defined in - -[packages/types/src/IContext.ts:71](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IContext.ts#L71) - -___ - -### getDidContextManager - -▸ **getDidContextManager**(): [`IDIDContextManager`](verida_types.IDIDContextManager.md) - -#### Returns - -[`IDIDContextManager`](verida_types.IDIDContextManager.md) - -#### Defined in - -[packages/types/src/IContext.ts:26](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IContext.ts#L26) - -___ - -### getMessaging - -▸ **getMessaging**(`messageConfig`): `Promise`<[`IMessaging`](verida_types.IMessaging.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `messageConfig` | [`MessagesConfig`](verida_types.MessagesConfig.md) | - -#### Returns - -`Promise`<[`IMessaging`](verida_types.IMessaging.md)\> - -#### Defined in - -[packages/types/src/IContext.ts:37](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IContext.ts#L37) - -___ - -### getNotification - -▸ **getNotification**(`did`, `contextName`): `Promise`<`undefined` \| [`INotification`](verida_types.INotification.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did` | `string` | -| `contextName` | `string` | - -#### Returns - -`Promise`<`undefined` \| [`INotification`](verida_types.INotification.md)\> - -#### Defined in - -[packages/types/src/IContext.ts:39](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IContext.ts#L39) - -___ - -### info - -▸ **info**(): `Promise`<[`ContextInfo`](verida_types.ContextInfo.md)\> - -#### Returns - -`Promise`<[`ContextInfo`](verida_types.ContextInfo.md)\> - -#### Defined in - -[packages/types/src/IContext.ts:73](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IContext.ts#L73) - -___ - -### openDatabase - -▸ **openDatabase**(`databaseName`, `config?`): `Promise`<[`IDatabase`](verida_types.IDatabase.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `databaseName` | `string` | -| `config?` | [`DatabaseOpenConfig`](verida_types.DatabaseOpenConfig.md) | - -#### Returns - -`Promise`<[`IDatabase`](verida_types.IDatabase.md)\> - -#### Defined in - -[packages/types/src/IContext.ts:46](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IContext.ts#L46) - -___ - -### openDatastore - -▸ **openDatastore**(`schemaUri`, `config?`): `Promise`<[`IDatastore`](verida_types.IDatastore.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schemaUri` | `string` | -| `config?` | [`DatastoreOpenConfig`](verida_types.DatastoreOpenConfig.md) | - -#### Returns - -`Promise`<[`IDatastore`](verida_types.IDatastore.md)\> - -#### Defined in - -[packages/types/src/IContext.ts:59](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IContext.ts#L59) - -___ - -### openExternalDatabase - -▸ **openExternalDatabase**(`databaseName`, `did`, `config?`): `Promise`<[`IDatabase`](verida_types.IDatabase.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `databaseName` | `string` | -| `did` | `string` | -| `config?` | [`DatabaseOpenConfig`](verida_types.DatabaseOpenConfig.md) | - -#### Returns - -`Promise`<[`IDatabase`](verida_types.IDatabase.md)\> - -#### Defined in - -[packages/types/src/IContext.ts:52](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IContext.ts#L52) - -___ - -### openExternalDatastore - -▸ **openExternalDatastore**(`schemaUri`, `did`, `options?`): `Promise`<[`IDatastore`](verida_types.IDatastore.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schemaUri` | `string` | -| `did` | `string` | -| `options?` | [`DatastoreOpenConfig`](verida_types.DatastoreOpenConfig.md) | - -#### Returns - -`Promise`<[`IDatastore`](verida_types.IDatastore.md)\> - -#### Defined in - -[packages/types/src/IContext.ts:65](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IContext.ts#L65) - -___ - -### openProfile - -▸ **openProfile**(`profileName?`, `did?`): `Promise`<`undefined` \| [`IProfile`](verida_types.IProfile.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `profileName?` | `string` | -| `did?` | `string` | - -#### Returns - -`Promise`<`undefined` \| [`IProfile`](verida_types.IProfile.md)\> - -#### Defined in - -[packages/types/src/IContext.ts:41](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IContext.ts#L41) diff --git a/docs/api/verida-js/interfaces/verida_types.IDIDClient.md b/docs/api/verida-js/interfaces/verida_types.IDIDClient.md deleted file mode 100644 index 6ed9ad8..0000000 --- a/docs/api/verida-js/interfaces/verida_types.IDIDClient.md +++ /dev/null @@ -1,151 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/types](../modules/verida_types.md) / IDIDClient - -# Interface: IDIDClient - -[@verida/types](../modules/verida_types.md).IDIDClient - -## Table of contents - -### Methods - -- [authenticate](verida_types.IDIDClient.md#authenticate) -- [authenticated](verida_types.IDIDClient.md#authenticated) -- [get](verida_types.IDIDClient.md#get) -- [getDid](verida_types.IDIDClient.md#getdid) -- [getLastEndpointErrors](verida_types.IDIDClient.md#getlastendpointerrors) -- [getPublicKey](verida_types.IDIDClient.md#getpublickey) -- [getRpcUrl](verida_types.IDIDClient.md#getrpcurl) -- [save](verida_types.IDIDClient.md#save) - -## Methods - -### authenticate - -▸ **authenticate**(`veridaPrivateKey`, `callType`, `web3Config`, `defaultEndpoints`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `veridaPrivateKey` | `string` | -| `callType` | [`Web3CallType`](../modules/verida_types.md#web3calltype) | -| `web3Config` | [`Web3MetaTransactionConfig`](verida_types.Web3MetaTransactionConfig.md) \| [`Web3SelfTransactionConfigPart`](verida_types.Web3SelfTransactionConfigPart.md) | -| `defaultEndpoints` | `string`[] | - -#### Returns - -`void` - -#### Defined in - -[packages/types/src/IDIDClient.ts:6](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IDIDClient.ts#L6) - -___ - -### authenticated - -▸ **authenticated**(): `boolean` - -#### Returns - -`boolean` - -#### Defined in - -[packages/types/src/IDIDClient.ts:13](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IDIDClient.ts#L13) - -___ - -### get - -▸ **get**(`did`): `Promise`<[`IDIDDocument`](verida_types.IDIDDocument.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did` | `string` | - -#### Returns - -`Promise`<[`IDIDDocument`](verida_types.IDIDDocument.md)\> - -#### Defined in - -[packages/types/src/IDIDClient.ts:23](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IDIDClient.ts#L23) - -___ - -### getDid - -▸ **getDid**(): `undefined` \| `string` - -#### Returns - -`undefined` \| `string` - -#### Defined in - -[packages/types/src/IDIDClient.ts:15](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IDIDClient.ts#L15) - -___ - -### getLastEndpointErrors - -▸ **getLastEndpointErrors**(): [`VdaDidEndpointResponses`](../modules/verida_types.md#vdadidendpointresponses) - -#### Returns - -[`VdaDidEndpointResponses`](../modules/verida_types.md#vdadidendpointresponses) - -#### Defined in - -[packages/types/src/IDIDClient.ts:21](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IDIDClient.ts#L21) - -___ - -### getPublicKey - -▸ **getPublicKey**(): `undefined` \| `string` - -#### Returns - -`undefined` \| `string` - -#### Defined in - -[packages/types/src/IDIDClient.ts:17](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IDIDClient.ts#L17) - -___ - -### getRpcUrl - -▸ **getRpcUrl**(): `string` - -#### Returns - -`string` - -#### Defined in - -[packages/types/src/IDIDClient.ts:25](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IDIDClient.ts#L25) - -___ - -### save - -▸ **save**(`document`): `Promise`<[`VdaDidEndpointResponses`](../modules/verida_types.md#vdadidendpointresponses)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `document` | [`IDIDDocument`](verida_types.IDIDDocument.md) | - -#### Returns - -`Promise`<[`VdaDidEndpointResponses`](../modules/verida_types.md#vdadidendpointresponses)\> - -#### Defined in - -[packages/types/src/IDIDClient.ts:19](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IDIDClient.ts#L19) diff --git a/docs/api/verida-js/interfaces/verida_types.IDIDContextManager.md b/docs/api/verida-js/interfaces/verida_types.IDIDContextManager.md deleted file mode 100644 index 7e462c0..0000000 --- a/docs/api/verida-js/interfaces/verida_types.IDIDContextManager.md +++ /dev/null @@ -1,145 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/types](../modules/verida_types.md) / IDIDContextManager - -# Interface: IDIDContextManager - -[@verida/types](../modules/verida_types.md).IDIDContextManager - -## Table of contents - -### Methods - -- [getContextDatabaseServer](verida_types.IDIDContextManager.md#getcontextdatabaseserver) -- [getContextMessageServer](verida_types.IDIDContextManager.md#getcontextmessageserver) -- [getContextStorageServer](verida_types.IDIDContextManager.md#getcontextstorageserver) -- [getDIDContextConfig](verida_types.IDIDContextManager.md#getdidcontextconfig) -- [getDIDContextHashConfig](verida_types.IDIDContextManager.md#getdidcontexthashconfig) -- [setAccount](verida_types.IDIDContextManager.md#setaccount) - -## Methods - -### getContextDatabaseServer - -▸ **getContextDatabaseServer**(`did`, `contextName`, `forceCreate`): `Promise`<[`SecureContextEndpoint`](verida_types.SecureContextEndpoint.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did` | `string` | -| `contextName` | `string` | -| `forceCreate` | `boolean` | - -#### Returns - -`Promise`<[`SecureContextEndpoint`](verida_types.SecureContextEndpoint.md)\> - -#### Defined in - -[packages/types/src/IDIDContextManager.ts:9](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IDIDContextManager.ts#L9) - -___ - -### getContextMessageServer - -▸ **getContextMessageServer**(`did`, `contextName`, `forceCreate`): `Promise`<[`SecureContextEndpoint`](verida_types.SecureContextEndpoint.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did` | `string` | -| `contextName` | `string` | -| `forceCreate` | `boolean` | - -#### Returns - -`Promise`<[`SecureContextEndpoint`](verida_types.SecureContextEndpoint.md)\> - -#### Defined in - -[packages/types/src/IDIDContextManager.ts:21](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IDIDContextManager.ts#L21) - -___ - -### getContextStorageServer - -▸ **getContextStorageServer**(`did`, `contextName`, `forceCreate`): `Promise`<[`SecureContextEndpoint`](verida_types.SecureContextEndpoint.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did` | `string` | -| `contextName` | `string` | -| `forceCreate` | `boolean` | - -#### Returns - -`Promise`<[`SecureContextEndpoint`](verida_types.SecureContextEndpoint.md)\> - -#### Defined in - -[packages/types/src/IDIDContextManager.ts:15](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IDIDContextManager.ts#L15) - -___ - -### getDIDContextConfig - -▸ **getDIDContextConfig**(`did`, `contextName`, `forceCreate?`): `Promise`<[`SecureContextConfig`](verida_types.SecureContextConfig.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did` | `string` | -| `contextName` | `string` | -| `forceCreate?` | `boolean` | - -#### Returns - -`Promise`<[`SecureContextConfig`](verida_types.SecureContextConfig.md)\> - -#### Defined in - -[packages/types/src/IDIDContextManager.ts:29](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IDIDContextManager.ts#L29) - -___ - -### getDIDContextHashConfig - -▸ **getDIDContextHashConfig**(`did`, `contextHash`): `Promise`<[`SecureContextConfig`](verida_types.SecureContextConfig.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did` | `string` | -| `contextHash` | `string` | - -#### Returns - -`Promise`<[`SecureContextConfig`](verida_types.SecureContextConfig.md)\> - -#### Defined in - -[packages/types/src/IDIDContextManager.ts:27](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IDIDContextManager.ts#L27) - -___ - -### setAccount - -▸ **setAccount**(`account`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `account` | [`IAccount`](verida_types.IAccount.md) | - -#### Returns - -`void` - -#### Defined in - -[packages/types/src/IDIDContextManager.ts:7](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IDIDContextManager.ts#L7) diff --git a/docs/api/verida-js/interfaces/verida_types.IDIDDocument.md b/docs/api/verida-js/interfaces/verida_types.IDIDDocument.md deleted file mode 100644 index c243b9e..0000000 --- a/docs/api/verida-js/interfaces/verida_types.IDIDDocument.md +++ /dev/null @@ -1,360 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/types](../modules/verida_types.md) / IDIDDocument - -# Interface: IDIDDocument - -[@verida/types](../modules/verida_types.md).IDIDDocument - -## Table of contents - -### Accessors - -- [id](verida_types.IDIDDocument.md#id) - -### Methods - -- [addContext](verida_types.IDIDDocument.md#addcontext) -- [addContextAsymKey](verida_types.IDIDDocument.md#addcontextasymkey) -- [addContextService](verida_types.IDIDDocument.md#addcontextservice) -- [addContextSignKey](verida_types.IDIDDocument.md#addcontextsignkey) -- [buildTimestamp](verida_types.IDIDDocument.md#buildtimestamp) -- [export](verida_types.IDIDDocument.md#export) -- [getErrors](verida_types.IDIDDocument.md#geterrors) -- [import](verida_types.IDIDDocument.md#import) -- [locateContextProof](verida_types.IDIDDocument.md#locatecontextproof) -- [locateServiceEndpoint](verida_types.IDIDDocument.md#locateserviceendpoint) -- [removeContext](verida_types.IDIDDocument.md#removecontext) -- [setAttributes](verida_types.IDIDDocument.md#setattributes) -- [signProof](verida_types.IDIDDocument.md#signproof) -- [verifyContextSignature](verida_types.IDIDDocument.md#verifycontextsignature) -- [verifyProof](verida_types.IDIDDocument.md#verifyproof) -- [verifySig](verida_types.IDIDDocument.md#verifysig) - -## Accessors - -### id - -• `get` **id**(): `string` - -#### Returns - -`string` - -#### Defined in - -[packages/types/src/IDIDDocument.ts:6](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IDIDDocument.ts#L6) - -## Methods - -### addContext - -▸ **addContext**(`contextName`, `keyring`, `privateKey`, `endpoints`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | -| `keyring` | [`IKeyring`](verida_types.IKeyring.md) | -| `privateKey` | `string` | -| `endpoints` | [`SecureContextEndpoints`](verida_types.SecureContextEndpoints.md) | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -[packages/types/src/IDIDDocument.ts:10](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IDIDDocument.ts#L10) - -___ - -### addContextAsymKey - -▸ **addContextAsymKey**(`contextHash`, `publicKeyHex`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextHash` | `string` | -| `publicKeyHex` | `string` | - -#### Returns - -`void` - -#### Defined in - -[packages/types/src/IDIDDocument.ts:24](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IDIDDocument.ts#L24) - -___ - -### addContextService - -▸ **addContextService**(`contextHash`, `endpointType`, `serviceType`, `endpointUris`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextHash` | `string` | -| `endpointType` | [`SecureContextEndpointType`](../enums/verida_types.SecureContextEndpointType.md) | -| `serviceType` | `string` | -| `endpointUris` | [`ServiceEndpoint`](../modules/verida_types._internal_.md#serviceendpoint)[] | - -#### Returns - -`void` - -#### Defined in - -[packages/types/src/IDIDDocument.ts:20](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IDIDDocument.ts#L20) - -___ - -### addContextSignKey - -▸ **addContextSignKey**(`contextHash`, `publicKeyHex`, `proof`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextHash` | `string` | -| `publicKeyHex` | `string` | -| `proof` | `string` | - -#### Returns - -`void` - -#### Defined in - -[packages/types/src/IDIDDocument.ts:22](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IDIDDocument.ts#L22) - -___ - -### buildTimestamp - -▸ **buildTimestamp**(`date`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `date` | `Date` | - -#### Returns - -`string` - -#### Defined in - -[packages/types/src/IDIDDocument.ts:38](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IDIDDocument.ts#L38) - -___ - -### export - -▸ **export**(): [`VeridaDocInterface`](verida_types.VeridaDocInterface.md) - -#### Returns - -[`VeridaDocInterface`](verida_types.VeridaDocInterface.md) - -#### Defined in - -[packages/types/src/IDIDDocument.ts:18](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IDIDDocument.ts#L18) - -___ - -### getErrors - -▸ **getErrors**(): `string`[] - -#### Returns - -`string`[] - -#### Defined in - -[packages/types/src/IDIDDocument.ts:8](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IDIDDocument.ts#L8) - -___ - -### import - -▸ **import**(`doc`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `doc` | [`VeridaDocInterface`](verida_types.VeridaDocInterface.md) | - -#### Returns - -`void` - -#### Defined in - -[packages/types/src/IDIDDocument.ts:16](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IDIDDocument.ts#L16) - -___ - -### locateContextProof - -▸ **locateContextProof**(`contextName`): `undefined` \| `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | - -#### Returns - -`undefined` \| `string` - -#### Defined in - -[packages/types/src/IDIDDocument.ts:32](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IDIDDocument.ts#L32) - -___ - -### locateServiceEndpoint - -▸ **locateServiceEndpoint**(`contextName`, `endpointType`): `undefined` \| [`Service`](verida_types._internal_.Service.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | -| `endpointType` | [`SecureContextEndpointType`](../enums/verida_types.SecureContextEndpointType.md) | - -#### Returns - -`undefined` \| [`Service`](verida_types._internal_.Service.md) - -#### Defined in - -[packages/types/src/IDIDDocument.ts:30](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IDIDDocument.ts#L30) - -___ - -### removeContext - -▸ **removeContext**(`contextName`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | - -#### Returns - -`boolean` - -#### Defined in - -[packages/types/src/IDIDDocument.ts:12](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IDIDDocument.ts#L12) - -___ - -### setAttributes - -▸ **setAttributes**(`attributes`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `attributes` | [`Record`](../modules/verida_types._internal_.md#record)<`string`, `any`\> | - -#### Returns - -`void` - -#### Defined in - -[packages/types/src/IDIDDocument.ts:14](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IDIDDocument.ts#L14) - -___ - -### signProof - -▸ **signProof**(`privateKey`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `privateKey` | `string` \| `Uint8Array` | - -#### Returns - -`void` - -#### Defined in - -[packages/types/src/IDIDDocument.ts:34](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IDIDDocument.ts#L34) - -___ - -### verifyContextSignature - -▸ **verifyContextSignature**(`data`, `contextName`, `signature`, `contextIsHash`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `any` | -| `contextName` | `string` | -| `signature` | `string` | -| `contextIsHash` | `boolean` | - -#### Returns - -`boolean` - -#### Defined in - -[packages/types/src/IDIDDocument.ts:28](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IDIDDocument.ts#L28) - -___ - -### verifyProof - -▸ **verifyProof**(): `boolean` - -#### Returns - -`boolean` - -#### Defined in - -[packages/types/src/IDIDDocument.ts:36](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IDIDDocument.ts#L36) - -___ - -### verifySig - -▸ **verifySig**(`data`, `signature`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `any` | -| `signature` | `string` | - -#### Returns - -`boolean` - -#### Defined in - -[packages/types/src/IDIDDocument.ts:26](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IDIDDocument.ts#L26) diff --git a/docs/api/verida-js/interfaces/verida_types.IDatabase.md b/docs/api/verida-js/interfaces/verida_types.IDatabase.md deleted file mode 100644 index 33690fe..0000000 --- a/docs/api/verida-js/interfaces/verida_types.IDatabase.md +++ /dev/null @@ -1,261 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/types](../modules/verida_types.md) / IDatabase - -# Interface: IDatabase - -[@verida/types](../modules/verida_types.md).IDatabase - -Interface for any database returned from a storage engine - -## Table of contents - -### Methods - -- [changes](verida_types.IDatabase.md#changes) -- [close](verida_types.IDatabase.md#close) -- [delete](verida_types.IDatabase.md#delete) -- [deleteAll](verida_types.IDatabase.md#deleteall) -- [destroy](verida_types.IDatabase.md#destroy) -- [get](verida_types.IDatabase.md#get) -- [getDb](verida_types.IDatabase.md#getdb) -- [getMany](verida_types.IDatabase.md#getmany) -- [info](verida_types.IDatabase.md#info) -- [registryEntry](verida_types.IDatabase.md#registryentry) -- [save](verida_types.IDatabase.md#save) -- [updateUsers](verida_types.IDatabase.md#updateusers) -- [usage](verida_types.IDatabase.md#usage) - -## Methods - -### changes - -▸ **changes**(`cb`, `options?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `cb` | `Function` | -| `options?` | `any` | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -[packages/types/src/IDatabase.ts:17](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IDatabase.ts#L17) - -___ - -### close - -▸ **close**(`options?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options?` | [`DatabaseCloseOptions`](verida_types.DatabaseCloseOptions.md) | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -[packages/types/src/IDatabase.ts:27](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IDatabase.ts#L27) - -___ - -### delete - -▸ **delete**(`doc`, `options?`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `doc` | `any` | -| `options?` | `any` | - -#### Returns - -`Promise`<`boolean`\> - -#### Defined in - -[packages/types/src/IDatabase.ts:13](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IDatabase.ts#L13) - -___ - -### deleteAll - -▸ **deleteAll**(): `Promise`<`void`\> - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -[packages/types/src/IDatabase.ts:15](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IDatabase.ts#L15) - -___ - -### destroy - -▸ **destroy**(`options?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options?` | [`DatabaseDeleteConfig`](verida_types.DatabaseDeleteConfig.md) | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -[packages/types/src/IDatabase.ts:29](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IDatabase.ts#L29) - -___ - -### get - -▸ **get**(`docId`, `options?`): `Promise`<`undefined` \| `object`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `docId` | `any` | -| `options?` | `any` | - -#### Returns - -`Promise`<`undefined` \| `object`\> - -#### Defined in - -[packages/types/src/IDatabase.ts:11](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IDatabase.ts#L11) - -___ - -### getDb - -▸ **getDb**(): `Promise`<`any`\> - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -[packages/types/src/IDatabase.ts:21](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IDatabase.ts#L21) - -___ - -### getMany - -▸ **getMany**(`filter?`, `options?`): `Promise`<`object`[]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `filter?` | `any` | -| `options?` | `any` | - -#### Returns - -`Promise`<`object`[]\> - -#### Defined in - -[packages/types/src/IDatabase.ts:9](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IDatabase.ts#L9) - -___ - -### info - -▸ **info**(): `Promise`<`any`\> - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -[packages/types/src/IDatabase.ts:23](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IDatabase.ts#L23) - -___ - -### registryEntry - -▸ **registryEntry**(): `Promise`<[`DbRegistryEntry`](verida_types.DbRegistryEntry.md)\> - -#### Returns - -`Promise`<[`DbRegistryEntry`](verida_types.DbRegistryEntry.md)\> - -#### Defined in - -[packages/types/src/IDatabase.ts:25](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IDatabase.ts#L25) - -___ - -### save - -▸ **save**(`data`, `options?`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `any` | -| `options?` | `any` | - -#### Returns - -`Promise`<`boolean`\> - -#### Defined in - -[packages/types/src/IDatabase.ts:7](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IDatabase.ts#L7) - -___ - -### updateUsers - -▸ **updateUsers**(`readList`, `writeList`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `readList` | `string`[] | -| `writeList` | `string`[] | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -[packages/types/src/IDatabase.ts:19](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IDatabase.ts#L19) - -___ - -### usage - -▸ **usage**(): `Promise`<[`EndpointUsage`](verida_types.EndpointUsage.md)\> - -#### Returns - -`Promise`<[`EndpointUsage`](verida_types.EndpointUsage.md)\> - -#### Defined in - -[packages/types/src/IDatabase.ts:31](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IDatabase.ts#L31) diff --git a/docs/api/verida-js/interfaces/verida_types.IDatastore.md b/docs/api/verida-js/interfaces/verida_types.IDatastore.md deleted file mode 100644 index 1f209ab..0000000 --- a/docs/api/verida-js/interfaces/verida_types.IDatastore.md +++ /dev/null @@ -1,249 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/types](../modules/verida_types.md) / IDatastore - -# Interface: IDatastore - -[@verida/types](../modules/verida_types.md).IDatastore - -## Table of contents - -### Properties - -- [errors](verida_types.IDatastore.md#errors) - -### Methods - -- [changes](verida_types.IDatastore.md#changes) -- [close](verida_types.IDatastore.md#close) -- [delete](verida_types.IDatastore.md#delete) -- [deleteAll](verida_types.IDatastore.md#deleteall) -- [ensureIndexes](verida_types.IDatastore.md#ensureindexes) -- [get](verida_types.IDatastore.md#get) -- [getDb](verida_types.IDatastore.md#getdb) -- [getMany](verida_types.IDatastore.md#getmany) -- [getOne](verida_types.IDatastore.md#getone) -- [save](verida_types.IDatastore.md#save) -- [updateUsers](verida_types.IDatastore.md#updateusers) - -## Properties - -### errors - -• **errors**: `any` - -#### Defined in - -[packages/types/src/IDatastore.ts:6](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IDatastore.ts#L6) - -## Methods - -### changes - -▸ **changes**(`cb`, `options`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `cb` | `any` | -| `options` | `any` | - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -[packages/types/src/IDatastore.ts:28](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IDatastore.ts#L28) - -___ - -### close - -▸ **close**(`options?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options?` | [`DatabaseCloseOptions`](verida_types.DatabaseCloseOptions.md) | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -[packages/types/src/IDatastore.ts:37](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IDatastore.ts#L37) - -___ - -### delete - -▸ **delete**(`docId`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `docId` | `string` | - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -[packages/types/src/IDatastore.ts:22](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IDatastore.ts#L22) - -___ - -### deleteAll - -▸ **deleteAll**(): `Promise`<`void`\> - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -[packages/types/src/IDatastore.ts:24](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IDatastore.ts#L24) - -___ - -### ensureIndexes - -▸ **ensureIndexes**(`indexes`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `indexes` | `any` | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -[packages/types/src/IDatastore.ts:30](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IDatastore.ts#L30) - -___ - -### get - -▸ **get**(`key`, `options`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `key` | `string` | -| `options` | `any` | - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -[packages/types/src/IDatastore.ts:20](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IDatastore.ts#L20) - -___ - -### getDb - -▸ **getDb**(): `Promise`<[`IDatabase`](verida_types.IDatabase.md)\> - -#### Returns - -`Promise`<[`IDatabase`](verida_types.IDatabase.md)\> - -#### Defined in - -[packages/types/src/IDatastore.ts:26](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IDatastore.ts#L26) - -___ - -### getMany - -▸ **getMany**(`customFilter?`, `options?`): `Promise`<`object`[]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `customFilter?` | `any` | -| `options?` | `any` | - -#### Returns - -`Promise`<`object`[]\> - -#### Defined in - -[packages/types/src/IDatastore.ts:10](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IDatastore.ts#L10) - -___ - -### getOne - -▸ **getOne**(`customFilter?`, `options?`): `Promise`<`undefined` \| `object`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `customFilter?` | `any` | -| `options?` | `any` | - -#### Returns - -`Promise`<`undefined` \| `object`\> - -#### Defined in - -[packages/types/src/IDatastore.ts:15](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IDatastore.ts#L15) - -___ - -### save - -▸ **save**(`data`, `options`): `Promise`<`boolean` \| `object`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `any` | -| `options` | `any` | - -#### Returns - -`Promise`<`boolean` \| `object`\> - -#### Defined in - -[packages/types/src/IDatastore.ts:8](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IDatastore.ts#L8) - -___ - -### updateUsers - -▸ **updateUsers**(`readList`, `writeList`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `readList` | `string`[] | -| `writeList` | `string`[] | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -[packages/types/src/IDatastore.ts:32](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IDatastore.ts#L32) diff --git a/docs/api/verida-js/interfaces/verida_types.IDbRegistry.md b/docs/api/verida-js/interfaces/verida_types.IDbRegistry.md deleted file mode 100644 index 6741ccf..0000000 --- a/docs/api/verida-js/interfaces/verida_types.IDbRegistry.md +++ /dev/null @@ -1,115 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/types](../modules/verida_types.md) / IDbRegistry - -# Interface: IDbRegistry - -[@verida/types](../modules/verida_types.md).IDbRegistry - -## Table of contents - -### Methods - -- [get](verida_types.IDbRegistry.md#get) -- [getMany](verida_types.IDbRegistry.md#getmany) -- [init](verida_types.IDbRegistry.md#init) -- [removeDb](verida_types.IDbRegistry.md#removedb) -- [saveDb](verida_types.IDbRegistry.md#savedb) - -## Methods - -### get - -▸ **get**(`dbName`, `did`, `contextName`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `dbName` | `string` | -| `did` | `string` | -| `contextName` | `string` | - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -[packages/types/src/IDbRegistry.ts:11](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IDbRegistry.ts#L11) - -___ - -### getMany - -▸ **getMany**(`filter`, `options`): `Promise`<`any`[]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `filter` | `any` | -| `options` | `any` | - -#### Returns - -`Promise`<`any`[]\> - -#### Defined in - -[packages/types/src/IDbRegistry.ts:9](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IDbRegistry.ts#L9) - -___ - -### init - -▸ **init**(): `Promise`<`void`\> - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -[packages/types/src/IDbRegistry.ts:17](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IDbRegistry.ts#L17) - -___ - -### removeDb - -▸ **removeDb**(`databaseName`, `did`, `contextName`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `databaseName` | `string` | -| `did` | `string` | -| `contextName` | `string` | - -#### Returns - -`Promise`<`boolean`\> - -#### Defined in - -[packages/types/src/IDbRegistry.ts:7](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IDbRegistry.ts#L7) - -___ - -### saveDb - -▸ **saveDb**(`database`, `checkPermissions`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `database` | [`IDatabase`](verida_types.IDatabase.md) | -| `checkPermissions` | `boolean` | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -[packages/types/src/IDbRegistry.ts:5](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IDbRegistry.ts#L5) diff --git a/docs/api/verida-js/interfaces/verida_types.IKeyring.md b/docs/api/verida-js/interfaces/verida_types.IKeyring.md deleted file mode 100644 index d00bcea..0000000 --- a/docs/api/verida-js/interfaces/verida_types.IKeyring.md +++ /dev/null @@ -1,262 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/types](../modules/verida_types.md) / IKeyring - -# Interface: IKeyring - -[@verida/types](../modules/verida_types.md).IKeyring - -## Table of contents - -### Methods - -- [\_init](verida_types.IKeyring.md#_init) -- [asymDecrypt](verida_types.IKeyring.md#asymdecrypt) -- [asymEncrypt](verida_types.IKeyring.md#asymencrypt) -- [buildSharedKeyEnd](verida_types.IKeyring.md#buildsharedkeyend) -- [buildSharedKeyStart](verida_types.IKeyring.md#buildsharedkeystart) -- [getKeys](verida_types.IKeyring.md#getkeys) -- [getSeed](verida_types.IKeyring.md#getseed) -- [getStorageContextKey](verida_types.IKeyring.md#getstoragecontextkey) -- [publicKeys](verida_types.IKeyring.md#publickeys) -- [sign](verida_types.IKeyring.md#sign) -- [symDecrypt](verida_types.IKeyring.md#symdecrypt) -- [symEncrypt](verida_types.IKeyring.md#symencrypt) -- [verifySig](verida_types.IKeyring.md#verifysig) - -## Methods - -### \_init - -▸ **_init**(): `Promise`<`void`\> - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -[packages/types/src/IKeyring.ts:5](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IKeyring.ts#L5) - -___ - -### asymDecrypt - -▸ **asymDecrypt**(`messageWithNonce`, `secretOrSharedKey`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `messageWithNonce` | `string` | -| `secretOrSharedKey` | `Uint8Array` | - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -[packages/types/src/IKeyring.ts:19](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IKeyring.ts#L19) - -___ - -### asymEncrypt - -▸ **asymEncrypt**(`data`, `secretOrSharedKey`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `string` | -| `secretOrSharedKey` | `Uint8Array` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -[packages/types/src/IKeyring.ts:17](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IKeyring.ts#L17) - -___ - -### buildSharedKeyEnd - -▸ **buildSharedKeyEnd**(`publicKey`): `Promise`<`Uint8Array`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `publicKey` | `Uint8Array` | - -#### Returns - -`Promise`<`Uint8Array`\> - -#### Defined in - -[packages/types/src/IKeyring.ts:23](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IKeyring.ts#L23) - -___ - -### buildSharedKeyStart - -▸ **buildSharedKeyStart**(`privateKey`): `Promise`<`Uint8Array`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `privateKey` | `Uint8Array` | - -#### Returns - -`Promise`<`Uint8Array`\> - -#### Defined in - -[packages/types/src/IKeyring.ts:21](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IKeyring.ts#L21) - -___ - -### getKeys - -▸ **getKeys**(): `Promise`<`any`\> - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -[packages/types/src/IKeyring.ts:3](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IKeyring.ts#L3) - -___ - -### getSeed - -▸ **getSeed**(): `string` - -#### Returns - -`string` - -#### Defined in - -[packages/types/src/IKeyring.ts:25](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IKeyring.ts#L25) - -___ - -### getStorageContextKey - -▸ **getStorageContextKey**(`databaseName`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `databaseName` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -[packages/types/src/IKeyring.ts:27](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IKeyring.ts#L27) - -___ - -### publicKeys - -▸ **publicKeys**(): `Promise`<[`KeyringPublicKeys`](verida_types.KeyringPublicKeys.md)\> - -#### Returns - -`Promise`<[`KeyringPublicKeys`](verida_types.KeyringPublicKeys.md)\> - -#### Defined in - -[packages/types/src/IKeyring.ts:7](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IKeyring.ts#L7) - -___ - -### sign - -▸ **sign**(`data`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `any` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -[packages/types/src/IKeyring.ts:9](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IKeyring.ts#L9) - -___ - -### symDecrypt - -▸ **symDecrypt**(`data`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `string` | - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -[packages/types/src/IKeyring.ts:15](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IKeyring.ts#L15) - -___ - -### symEncrypt - -▸ **symEncrypt**(`data`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -[packages/types/src/IKeyring.ts:13](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IKeyring.ts#L13) - -___ - -### verifySig - -▸ **verifySig**(`data`, `sig`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `string` | -| `sig` | `string` | - -#### Returns - -`Promise`<`boolean`\> - -#### Defined in - -[packages/types/src/IKeyring.ts:11](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IKeyring.ts#L11) diff --git a/docs/api/verida-js/interfaces/verida_types.IMessaging.md b/docs/api/verida-js/interfaces/verida_types.IMessaging.md deleted file mode 100644 index 362bea7..0000000 --- a/docs/api/verida-js/interfaces/verida_types.IMessaging.md +++ /dev/null @@ -1,180 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/types](../modules/verida_types.md) / IMessaging - -# Interface: IMessaging - -[@verida/types](../modules/verida_types.md).IMessaging - -Interface Messaging - -## Table of contents - -### Methods - -- [connectAccount](verida_types.IMessaging.md#connectaccount) -- [getInbox](verida_types.IMessaging.md#getinbox) -- [getMessages](verida_types.IMessaging.md#getmessages) -- [init](verida_types.IMessaging.md#init) -- [offMessage](verida_types.IMessaging.md#offmessage) -- [onMessage](verida_types.IMessaging.md#onmessage) -- [send](verida_types.IMessaging.md#send) - -## Methods - -### connectAccount - -▸ **connectAccount**(`account`): `Promise`<`void`\> - -Connect an account to this messaging instance. - -Used internally. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `account` | [`IAccount`](verida_types.IAccount.md) | Account | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -[packages/types/src/IMessaging.ts:74](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IMessaging.ts#L74) - -___ - -### getInbox - -▸ **getInbox**(): `Promise`<`any`\> - -Get the underlying inbox instance specific for the message storage type. - -#### Returns - -`Promise`<`any`\> - -any Currently returns a `Datastore` instance. - -#### Defined in - -[packages/types/src/IMessaging.ts:65](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IMessaging.ts#L65) - -___ - -### getMessages - -▸ **getMessages**(`filter?`, `options?`): `Promise`<`any`\> - -Get messages from this inbox. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `filter?` | `object` | object An optional datastore filter | -| `options?` | `any` | object An optional list of datastore options | - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -[packages/types/src/IMessaging.ts:58](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IMessaging.ts#L58) - -___ - -### init - -▸ **init**(): `Promise`<`void`\> - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -[packages/types/src/IMessaging.ts:9](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IMessaging.ts#L9) - -___ - -### offMessage - -▸ **offMessage**(`callback`): `Promise`<`void`\> - -Unregister a callback to fire when a new message is received - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `callback` | `any` | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -[packages/types/src/IMessaging.ts:50](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IMessaging.ts#L50) - -___ - -### onMessage - -▸ **onMessage**(`callback`): `Promise`<[`EventEmitter`](../classes/verida_types._internal_.EventEmitter-1.md)\> - -Register a callback to fire when a new message is received from another DID or application. - -Usage: - -``` -// configure the listener -const callback = (msg) => { console.log(msg) } -const emitter = messaging.onMessage(callback) -``` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `callback` | `any` | - -#### Returns - -`Promise`<[`EventEmitter`](../classes/verida_types._internal_.EventEmitter-1.md)\> - -Returns an event emitter - -#### Defined in - -[packages/types/src/IMessaging.ts:43](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IMessaging.ts#L43) - -___ - -### send - -▸ **send**(`did`, `type`, `data`, `message`, `config`): `Promise`<``null`` \| `object`\> - -Send a message to another DID on the network. - -**`todo:`** Link to documentation - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `did` | `string` | string DID to receive the message | -| `type` | `string` | string Type of inbox message (See https://github.com/verida/schemas/tree/master/schemas/inbox/type). ie: `dataSend` | -| `data` | `object` | object Data to send. Structure of data will depend on the inbox message type. | -| `message` | `string` | string A human readable message that will be displayed to the user upon receipt of the message. Similar to an email subject. | -| `config` | [`MessageSendConfig`](verida_types.MessageSendConfig.md) | object Optional configuration. | - -#### Returns - -`Promise`<``null`` \| `object`\> - -#### Defined in - -[packages/types/src/IMessaging.ts:22](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IMessaging.ts#L22) diff --git a/docs/api/verida-js/interfaces/verida_types.INotification.md b/docs/api/verida-js/interfaces/verida_types.INotification.md deleted file mode 100644 index e82ca83..0000000 --- a/docs/api/verida-js/interfaces/verida_types.INotification.md +++ /dev/null @@ -1,71 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/types](../modules/verida_types.md) / INotification - -# Interface: INotification - -[@verida/types](../modules/verida_types.md).INotification - -Interface for notifications - -## Table of contents - -### Methods - -- [getErrors](verida_types.INotification.md#geterrors) -- [init](verida_types.INotification.md#init) -- [ping](verida_types.INotification.md#ping) - -## Methods - -### getErrors - -▸ **getErrors**(): `string`[] - -#### Returns - -`string`[] - -#### Defined in - -[packages/types/src/INotification.ts:19](https://github.com/verida/verida-js/blob/5040472/packages/types/src/INotification.ts#L19) - -___ - -### init - -▸ **init**(): `Promise`<`void`\> - -Initialize notifications for the connected user - -(ie; connect to a notification server) - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -[packages/types/src/INotification.ts:11](https://github.com/verida/verida-js/blob/5040472/packages/types/src/INotification.ts#L11) - -___ - -### ping - -▸ **ping**(`recipientContextName`, `didToNotify`): `Promise`<`boolean`\> - -Ping a notification server to fetch new messages -TODO: Change this - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `recipientContextName` | `string` | -| `didToNotify` | `any` | - -#### Returns - -`Promise`<`boolean`\> - -#### Defined in - -[packages/types/src/INotification.ts:17](https://github.com/verida/verida-js/blob/5040472/packages/types/src/INotification.ts#L17) diff --git a/docs/api/verida-js/interfaces/verida_types.IProfile.md b/docs/api/verida-js/interfaces/verida_types.IProfile.md deleted file mode 100644 index 8b2d185..0000000 --- a/docs/api/verida-js/interfaces/verida_types.IProfile.md +++ /dev/null @@ -1,140 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/types](../modules/verida_types.md) / IProfile - -# Interface: IProfile - -[@verida/types](../modules/verida_types.md).IProfile - -## Table of contents - -### Methods - -- [delete](verida_types.IProfile.md#delete) -- [get](verida_types.IProfile.md#get) -- [getMany](verida_types.IProfile.md#getmany) -- [listen](verida_types.IProfile.md#listen) -- [set](verida_types.IProfile.md#set) -- [setMany](verida_types.IProfile.md#setmany) - -## Methods - -### delete - -▸ **delete**(`key`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `key` | `string` | - -#### Returns - -`Promise`<`boolean`\> - -#### Defined in - -[packages/types/src/IProfile.ts:13](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IProfile.ts#L13) - -___ - -### get - -▸ **get**(`key`, `options?`, `extended?`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `key` | `string` | -| `options?` | `any` | -| `extended?` | `boolean` | - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -[packages/types/src/IProfile.ts:7](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IProfile.ts#L7) - -___ - -### getMany - -▸ **getMany**(`filter`, `options`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `filter` | `any` | -| `options` | `any` | - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -[packages/types/src/IProfile.ts:15](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IProfile.ts#L15) - -___ - -### listen - -▸ **listen**(`callback`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `callback` | `any` | - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -[packages/types/src/IProfile.ts:21](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IProfile.ts#L21) - -___ - -### set - -▸ **set**(`key`, `value`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `key` | `string` | -| `value` | `any` | - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -[packages/types/src/IProfile.ts:17](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IProfile.ts#L17) - -___ - -### setMany - -▸ **setMany**(`data`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `any` | - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -[packages/types/src/IProfile.ts:19](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IProfile.ts#L19) diff --git a/docs/api/verida-js/interfaces/verida_types.ISchema.md b/docs/api/verida-js/interfaces/verida_types.ISchema.md deleted file mode 100644 index c54d195..0000000 --- a/docs/api/verida-js/interfaces/verida_types.ISchema.md +++ /dev/null @@ -1,90 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/types](../modules/verida_types.md) / ISchema - -# Interface: ISchema - -[@verida/types](../modules/verida_types.md).ISchema - -## Table of contents - -### Properties - -- [errors](verida_types.ISchema.md#errors) - -### Methods - -- [getAppearance](verida_types.ISchema.md#getappearance) -- [getSchemaJson](verida_types.ISchema.md#getschemajson) -- [getSpecification](verida_types.ISchema.md#getspecification) -- [validate](verida_types.ISchema.md#validate) - -## Properties - -### errors - -• **errors**: `string`[] - -#### Defined in - -[packages/types/src/ISchema.ts:3](https://github.com/verida/verida-js/blob/5040472/packages/types/src/ISchema.ts#L3) - -## Methods - -### getAppearance - -▸ **getAppearance**(): `Promise`<`any`\> - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -[packages/types/src/ISchema.ts:11](https://github.com/verida/verida-js/blob/5040472/packages/types/src/ISchema.ts#L11) - -___ - -### getSchemaJson - -▸ **getSchemaJson**(): `Promise`<`object`\> - -#### Returns - -`Promise`<`object`\> - -#### Defined in - -[packages/types/src/ISchema.ts:9](https://github.com/verida/verida-js/blob/5040472/packages/types/src/ISchema.ts#L9) - -___ - -### getSpecification - -▸ **getSpecification**(): `Promise`<`any`\> - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -[packages/types/src/ISchema.ts:5](https://github.com/verida/verida-js/blob/5040472/packages/types/src/ISchema.ts#L5) - -___ - -### validate - -▸ **validate**(`data`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `any` | - -#### Returns - -`Promise`<`boolean`\> - -#### Defined in - -[packages/types/src/ISchema.ts:7](https://github.com/verida/verida-js/blob/5040472/packages/types/src/ISchema.ts#L7) diff --git a/docs/api/verida-js/interfaces/verida_types.IStorageEngine.md b/docs/api/verida-js/interfaces/verida_types.IStorageEngine.md deleted file mode 100644 index e41d155..0000000 --- a/docs/api/verida-js/interfaces/verida_types.IStorageEngine.md +++ /dev/null @@ -1,211 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/types](../modules/verida_types.md) / IStorageEngine - -# Interface: IStorageEngine - -[@verida/types](../modules/verida_types.md).IStorageEngine - -**`emits`** EndpointUnavailable - -## Table of contents - -### Methods - -- [addEndpoint](verida_types.IStorageEngine.md#addendpoint) -- [connectAccount](verida_types.IStorageEngine.md#connectaccount) -- [deleteDatabase](verida_types.IStorageEngine.md#deletedatabase) -- [getAccount](verida_types.IStorageEngine.md#getaccount) -- [getContextConfig](verida_types.IStorageEngine.md#getcontextconfig) -- [getDbRegistry](verida_types.IStorageEngine.md#getdbregistry) -- [getKeyring](verida_types.IStorageEngine.md#getkeyring) -- [info](verida_types.IStorageEngine.md#info) -- [logout](verida_types.IStorageEngine.md#logout) -- [openDatabase](verida_types.IStorageEngine.md#opendatabase) -- [openDatastore](verida_types.IStorageEngine.md#opendatastore) - -## Methods - -### addEndpoint - -▸ **addEndpoint**(`context`, `uri`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `context` | [`IContext`](verida_types.IContext.md) | -| `uri` | `string` | - -#### Returns - -`Promise`<`boolean`\> - -#### Defined in - -[packages/types/src/IStorageEngine.ts:41](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IStorageEngine.ts#L41) - -___ - -### connectAccount - -▸ **connectAccount**(`account`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `account` | [`IAccount`](verida_types.IAccount.md) | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -[packages/types/src/IStorageEngine.ts:20](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IStorageEngine.ts#L20) - -___ - -### deleteDatabase - -▸ **deleteDatabase**(`databaseName`, `config?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `databaseName` | `string` | -| `config?` | [`DatabaseDeleteConfig`](verida_types.DatabaseDeleteConfig.md) | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -[packages/types/src/IStorageEngine.ts:34](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IStorageEngine.ts#L34) - -___ - -### getAccount - -▸ **getAccount**(): [`IAccount`](verida_types.IAccount.md) - -#### Returns - -[`IAccount`](verida_types.IAccount.md) - -#### Defined in - -[packages/types/src/IStorageEngine.ts:18](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IStorageEngine.ts#L18) - -___ - -### getContextConfig - -▸ **getContextConfig**(): [`SecureContextConfig`](verida_types.SecureContextConfig.md) - -#### Returns - -[`SecureContextConfig`](verida_types.SecureContextConfig.md) - -#### Defined in - -[packages/types/src/IStorageEngine.ts:16](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IStorageEngine.ts#L16) - -___ - -### getDbRegistry - -▸ **getDbRegistry**(): [`IDbRegistry`](verida_types.IDbRegistry.md) - -#### Returns - -[`IDbRegistry`](verida_types.IDbRegistry.md) - -#### Defined in - -[packages/types/src/IStorageEngine.ts:22](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IStorageEngine.ts#L22) - -___ - -### getKeyring - -▸ **getKeyring**(): [`IKeyring`](verida_types.IKeyring.md) - -#### Returns - -[`IKeyring`](verida_types.IKeyring.md) - -#### Defined in - -[packages/types/src/IStorageEngine.ts:14](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IStorageEngine.ts#L14) - -___ - -### info - -▸ **info**(): `Promise`<[`ContextDatabaseInfo`](verida_types.ContextDatabaseInfo.md)\> - -#### Returns - -`Promise`<[`ContextDatabaseInfo`](verida_types.ContextDatabaseInfo.md)\> - -#### Defined in - -[packages/types/src/IStorageEngine.ts:43](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IStorageEngine.ts#L43) - -___ - -### logout - -▸ **logout**(): `void` - -#### Returns - -`void` - -#### Defined in - -[packages/types/src/IStorageEngine.ts:39](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IStorageEngine.ts#L39) - -___ - -### openDatabase - -▸ **openDatabase**(`databaseName`, `config`): `Promise`<[`IDatabase`](verida_types.IDatabase.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `databaseName` | `string` | -| `config` | [`DatabaseOpenConfig`](verida_types.DatabaseOpenConfig.md) | - -#### Returns - -`Promise`<[`IDatabase`](verida_types.IDatabase.md)\> - -#### Defined in - -[packages/types/src/IStorageEngine.ts:24](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IStorageEngine.ts#L24) - -___ - -### openDatastore - -▸ **openDatastore**(`schemaName`, `config`): `Promise`<[`IDatastore`](verida_types.IDatastore.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schemaName` | `string` | -| `config` | [`DatastoreOpenConfig`](verida_types.DatastoreOpenConfig.md) | - -#### Returns - -`Promise`<[`IDatastore`](verida_types.IDatastore.md)\> - -#### Defined in - -[packages/types/src/IStorageEngine.ts:29](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IStorageEngine.ts#L29) diff --git a/docs/api/verida-js/interfaces/verida_types.KeyringPublicKeys.md b/docs/api/verida-js/interfaces/verida_types.KeyringPublicKeys.md deleted file mode 100644 index 7521079..0000000 --- a/docs/api/verida-js/interfaces/verida_types.KeyringPublicKeys.md +++ /dev/null @@ -1,76 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/types](../modules/verida_types.md) / KeyringPublicKeys - -# Interface: KeyringPublicKeys - -[@verida/types](../modules/verida_types.md).KeyringPublicKeys - -## Table of contents - -### Properties - -- [asymPublicKey](verida_types.KeyringPublicKeys.md#asympublickey) -- [asymPublicKeyBase58](verida_types.KeyringPublicKeys.md#asympublickeybase58) -- [asymPublicKeyHex](verida_types.KeyringPublicKeys.md#asympublickeyhex) -- [signPublicKey](verida_types.KeyringPublicKeys.md#signpublickey) -- [signPublicKeyBase58](verida_types.KeyringPublicKeys.md#signpublickeybase58) -- [signPublicKeyHex](verida_types.KeyringPublicKeys.md#signpublickeyhex) - -## Properties - -### asymPublicKey - -• **asymPublicKey**: `Uint8Array` - -#### Defined in - -[packages/types/src/IKeyring.ts:31](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IKeyring.ts#L31) - -___ - -### asymPublicKeyBase58 - -• **asymPublicKeyBase58**: `string` - -#### Defined in - -[packages/types/src/IKeyring.ts:33](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IKeyring.ts#L33) - -___ - -### asymPublicKeyHex - -• **asymPublicKeyHex**: `string` - -#### Defined in - -[packages/types/src/IKeyring.ts:32](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IKeyring.ts#L32) - -___ - -### signPublicKey - -• **signPublicKey**: `Uint8Array` - -#### Defined in - -[packages/types/src/IKeyring.ts:34](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IKeyring.ts#L34) - -___ - -### signPublicKeyBase58 - -• **signPublicKeyBase58**: `string` - -#### Defined in - -[packages/types/src/IKeyring.ts:36](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IKeyring.ts#L36) - -___ - -### signPublicKeyHex - -• **signPublicKeyHex**: `string` - -#### Defined in - -[packages/types/src/IKeyring.ts:35](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IKeyring.ts#L35) diff --git a/docs/api/verida-js/interfaces/verida_types.MessageSendConfig.md b/docs/api/verida-js/interfaces/verida_types.MessageSendConfig.md deleted file mode 100644 index f2f561c..0000000 --- a/docs/api/verida-js/interfaces/verida_types.MessageSendConfig.md +++ /dev/null @@ -1,56 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/types](../modules/verida_types.md) / MessageSendConfig - -# Interface: MessageSendConfig - -[@verida/types](../modules/verida_types.md).MessageSendConfig - -Interface for any MessageSendConfig - -## Table of contents - -### Properties - -- [did](verida_types.MessageSendConfig.md#did) -- [expiry](verida_types.MessageSendConfig.md#expiry) -- [openUrl](verida_types.MessageSendConfig.md#openurl) -- [recipientContextName](verida_types.MessageSendConfig.md#recipientcontextname) - -## Properties - -### did - -• **did**: `string` - -#### Defined in - -[packages/types/src/ContextInterfaces.ts:149](https://github.com/verida/verida-js/blob/5040472/packages/types/src/ContextInterfaces.ts#L149) - -___ - -### expiry - -• `Optional` **expiry**: [`Number`](../modules/verida_types._internal_.md#number) - -#### Defined in - -[packages/types/src/ContextInterfaces.ts:150](https://github.com/verida/verida-js/blob/5040472/packages/types/src/ContextInterfaces.ts#L150) - -___ - -### openUrl - -• `Optional` **openUrl**: `string` - -#### Defined in - -[packages/types/src/ContextInterfaces.ts:152](https://github.com/verida/verida-js/blob/5040472/packages/types/src/ContextInterfaces.ts#L152) - -___ - -### recipientContextName - -• `Optional` **recipientContextName**: `string` - -#### Defined in - -[packages/types/src/ContextInterfaces.ts:151](https://github.com/verida/verida-js/blob/5040472/packages/types/src/ContextInterfaces.ts#L151) diff --git a/docs/api/verida-js/interfaces/verida_types.MessagesConfig.md b/docs/api/verida-js/interfaces/verida_types.MessagesConfig.md deleted file mode 100644 index 74a0130..0000000 --- a/docs/api/verida-js/interfaces/verida_types.MessagesConfig.md +++ /dev/null @@ -1,23 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/types](../modules/verida_types.md) / MessagesConfig - -# Interface: MessagesConfig - -[@verida/types](../modules/verida_types.md).MessagesConfig - -Interface for any MessagesConfig - -## Table of contents - -### Properties - -- [maxItems](verida_types.MessagesConfig.md#maxitems) - -## Properties - -### maxItems - -• `Optional` **maxItems**: [`Number`](../modules/verida_types._internal_.md#number) - -#### Defined in - -[packages/types/src/ContextInterfaces.ts:113](https://github.com/verida/verida-js/blob/5040472/packages/types/src/ContextInterfaces.ts#L113) diff --git a/docs/api/verida-js/interfaces/verida_types.NetworkConnectionConfig.md b/docs/api/verida-js/interfaces/verida_types.NetworkConnectionConfig.md deleted file mode 100644 index df9b406..0000000 --- a/docs/api/verida-js/interfaces/verida_types.NetworkConnectionConfig.md +++ /dev/null @@ -1,45 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/types](../modules/verida_types.md) / NetworkConnectionConfig - -# Interface: NetworkConnectionConfig - -[@verida/types](../modules/verida_types.md).NetworkConnectionConfig - -Interface for NetworkConnectionConfig - -## Table of contents - -### Properties - -- [account](verida_types.NetworkConnectionConfig.md#account) -- [client](verida_types.NetworkConnectionConfig.md#client) -- [context](verida_types.NetworkConnectionConfig.md#context) - -## Properties - -### account - -• **account**: [`IAccount`](verida_types.IAccount.md) - -#### Defined in - -[packages/types/src/NetworkInterfaces.ts:68](https://github.com/verida/verida-js/blob/5040472/packages/types/src/NetworkInterfaces.ts#L68) - -___ - -### client - -• `Optional` **client**: [`ClientConfig`](verida_types.ClientConfig.md) - -#### Defined in - -[packages/types/src/NetworkInterfaces.ts:66](https://github.com/verida/verida-js/blob/5040472/packages/types/src/NetworkInterfaces.ts#L66) - -___ - -### context - -• **context**: [`ContextConfig`](verida_types.ContextConfig.md) - -#### Defined in - -[packages/types/src/NetworkInterfaces.ts:67](https://github.com/verida/verida-js/blob/5040472/packages/types/src/NetworkInterfaces.ts#L67) diff --git a/docs/api/verida-js/interfaces/verida_types.ProfileDocument.md b/docs/api/verida-js/interfaces/verida_types.ProfileDocument.md deleted file mode 100644 index 8d527cb..0000000 --- a/docs/api/verida-js/interfaces/verida_types.ProfileDocument.md +++ /dev/null @@ -1,25 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/types](../modules/verida_types.md) / ProfileDocument - -# Interface: ProfileDocument - -[@verida/types](../modules/verida_types.md).ProfileDocument - -## Indexable - -▪ [key: `string`]: `string` - -## Table of contents - -### Properties - -- [\_id](verida_types.ProfileDocument.md#_id) - -## Properties - -### \_id - -• **\_id**: `string` - -#### Defined in - -[packages/types/src/IProfile.ts:2](https://github.com/verida/verida-js/blob/5040472/packages/types/src/IProfile.ts#L2) diff --git a/docs/api/verida-js/interfaces/verida_types.ProofInterface.md b/docs/api/verida-js/interfaces/verida_types.ProofInterface.md deleted file mode 100644 index 5277961..0000000 --- a/docs/api/verida-js/interfaces/verida_types.ProofInterface.md +++ /dev/null @@ -1,54 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/types](../modules/verida_types.md) / ProofInterface - -# Interface: ProofInterface - -[@verida/types](../modules/verida_types.md).ProofInterface - -## Table of contents - -### Properties - -- [proofPurpose](verida_types.ProofInterface.md#proofpurpose) -- [proofValue](verida_types.ProofInterface.md#proofvalue) -- [type](verida_types.ProofInterface.md#type) -- [verificationMethod](verida_types.ProofInterface.md#verificationmethod) - -## Properties - -### proofPurpose - -• **proofPurpose**: `string` - -#### Defined in - -[packages/types/src/DocumentInterfaces.ts:41](https://github.com/verida/verida-js/blob/5040472/packages/types/src/DocumentInterfaces.ts#L41) - -___ - -### proofValue - -• **proofValue**: `string` - -#### Defined in - -[packages/types/src/DocumentInterfaces.ts:42](https://github.com/verida/verida-js/blob/5040472/packages/types/src/DocumentInterfaces.ts#L42) - -___ - -### type - -• **type**: `string` - -#### Defined in - -[packages/types/src/DocumentInterfaces.ts:39](https://github.com/verida/verida-js/blob/5040472/packages/types/src/DocumentInterfaces.ts#L39) - -___ - -### verificationMethod - -• **verificationMethod**: `string` - -#### Defined in - -[packages/types/src/DocumentInterfaces.ts:40](https://github.com/verida/verida-js/blob/5040472/packages/types/src/DocumentInterfaces.ts#L40) diff --git a/docs/api/verida-js/interfaces/verida_types.SecureContextConfig.md b/docs/api/verida-js/interfaces/verida_types.SecureContextConfig.md deleted file mode 100644 index e058c32..0000000 --- a/docs/api/verida-js/interfaces/verida_types.SecureContextConfig.md +++ /dev/null @@ -1,43 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/types](../modules/verida_types.md) / SecureContextConfig - -# Interface: SecureContextConfig - -[@verida/types](../modules/verida_types.md).SecureContextConfig - -## Table of contents - -### Properties - -- [id](verida_types.SecureContextConfig.md#id) -- [publicKeys](verida_types.SecureContextConfig.md#publickeys) -- [services](verida_types.SecureContextConfig.md#services) - -## Properties - -### id - -• **id**: `string` - -#### Defined in - -[packages/types/src/StorageLinkInterfaces.ts:21](https://github.com/verida/verida-js/blob/5040472/packages/types/src/StorageLinkInterfaces.ts#L21) - -___ - -### publicKeys - -• **publicKeys**: [`SecureStorageContextPublicKeys`](verida_types.SecureStorageContextPublicKeys.md) - -#### Defined in - -[packages/types/src/StorageLinkInterfaces.ts:22](https://github.com/verida/verida-js/blob/5040472/packages/types/src/StorageLinkInterfaces.ts#L22) - -___ - -### services - -• **services**: [`SecureContextServices`](verida_types.SecureContextServices.md) - -#### Defined in - -[packages/types/src/StorageLinkInterfaces.ts:23](https://github.com/verida/verida-js/blob/5040472/packages/types/src/StorageLinkInterfaces.ts#L23) diff --git a/docs/api/verida-js/interfaces/verida_types.SecureContextEndpoint.md b/docs/api/verida-js/interfaces/verida_types.SecureContextEndpoint.md deleted file mode 100644 index 873fbf3..0000000 --- a/docs/api/verida-js/interfaces/verida_types.SecureContextEndpoint.md +++ /dev/null @@ -1,43 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/types](../modules/verida_types.md) / SecureContextEndpoint - -# Interface: SecureContextEndpoint - -[@verida/types](../modules/verida_types.md).SecureContextEndpoint - -## Table of contents - -### Properties - -- [config](verida_types.SecureContextEndpoint.md#config) -- [endpointUri](verida_types.SecureContextEndpoint.md#endpointuri) -- [type](verida_types.SecureContextEndpoint.md#type) - -## Properties - -### config - -• `Optional` **config**: `object` - -#### Defined in - -[packages/types/src/DocumentInterfaces.ts:7](https://github.com/verida/verida-js/blob/5040472/packages/types/src/DocumentInterfaces.ts#L7) - -___ - -### endpointUri - -• **endpointUri**: [`ServiceEndpoint`](../modules/verida_types._internal_.md#serviceendpoint)[] - -#### Defined in - -[packages/types/src/DocumentInterfaces.ts:6](https://github.com/verida/verida-js/blob/5040472/packages/types/src/DocumentInterfaces.ts#L6) - -___ - -### type - -• **type**: `string` - -#### Defined in - -[packages/types/src/DocumentInterfaces.ts:5](https://github.com/verida/verida-js/blob/5040472/packages/types/src/DocumentInterfaces.ts#L5) diff --git a/docs/api/verida-js/interfaces/verida_types.SecureContextEndpoints.md b/docs/api/verida-js/interfaces/verida_types.SecureContextEndpoints.md deleted file mode 100644 index 66b8b84..0000000 --- a/docs/api/verida-js/interfaces/verida_types.SecureContextEndpoints.md +++ /dev/null @@ -1,54 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/types](../modules/verida_types.md) / SecureContextEndpoints - -# Interface: SecureContextEndpoints - -[@verida/types](../modules/verida_types.md).SecureContextEndpoints - -## Table of contents - -### Properties - -- [database](verida_types.SecureContextEndpoints.md#database) -- [messaging](verida_types.SecureContextEndpoints.md#messaging) -- [notification](verida_types.SecureContextEndpoints.md#notification) -- [storage](verida_types.SecureContextEndpoints.md#storage) - -## Properties - -### database - -• **database**: [`SecureContextEndpoint`](verida_types.SecureContextEndpoint.md) - -#### Defined in - -[packages/types/src/DocumentInterfaces.ts:11](https://github.com/verida/verida-js/blob/5040472/packages/types/src/DocumentInterfaces.ts#L11) - -___ - -### messaging - -• **messaging**: [`SecureContextEndpoint`](verida_types.SecureContextEndpoint.md) - -#### Defined in - -[packages/types/src/DocumentInterfaces.ts:12](https://github.com/verida/verida-js/blob/5040472/packages/types/src/DocumentInterfaces.ts#L12) - -___ - -### notification - -• `Optional` **notification**: [`SecureContextEndpoint`](verida_types.SecureContextEndpoint.md) - -#### Defined in - -[packages/types/src/DocumentInterfaces.ts:14](https://github.com/verida/verida-js/blob/5040472/packages/types/src/DocumentInterfaces.ts#L14) - -___ - -### storage - -• `Optional` **storage**: [`SecureContextEndpoint`](verida_types.SecureContextEndpoint.md) - -#### Defined in - -[packages/types/src/DocumentInterfaces.ts:13](https://github.com/verida/verida-js/blob/5040472/packages/types/src/DocumentInterfaces.ts#L13) diff --git a/docs/api/verida-js/interfaces/verida_types.SecureContextPublicKey.md b/docs/api/verida-js/interfaces/verida_types.SecureContextPublicKey.md deleted file mode 100644 index ed91ae2..0000000 --- a/docs/api/verida-js/interfaces/verida_types.SecureContextPublicKey.md +++ /dev/null @@ -1,32 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/types](../modules/verida_types.md) / SecureContextPublicKey - -# Interface: SecureContextPublicKey - -[@verida/types](../modules/verida_types.md).SecureContextPublicKey - -## Table of contents - -### Properties - -- [publicKeyHex](verida_types.SecureContextPublicKey.md#publickeyhex) -- [type](verida_types.SecureContextPublicKey.md#type) - -## Properties - -### publicKeyHex - -• **publicKeyHex**: `string` - -#### Defined in - -[packages/types/src/StorageLinkInterfaces.ts:5](https://github.com/verida/verida-js/blob/5040472/packages/types/src/StorageLinkInterfaces.ts#L5) - -___ - -### type - -• **type**: `string` - -#### Defined in - -[packages/types/src/StorageLinkInterfaces.ts:4](https://github.com/verida/verida-js/blob/5040472/packages/types/src/StorageLinkInterfaces.ts#L4) diff --git a/docs/api/verida-js/interfaces/verida_types.SecureContextServices.md b/docs/api/verida-js/interfaces/verida_types.SecureContextServices.md deleted file mode 100644 index 94bebb1..0000000 --- a/docs/api/verida-js/interfaces/verida_types.SecureContextServices.md +++ /dev/null @@ -1,54 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/types](../modules/verida_types.md) / SecureContextServices - -# Interface: SecureContextServices - -[@verida/types](../modules/verida_types.md).SecureContextServices - -## Table of contents - -### Properties - -- [databaseServer](verida_types.SecureContextServices.md#databaseserver) -- [messageServer](verida_types.SecureContextServices.md#messageserver) -- [notificationServer](verida_types.SecureContextServices.md#notificationserver) -- [storageServer](verida_types.SecureContextServices.md#storageserver) - -## Properties - -### databaseServer - -• **databaseServer**: [`SecureContextEndpoint`](verida_types.SecureContextEndpoint.md) - -#### Defined in - -[packages/types/src/StorageLinkInterfaces.ts:14](https://github.com/verida/verida-js/blob/5040472/packages/types/src/StorageLinkInterfaces.ts#L14) - -___ - -### messageServer - -• **messageServer**: [`SecureContextEndpoint`](verida_types.SecureContextEndpoint.md) - -#### Defined in - -[packages/types/src/StorageLinkInterfaces.ts:15](https://github.com/verida/verida-js/blob/5040472/packages/types/src/StorageLinkInterfaces.ts#L15) - -___ - -### notificationServer - -• `Optional` **notificationServer**: [`SecureContextEndpoint`](verida_types.SecureContextEndpoint.md) - -#### Defined in - -[packages/types/src/StorageLinkInterfaces.ts:17](https://github.com/verida/verida-js/blob/5040472/packages/types/src/StorageLinkInterfaces.ts#L17) - -___ - -### storageServer - -• `Optional` **storageServer**: [`SecureContextEndpoint`](verida_types.SecureContextEndpoint.md) - -#### Defined in - -[packages/types/src/StorageLinkInterfaces.ts:16](https://github.com/verida/verida-js/blob/5040472/packages/types/src/StorageLinkInterfaces.ts#L16) diff --git a/docs/api/verida-js/interfaces/verida_types.SecureStorageContextPublicKeys.md b/docs/api/verida-js/interfaces/verida_types.SecureStorageContextPublicKeys.md deleted file mode 100644 index 8403562..0000000 --- a/docs/api/verida-js/interfaces/verida_types.SecureStorageContextPublicKeys.md +++ /dev/null @@ -1,32 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/types](../modules/verida_types.md) / SecureStorageContextPublicKeys - -# Interface: SecureStorageContextPublicKeys - -[@verida/types](../modules/verida_types.md).SecureStorageContextPublicKeys - -## Table of contents - -### Properties - -- [asymKey](verida_types.SecureStorageContextPublicKeys.md#asymkey) -- [signKey](verida_types.SecureStorageContextPublicKeys.md#signkey) - -## Properties - -### asymKey - -• **asymKey**: [`SecureContextPublicKey`](verida_types.SecureContextPublicKey.md) - -#### Defined in - -[packages/types/src/StorageLinkInterfaces.ts:9](https://github.com/verida/verida-js/blob/5040472/packages/types/src/StorageLinkInterfaces.ts#L9) - -___ - -### signKey - -• **signKey**: [`SecureContextPublicKey`](verida_types.SecureContextPublicKey.md) - -#### Defined in - -[packages/types/src/StorageLinkInterfaces.ts:10](https://github.com/verida/verida-js/blob/5040472/packages/types/src/StorageLinkInterfaces.ts#L10) diff --git a/docs/api/verida-js/interfaces/verida_types.StorageEngineTypes.md b/docs/api/verida-js/interfaces/verida_types.StorageEngineTypes.md deleted file mode 100644 index 546cf2f..0000000 --- a/docs/api/verida-js/interfaces/verida_types.StorageEngineTypes.md +++ /dev/null @@ -1,11 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/types](../modules/verida_types.md) / StorageEngineTypes - -# Interface: StorageEngineTypes - -[@verida/types](../modules/verida_types.md).StorageEngineTypes - -Interface for any StorageEngineTypes - -## Indexable - -▪ [key: `string`]: `any` diff --git a/docs/api/verida-js/interfaces/verida_types.VdaClientConfig.md b/docs/api/verida-js/interfaces/verida_types.VdaClientConfig.md deleted file mode 100644 index e1586c4..0000000 --- a/docs/api/verida-js/interfaces/verida_types.VdaClientConfig.md +++ /dev/null @@ -1,77 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/types](../modules/verida_types.md) / VdaClientConfig - -# Interface: VdaClientConfig - -[@verida/types](../modules/verida_types.md).VdaClientConfig - -Interface for vda-xxx-client instance creation. - -**`param`** DID - -**`param`** private key of DID. Used to generate signature in transactions to chains - -**`param`** Target chain name or chain id. - -**`param`** : VDA-DID run mode. Values from vda-did-resolver - -**`param`** Web3 configuration depending on call type. Values from vda-did-resolver - -## Table of contents - -### Properties - -- [callType](verida_types.VdaClientConfig.md#calltype) -- [did](verida_types.VdaClientConfig.md#did) -- [network](verida_types.VdaClientConfig.md#network) -- [signKey](verida_types.VdaClientConfig.md#signkey) -- [web3Options](verida_types.VdaClientConfig.md#web3options) - -## Properties - -### callType - -• `Optional` **callType**: [`Web3CallType`](../modules/verida_types.md#web3calltype) - -#### Defined in - -[packages/types/src/VdaClientConfig.ts:15](https://github.com/verida/verida-js/blob/5040472/packages/types/src/VdaClientConfig.ts#L15) - -___ - -### did - -• `Optional` **did**: `string` - -#### Defined in - -[packages/types/src/VdaClientConfig.ts:13](https://github.com/verida/verida-js/blob/5040472/packages/types/src/VdaClientConfig.ts#L13) - -___ - -### network - -• **network**: [`EnvironmentType`](../enums/verida_types.EnvironmentType.md) - -#### Defined in - -[packages/types/src/VdaClientConfig.ts:12](https://github.com/verida/verida-js/blob/5040472/packages/types/src/VdaClientConfig.ts#L12) - -___ - -### signKey - -• `Optional` **signKey**: `string` - -#### Defined in - -[packages/types/src/VdaClientConfig.ts:14](https://github.com/verida/verida-js/blob/5040472/packages/types/src/VdaClientConfig.ts#L14) - -___ - -### web3Options - -• `Optional` **web3Options**: [`Web3SelfTransactionConfig`](verida_types.Web3SelfTransactionConfig.md) \| [`Web3MetaTransactionConfig`](verida_types.Web3MetaTransactionConfig.md) - -#### Defined in - -[packages/types/src/VdaClientConfig.ts:16](https://github.com/verida/verida-js/blob/5040472/packages/types/src/VdaClientConfig.ts#L16) diff --git a/docs/api/verida-js/interfaces/verida_types.VdaDidConfigurationOptions.md b/docs/api/verida-js/interfaces/verida_types.VdaDidConfigurationOptions.md deleted file mode 100644 index bec47f4..0000000 --- a/docs/api/verida-js/interfaces/verida_types.VdaDidConfigurationOptions.md +++ /dev/null @@ -1,105 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/types](../modules/verida_types.md) / VdaDidConfigurationOptions - -# Interface: VdaDidConfigurationOptions - -[@verida/types](../modules/verida_types.md).VdaDidConfigurationOptions - -Interface for VDA-DID instance creation. - -`signKey` or `signer` must be provided - -**`param`** DID - -**`param`** private key of DID's controller. Used to generate signature in transactions to chains - -**`param`** Signing function that accepts a private key and returns a signature in hex format - -**`param`** Target chain name or chain id. - -**`param`** : VDA-DID run mode. Values from vda-did-resolver - -**`param`** Web3 configuration depending on call type. Values from vda-did-resolver - -## Table of contents - -### Properties - -- [callType](verida_types.VdaDidConfigurationOptions.md#calltype) -- [chainNameOrId](verida_types.VdaDidConfigurationOptions.md#chainnameorid) -- [identifier](verida_types.VdaDidConfigurationOptions.md#identifier) -- [signKey](verida_types.VdaDidConfigurationOptions.md#signkey) -- [web3Options](verida_types.VdaDidConfigurationOptions.md#web3options) - -### Methods - -- [signer](verida_types.VdaDidConfigurationOptions.md#signer) - -## Properties - -### callType - -• **callType**: [`Web3CallType`](../modules/verida_types.md#web3calltype) - -#### Defined in - -[packages/types/src/Web3Interfaces.ts:126](https://github.com/verida/verida-js/blob/5040472/packages/types/src/Web3Interfaces.ts#L126) - -___ - -### chainNameOrId - -• `Optional` **chainNameOrId**: `string` \| `number` - -#### Defined in - -[packages/types/src/Web3Interfaces.ts:124](https://github.com/verida/verida-js/blob/5040472/packages/types/src/Web3Interfaces.ts#L124) - -___ - -### identifier - -• **identifier**: `string` - -#### Defined in - -[packages/types/src/Web3Interfaces.ts:121](https://github.com/verida/verida-js/blob/5040472/packages/types/src/Web3Interfaces.ts#L121) - -___ - -### signKey - -• `Optional` **signKey**: `string` - -#### Defined in - -[packages/types/src/Web3Interfaces.ts:122](https://github.com/verida/verida-js/blob/5040472/packages/types/src/Web3Interfaces.ts#L122) - -___ - -### web3Options - -• **web3Options**: [`VeridaWeb3ConfigurationOptions`](../modules/verida_types.md#veridaweb3configurationoptions) - -#### Defined in - -[packages/types/src/Web3Interfaces.ts:127](https://github.com/verida/verida-js/blob/5040472/packages/types/src/Web3Interfaces.ts#L127) - -## Methods - -### signer - -▸ `Optional` **signer**(`data`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `any` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -[packages/types/src/Web3Interfaces.ts:123](https://github.com/verida/verida-js/blob/5040472/packages/types/src/Web3Interfaces.ts#L123) diff --git a/docs/api/verida-js/interfaces/verida_types.VdaDidEndpointResponse.md b/docs/api/verida-js/interfaces/verida_types.VdaDidEndpointResponse.md deleted file mode 100644 index 64ea689..0000000 --- a/docs/api/verida-js/interfaces/verida_types.VdaDidEndpointResponse.md +++ /dev/null @@ -1,32 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/types](../modules/verida_types.md) / VdaDidEndpointResponse - -# Interface: VdaDidEndpointResponse - -[@verida/types](../modules/verida_types.md).VdaDidEndpointResponse - -## Table of contents - -### Properties - -- [message](verida_types.VdaDidEndpointResponse.md#message) -- [status](verida_types.VdaDidEndpointResponse.md#status) - -## Properties - -### message - -• `Optional` **message**: `string` - -#### Defined in - -[packages/types/src/Web3Interfaces.ts:132](https://github.com/verida/verida-js/blob/5040472/packages/types/src/Web3Interfaces.ts#L132) - -___ - -### status - -• **status**: ``"success"`` \| ``"fail"`` - -#### Defined in - -[packages/types/src/Web3Interfaces.ts:131](https://github.com/verida/verida-js/blob/5040472/packages/types/src/Web3Interfaces.ts#L131) diff --git a/docs/api/verida-js/interfaces/verida_types.VdaTransactionResult.md b/docs/api/verida-js/interfaces/verida_types.VdaTransactionResult.md deleted file mode 100644 index d9d122e..0000000 --- a/docs/api/verida-js/interfaces/verida_types.VdaTransactionResult.md +++ /dev/null @@ -1,43 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/types](../modules/verida_types.md) / VdaTransactionResult - -# Interface: VdaTransactionResult - -[@verida/types](../modules/verida_types.md).VdaTransactionResult - -## Table of contents - -### Properties - -- [data](verida_types.VdaTransactionResult.md#data) -- [error](verida_types.VdaTransactionResult.md#error) -- [success](verida_types.VdaTransactionResult.md#success) - -## Properties - -### data - -• `Optional` **data**: `any` - -#### Defined in - -[packages/types/src/Web3Interfaces.ts:150](https://github.com/verida/verida-js/blob/5040472/packages/types/src/Web3Interfaces.ts#L150) - -___ - -### error - -• `Optional` **error**: `string` - -#### Defined in - -[packages/types/src/Web3Interfaces.ts:151](https://github.com/verida/verida-js/blob/5040472/packages/types/src/Web3Interfaces.ts#L151) - -___ - -### success - -• **success**: `boolean` - -#### Defined in - -[packages/types/src/Web3Interfaces.ts:149](https://github.com/verida/verida-js/blob/5040472/packages/types/src/Web3Interfaces.ts#L149) diff --git a/docs/api/verida-js/interfaces/verida_types.VeridaDatabaseAuthContext.md b/docs/api/verida-js/interfaces/verida_types.VeridaDatabaseAuthContext.md deleted file mode 100644 index 348282c..0000000 --- a/docs/api/verida-js/interfaces/verida_types.VeridaDatabaseAuthContext.md +++ /dev/null @@ -1,75 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/types](../modules/verida_types.md) / VeridaDatabaseAuthContext - -# Interface: VeridaDatabaseAuthContext - -[@verida/types](../modules/verida_types.md).VeridaDatabaseAuthContext - -## Hierarchy - -- [`AuthContext`](verida_types.AuthContext.md) - - ↳ **`VeridaDatabaseAuthContext`** - -## Table of contents - -### Properties - -- [accessToken](verida_types.VeridaDatabaseAuthContext.md#accesstoken) -- [endpointUri](verida_types.VeridaDatabaseAuthContext.md#endpointuri) -- [host](verida_types.VeridaDatabaseAuthContext.md#host) -- [publicSigningKey](verida_types.VeridaDatabaseAuthContext.md#publicsigningkey) -- [refreshToken](verida_types.VeridaDatabaseAuthContext.md#refreshtoken) - -## Properties - -### accessToken - -• `Optional` **accessToken**: `string` - -#### Defined in - -[packages/types/src/AccountInterfaces.ts:24](https://github.com/verida/verida-js/blob/5040472/packages/types/src/AccountInterfaces.ts#L24) - -___ - -### endpointUri - -• **endpointUri**: [`ServiceEndpoint`](../modules/verida_types._internal_.md#serviceendpoint) - -#### Defined in - -[packages/types/src/AccountInterfaces.ts:25](https://github.com/verida/verida-js/blob/5040472/packages/types/src/AccountInterfaces.ts#L25) - -___ - -### host - -• **host**: `string` - -#### Defined in - -[packages/types/src/AccountInterfaces.ts:26](https://github.com/verida/verida-js/blob/5040472/packages/types/src/AccountInterfaces.ts#L26) - -___ - -### publicSigningKey - -• **publicSigningKey**: [`SecureContextPublicKey`](verida_types.SecureContextPublicKey.md) - -#### Inherited from - -[AuthContext](verida_types.AuthContext.md).[publicSigningKey](verida_types.AuthContext.md#publicsigningkey) - -#### Defined in - -[packages/types/src/AccountInterfaces.ts:15](https://github.com/verida/verida-js/blob/5040472/packages/types/src/AccountInterfaces.ts#L15) - -___ - -### refreshToken - -• `Optional` **refreshToken**: `string` - -#### Defined in - -[packages/types/src/AccountInterfaces.ts:23](https://github.com/verida/verida-js/blob/5040472/packages/types/src/AccountInterfaces.ts#L23) diff --git a/docs/api/verida-js/interfaces/verida_types.VeridaDatabaseAuthTypeConfig.md b/docs/api/verida-js/interfaces/verida_types.VeridaDatabaseAuthTypeConfig.md deleted file mode 100644 index 2d28555..0000000 --- a/docs/api/verida-js/interfaces/verida_types.VeridaDatabaseAuthTypeConfig.md +++ /dev/null @@ -1,64 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/types](../modules/verida_types.md) / VeridaDatabaseAuthTypeConfig - -# Interface: VeridaDatabaseAuthTypeConfig - -[@verida/types](../modules/verida_types.md).VeridaDatabaseAuthTypeConfig - -## Hierarchy - -- [`AuthTypeConfig`](verida_types.AuthTypeConfig.md) - - ↳ **`VeridaDatabaseAuthTypeConfig`** - -## Table of contents - -### Properties - -- [deviceId](verida_types.VeridaDatabaseAuthTypeConfig.md#deviceid) -- [endpointUri](verida_types.VeridaDatabaseAuthTypeConfig.md#endpointuri) -- [force](verida_types.VeridaDatabaseAuthTypeConfig.md#force) -- [invalidAccessToken](verida_types.VeridaDatabaseAuthTypeConfig.md#invalidaccesstoken) - -## Properties - -### deviceId - -• `Optional` **deviceId**: `string` - -#### Defined in - -[packages/types/src/AccountInterfaces.ts:30](https://github.com/verida/verida-js/blob/5040472/packages/types/src/AccountInterfaces.ts#L30) - -___ - -### endpointUri - -• `Optional` **endpointUri**: `string` - -#### Defined in - -[packages/types/src/AccountInterfaces.ts:31](https://github.com/verida/verida-js/blob/5040472/packages/types/src/AccountInterfaces.ts#L31) - -___ - -### force - -• `Optional` **force**: `boolean` - -#### Inherited from - -[AuthTypeConfig](verida_types.AuthTypeConfig.md).[force](verida_types.AuthTypeConfig.md#force) - -#### Defined in - -[packages/types/src/AccountInterfaces.ts:19](https://github.com/verida/verida-js/blob/5040472/packages/types/src/AccountInterfaces.ts#L19) - -___ - -### invalidAccessToken - -• `Optional` **invalidAccessToken**: `boolean` - -#### Defined in - -[packages/types/src/AccountInterfaces.ts:32](https://github.com/verida/verida-js/blob/5040472/packages/types/src/AccountInterfaces.ts#L32) diff --git a/docs/api/verida-js/interfaces/verida_types.VeridaDocInterface.md b/docs/api/verida-js/interfaces/verida_types.VeridaDocInterface.md deleted file mode 100644 index da4c01c..0000000 --- a/docs/api/verida-js/interfaces/verida_types.VeridaDocInterface.md +++ /dev/null @@ -1,233 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/types](../modules/verida_types.md) / VeridaDocInterface - -# Interface: VeridaDocInterface - -[@verida/types](../modules/verida_types.md).VeridaDocInterface - -## Hierarchy - -- [`DIDDocument`](../modules/verida_types._internal_.md#diddocument) - - ↳ **`VeridaDocInterface`** - -## Table of contents - -### Properties - -- [@context](verida_types.VeridaDocInterface.md#@context) -- [alsoKnownAs](verida_types.VeridaDocInterface.md#alsoknownas) -- [assertionMethod](verida_types.VeridaDocInterface.md#assertionmethod) -- [authentication](verida_types.VeridaDocInterface.md#authentication) -- [capabilityDelegation](verida_types.VeridaDocInterface.md#capabilitydelegation) -- [capabilityInvocation](verida_types.VeridaDocInterface.md#capabilityinvocation) -- [controller](verida_types.VeridaDocInterface.md#controller) -- [created](verida_types.VeridaDocInterface.md#created) -- [deactivated](verida_types.VeridaDocInterface.md#deactivated) -- [id](verida_types.VeridaDocInterface.md#id) -- [keyAgreement](verida_types.VeridaDocInterface.md#keyagreement) -- [proof](verida_types.VeridaDocInterface.md#proof) -- [publicKey](verida_types.VeridaDocInterface.md#publickey) -- [service](verida_types.VeridaDocInterface.md#service) -- [updated](verida_types.VeridaDocInterface.md#updated) -- [verificationMethod](verida_types.VeridaDocInterface.md#verificationmethod) -- [versionId](verida_types.VeridaDocInterface.md#versionid) - -## Properties - -### @context - -• `Optional` **@context**: `string` \| `string`[] - -#### Inherited from - -DocInterface.@context - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:61 - -___ - -### alsoKnownAs - -• `Optional` **alsoKnownAs**: `string`[] - -#### Inherited from - -DocInterface.alsoKnownAs - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:63 - -___ - -### assertionMethod - -• **assertionMethod**: `undefined` \| (`string` \| [`VerificationMethod`](verida_types._internal_.VerificationMethod.md))[] - -#### Inherited from - -DocInterface.assertionMethod - -___ - -### authentication - -• **authentication**: `undefined` \| (`string` \| [`VerificationMethod`](verida_types._internal_.VerificationMethod.md))[] - -#### Inherited from - -DocInterface.authentication - -___ - -### capabilityDelegation - -• **capabilityDelegation**: `undefined` \| (`string` \| [`VerificationMethod`](verida_types._internal_.VerificationMethod.md))[] - -#### Inherited from - -DocInterface.capabilityDelegation - -___ - -### capabilityInvocation - -• **capabilityInvocation**: `undefined` \| (`string` \| [`VerificationMethod`](verida_types._internal_.VerificationMethod.md))[] - -#### Inherited from - -DocInterface.capabilityInvocation - -___ - -### controller - -• `Optional` **controller**: `string` \| `string`[] - -#### Inherited from - -DocInterface.controller - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:64 - -___ - -### created - -• `Optional` **created**: `string` - -#### Defined in - -[packages/types/src/DocumentInterfaces.ts:48](https://github.com/verida/verida-js/blob/5040472/packages/types/src/DocumentInterfaces.ts#L48) - -___ - -### deactivated - -• `Optional` **deactivated**: `string` - -#### Defined in - -[packages/types/src/DocumentInterfaces.ts:50](https://github.com/verida/verida-js/blob/5040472/packages/types/src/DocumentInterfaces.ts#L50) - -___ - -### id - -• **id**: `string` - -#### Inherited from - -DocInterface.id - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:62 - -___ - -### keyAgreement - -• **keyAgreement**: `undefined` \| (`string` \| [`VerificationMethod`](verida_types._internal_.VerificationMethod.md))[] - -#### Inherited from - -DocInterface.keyAgreement - -___ - -### proof - -• `Optional` **proof**: [`ProofInterface`](verida_types.ProofInterface.md) - -#### Defined in - -[packages/types/src/DocumentInterfaces.ts:51](https://github.com/verida/verida-js/blob/5040472/packages/types/src/DocumentInterfaces.ts#L51) - -___ - -### publicKey - -• `Optional` **publicKey**: [`VerificationMethod`](verida_types._internal_.VerificationMethod.md)[] - -**`deprecated`** - -#### Inherited from - -DocInterface.publicKey - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:70 - -___ - -### service - -• `Optional` **service**: [`Service`](verida_types._internal_.Service.md)[] - -#### Inherited from - -DocInterface.service - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:66 - -___ - -### updated - -• `Optional` **updated**: `string` - -#### Defined in - -[packages/types/src/DocumentInterfaces.ts:49](https://github.com/verida/verida-js/blob/5040472/packages/types/src/DocumentInterfaces.ts#L49) - -___ - -### verificationMethod - -• `Optional` **verificationMethod**: [`VerificationMethod`](verida_types._internal_.VerificationMethod.md)[] - -#### Inherited from - -DocInterface.verificationMethod - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:65 - -___ - -### versionId - -• **versionId**: `number` - -#### Defined in - -[packages/types/src/DocumentInterfaces.ts:47](https://github.com/verida/verida-js/blob/5040472/packages/types/src/DocumentInterfaces.ts#L47) diff --git a/docs/api/verida-js/interfaces/verida_types.WalletConnectConfig.md b/docs/api/verida-js/interfaces/verida_types.WalletConnectConfig.md deleted file mode 100644 index 8075b5d..0000000 --- a/docs/api/verida-js/interfaces/verida_types.WalletConnectConfig.md +++ /dev/null @@ -1,43 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/types](../modules/verida_types.md) / WalletConnectConfig - -# Interface: WalletConnectConfig - -[@verida/types](../modules/verida_types.md).WalletConnectConfig - -## Table of contents - -### Properties - -- [chainId](verida_types.WalletConnectConfig.md#chainid) -- [uri](verida_types.WalletConnectConfig.md#uri) -- [version](verida_types.WalletConnectConfig.md#version) - -## Properties - -### chainId - -• **chainId**: `string` - -#### Defined in - -[packages/types/src/AccountInterfaces.ts:63](https://github.com/verida/verida-js/blob/5040472/packages/types/src/AccountInterfaces.ts#L63) - -___ - -### uri - -• **uri**: `string` - -#### Defined in - -[packages/types/src/AccountInterfaces.ts:62](https://github.com/verida/verida-js/blob/5040472/packages/types/src/AccountInterfaces.ts#L62) - -___ - -### version - -• **version**: `string` - -#### Defined in - -[packages/types/src/AccountInterfaces.ts:61](https://github.com/verida/verida-js/blob/5040472/packages/types/src/AccountInterfaces.ts#L61) diff --git a/docs/api/verida-js/interfaces/verida_types.Web3ContractInfo.md b/docs/api/verida-js/interfaces/verida_types.Web3ContractInfo.md deleted file mode 100644 index 7a996b6..0000000 --- a/docs/api/verida-js/interfaces/verida_types.Web3ContractInfo.md +++ /dev/null @@ -1,45 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/types](../modules/verida_types.md) / Web3ContractInfo - -# Interface: Web3ContractInfo - -[@verida/types](../modules/verida_types.md).Web3ContractInfo - -Contract Info. Used for 'web3' mode - -## Table of contents - -### Properties - -- [abi](verida_types.Web3ContractInfo.md#abi) -- [address](verida_types.Web3ContractInfo.md#address) -- [logPerformance](verida_types.Web3ContractInfo.md#logperformance) - -## Properties - -### abi - -• **abi**: `any` - -#### Defined in - -[packages/types/src/Web3Interfaces.ts:11](https://github.com/verida/verida-js/blob/5040472/packages/types/src/Web3Interfaces.ts#L11) - -___ - -### address - -• **address**: `string` - -#### Defined in - -[packages/types/src/Web3Interfaces.ts:12](https://github.com/verida/verida-js/blob/5040472/packages/types/src/Web3Interfaces.ts#L12) - -___ - -### logPerformance - -• `Optional` **logPerformance**: `boolean` - -#### Defined in - -[packages/types/src/Web3Interfaces.ts:13](https://github.com/verida/verida-js/blob/5040472/packages/types/src/Web3Interfaces.ts#L13) diff --git a/docs/api/verida-js/interfaces/verida_types.Web3GasConfiguration.md b/docs/api/verida-js/interfaces/verida_types.Web3GasConfiguration.md deleted file mode 100644 index 3eb9141..0000000 --- a/docs/api/verida-js/interfaces/verida_types.Web3GasConfiguration.md +++ /dev/null @@ -1,91 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/types](../modules/verida_types.md) / Web3GasConfiguration - -# Interface: Web3GasConfiguration - -[@verida/types](../modules/verida_types.md).Web3GasConfiguration - -Gas configuration - -eip1559Mode - optional - Once this parameter is set, all other parameters are not used. Gas information is pulled from network. - -maxFeePerGas - optional - Used for EIP1559 chains -maxPriorityFeePerGas - optional - Used for EIP1559 chains -gasLimit - optional - Used for non EIP1559 chains -gasPrice - optional - Used for non EIP1559 chains - -## Hierarchy - -- **`Web3GasConfiguration`** - - ↳ [`Web3SelfTransactionConfig`](verida_types.Web3SelfTransactionConfig.md) - -## Table of contents - -### Properties - -- [eip1559Mode](verida_types.Web3GasConfiguration.md#eip1559mode) -- [eip1559gasStationUrl](verida_types.Web3GasConfiguration.md#eip1559gasstationurl) -- [gasLimit](verida_types.Web3GasConfiguration.md#gaslimit) -- [gasPrice](verida_types.Web3GasConfiguration.md#gasprice) -- [maxFeePerGas](verida_types.Web3GasConfiguration.md#maxfeepergas) -- [maxPriorityFeePerGas](verida_types.Web3GasConfiguration.md#maxpriorityfeepergas) - -## Properties - -### eip1559Mode - -• `Optional` **eip1559Mode**: [`EIP1559GasMode`](../modules/verida_types.md#eip1559gasmode) - -#### Defined in - -[packages/types/src/Web3Interfaces.ts:28](https://github.com/verida/verida-js/blob/5040472/packages/types/src/Web3Interfaces.ts#L28) - -___ - -### eip1559gasStationUrl - -• `Optional` **eip1559gasStationUrl**: `string` - -#### Defined in - -[packages/types/src/Web3Interfaces.ts:29](https://github.com/verida/verida-js/blob/5040472/packages/types/src/Web3Interfaces.ts#L29) - -___ - -### gasLimit - -• `Optional` **gasLimit**: [`BigNumber`](../classes/verida_types._internal_.BigNumber.md) - -#### Defined in - -[packages/types/src/Web3Interfaces.ts:33](https://github.com/verida/verida-js/blob/5040472/packages/types/src/Web3Interfaces.ts#L33) - -___ - -### gasPrice - -• `Optional` **gasPrice**: [`BigNumber`](../classes/verida_types._internal_.BigNumber.md) - -#### Defined in - -[packages/types/src/Web3Interfaces.ts:34](https://github.com/verida/verida-js/blob/5040472/packages/types/src/Web3Interfaces.ts#L34) - -___ - -### maxFeePerGas - -• `Optional` **maxFeePerGas**: [`BigNumber`](../classes/verida_types._internal_.BigNumber.md) - -#### Defined in - -[packages/types/src/Web3Interfaces.ts:31](https://github.com/verida/verida-js/blob/5040472/packages/types/src/Web3Interfaces.ts#L31) - -___ - -### maxPriorityFeePerGas - -• `Optional` **maxPriorityFeePerGas**: [`BigNumber`](../classes/verida_types._internal_.BigNumber.md) - -#### Defined in - -[packages/types/src/Web3Interfaces.ts:32](https://github.com/verida/verida-js/blob/5040472/packages/types/src/Web3Interfaces.ts#L32) diff --git a/docs/api/verida-js/interfaces/verida_types.Web3GaslessPostConfig.md b/docs/api/verida-js/interfaces/verida_types.Web3GaslessPostConfig.md deleted file mode 100644 index 270b16a..0000000 --- a/docs/api/verida-js/interfaces/verida_types.Web3GaslessPostConfig.md +++ /dev/null @@ -1,37 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/types](../modules/verida_types.md) / Web3GaslessPostConfig - -# Interface: Web3GaslessPostConfig - -[@verida/types](../modules/verida_types.md).Web3GaslessPostConfig - -Configuration type for gasless post - -## Indexable - -▪ [key: `string`]: `any` - -## Table of contents - -### Properties - -- [headers](verida_types.Web3GaslessPostConfig.md#headers) - -## Properties - -### headers - -• **headers**: `Object` - -#### Index signature - -▪ [key: `string`]: `any` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `user-agent` | `string` | - -#### Defined in - -[packages/types/src/Web3Interfaces.ts:75](https://github.com/verida/verida-js/blob/5040472/packages/types/src/Web3Interfaces.ts#L75) diff --git a/docs/api/verida-js/interfaces/verida_types.Web3GaslessRequestConfig.md b/docs/api/verida-js/interfaces/verida_types.Web3GaslessRequestConfig.md deleted file mode 100644 index 3eaa524..0000000 --- a/docs/api/verida-js/interfaces/verida_types.Web3GaslessRequestConfig.md +++ /dev/null @@ -1,37 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/types](../modules/verida_types.md) / Web3GaslessRequestConfig - -# Interface: Web3GaslessRequestConfig - -[@verida/types](../modules/verida_types.md).Web3GaslessRequestConfig - -Configuration type for gasless request - -## Indexable - -▪ [key: `string`]: `any` - -## Table of contents - -### Properties - -- [headers](verida_types.Web3GaslessRequestConfig.md#headers) - -## Properties - -### headers - -• **headers**: `Object` - -#### Index signature - -▪ [key: `string`]: `any` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `context-name` | `string` | - -#### Defined in - -[packages/types/src/Web3Interfaces.ts:66](https://github.com/verida/verida-js/blob/5040472/packages/types/src/Web3Interfaces.ts#L66) diff --git a/docs/api/verida-js/interfaces/verida_types.Web3MetaTransactionConfig.md b/docs/api/verida-js/interfaces/verida_types.Web3MetaTransactionConfig.md deleted file mode 100644 index d123b9b..0000000 --- a/docs/api/verida-js/interfaces/verida_types.Web3MetaTransactionConfig.md +++ /dev/null @@ -1,45 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/types](../modules/verida_types.md) / Web3MetaTransactionConfig - -# Interface: Web3MetaTransactionConfig - -[@verida/types](../modules/verida_types.md).Web3MetaTransactionConfig - -Configuration type for gasless mode - -## Table of contents - -### Properties - -- [endpointUrl](verida_types.Web3MetaTransactionConfig.md#endpointurl) -- [postConfig](verida_types.Web3MetaTransactionConfig.md#postconfig) -- [serverConfig](verida_types.Web3MetaTransactionConfig.md#serverconfig) - -## Properties - -### endpointUrl - -• **endpointUrl**: `string` - -#### Defined in - -[packages/types/src/Web3Interfaces.ts:59](https://github.com/verida/verida-js/blob/5040472/packages/types/src/Web3Interfaces.ts#L59) - -___ - -### postConfig - -• **postConfig**: [`Web3GaslessPostConfig`](verida_types.Web3GaslessPostConfig.md) - -#### Defined in - -[packages/types/src/Web3Interfaces.ts:58](https://github.com/verida/verida-js/blob/5040472/packages/types/src/Web3Interfaces.ts#L58) - -___ - -### serverConfig - -• **serverConfig**: [`Web3GaslessRequestConfig`](verida_types.Web3GaslessRequestConfig.md) - -#### Defined in - -[packages/types/src/Web3Interfaces.ts:57](https://github.com/verida/verida-js/blob/5040472/packages/types/src/Web3Interfaces.ts#L57) diff --git a/docs/api/verida-js/interfaces/verida_types.Web3ProviderConfiguration.md b/docs/api/verida-js/interfaces/verida_types.Web3ProviderConfiguration.md deleted file mode 100644 index 0f57834..0000000 --- a/docs/api/verida-js/interfaces/verida_types.Web3ProviderConfiguration.md +++ /dev/null @@ -1,68 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/types](../modules/verida_types.md) / Web3ProviderConfiguration - -# Interface: Web3ProviderConfiguration - -[@verida/types](../modules/verida_types.md).Web3ProviderConfiguration - -A configuration entry for an ethereum network -It should contain at least one of `name` or `chainId` AND one of `provider`, `web3`, or `rpcUrl` - -**`example`** ```js -{ name: 'development', registry: '0x9af37603e98e0dc2b855be647c39abe984fc2445', rpcUrl: 'http://127.0.0.1:8545/' } -{ name: 'goerli', chainId: 5, provider: new InfuraProvider('goerli') } -{ name: 'rinkeby', provider: new AlchemyProvider('rinkeby') } -{ name: 'rsk:testnet', chainId: '0x1f', rpcUrl: 'https://public-node.testnet.rsk.co' } -``` - -## Indexable - -▪ [index: `string`]: `any` - -## Table of contents - -### Properties - -- [chainId](verida_types.Web3ProviderConfiguration.md#chainid) -- [provider](verida_types.Web3ProviderConfiguration.md#provider) -- [rpcUrl](verida_types.Web3ProviderConfiguration.md#rpcurl) -- [web3](verida_types.Web3ProviderConfiguration.md#web3) - -## Properties - -### chainId - -• `Optional` **chainId**: `string` \| `number` - -#### Defined in - -[packages/types/src/Web3Interfaces.ts:97](https://github.com/verida/verida-js/blob/5040472/packages/types/src/Web3Interfaces.ts#L97) - -___ - -### provider - -• `Optional` **provider**: [`Provider`](../classes/verida_types._internal_.Provider.md) - -#### Defined in - -[packages/types/src/Web3Interfaces.ts:95](https://github.com/verida/verida-js/blob/5040472/packages/types/src/Web3Interfaces.ts#L95) - -___ - -### rpcUrl - -• `Optional` **rpcUrl**: `string` - -#### Defined in - -[packages/types/src/Web3Interfaces.ts:96](https://github.com/verida/verida-js/blob/5040472/packages/types/src/Web3Interfaces.ts#L96) - -___ - -### web3 - -• `Optional` **web3**: `any` - -#### Defined in - -[packages/types/src/Web3Interfaces.ts:99](https://github.com/verida/verida-js/blob/5040472/packages/types/src/Web3Interfaces.ts#L99) diff --git a/docs/api/verida-js/interfaces/verida_types.Web3ResolverConfigurationOptions.md b/docs/api/verida-js/interfaces/verida_types.Web3ResolverConfigurationOptions.md deleted file mode 100644 index 8d6b8cc..0000000 --- a/docs/api/verida-js/interfaces/verida_types.Web3ResolverConfigurationOptions.md +++ /dev/null @@ -1,32 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/types](../modules/verida_types.md) / Web3ResolverConfigurationOptions - -# Interface: Web3ResolverConfigurationOptions - -[@verida/types](../modules/verida_types.md).Web3ResolverConfigurationOptions - -## Table of contents - -### Properties - -- [rpcUrl](verida_types.Web3ResolverConfigurationOptions.md#rpcurl) -- [timeout](verida_types.Web3ResolverConfigurationOptions.md#timeout) - -## Properties - -### rpcUrl - -• `Optional` **rpcUrl**: `string` - -#### Defined in - -[packages/types/src/Web3Interfaces.ts:144](https://github.com/verida/verida-js/blob/5040472/packages/types/src/Web3Interfaces.ts#L144) - -___ - -### timeout - -• `Optional` **timeout**: `number` - -#### Defined in - -[packages/types/src/Web3Interfaces.ts:145](https://github.com/verida/verida-js/blob/5040472/packages/types/src/Web3Interfaces.ts#L145) diff --git a/docs/api/verida-js/interfaces/verida_types.Web3SelfTransactionConfig.md b/docs/api/verida-js/interfaces/verida_types.Web3SelfTransactionConfig.md deleted file mode 100644 index e2d06b5..0000000 --- a/docs/api/verida-js/interfaces/verida_types.Web3SelfTransactionConfig.md +++ /dev/null @@ -1,179 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/types](../modules/verida_types.md) / Web3SelfTransactionConfig - -# Interface: Web3SelfTransactionConfig - -[@verida/types](../modules/verida_types.md).Web3SelfTransactionConfig - -Configuration type for Web3 mode - -signer - optional - a Signer that sign the blockchain transactions. If a 'signer' is not provided, then 'contract' with an attached signer need to be used to make transactions -provider - optional - a web3 provider. At least one of `signer`,`provider`, or `rpcUrl` is required -rpcUrl - optinal - a JSON-RPC URL that can be used to connect to an ethereum network. At least one of `signer`, `provider`, or `rpcUrl` is required -web3 - optional - Can use provider or web.currentProvider as a provider. - -## Hierarchy - -- [`Web3GasConfiguration`](verida_types.Web3GasConfiguration.md) - - ↳ **`Web3SelfTransactionConfig`** - -## Table of contents - -### Properties - -- [eip1559Mode](verida_types.Web3SelfTransactionConfig.md#eip1559mode) -- [eip1559gasStationUrl](verida_types.Web3SelfTransactionConfig.md#eip1559gasstationurl) -- [gasLimit](verida_types.Web3SelfTransactionConfig.md#gaslimit) -- [gasPrice](verida_types.Web3SelfTransactionConfig.md#gasprice) -- [maxFeePerGas](verida_types.Web3SelfTransactionConfig.md#maxfeepergas) -- [maxPriorityFeePerGas](verida_types.Web3SelfTransactionConfig.md#maxpriorityfeepergas) -- [methodDefaults](verida_types.Web3SelfTransactionConfig.md#methoddefaults) -- [privateKey](verida_types.Web3SelfTransactionConfig.md#privatekey) -- [provider](verida_types.Web3SelfTransactionConfig.md#provider) -- [rpcUrl](verida_types.Web3SelfTransactionConfig.md#rpcurl) -- [signer](verida_types.Web3SelfTransactionConfig.md#signer) -- [web3](verida_types.Web3SelfTransactionConfig.md#web3) - -## Properties - -### eip1559Mode - -• `Optional` **eip1559Mode**: [`EIP1559GasMode`](../modules/verida_types.md#eip1559gasmode) - -#### Inherited from - -[Web3GasConfiguration](verida_types.Web3GasConfiguration.md).[eip1559Mode](verida_types.Web3GasConfiguration.md#eip1559mode) - -#### Defined in - -[packages/types/src/Web3Interfaces.ts:28](https://github.com/verida/verida-js/blob/5040472/packages/types/src/Web3Interfaces.ts#L28) - -___ - -### eip1559gasStationUrl - -• `Optional` **eip1559gasStationUrl**: `string` - -#### Inherited from - -[Web3GasConfiguration](verida_types.Web3GasConfiguration.md).[eip1559gasStationUrl](verida_types.Web3GasConfiguration.md#eip1559gasstationurl) - -#### Defined in - -[packages/types/src/Web3Interfaces.ts:29](https://github.com/verida/verida-js/blob/5040472/packages/types/src/Web3Interfaces.ts#L29) - -___ - -### gasLimit - -• `Optional` **gasLimit**: [`BigNumber`](../classes/verida_types._internal_.BigNumber.md) - -#### Inherited from - -[Web3GasConfiguration](verida_types.Web3GasConfiguration.md).[gasLimit](verida_types.Web3GasConfiguration.md#gaslimit) - -#### Defined in - -[packages/types/src/Web3Interfaces.ts:33](https://github.com/verida/verida-js/blob/5040472/packages/types/src/Web3Interfaces.ts#L33) - -___ - -### gasPrice - -• `Optional` **gasPrice**: [`BigNumber`](../classes/verida_types._internal_.BigNumber.md) - -#### Inherited from - -[Web3GasConfiguration](verida_types.Web3GasConfiguration.md).[gasPrice](verida_types.Web3GasConfiguration.md#gasprice) - -#### Defined in - -[packages/types/src/Web3Interfaces.ts:34](https://github.com/verida/verida-js/blob/5040472/packages/types/src/Web3Interfaces.ts#L34) - -___ - -### maxFeePerGas - -• `Optional` **maxFeePerGas**: [`BigNumber`](../classes/verida_types._internal_.BigNumber.md) - -#### Inherited from - -[Web3GasConfiguration](verida_types.Web3GasConfiguration.md).[maxFeePerGas](verida_types.Web3GasConfiguration.md#maxfeepergas) - -#### Defined in - -[packages/types/src/Web3Interfaces.ts:31](https://github.com/verida/verida-js/blob/5040472/packages/types/src/Web3Interfaces.ts#L31) - -___ - -### maxPriorityFeePerGas - -• `Optional` **maxPriorityFeePerGas**: [`BigNumber`](../classes/verida_types._internal_.BigNumber.md) - -#### Inherited from - -[Web3GasConfiguration](verida_types.Web3GasConfiguration.md).[maxPriorityFeePerGas](verida_types.Web3GasConfiguration.md#maxpriorityfeepergas) - -#### Defined in - -[packages/types/src/Web3Interfaces.ts:32](https://github.com/verida/verida-js/blob/5040472/packages/types/src/Web3Interfaces.ts#L32) - -___ - -### methodDefaults - -• `Optional` **methodDefaults**: [`Record`](../modules/verida_types._internal_.md#record)<`string`, [`Web3GasConfiguration`](verida_types.Web3GasConfiguration.md)\> - -#### Defined in - -[packages/types/src/Web3Interfaces.ts:52](https://github.com/verida/verida-js/blob/5040472/packages/types/src/Web3Interfaces.ts#L52) - -___ - -### privateKey - -• `Optional` **privateKey**: `string` - -#### Defined in - -[packages/types/src/Web3Interfaces.ts:47](https://github.com/verida/verida-js/blob/5040472/packages/types/src/Web3Interfaces.ts#L47) - -___ - -### provider - -• `Optional` **provider**: [`Provider`](../classes/verida_types._internal_.Provider.md) - -#### Defined in - -[packages/types/src/Web3Interfaces.ts:48](https://github.com/verida/verida-js/blob/5040472/packages/types/src/Web3Interfaces.ts#L48) - -___ - -### rpcUrl - -• `Optional` **rpcUrl**: `string` - -#### Defined in - -[packages/types/src/Web3Interfaces.ts:49](https://github.com/verida/verida-js/blob/5040472/packages/types/src/Web3Interfaces.ts#L49) - -___ - -### signer - -• `Optional` **signer**: [`Signer`](../classes/verida_types._internal_.Signer.md) - -#### Defined in - -[packages/types/src/Web3Interfaces.ts:46](https://github.com/verida/verida-js/blob/5040472/packages/types/src/Web3Interfaces.ts#L46) - -___ - -### web3 - -• `Optional` **web3**: `any` - -#### Defined in - -[packages/types/src/Web3Interfaces.ts:50](https://github.com/verida/verida-js/blob/5040472/packages/types/src/Web3Interfaces.ts#L50) diff --git a/docs/api/verida-js/interfaces/verida_types.Web3SelfTransactionConfigPart.md b/docs/api/verida-js/interfaces/verida_types.Web3SelfTransactionConfigPart.md deleted file mode 100644 index 9d9f350..0000000 --- a/docs/api/verida-js/interfaces/verida_types.Web3SelfTransactionConfigPart.md +++ /dev/null @@ -1,32 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/types](../modules/verida_types.md) / Web3SelfTransactionConfigPart - -# Interface: Web3SelfTransactionConfigPart - -[@verida/types](../modules/verida_types.md).Web3SelfTransactionConfigPart - -## Table of contents - -### Properties - -- [privateKey](verida_types.Web3SelfTransactionConfigPart.md#privatekey) -- [signer](verida_types.Web3SelfTransactionConfigPart.md#signer) - -## Properties - -### privateKey - -• `Optional` **privateKey**: `string` - -#### Defined in - -[packages/types/src/Web3Interfaces.ts:140](https://github.com/verida/verida-js/blob/5040472/packages/types/src/Web3Interfaces.ts#L140) - -___ - -### signer - -• `Optional` **signer**: [`Signer`](../classes/verida_types._internal_.Signer.md) - -#### Defined in - -[packages/types/src/Web3Interfaces.ts:139](https://github.com/verida/verida-js/blob/5040472/packages/types/src/Web3Interfaces.ts#L139) diff --git a/docs/api/verida-js/interfaces/verida_types._internal_.ArrayLike.md b/docs/api/verida-js/interfaces/verida_types._internal_.ArrayLike.md deleted file mode 100644 index b174719..0000000 --- a/docs/api/verida-js/interfaces/verida_types._internal_.ArrayLike.md +++ /dev/null @@ -1,31 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/types](../modules/verida_types.md) / [](../modules/verida_types._internal_.md) / ArrayLike - -# Interface: ArrayLike - -[@verida/types](../modules/verida_types.md).[](../modules/verida_types._internal_.md).ArrayLike - -## Type parameters - -| Name | -| :------ | -| `T` | - -## Indexable - -▪ [n: `number`]: `T` - -## Table of contents - -### Properties - -- [length](verida_types._internal_.ArrayLike.md#length) - -## Properties - -### length - -• `Readonly` **length**: `number` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1464 diff --git a/docs/api/verida-js/interfaces/verida_types._internal_.AsyncIterableIterator.md b/docs/api/verida-js/interfaces/verida_types._internal_.AsyncIterableIterator.md deleted file mode 100644 index 21e2d11..0000000 --- a/docs/api/verida-js/interfaces/verida_types._internal_.AsyncIterableIterator.md +++ /dev/null @@ -1,112 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/types](../modules/verida_types.md) / [](../modules/verida_types._internal_.md) / AsyncIterableIterator - -# Interface: AsyncIterableIterator - -[@verida/types](../modules/verida_types.md).[](../modules/verida_types._internal_.md).AsyncIterableIterator - -## Type parameters - -| Name | -| :------ | -| `T` | - -## Hierarchy - -- [`AsyncIterator`](verida_types._internal_.AsyncIterator.md)<`T`\> - - ↳ **`AsyncIterableIterator`** - -## Table of contents - -### Methods - -- [[asyncIterator]](verida_types._internal_.AsyncIterableIterator.md#[asynciterator]) -- [next](verida_types._internal_.AsyncIterableIterator.md#next) -- [return](verida_types._internal_.AsyncIterableIterator.md#return) -- [throw](verida_types._internal_.AsyncIterableIterator.md#throw) - -## Methods - -### [asyncIterator] - -▸ **[asyncIterator]**(): [`AsyncIterableIterator`](verida_types._internal_.AsyncIterableIterator.md)<`T`\> - -#### Returns - -[`AsyncIterableIterator`](verida_types._internal_.AsyncIterableIterator.md)<`T`\> - -#### Defined in - -node_modules/typescript/lib/lib.es2018.asynciterable.d.ts:44 - -___ - -### next - -▸ **next**(...`args`): `Promise`<[`IteratorResult`](../modules/verida_types._internal_.md#iteratorresult)<`T`, `any`\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `...args` | [] \| [`undefined`] | - -#### Returns - -`Promise`<[`IteratorResult`](../modules/verida_types._internal_.md#iteratorresult)<`T`, `any`\>\> - -#### Inherited from - -[AsyncIterator](verida_types._internal_.AsyncIterator.md).[next](verida_types._internal_.AsyncIterator.md#next) - -#### Defined in - -node_modules/typescript/lib/lib.es2018.asynciterable.d.ts:34 - -___ - -### return - -▸ `Optional` **return**(`value?`): `Promise`<[`IteratorResult`](../modules/verida_types._internal_.md#iteratorresult)<`T`, `any`\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value?` | `any` | - -#### Returns - -`Promise`<[`IteratorResult`](../modules/verida_types._internal_.md#iteratorresult)<`T`, `any`\>\> - -#### Inherited from - -[AsyncIterator](verida_types._internal_.AsyncIterator.md).[return](verida_types._internal_.AsyncIterator.md#return) - -#### Defined in - -node_modules/typescript/lib/lib.es2018.asynciterable.d.ts:35 - -___ - -### throw - -▸ `Optional` **throw**(`e?`): `Promise`<[`IteratorResult`](../modules/verida_types._internal_.md#iteratorresult)<`T`, `any`\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `e?` | `any` | - -#### Returns - -`Promise`<[`IteratorResult`](../modules/verida_types._internal_.md#iteratorresult)<`T`, `any`\>\> - -#### Inherited from - -[AsyncIterator](verida_types._internal_.AsyncIterator.md).[throw](verida_types._internal_.AsyncIterator.md#throw) - -#### Defined in - -node_modules/typescript/lib/lib.es2018.asynciterable.d.ts:36 diff --git a/docs/api/verida-js/interfaces/verida_types._internal_.AsyncIterator.md b/docs/api/verida-js/interfaces/verida_types._internal_.AsyncIterator.md deleted file mode 100644 index 9807348..0000000 --- a/docs/api/verida-js/interfaces/verida_types._internal_.AsyncIterator.md +++ /dev/null @@ -1,87 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/types](../modules/verida_types.md) / [](../modules/verida_types._internal_.md) / AsyncIterator - -# Interface: AsyncIterator - -[@verida/types](../modules/verida_types.md).[](../modules/verida_types._internal_.md).AsyncIterator - -## Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `T` | -| `TReturn` | `any` | -| `TNext` | `undefined` | - -## Hierarchy - -- **`AsyncIterator`** - - ↳ [`AsyncIterableIterator`](verida_types._internal_.AsyncIterableIterator.md) - -## Table of contents - -### Methods - -- [next](verida_types._internal_.AsyncIterator.md#next) -- [return](verida_types._internal_.AsyncIterator.md#return) -- [throw](verida_types._internal_.AsyncIterator.md#throw) - -## Methods - -### next - -▸ **next**(...`args`): `Promise`<[`IteratorResult`](../modules/verida_types._internal_.md#iteratorresult)<`T`, `TReturn`\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `...args` | [] \| [`TNext`] | - -#### Returns - -`Promise`<[`IteratorResult`](../modules/verida_types._internal_.md#iteratorresult)<`T`, `TReturn`\>\> - -#### Defined in - -node_modules/typescript/lib/lib.es2018.asynciterable.d.ts:34 - -___ - -### return - -▸ `Optional` **return**(`value?`): `Promise`<[`IteratorResult`](../modules/verida_types._internal_.md#iteratorresult)<`T`, `TReturn`\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value?` | `TReturn` \| [`PromiseLike`](verida_types._internal_.PromiseLike.md)<`TReturn`\> | - -#### Returns - -`Promise`<[`IteratorResult`](../modules/verida_types._internal_.md#iteratorresult)<`T`, `TReturn`\>\> - -#### Defined in - -node_modules/typescript/lib/lib.es2018.asynciterable.d.ts:35 - -___ - -### throw - -▸ `Optional` **throw**(`e?`): `Promise`<[`IteratorResult`](../modules/verida_types._internal_.md#iteratorresult)<`T`, `TReturn`\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `e?` | `any` | - -#### Returns - -`Promise`<[`IteratorResult`](../modules/verida_types._internal_.md#iteratorresult)<`T`, `TReturn`\>\> - -#### Defined in - -node_modules/typescript/lib/lib.es2018.asynciterable.d.ts:36 diff --git a/docs/api/verida-js/interfaces/verida_types._internal_.Block.md b/docs/api/verida-js/interfaces/verida_types._internal_.Block.md deleted file mode 100644 index abeac90..0000000 --- a/docs/api/verida-js/interfaces/verida_types._internal_.Block.md +++ /dev/null @@ -1,207 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/types](../modules/verida_types.md) / [](../modules/verida_types._internal_.md) / Block - -# Interface: Block - -[@verida/types](../modules/verida_types.md).[](../modules/verida_types._internal_.md).Block - -## Hierarchy - -- [`_Block`](verida_types._internal_._Block.md) - - ↳ **`Block`** - -## Table of contents - -### Properties - -- [\_difficulty](verida_types._internal_.Block.md#_difficulty) -- [baseFeePerGas](verida_types._internal_.Block.md#basefeepergas) -- [difficulty](verida_types._internal_.Block.md#difficulty) -- [extraData](verida_types._internal_.Block.md#extradata) -- [gasLimit](verida_types._internal_.Block.md#gaslimit) -- [gasUsed](verida_types._internal_.Block.md#gasused) -- [hash](verida_types._internal_.Block.md#hash) -- [miner](verida_types._internal_.Block.md#miner) -- [nonce](verida_types._internal_.Block.md#nonce) -- [number](verida_types._internal_.Block.md#number) -- [parentHash](verida_types._internal_.Block.md#parenthash) -- [timestamp](verida_types._internal_.Block.md#timestamp) -- [transactions](verida_types._internal_.Block.md#transactions) - -## Properties - -### \_difficulty - -• **\_difficulty**: [`BigNumber`](../classes/verida_types._internal_.BigNumber.md) - -#### Inherited from - -[_Block](verida_types._internal_._Block.md).[_difficulty](verida_types._internal_._Block.md#_difficulty) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:41 - -___ - -### baseFeePerGas - -• `Optional` **baseFeePerGas**: ``null`` \| [`BigNumber`](../classes/verida_types._internal_.BigNumber.md) - -#### Inherited from - -[_Block](verida_types._internal_._Block.md).[baseFeePerGas](verida_types._internal_._Block.md#basefeepergas) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:46 - -___ - -### difficulty - -• **difficulty**: `number` - -#### Inherited from - -[_Block](verida_types._internal_._Block.md).[difficulty](verida_types._internal_._Block.md#difficulty) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:40 - -___ - -### extraData - -• **extraData**: `string` - -#### Inherited from - -[_Block](verida_types._internal_._Block.md).[extraData](verida_types._internal_._Block.md#extradata) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:45 - -___ - -### gasLimit - -• **gasLimit**: [`BigNumber`](../classes/verida_types._internal_.BigNumber.md) - -#### Inherited from - -[_Block](verida_types._internal_._Block.md).[gasLimit](verida_types._internal_._Block.md#gaslimit) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:42 - -___ - -### gasUsed - -• **gasUsed**: [`BigNumber`](../classes/verida_types._internal_.BigNumber.md) - -#### Inherited from - -[_Block](verida_types._internal_._Block.md).[gasUsed](verida_types._internal_._Block.md#gasused) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:43 - -___ - -### hash - -• **hash**: `string` - -#### Inherited from - -[_Block](verida_types._internal_._Block.md).[hash](verida_types._internal_._Block.md#hash) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:35 - -___ - -### miner - -• **miner**: `string` - -#### Inherited from - -[_Block](verida_types._internal_._Block.md).[miner](verida_types._internal_._Block.md#miner) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:44 - -___ - -### nonce - -• **nonce**: `string` - -#### Inherited from - -[_Block](verida_types._internal_._Block.md).[nonce](verida_types._internal_._Block.md#nonce) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:39 - -___ - -### number - -• **number**: `number` - -#### Inherited from - -[_Block](verida_types._internal_._Block.md).[number](verida_types._internal_._Block.md#number) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:37 - -___ - -### parentHash - -• **parentHash**: `string` - -#### Inherited from - -[_Block](verida_types._internal_._Block.md).[parentHash](verida_types._internal_._Block.md#parenthash) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:36 - -___ - -### timestamp - -• **timestamp**: `number` - -#### Inherited from - -[_Block](verida_types._internal_._Block.md).[timestamp](verida_types._internal_._Block.md#timestamp) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:38 - -___ - -### transactions - -• **transactions**: `string`[] - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:49 diff --git a/docs/api/verida-js/interfaces/verida_types._internal_.BlockWithTransactions.md b/docs/api/verida-js/interfaces/verida_types._internal_.BlockWithTransactions.md deleted file mode 100644 index ed3903a..0000000 --- a/docs/api/verida-js/interfaces/verida_types._internal_.BlockWithTransactions.md +++ /dev/null @@ -1,207 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/types](../modules/verida_types.md) / [](../modules/verida_types._internal_.md) / BlockWithTransactions - -# Interface: BlockWithTransactions - -[@verida/types](../modules/verida_types.md).[](../modules/verida_types._internal_.md).BlockWithTransactions - -## Hierarchy - -- [`_Block`](verida_types._internal_._Block.md) - - ↳ **`BlockWithTransactions`** - -## Table of contents - -### Properties - -- [\_difficulty](verida_types._internal_.BlockWithTransactions.md#_difficulty) -- [baseFeePerGas](verida_types._internal_.BlockWithTransactions.md#basefeepergas) -- [difficulty](verida_types._internal_.BlockWithTransactions.md#difficulty) -- [extraData](verida_types._internal_.BlockWithTransactions.md#extradata) -- [gasLimit](verida_types._internal_.BlockWithTransactions.md#gaslimit) -- [gasUsed](verida_types._internal_.BlockWithTransactions.md#gasused) -- [hash](verida_types._internal_.BlockWithTransactions.md#hash) -- [miner](verida_types._internal_.BlockWithTransactions.md#miner) -- [nonce](verida_types._internal_.BlockWithTransactions.md#nonce) -- [number](verida_types._internal_.BlockWithTransactions.md#number) -- [parentHash](verida_types._internal_.BlockWithTransactions.md#parenthash) -- [timestamp](verida_types._internal_.BlockWithTransactions.md#timestamp) -- [transactions](verida_types._internal_.BlockWithTransactions.md#transactions) - -## Properties - -### \_difficulty - -• **\_difficulty**: [`BigNumber`](../classes/verida_types._internal_.BigNumber.md) - -#### Inherited from - -[_Block](verida_types._internal_._Block.md).[_difficulty](verida_types._internal_._Block.md#_difficulty) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:41 - -___ - -### baseFeePerGas - -• `Optional` **baseFeePerGas**: ``null`` \| [`BigNumber`](../classes/verida_types._internal_.BigNumber.md) - -#### Inherited from - -[_Block](verida_types._internal_._Block.md).[baseFeePerGas](verida_types._internal_._Block.md#basefeepergas) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:46 - -___ - -### difficulty - -• **difficulty**: `number` - -#### Inherited from - -[_Block](verida_types._internal_._Block.md).[difficulty](verida_types._internal_._Block.md#difficulty) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:40 - -___ - -### extraData - -• **extraData**: `string` - -#### Inherited from - -[_Block](verida_types._internal_._Block.md).[extraData](verida_types._internal_._Block.md#extradata) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:45 - -___ - -### gasLimit - -• **gasLimit**: [`BigNumber`](../classes/verida_types._internal_.BigNumber.md) - -#### Inherited from - -[_Block](verida_types._internal_._Block.md).[gasLimit](verida_types._internal_._Block.md#gaslimit) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:42 - -___ - -### gasUsed - -• **gasUsed**: [`BigNumber`](../classes/verida_types._internal_.BigNumber.md) - -#### Inherited from - -[_Block](verida_types._internal_._Block.md).[gasUsed](verida_types._internal_._Block.md#gasused) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:43 - -___ - -### hash - -• **hash**: `string` - -#### Inherited from - -[_Block](verida_types._internal_._Block.md).[hash](verida_types._internal_._Block.md#hash) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:35 - -___ - -### miner - -• **miner**: `string` - -#### Inherited from - -[_Block](verida_types._internal_._Block.md).[miner](verida_types._internal_._Block.md#miner) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:44 - -___ - -### nonce - -• **nonce**: `string` - -#### Inherited from - -[_Block](verida_types._internal_._Block.md).[nonce](verida_types._internal_._Block.md#nonce) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:39 - -___ - -### number - -• **number**: `number` - -#### Inherited from - -[_Block](verida_types._internal_._Block.md).[number](verida_types._internal_._Block.md#number) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:37 - -___ - -### parentHash - -• **parentHash**: `string` - -#### Inherited from - -[_Block](verida_types._internal_._Block.md).[parentHash](verida_types._internal_._Block.md#parenthash) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:36 - -___ - -### timestamp - -• **timestamp**: `number` - -#### Inherited from - -[_Block](verida_types._internal_._Block.md).[timestamp](verida_types._internal_._Block.md#timestamp) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:38 - -___ - -### transactions - -• **transactions**: [`TransactionResponse`](verida_types._internal_.TransactionResponse.md)[] - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:52 diff --git a/docs/api/verida-js/interfaces/verida_types._internal_.CallSite.md b/docs/api/verida-js/interfaces/verida_types._internal_.CallSite.md deleted file mode 100644 index 03696bd..0000000 --- a/docs/api/verida-js/interfaces/verida_types._internal_.CallSite.md +++ /dev/null @@ -1,238 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/types](../modules/verida_types.md) / [](../modules/verida_types._internal_.md) / CallSite - -# Interface: CallSite - -[@verida/types](../modules/verida_types.md).[](../modules/verida_types._internal_.md).CallSite - -## Table of contents - -### Methods - -- [getColumnNumber](verida_types._internal_.CallSite.md#getcolumnnumber) -- [getEvalOrigin](verida_types._internal_.CallSite.md#getevalorigin) -- [getFileName](verida_types._internal_.CallSite.md#getfilename) -- [getFunction](verida_types._internal_.CallSite.md#getfunction) -- [getFunctionName](verida_types._internal_.CallSite.md#getfunctionname) -- [getLineNumber](verida_types._internal_.CallSite.md#getlinenumber) -- [getMethodName](verida_types._internal_.CallSite.md#getmethodname) -- [getThis](verida_types._internal_.CallSite.md#getthis) -- [getTypeName](verida_types._internal_.CallSite.md#gettypename) -- [isConstructor](verida_types._internal_.CallSite.md#isconstructor) -- [isEval](verida_types._internal_.CallSite.md#iseval) -- [isNative](verida_types._internal_.CallSite.md#isnative) -- [isToplevel](verida_types._internal_.CallSite.md#istoplevel) - -## Methods - -### getColumnNumber - -▸ **getColumnNumber**(): ``null`` \| `number` - -Current column number [if this function was defined in a script] - -#### Returns - -``null`` \| `number` - -#### Defined in - -packages/types/node_modules/@types/node/ts4.8/globals.d.ts:164 - -___ - -### getEvalOrigin - -▸ **getEvalOrigin**(): `undefined` \| `string` - -A call site object representing the location where eval was called -[if this function was created using a call to eval] - -#### Returns - -`undefined` \| `string` - -#### Defined in - -packages/types/node_modules/@types/node/ts4.8/globals.d.ts:170 - -___ - -### getFileName - -▸ **getFileName**(): ``null`` \| `string` - -Name of the script [if this function was defined in a script] - -#### Returns - -``null`` \| `string` - -#### Defined in - -packages/types/node_modules/@types/node/ts4.8/globals.d.ts:154 - -___ - -### getFunction - -▸ **getFunction**(): `undefined` \| `Function` - -Current function - -#### Returns - -`undefined` \| `Function` - -#### Defined in - -packages/types/node_modules/@types/node/ts4.8/globals.d.ts:136 - -___ - -### getFunctionName - -▸ **getFunctionName**(): ``null`` \| `string` - -Name of the current function, typically its name property. -If a name property is not available an attempt will be made to try -to infer a name from the function's context. - -#### Returns - -``null`` \| `string` - -#### Defined in - -packages/types/node_modules/@types/node/ts4.8/globals.d.ts:143 - -___ - -### getLineNumber - -▸ **getLineNumber**(): ``null`` \| `number` - -Current line number [if this function was defined in a script] - -#### Returns - -``null`` \| `number` - -#### Defined in - -packages/types/node_modules/@types/node/ts4.8/globals.d.ts:159 - -___ - -### getMethodName - -▸ **getMethodName**(): ``null`` \| `string` - -Name of the property [of "this" or one of its prototypes] that holds -the current function - -#### Returns - -``null`` \| `string` - -#### Defined in - -packages/types/node_modules/@types/node/ts4.8/globals.d.ts:149 - -___ - -### getThis - -▸ **getThis**(): `unknown` - -Value of "this" - -#### Returns - -`unknown` - -#### Defined in - -packages/types/node_modules/@types/node/ts4.8/globals.d.ts:123 - -___ - -### getTypeName - -▸ **getTypeName**(): ``null`` \| `string` - -Type of "this" as a string. -This is the name of the function stored in the constructor field of -"this", if available. Otherwise the object's [[Class]] internal -property. - -#### Returns - -``null`` \| `string` - -#### Defined in - -packages/types/node_modules/@types/node/ts4.8/globals.d.ts:131 - -___ - -### isConstructor - -▸ **isConstructor**(): `boolean` - -Is this a constructor call? - -#### Returns - -`boolean` - -#### Defined in - -packages/types/node_modules/@types/node/ts4.8/globals.d.ts:190 - -___ - -### isEval - -▸ **isEval**(): `boolean` - -Does this call take place in code defined by a call to eval? - -#### Returns - -`boolean` - -#### Defined in - -packages/types/node_modules/@types/node/ts4.8/globals.d.ts:180 - -___ - -### isNative - -▸ **isNative**(): `boolean` - -Is this call in native V8 code? - -#### Returns - -`boolean` - -#### Defined in - -packages/types/node_modules/@types/node/ts4.8/globals.d.ts:185 - -___ - -### isToplevel - -▸ **isToplevel**(): `boolean` - -Is this a toplevel invocation, that is, is "this" the global object? - -#### Returns - -`boolean` - -#### Defined in - -packages/types/node_modules/@types/node/ts4.8/globals.d.ts:175 diff --git a/docs/api/verida-js/interfaces/verida_types._internal_.Error.md b/docs/api/verida-js/interfaces/verida_types._internal_.Error.md deleted file mode 100644 index 528ab37..0000000 --- a/docs/api/verida-js/interfaces/verida_types._internal_.Error.md +++ /dev/null @@ -1,43 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/types](../modules/verida_types.md) / [](../modules/verida_types._internal_.md) / Error - -# Interface: Error - -[@verida/types](../modules/verida_types.md).[](../modules/verida_types._internal_.md).Error - -## Table of contents - -### Properties - -- [message](verida_types._internal_.Error.md#message) -- [name](verida_types._internal_.Error.md#name) -- [stack](verida_types._internal_.Error.md#stack) - -## Properties - -### message - -• **message**: `string` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:974 - -___ - -### name - -• **name**: `string` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:973 - -___ - -### stack - -• `Optional` **stack**: `string` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:975 diff --git a/docs/api/verida-js/interfaces/verida_types._internal_.EventEmitter.Abortable.md b/docs/api/verida-js/interfaces/verida_types._internal_.EventEmitter.Abortable.md deleted file mode 100644 index 32ec752..0000000 --- a/docs/api/verida-js/interfaces/verida_types._internal_.EventEmitter.Abortable.md +++ /dev/null @@ -1,23 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/types](../modules/verida_types.md) / [](../modules/verida_types._internal_.md) / [EventEmitter](../modules/verida_types._internal_.EventEmitter.md) / Abortable - -# Interface: Abortable - -[](../modules/verida_types._internal_.md).[EventEmitter](../modules/verida_types._internal_.EventEmitter.md).Abortable - -## Table of contents - -### Properties - -- [signal](verida_types._internal_.EventEmitter.Abortable.md#signal) - -## Properties - -### signal - -• `Optional` **signal**: `AbortSignal` - -When provided the corresponding `AbortController` can be used to cancel an asynchronous action. - -#### Defined in - -packages/types/node_modules/@types/node/ts4.8/events.d.ts:344 diff --git a/docs/api/verida-js/interfaces/verida_types._internal_.EventEmitterOptions.md b/docs/api/verida-js/interfaces/verida_types._internal_.EventEmitterOptions.md deleted file mode 100644 index 7e7a940..0000000 --- a/docs/api/verida-js/interfaces/verida_types._internal_.EventEmitterOptions.md +++ /dev/null @@ -1,23 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/types](../modules/verida_types.md) / [](../modules/verida_types._internal_.md) / EventEmitterOptions - -# Interface: EventEmitterOptions - -[@verida/types](../modules/verida_types.md).[](../modules/verida_types._internal_.md).EventEmitterOptions - -## Table of contents - -### Properties - -- [captureRejections](verida_types._internal_.EventEmitterOptions.md#capturerejections) - -## Properties - -### captureRejections - -• `Optional` **captureRejections**: `boolean` - -Enables automatic capturing of promise rejection. - -#### Defined in - -packages/types/node_modules/@types/node/ts4.8/events.d.ts:77 diff --git a/docs/api/verida-js/interfaces/verida_types._internal_.EventFilter.md b/docs/api/verida-js/interfaces/verida_types._internal_.EventFilter.md deleted file mode 100644 index 470c3bc..0000000 --- a/docs/api/verida-js/interfaces/verida_types._internal_.EventFilter.md +++ /dev/null @@ -1,38 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/types](../modules/verida_types.md) / [](../modules/verida_types._internal_.md) / EventFilter - -# Interface: EventFilter - -[@verida/types](../modules/verida_types.md).[](../modules/verida_types._internal_.md).EventFilter - -## Hierarchy - -- **`EventFilter`** - - ↳ [`Filter`](verida_types._internal_.Filter.md) - -## Table of contents - -### Properties - -- [address](verida_types._internal_.EventFilter.md#address) -- [topics](verida_types._internal_.EventFilter.md#topics) - -## Properties - -### address - -• `Optional` **address**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:91 - -___ - -### topics - -• `Optional` **topics**: (``null`` \| `string` \| `string`[])[] - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:92 diff --git a/docs/api/verida-js/interfaces/verida_types._internal_.FeeData.md b/docs/api/verida-js/interfaces/verida_types._internal_.FeeData.md deleted file mode 100644 index 99ee107..0000000 --- a/docs/api/verida-js/interfaces/verida_types._internal_.FeeData.md +++ /dev/null @@ -1,54 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/types](../modules/verida_types.md) / [](../modules/verida_types._internal_.md) / FeeData - -# Interface: FeeData - -[@verida/types](../modules/verida_types.md).[](../modules/verida_types._internal_.md).FeeData - -## Table of contents - -### Properties - -- [gasPrice](verida_types._internal_.FeeData.md#gasprice) -- [lastBaseFeePerGas](verida_types._internal_.FeeData.md#lastbasefeepergas) -- [maxFeePerGas](verida_types._internal_.FeeData.md#maxfeepergas) -- [maxPriorityFeePerGas](verida_types._internal_.FeeData.md#maxpriorityfeepergas) - -## Properties - -### gasPrice - -• **gasPrice**: ``null`` \| [`BigNumber`](../classes/verida_types._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:88 - -___ - -### lastBaseFeePerGas - -• **lastBaseFeePerGas**: ``null`` \| [`BigNumber`](../classes/verida_types._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:85 - -___ - -### maxFeePerGas - -• **maxFeePerGas**: ``null`` \| [`BigNumber`](../classes/verida_types._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:86 - -___ - -### maxPriorityFeePerGas - -• **maxPriorityFeePerGas**: ``null`` \| [`BigNumber`](../classes/verida_types._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:87 diff --git a/docs/api/verida-js/interfaces/verida_types._internal_.Filter.md b/docs/api/verida-js/interfaces/verida_types._internal_.Filter.md deleted file mode 100644 index 698b484..0000000 --- a/docs/api/verida-js/interfaces/verida_types._internal_.Filter.md +++ /dev/null @@ -1,68 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/types](../modules/verida_types.md) / [](../modules/verida_types._internal_.md) / Filter - -# Interface: Filter - -[@verida/types](../modules/verida_types.md).[](../modules/verida_types._internal_.md).Filter - -## Hierarchy - -- [`EventFilter`](verida_types._internal_.EventFilter.md) - - ↳ **`Filter`** - -## Table of contents - -### Properties - -- [address](verida_types._internal_.Filter.md#address) -- [fromBlock](verida_types._internal_.Filter.md#fromblock) -- [toBlock](verida_types._internal_.Filter.md#toblock) -- [topics](verida_types._internal_.Filter.md#topics) - -## Properties - -### address - -• `Optional` **address**: `string` - -#### Inherited from - -[EventFilter](verida_types._internal_.EventFilter.md).[address](verida_types._internal_.EventFilter.md#address) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:91 - -___ - -### fromBlock - -• `Optional` **fromBlock**: [`BlockTag`](../modules/verida_types._internal_.md#blocktag) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:95 - -___ - -### toBlock - -• `Optional` **toBlock**: [`BlockTag`](../modules/verida_types._internal_.md#blocktag) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:96 - -___ - -### topics - -• `Optional` **topics**: (``null`` \| `string` \| `string`[])[] - -#### Inherited from - -[EventFilter](verida_types._internal_.EventFilter.md).[topics](verida_types._internal_.EventFilter.md#topics) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:92 diff --git a/docs/api/verida-js/interfaces/verida_types._internal_.Hexable.md b/docs/api/verida-js/interfaces/verida_types._internal_.Hexable.md deleted file mode 100644 index 7e836f8..0000000 --- a/docs/api/verida-js/interfaces/verida_types._internal_.Hexable.md +++ /dev/null @@ -1,29 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/types](../modules/verida_types.md) / [](../modules/verida_types._internal_.md) / Hexable - -# Interface: Hexable - -[@verida/types](../modules/verida_types.md).[](../modules/verida_types._internal_.md).Hexable - -## Implemented by - -- [`BigNumber`](../classes/verida_types._internal_.BigNumber.md) - -## Table of contents - -### Methods - -- [toHexString](verida_types._internal_.Hexable.md#tohexstring) - -## Methods - -### toHexString - -▸ **toHexString**(): `string` - -#### Returns - -`string` - -#### Defined in - -node_modules/@ethersproject/bytes/lib/index.d.ts:8 diff --git a/docs/api/verida-js/interfaces/verida_types._internal_.IteratorReturnResult.md b/docs/api/verida-js/interfaces/verida_types._internal_.IteratorReturnResult.md deleted file mode 100644 index 3abf7c7..0000000 --- a/docs/api/verida-js/interfaces/verida_types._internal_.IteratorReturnResult.md +++ /dev/null @@ -1,38 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/types](../modules/verida_types.md) / [](../modules/verida_types._internal_.md) / IteratorReturnResult - -# Interface: IteratorReturnResult - -[@verida/types](../modules/verida_types.md).[](../modules/verida_types._internal_.md).IteratorReturnResult - -## Type parameters - -| Name | -| :------ | -| `TReturn` | - -## Table of contents - -### Properties - -- [done](verida_types._internal_.IteratorReturnResult.md#done) -- [value](verida_types._internal_.IteratorReturnResult.md#value) - -## Properties - -### done - -• **done**: ``true`` - -#### Defined in - -node_modules/typescript/lib/lib.es2015.iterable.d.ts:37 - -___ - -### value - -• **value**: `TReturn` - -#### Defined in - -node_modules/typescript/lib/lib.es2015.iterable.d.ts:38 diff --git a/docs/api/verida-js/interfaces/verida_types._internal_.IteratorYieldResult.md b/docs/api/verida-js/interfaces/verida_types._internal_.IteratorYieldResult.md deleted file mode 100644 index 1ac1db2..0000000 --- a/docs/api/verida-js/interfaces/verida_types._internal_.IteratorYieldResult.md +++ /dev/null @@ -1,38 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/types](../modules/verida_types.md) / [](../modules/verida_types._internal_.md) / IteratorYieldResult - -# Interface: IteratorYieldResult - -[@verida/types](../modules/verida_types.md).[](../modules/verida_types._internal_.md).IteratorYieldResult - -## Type parameters - -| Name | -| :------ | -| `TYield` | - -## Table of contents - -### Properties - -- [done](verida_types._internal_.IteratorYieldResult.md#done) -- [value](verida_types._internal_.IteratorYieldResult.md#value) - -## Properties - -### done - -• `Optional` **done**: ``false`` - -#### Defined in - -node_modules/typescript/lib/lib.es2015.iterable.d.ts:32 - -___ - -### value - -• **value**: `TYield` - -#### Defined in - -node_modules/typescript/lib/lib.es2015.iterable.d.ts:33 diff --git a/docs/api/verida-js/interfaces/verida_types._internal_.JsonWebKey.md b/docs/api/verida-js/interfaces/verida_types._internal_.JsonWebKey.md deleted file mode 100644 index 5a32d1b..0000000 --- a/docs/api/verida-js/interfaces/verida_types._internal_.JsonWebKey.md +++ /dev/null @@ -1,145 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/types](../modules/verida_types.md) / [](../modules/verida_types._internal_.md) / JsonWebKey - -# Interface: JsonWebKey - -[@verida/types](../modules/verida_types.md).[](../modules/verida_types._internal_.md).JsonWebKey - -Encapsulates a JSON web key type that includes only the public properties that -can be used in DID documents. - -The private properties are intentionally omitted to discourage the use -(and accidental disclosure) of private keys in DID documents. - -**`see`** [RFC7517 JsonWebKey (JWK)](https://www.rfc-editor.org/rfc/rfc7517) - -## Hierarchy - -- [`Extensible`](../modules/verida_types._internal_.md#extensible) - - ↳ **`JsonWebKey`** - -## Table of contents - -### Properties - -- [alg](verida_types._internal_.JsonWebKey.md#alg) -- [crv](verida_types._internal_.JsonWebKey.md#crv) -- [e](verida_types._internal_.JsonWebKey.md#e) -- [ext](verida_types._internal_.JsonWebKey.md#ext) -- [key\_ops](verida_types._internal_.JsonWebKey.md#key_ops) -- [kid](verida_types._internal_.JsonWebKey.md#kid) -- [kty](verida_types._internal_.JsonWebKey.md#kty) -- [n](verida_types._internal_.JsonWebKey.md#n) -- [use](verida_types._internal_.JsonWebKey.md#use) -- [x](verida_types._internal_.JsonWebKey.md#x) -- [y](verida_types._internal_.JsonWebKey.md#y) - -## Properties - -### alg - -• `Optional` **alg**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:103 - -___ - -### crv - -• `Optional` **crv**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:104 - -___ - -### e - -• `Optional` **e**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:105 - -___ - -### ext - -• `Optional` **ext**: `boolean` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:106 - -___ - -### key\_ops - -• `Optional` **key\_ops**: `string`[] - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:107 - -___ - -### kid - -• `Optional` **kid**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:108 - -___ - -### kty - -• **kty**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:109 - -___ - -### n - -• `Optional` **n**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:110 - -___ - -### use - -• `Optional` **use**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:111 - -___ - -### x - -• `Optional` **x**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:112 - -___ - -### y - -• `Optional` **y**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:113 diff --git a/docs/api/verida-js/interfaces/verida_types._internal_.Log.md b/docs/api/verida-js/interfaces/verida_types._internal_.Log.md deleted file mode 100644 index 69038f9..0000000 --- a/docs/api/verida-js/interfaces/verida_types._internal_.Log.md +++ /dev/null @@ -1,109 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/types](../modules/verida_types.md) / [](../modules/verida_types._internal_.md) / Log - -# Interface: Log - -[@verida/types](../modules/verida_types.md).[](../modules/verida_types._internal_.md).Log - -## Table of contents - -### Properties - -- [address](verida_types._internal_.Log.md#address) -- [blockHash](verida_types._internal_.Log.md#blockhash) -- [blockNumber](verida_types._internal_.Log.md#blocknumber) -- [data](verida_types._internal_.Log.md#data) -- [logIndex](verida_types._internal_.Log.md#logindex) -- [removed](verida_types._internal_.Log.md#removed) -- [topics](verida_types._internal_.Log.md#topics) -- [transactionHash](verida_types._internal_.Log.md#transactionhash) -- [transactionIndex](verida_types._internal_.Log.md#transactionindex) - -## Properties - -### address - -• **address**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:59 - -___ - -### blockHash - -• **blockHash**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:56 - -___ - -### blockNumber - -• **blockNumber**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:55 - -___ - -### data - -• **data**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:60 - -___ - -### logIndex - -• **logIndex**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:63 - -___ - -### removed - -• **removed**: `boolean` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:58 - -___ - -### topics - -• **topics**: `string`[] - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:61 - -___ - -### transactionHash - -• **transactionHash**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:62 - -___ - -### transactionIndex - -• **transactionIndex**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:57 diff --git a/docs/api/verida-js/interfaces/verida_types._internal_.Number.md b/docs/api/verida-js/interfaces/verida_types._internal_.Number.md deleted file mode 100644 index d557281..0000000 --- a/docs/api/verida-js/interfaces/verida_types._internal_.Number.md +++ /dev/null @@ -1,143 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/types](../modules/verida_types.md) / [](../modules/verida_types._internal_.md) / Number - -# Interface: Number - -[@verida/types](../modules/verida_types.md).[](../modules/verida_types._internal_.md).Number - -## Table of contents - -### Methods - -- [toExponential](verida_types._internal_.Number.md#toexponential) -- [toFixed](verida_types._internal_.Number.md#tofixed) -- [toLocaleString](verida_types._internal_.Number.md#tolocalestring) -- [toPrecision](verida_types._internal_.Number.md#toprecision) -- [toString](verida_types._internal_.Number.md#tostring) -- [valueOf](verida_types._internal_.Number.md#valueof) - -## Methods - -### toExponential - -▸ **toExponential**(`fractionDigits?`): `string` - -Returns a string containing a number represented in exponential notation. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `fractionDigits?` | `number` | Number of digits after the decimal point. Must be in the range 0 - 20, inclusive. | - -#### Returns - -`string` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:559 - -___ - -### toFixed - -▸ **toFixed**(`fractionDigits?`): `string` - -Returns a string representing a number in fixed-point notation. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `fractionDigits?` | `number` | Number of digits after the decimal point. Must be in the range 0 - 20, inclusive. | - -#### Returns - -`string` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:553 - -___ - -### toLocaleString - -▸ **toLocaleString**(`locales?`, `options?`): `string` - -Converts a number to a string by using the current or specified locale. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `locales?` | `string` \| `string`[] | A locale string or array of locale strings that contain one or more language or locale tags. If you include more than one locale string, list them in descending order of priority so that the first entry is the preferred locale. If you omit this parameter, the default locale of the JavaScript runtime is used. | -| `options?` | `NumberFormatOptions` | An object that contains one or more properties that specify comparison options. | - -#### Returns - -`string` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:4412 - -___ - -### toPrecision - -▸ **toPrecision**(`precision?`): `string` - -Returns a string containing a number represented either in exponential or fixed-point notation with a specified number of digits. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `precision?` | `number` | Number of significant digits. Must be in the range 1 - 21, inclusive. | - -#### Returns - -`string` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:565 - -___ - -### toString - -▸ **toString**(`radix?`): `string` - -Returns a string representation of an object. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `radix?` | `number` | Specifies a radix for converting numeric values to strings. This value is only used for numbers. | - -#### Returns - -`string` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:547 - -___ - -### valueOf - -▸ **valueOf**(): `number` - -Returns the primitive value of the specified object. - -#### Returns - -`number` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:568 diff --git a/docs/api/verida-js/interfaces/verida_types._internal_.OnceBlockable.md b/docs/api/verida-js/interfaces/verida_types._internal_.OnceBlockable.md deleted file mode 100644 index db7003e..0000000 --- a/docs/api/verida-js/interfaces/verida_types._internal_.OnceBlockable.md +++ /dev/null @@ -1,36 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/types](../modules/verida_types.md) / [](../modules/verida_types._internal_.md) / OnceBlockable - -# Interface: OnceBlockable - -[@verida/types](../modules/verida_types.md).[](../modules/verida_types._internal_.md).OnceBlockable - -## Implemented by - -- [`Provider`](../classes/verida_types._internal_.Provider.md) - -## Table of contents - -### Methods - -- [once](verida_types._internal_.OnceBlockable.md#once) - -## Methods - -### once - -▸ **once**(`eventName`, `handler`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | ``"block"`` | -| `handler` | () => `void` | - -#### Returns - -`void` - -#### Defined in - -node_modules/@ethersproject/web/lib/index.d.ts:19 diff --git a/docs/api/verida-js/interfaces/verida_types._internal_.PromiseLike.md b/docs/api/verida-js/interfaces/verida_types._internal_.PromiseLike.md deleted file mode 100644 index a9626f6..0000000 --- a/docs/api/verida-js/interfaces/verida_types._internal_.PromiseLike.md +++ /dev/null @@ -1,49 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/types](../modules/verida_types.md) / [](../modules/verida_types._internal_.md) / PromiseLike - -# Interface: PromiseLike - -[@verida/types](../modules/verida_types.md).[](../modules/verida_types._internal_.md).PromiseLike - -## Type parameters - -| Name | -| :------ | -| `T` | - -## Table of contents - -### Methods - -- [then](verida_types._internal_.PromiseLike.md#then) - -## Methods - -### then - -▸ **then**<`TResult1`, `TResult2`\>(`onfulfilled?`, `onrejected?`): [`PromiseLike`](verida_types._internal_.PromiseLike.md)<`TResult1` \| `TResult2`\> - -Attaches callbacks for the resolution and/or rejection of the Promise. - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `TResult1` | `T` | -| `TResult2` | `never` | - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `onfulfilled?` | ``null`` \| (`value`: `T`) => `TResult1` \| [`PromiseLike`](verida_types._internal_.PromiseLike.md)<`TResult1`\> | The callback to execute when the Promise is resolved. | -| `onrejected?` | ``null`` \| (`reason`: `any`) => `TResult2` \| [`PromiseLike`](verida_types._internal_.PromiseLike.md)<`TResult2`\> | The callback to execute when the Promise is rejected. | - -#### Returns - -[`PromiseLike`](verida_types._internal_.PromiseLike.md)<`TResult1` \| `TResult2`\> - -A Promise for the completion of which ever callback is executed. - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1440 diff --git a/docs/api/verida-js/interfaces/verida_types._internal_.Service.md b/docs/api/verida-js/interfaces/verida_types._internal_.Service.md deleted file mode 100644 index 8cb9d0e..0000000 --- a/docs/api/verida-js/interfaces/verida_types._internal_.Service.md +++ /dev/null @@ -1,53 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/types](../modules/verida_types.md) / [](../modules/verida_types._internal_.md) / Service - -# Interface: Service - -[@verida/types](../modules/verida_types.md).[](../modules/verida_types._internal_.md).Service - -Represents a Service entry in a [DID document](https://www.w3.org/TR/did-core/#did-document-properties). - -**`see`** [https://www.w3.org/TR/did-core/#services](https://www.w3.org/TR/did-core/#services) - -**`see`** [https://www.w3.org/TR/did-core/#service-properties](https://www.w3.org/TR/did-core/#service-properties) - -## Indexable - -▪ [x: `string`]: `any` - -## Table of contents - -### Properties - -- [id](verida_types._internal_.Service.md#id) -- [serviceEndpoint](verida_types._internal_.Service.md#serviceendpoint) -- [type](verida_types._internal_.Service.md#type) - -## Properties - -### id - -• **id**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:81 - -___ - -### serviceEndpoint - -• **serviceEndpoint**: [`ServiceEndpoint`](../modules/verida_types._internal_.md#serviceendpoint) \| [`ServiceEndpoint`](../modules/verida_types._internal_.md#serviceendpoint)[] - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:83 - -___ - -### type - -• **type**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:82 diff --git a/docs/api/verida-js/interfaces/verida_types._internal_.StaticEventEmitterOptions.md b/docs/api/verida-js/interfaces/verida_types._internal_.StaticEventEmitterOptions.md deleted file mode 100644 index 2f86dbb..0000000 --- a/docs/api/verida-js/interfaces/verida_types._internal_.StaticEventEmitterOptions.md +++ /dev/null @@ -1,21 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/types](../modules/verida_types.md) / [](../modules/verida_types._internal_.md) / StaticEventEmitterOptions - -# Interface: StaticEventEmitterOptions - -[@verida/types](../modules/verida_types.md).[](../modules/verida_types._internal_.md).StaticEventEmitterOptions - -## Table of contents - -### Properties - -- [signal](verida_types._internal_.StaticEventEmitterOptions.md#signal) - -## Properties - -### signal - -• `Optional` **signal**: `AbortSignal` - -#### Defined in - -packages/types/node_modules/@types/node/ts4.8/events.d.ts:94 diff --git a/docs/api/verida-js/interfaces/verida_types._internal_.Transaction.md b/docs/api/verida-js/interfaces/verida_types._internal_.Transaction.md deleted file mode 100644 index 7b0fb7d..0000000 --- a/docs/api/verida-js/interfaces/verida_types._internal_.Transaction.md +++ /dev/null @@ -1,192 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/types](../modules/verida_types.md) / [](../modules/verida_types._internal_.md) / Transaction - -# Interface: Transaction - -[@verida/types](../modules/verida_types.md).[](../modules/verida_types._internal_.md).Transaction - -## Hierarchy - -- **`Transaction`** - - ↳ [`TransactionResponse`](verida_types._internal_.TransactionResponse.md) - -## Table of contents - -### Properties - -- [accessList](verida_types._internal_.Transaction.md#accesslist) -- [chainId](verida_types._internal_.Transaction.md#chainid) -- [data](verida_types._internal_.Transaction.md#data) -- [from](verida_types._internal_.Transaction.md#from) -- [gasLimit](verida_types._internal_.Transaction.md#gaslimit) -- [gasPrice](verida_types._internal_.Transaction.md#gasprice) -- [hash](verida_types._internal_.Transaction.md#hash) -- [maxFeePerGas](verida_types._internal_.Transaction.md#maxfeepergas) -- [maxPriorityFeePerGas](verida_types._internal_.Transaction.md#maxpriorityfeepergas) -- [nonce](verida_types._internal_.Transaction.md#nonce) -- [r](verida_types._internal_.Transaction.md#r) -- [s](verida_types._internal_.Transaction.md#s) -- [to](verida_types._internal_.Transaction.md#to) -- [type](verida_types._internal_.Transaction.md#type) -- [v](verida_types._internal_.Transaction.md#v) -- [value](verida_types._internal_.Transaction.md#value) - -## Properties - -### accessList - -• `Optional` **accessList**: [`AccessList`](../modules/verida_types._internal_.md#accesslist) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:40 - -___ - -### chainId - -• **chainId**: `number` - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:35 - -___ - -### data - -• **data**: `string` - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:33 - -___ - -### from - -• `Optional` **from**: `string` - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:29 - -___ - -### gasLimit - -• **gasLimit**: [`BigNumber`](../classes/verida_types._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:31 - -___ - -### gasPrice - -• `Optional` **gasPrice**: [`BigNumber`](../classes/verida_types._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:32 - -___ - -### hash - -• `Optional` **hash**: `string` - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:27 - -___ - -### maxFeePerGas - -• `Optional` **maxFeePerGas**: [`BigNumber`](../classes/verida_types._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:42 - -___ - -### maxPriorityFeePerGas - -• `Optional` **maxPriorityFeePerGas**: [`BigNumber`](../classes/verida_types._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:41 - -___ - -### nonce - -• **nonce**: `number` - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:30 - -___ - -### r - -• `Optional` **r**: `string` - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:36 - -___ - -### s - -• `Optional` **s**: `string` - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:37 - -___ - -### to - -• `Optional` **to**: `string` - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:28 - -___ - -### type - -• `Optional` **type**: ``null`` \| `number` - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:39 - -___ - -### v - -• `Optional` **v**: `number` - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:38 - -___ - -### value - -• **value**: [`BigNumber`](../classes/verida_types._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:34 diff --git a/docs/api/verida-js/interfaces/verida_types._internal_.TransactionReceipt.md b/docs/api/verida-js/interfaces/verida_types._internal_.TransactionReceipt.md deleted file mode 100644 index 8f9611d..0000000 --- a/docs/api/verida-js/interfaces/verida_types._internal_.TransactionReceipt.md +++ /dev/null @@ -1,197 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/types](../modules/verida_types.md) / [](../modules/verida_types._internal_.md) / TransactionReceipt - -# Interface: TransactionReceipt - -[@verida/types](../modules/verida_types.md).[](../modules/verida_types._internal_.md).TransactionReceipt - -## Table of contents - -### Properties - -- [blockHash](verida_types._internal_.TransactionReceipt.md#blockhash) -- [blockNumber](verida_types._internal_.TransactionReceipt.md#blocknumber) -- [byzantium](verida_types._internal_.TransactionReceipt.md#byzantium) -- [confirmations](verida_types._internal_.TransactionReceipt.md#confirmations) -- [contractAddress](verida_types._internal_.TransactionReceipt.md#contractaddress) -- [cumulativeGasUsed](verida_types._internal_.TransactionReceipt.md#cumulativegasused) -- [effectiveGasPrice](verida_types._internal_.TransactionReceipt.md#effectivegasprice) -- [from](verida_types._internal_.TransactionReceipt.md#from) -- [gasUsed](verida_types._internal_.TransactionReceipt.md#gasused) -- [logs](verida_types._internal_.TransactionReceipt.md#logs) -- [logsBloom](verida_types._internal_.TransactionReceipt.md#logsbloom) -- [root](verida_types._internal_.TransactionReceipt.md#root) -- [status](verida_types._internal_.TransactionReceipt.md#status) -- [to](verida_types._internal_.TransactionReceipt.md#to) -- [transactionHash](verida_types._internal_.TransactionReceipt.md#transactionhash) -- [transactionIndex](verida_types._internal_.TransactionReceipt.md#transactionindex) -- [type](verida_types._internal_.TransactionReceipt.md#type) - -## Properties - -### blockHash - -• **blockHash**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:73 - -___ - -### blockNumber - -• **blockNumber**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:76 - -___ - -### byzantium - -• **byzantium**: `boolean` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:80 - -___ - -### confirmations - -• **confirmations**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:77 - -___ - -### contractAddress - -• **contractAddress**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:68 - -___ - -### cumulativeGasUsed - -• **cumulativeGasUsed**: [`BigNumber`](../classes/verida_types._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:78 - -___ - -### effectiveGasPrice - -• **effectiveGasPrice**: [`BigNumber`](../classes/verida_types._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:79 - -___ - -### from - -• **from**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:67 - -___ - -### gasUsed - -• **gasUsed**: [`BigNumber`](../classes/verida_types._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:71 - -___ - -### logs - -• **logs**: [`Log`](verida_types._internal_.Log.md)[] - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:75 - -___ - -### logsBloom - -• **logsBloom**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:72 - -___ - -### root - -• `Optional` **root**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:70 - -___ - -### status - -• `Optional` **status**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:82 - -___ - -### to - -• **to**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:66 - -___ - -### transactionHash - -• **transactionHash**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:74 - -___ - -### transactionIndex - -• **transactionIndex**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:69 - -___ - -### type - -• **type**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:81 diff --git a/docs/api/verida-js/interfaces/verida_types._internal_.TransactionResponse.md b/docs/api/verida-js/interfaces/verida_types._internal_.TransactionResponse.md deleted file mode 100644 index 07362ef..0000000 --- a/docs/api/verida-js/interfaces/verida_types._internal_.TransactionResponse.md +++ /dev/null @@ -1,335 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/types](../modules/verida_types.md) / [](../modules/verida_types._internal_.md) / TransactionResponse - -# Interface: TransactionResponse - -[@verida/types](../modules/verida_types.md).[](../modules/verida_types._internal_.md).TransactionResponse - -## Hierarchy - -- [`Transaction`](verida_types._internal_.Transaction.md) - - ↳ **`TransactionResponse`** - -## Table of contents - -### Properties - -- [accessList](verida_types._internal_.TransactionResponse.md#accesslist) -- [blockHash](verida_types._internal_.TransactionResponse.md#blockhash) -- [blockNumber](verida_types._internal_.TransactionResponse.md#blocknumber) -- [chainId](verida_types._internal_.TransactionResponse.md#chainid) -- [confirmations](verida_types._internal_.TransactionResponse.md#confirmations) -- [data](verida_types._internal_.TransactionResponse.md#data) -- [from](verida_types._internal_.TransactionResponse.md#from) -- [gasLimit](verida_types._internal_.TransactionResponse.md#gaslimit) -- [gasPrice](verida_types._internal_.TransactionResponse.md#gasprice) -- [hash](verida_types._internal_.TransactionResponse.md#hash) -- [maxFeePerGas](verida_types._internal_.TransactionResponse.md#maxfeepergas) -- [maxPriorityFeePerGas](verida_types._internal_.TransactionResponse.md#maxpriorityfeepergas) -- [nonce](verida_types._internal_.TransactionResponse.md#nonce) -- [r](verida_types._internal_.TransactionResponse.md#r) -- [raw](verida_types._internal_.TransactionResponse.md#raw) -- [s](verida_types._internal_.TransactionResponse.md#s) -- [timestamp](verida_types._internal_.TransactionResponse.md#timestamp) -- [to](verida_types._internal_.TransactionResponse.md#to) -- [type](verida_types._internal_.TransactionResponse.md#type) -- [v](verida_types._internal_.TransactionResponse.md#v) -- [value](verida_types._internal_.TransactionResponse.md#value) - -### Methods - -- [wait](verida_types._internal_.TransactionResponse.md#wait) - -## Properties - -### accessList - -• `Optional` **accessList**: [`AccessList`](../modules/verida_types._internal_.md#accesslist) - -#### Inherited from - -[Transaction](verida_types._internal_.Transaction.md).[accessList](verida_types._internal_.Transaction.md#accesslist) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:40 - -___ - -### blockHash - -• `Optional` **blockHash**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:26 - -___ - -### blockNumber - -• `Optional` **blockNumber**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:25 - -___ - -### chainId - -• **chainId**: `number` - -#### Inherited from - -[Transaction](verida_types._internal_.Transaction.md).[chainId](verida_types._internal_.Transaction.md#chainid) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:35 - -___ - -### confirmations - -• **confirmations**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:28 - -___ - -### data - -• **data**: `string` - -#### Inherited from - -[Transaction](verida_types._internal_.Transaction.md).[data](verida_types._internal_.Transaction.md#data) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:33 - -___ - -### from - -• **from**: `string` - -#### Overrides - -[Transaction](verida_types._internal_.Transaction.md).[from](verida_types._internal_.Transaction.md#from) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:29 - -___ - -### gasLimit - -• **gasLimit**: [`BigNumber`](../classes/verida_types._internal_.BigNumber.md) - -#### Inherited from - -[Transaction](verida_types._internal_.Transaction.md).[gasLimit](verida_types._internal_.Transaction.md#gaslimit) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:31 - -___ - -### gasPrice - -• `Optional` **gasPrice**: [`BigNumber`](../classes/verida_types._internal_.BigNumber.md) - -#### Inherited from - -[Transaction](verida_types._internal_.Transaction.md).[gasPrice](verida_types._internal_.Transaction.md#gasprice) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:32 - -___ - -### hash - -• **hash**: `string` - -#### Overrides - -[Transaction](verida_types._internal_.Transaction.md).[hash](verida_types._internal_.Transaction.md#hash) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:24 - -___ - -### maxFeePerGas - -• `Optional` **maxFeePerGas**: [`BigNumber`](../classes/verida_types._internal_.BigNumber.md) - -#### Inherited from - -[Transaction](verida_types._internal_.Transaction.md).[maxFeePerGas](verida_types._internal_.Transaction.md#maxfeepergas) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:42 - -___ - -### maxPriorityFeePerGas - -• `Optional` **maxPriorityFeePerGas**: [`BigNumber`](../classes/verida_types._internal_.BigNumber.md) - -#### Inherited from - -[Transaction](verida_types._internal_.Transaction.md).[maxPriorityFeePerGas](verida_types._internal_.Transaction.md#maxpriorityfeepergas) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:41 - -___ - -### nonce - -• **nonce**: `number` - -#### Inherited from - -[Transaction](verida_types._internal_.Transaction.md).[nonce](verida_types._internal_.Transaction.md#nonce) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:30 - -___ - -### r - -• `Optional` **r**: `string` - -#### Inherited from - -[Transaction](verida_types._internal_.Transaction.md).[r](verida_types._internal_.Transaction.md#r) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:36 - -___ - -### raw - -• `Optional` **raw**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:30 - -___ - -### s - -• `Optional` **s**: `string` - -#### Inherited from - -[Transaction](verida_types._internal_.Transaction.md).[s](verida_types._internal_.Transaction.md#s) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:37 - -___ - -### timestamp - -• `Optional` **timestamp**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:27 - -___ - -### to - -• `Optional` **to**: `string` - -#### Inherited from - -[Transaction](verida_types._internal_.Transaction.md).[to](verida_types._internal_.Transaction.md#to) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:28 - -___ - -### type - -• `Optional` **type**: ``null`` \| `number` - -#### Inherited from - -[Transaction](verida_types._internal_.Transaction.md).[type](verida_types._internal_.Transaction.md#type) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:39 - -___ - -### v - -• `Optional` **v**: `number` - -#### Inherited from - -[Transaction](verida_types._internal_.Transaction.md).[v](verida_types._internal_.Transaction.md#v) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:38 - -___ - -### value - -• **value**: [`BigNumber`](../classes/verida_types._internal_.BigNumber.md) - -#### Inherited from - -[Transaction](verida_types._internal_.Transaction.md).[value](verida_types._internal_.Transaction.md#value) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:34 - -## Methods - -### wait - -▸ **wait**(`confirmations?`): `Promise`<[`TransactionReceipt`](verida_types._internal_.TransactionReceipt.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `confirmations?` | `number` | - -#### Returns - -`Promise`<[`TransactionReceipt`](verida_types._internal_.TransactionReceipt.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:31 diff --git a/docs/api/verida-js/interfaces/verida_types._internal_.VerificationMethod.md b/docs/api/verida-js/interfaces/verida_types._internal_.VerificationMethod.md deleted file mode 100644 index 7505117..0000000 --- a/docs/api/verida-js/interfaces/verida_types._internal_.VerificationMethod.md +++ /dev/null @@ -1,129 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/types](../modules/verida_types.md) / [](../modules/verida_types._internal_.md) / VerificationMethod - -# Interface: VerificationMethod - -[@verida/types](../modules/verida_types.md).[](../modules/verida_types._internal_.md).VerificationMethod - -Represents the properties of a Verification Method listed in a DID document. - -This data type includes public key representations that are no longer present in the spec but are still used by -several DID methods / resolvers and kept for backward compatibility. - -**`see`** [https://www.w3.org/TR/did-core/#verification-methods](https://www.w3.org/TR/did-core/#verification-methods) - -**`see`** [https://www.w3.org/TR/did-core/#verification-method-properties](https://www.w3.org/TR/did-core/#verification-method-properties) - -## Table of contents - -### Properties - -- [blockchainAccountId](verida_types._internal_.VerificationMethod.md#blockchainaccountid) -- [controller](verida_types._internal_.VerificationMethod.md#controller) -- [ethereumAddress](verida_types._internal_.VerificationMethod.md#ethereumaddress) -- [id](verida_types._internal_.VerificationMethod.md#id) -- [publicKeyBase58](verida_types._internal_.VerificationMethod.md#publickeybase58) -- [publicKeyBase64](verida_types._internal_.VerificationMethod.md#publickeybase64) -- [publicKeyHex](verida_types._internal_.VerificationMethod.md#publickeyhex) -- [publicKeyJwk](verida_types._internal_.VerificationMethod.md#publickeyjwk) -- [publicKeyMultibase](verida_types._internal_.VerificationMethod.md#publickeymultibase) -- [type](verida_types._internal_.VerificationMethod.md#type) - -## Properties - -### blockchainAccountId - -• `Optional` **blockchainAccountId**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:133 - -___ - -### controller - -• **controller**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:127 - -___ - -### ethereumAddress - -• `Optional` **ethereumAddress**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:134 - -___ - -### id - -• **id**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:125 - -___ - -### publicKeyBase58 - -• `Optional` **publicKeyBase58**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:128 - -___ - -### publicKeyBase64 - -• `Optional` **publicKeyBase64**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:129 - -___ - -### publicKeyHex - -• `Optional` **publicKeyHex**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:131 - -___ - -### publicKeyJwk - -• `Optional` **publicKeyJwk**: [`JsonWebKey`](verida_types._internal_.JsonWebKey.md) - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:130 - -___ - -### publicKeyMultibase - -• `Optional` **publicKeyMultibase**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:132 - -___ - -### type - -• **type**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:126 diff --git a/docs/api/verida-js/interfaces/verida_types._internal_._Block.md b/docs/api/verida-js/interfaces/verida_types._internal_._Block.md deleted file mode 100644 index edd01aa..0000000 --- a/docs/api/verida-js/interfaces/verida_types._internal_._Block.md +++ /dev/null @@ -1,150 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/types](../modules/verida_types.md) / [](../modules/verida_types._internal_.md) / \_Block - -# Interface: \_Block - -[@verida/types](../modules/verida_types.md).[](../modules/verida_types._internal_.md)._Block - -## Hierarchy - -- **`_Block`** - - ↳ [`Block`](verida_types._internal_.Block.md) - - ↳ [`BlockWithTransactions`](verida_types._internal_.BlockWithTransactions.md) - -## Table of contents - -### Properties - -- [\_difficulty](verida_types._internal_._Block.md#_difficulty) -- [baseFeePerGas](verida_types._internal_._Block.md#basefeepergas) -- [difficulty](verida_types._internal_._Block.md#difficulty) -- [extraData](verida_types._internal_._Block.md#extradata) -- [gasLimit](verida_types._internal_._Block.md#gaslimit) -- [gasUsed](verida_types._internal_._Block.md#gasused) -- [hash](verida_types._internal_._Block.md#hash) -- [miner](verida_types._internal_._Block.md#miner) -- [nonce](verida_types._internal_._Block.md#nonce) -- [number](verida_types._internal_._Block.md#number) -- [parentHash](verida_types._internal_._Block.md#parenthash) -- [timestamp](verida_types._internal_._Block.md#timestamp) - -## Properties - -### \_difficulty - -• **\_difficulty**: [`BigNumber`](../classes/verida_types._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:41 - -___ - -### baseFeePerGas - -• `Optional` **baseFeePerGas**: ``null`` \| [`BigNumber`](../classes/verida_types._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:46 - -___ - -### difficulty - -• **difficulty**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:40 - -___ - -### extraData - -• **extraData**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:45 - -___ - -### gasLimit - -• **gasLimit**: [`BigNumber`](../classes/verida_types._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:42 - -___ - -### gasUsed - -• **gasUsed**: [`BigNumber`](../classes/verida_types._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:43 - -___ - -### hash - -• **hash**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:35 - -___ - -### miner - -• **miner**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:44 - -___ - -### nonce - -• **nonce**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:39 - -___ - -### number - -• **number**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:37 - -___ - -### parentHash - -• **parentHash**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:36 - -___ - -### timestamp - -• **timestamp**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:38 diff --git a/docs/api/verida-js/interfaces/verida_types._internal_._DOMEventTarget.md b/docs/api/verida-js/interfaces/verida_types._internal_._DOMEventTarget.md deleted file mode 100644 index 1ded9d5..0000000 --- a/docs/api/verida-js/interfaces/verida_types._internal_._DOMEventTarget.md +++ /dev/null @@ -1,34 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/types](../modules/verida_types.md) / [](../modules/verida_types._internal_.md) / \_DOMEventTarget - -# Interface: \_DOMEventTarget - -[@verida/types](../modules/verida_types.md).[](../modules/verida_types._internal_.md)._DOMEventTarget - -## Table of contents - -### Methods - -- [addEventListener](verida_types._internal_._DOMEventTarget.md#addeventlistener) - -## Methods - -### addEventListener - -▸ **addEventListener**(`eventName`, `listener`, `opts?`): `any` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | `string` | -| `listener` | (...`args`: `any`[]) => `void` | -| `opts?` | `Object` | -| `opts.once` | `boolean` | - -#### Returns - -`any` - -#### Defined in - -packages/types/node_modules/@types/node/ts4.8/events.d.ts:85 diff --git a/docs/api/verida-js/interfaces/verida_types._internal_._NodeEventTarget.md b/docs/api/verida-js/interfaces/verida_types._internal_._NodeEventTarget.md deleted file mode 100644 index 92e603f..0000000 --- a/docs/api/verida-js/interfaces/verida_types._internal_._NodeEventTarget.md +++ /dev/null @@ -1,32 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/types](../modules/verida_types.md) / [](../modules/verida_types._internal_.md) / \_NodeEventTarget - -# Interface: \_NodeEventTarget - -[@verida/types](../modules/verida_types.md).[](../modules/verida_types._internal_.md)._NodeEventTarget - -## Table of contents - -### Methods - -- [once](verida_types._internal_._NodeEventTarget.md#once) - -## Methods - -### once - -▸ **once**(`eventName`, `listener`): [`_NodeEventTarget`](verida_types._internal_._NodeEventTarget.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | `string` \| `symbol` | -| `listener` | (...`args`: `any`[]) => `void` | - -#### Returns - -[`_NodeEventTarget`](verida_types._internal_._NodeEventTarget.md) - -#### Defined in - -packages/types/node_modules/@types/node/ts4.8/events.d.ts:81 diff --git a/docs/api/verida-js/interfaces/verida_vda_common.CONTRACT_INFO.md b/docs/api/verida-js/interfaces/verida_vda_common.CONTRACT_INFO.md deleted file mode 100644 index c629ef9..0000000 --- a/docs/api/verida-js/interfaces/verida_vda_common.CONTRACT_INFO.md +++ /dev/null @@ -1,32 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-common](../modules/verida_vda_common.md) / CONTRACT\_INFO - -# Interface: CONTRACT\_INFO - -[@verida/vda-common](../modules/verida_vda_common.md).CONTRACT_INFO - -## Table of contents - -### Properties - -- [abi](verida_vda_common.CONTRACT_INFO.md#abi) -- [address](verida_vda_common.CONTRACT_INFO.md#address) - -## Properties - -### abi - -• **abi**: `any` - -#### Defined in - -[packages/vda-common/src/contract.ts:13](https://github.com/verida/verida-js/blob/5040472/packages/vda-common/src/contract.ts#L13) - -___ - -### address - -• **address**: `string` - -#### Defined in - -[packages/vda-common/src/contract.ts:14](https://github.com/verida/verida-js/blob/5040472/packages/vda-common/src/contract.ts#L14) diff --git a/docs/api/verida-js/interfaces/verida_vda_common._internal_.ArrayLike.md b/docs/api/verida-js/interfaces/verida_vda_common._internal_.ArrayLike.md deleted file mode 100644 index 2729049..0000000 --- a/docs/api/verida-js/interfaces/verida_vda_common._internal_.ArrayLike.md +++ /dev/null @@ -1,31 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-common](../modules/verida_vda_common.md) / [](../modules/verida_vda_common._internal_.md) / ArrayLike - -# Interface: ArrayLike - -[@verida/vda-common](../modules/verida_vda_common.md).[](../modules/verida_vda_common._internal_.md).ArrayLike - -## Type parameters - -| Name | -| :------ | -| `T` | - -## Indexable - -▪ [n: `number`]: `T` - -## Table of contents - -### Properties - -- [length](verida_vda_common._internal_.ArrayLike.md#length) - -## Properties - -### length - -• `Readonly` **length**: `number` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1464 diff --git a/docs/api/verida-js/interfaces/verida_vda_common._internal_.Hexable.md b/docs/api/verida-js/interfaces/verida_vda_common._internal_.Hexable.md deleted file mode 100644 index a9bee1c..0000000 --- a/docs/api/verida-js/interfaces/verida_vda_common._internal_.Hexable.md +++ /dev/null @@ -1,29 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-common](../modules/verida_vda_common.md) / [](../modules/verida_vda_common._internal_.md) / Hexable - -# Interface: Hexable - -[@verida/vda-common](../modules/verida_vda_common.md).[](../modules/verida_vda_common._internal_.md).Hexable - -## Implemented by - -- [`BigNumber`](../classes/verida_vda_common._internal_.BigNumber.md) - -## Table of contents - -### Methods - -- [toHexString](verida_vda_common._internal_.Hexable.md#tohexstring) - -## Methods - -### toHexString - -▸ **toHexString**(): `string` - -#### Returns - -`string` - -#### Defined in - -node_modules/ethers/node_modules/@ethersproject/bytes/lib/index.d.ts:8 diff --git a/docs/api/verida-js/interfaces/verida_vda_common_test.DidInterface.md b/docs/api/verida-js/interfaces/verida_vda_common_test.DidInterface.md deleted file mode 100644 index 2b3db8b..0000000 --- a/docs/api/verida-js/interfaces/verida_vda_common_test.DidInterface.md +++ /dev/null @@ -1,43 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-common-test](../modules/verida_vda_common_test.md) / DidInterface - -# Interface: DidInterface - -[@verida/vda-common-test](../modules/verida_vda_common_test.md).DidInterface - -## Table of contents - -### Properties - -- [address](verida_vda_common_test.DidInterface.md#address) -- [privateKey](verida_vda_common_test.DidInterface.md#privatekey) -- [publicKey](verida_vda_common_test.DidInterface.md#publickey) - -## Properties - -### address - -• **address**: `string` - -#### Defined in - -[packages/vda-common-test/src/const.ts:4](https://github.com/verida/verida-js/blob/5040472/packages/vda-common-test/src/const.ts#L4) - -___ - -### privateKey - -• **privateKey**: `string` - -#### Defined in - -[packages/vda-common-test/src/const.ts:5](https://github.com/verida/verida-js/blob/5040472/packages/vda-common-test/src/const.ts#L5) - -___ - -### publicKey - -• **publicKey**: `string` - -#### Defined in - -[packages/vda-common-test/src/const.ts:6](https://github.com/verida/verida-js/blob/5040472/packages/vda-common-test/src/const.ts#L6) diff --git a/docs/api/verida-js/interfaces/verida_vda_did._internal_.ArrayLike.md b/docs/api/verida-js/interfaces/verida_vda_did._internal_.ArrayLike.md deleted file mode 100644 index 0eccea3..0000000 --- a/docs/api/verida-js/interfaces/verida_vda_did._internal_.ArrayLike.md +++ /dev/null @@ -1,31 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-did](../modules/verida_vda_did.md) / [](../modules/verida_vda_did._internal_.md) / ArrayLike - -# Interface: ArrayLike - -[@verida/vda-did](../modules/verida_vda_did.md).[](../modules/verida_vda_did._internal_.md).ArrayLike - -## Type parameters - -| Name | -| :------ | -| `T` | - -## Indexable - -▪ [n: `number`]: `T` - -## Table of contents - -### Properties - -- [length](verida_vda_did._internal_.ArrayLike.md#length) - -## Properties - -### length - -• `Readonly` **length**: `number` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1464 diff --git a/docs/api/verida-js/interfaces/verida_vda_did._internal_.Block.md b/docs/api/verida-js/interfaces/verida_vda_did._internal_.Block.md deleted file mode 100644 index dc0e914..0000000 --- a/docs/api/verida-js/interfaces/verida_vda_did._internal_.Block.md +++ /dev/null @@ -1,207 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-did](../modules/verida_vda_did.md) / [](../modules/verida_vda_did._internal_.md) / Block - -# Interface: Block - -[@verida/vda-did](../modules/verida_vda_did.md).[](../modules/verida_vda_did._internal_.md).Block - -## Hierarchy - -- [`_Block`](verida_vda_did._internal_._Block.md) - - ↳ **`Block`** - -## Table of contents - -### Properties - -- [\_difficulty](verida_vda_did._internal_.Block.md#_difficulty) -- [baseFeePerGas](verida_vda_did._internal_.Block.md#basefeepergas) -- [difficulty](verida_vda_did._internal_.Block.md#difficulty) -- [extraData](verida_vda_did._internal_.Block.md#extradata) -- [gasLimit](verida_vda_did._internal_.Block.md#gaslimit) -- [gasUsed](verida_vda_did._internal_.Block.md#gasused) -- [hash](verida_vda_did._internal_.Block.md#hash) -- [miner](verida_vda_did._internal_.Block.md#miner) -- [nonce](verida_vda_did._internal_.Block.md#nonce) -- [number](verida_vda_did._internal_.Block.md#number) -- [parentHash](verida_vda_did._internal_.Block.md#parenthash) -- [timestamp](verida_vda_did._internal_.Block.md#timestamp) -- [transactions](verida_vda_did._internal_.Block.md#transactions) - -## Properties - -### \_difficulty - -• **\_difficulty**: [`BigNumber`](../classes/verida_vda_did._internal_.BigNumber.md) - -#### Inherited from - -[_Block](verida_vda_did._internal_._Block.md).[_difficulty](verida_vda_did._internal_._Block.md#_difficulty) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:41 - -___ - -### baseFeePerGas - -• `Optional` **baseFeePerGas**: ``null`` \| [`BigNumber`](../classes/verida_vda_did._internal_.BigNumber.md) - -#### Inherited from - -[_Block](verida_vda_did._internal_._Block.md).[baseFeePerGas](verida_vda_did._internal_._Block.md#basefeepergas) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:46 - -___ - -### difficulty - -• **difficulty**: `number` - -#### Inherited from - -[_Block](verida_vda_did._internal_._Block.md).[difficulty](verida_vda_did._internal_._Block.md#difficulty) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:40 - -___ - -### extraData - -• **extraData**: `string` - -#### Inherited from - -[_Block](verida_vda_did._internal_._Block.md).[extraData](verida_vda_did._internal_._Block.md#extradata) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:45 - -___ - -### gasLimit - -• **gasLimit**: [`BigNumber`](../classes/verida_vda_did._internal_.BigNumber.md) - -#### Inherited from - -[_Block](verida_vda_did._internal_._Block.md).[gasLimit](verida_vda_did._internal_._Block.md#gaslimit) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:42 - -___ - -### gasUsed - -• **gasUsed**: [`BigNumber`](../classes/verida_vda_did._internal_.BigNumber.md) - -#### Inherited from - -[_Block](verida_vda_did._internal_._Block.md).[gasUsed](verida_vda_did._internal_._Block.md#gasused) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:43 - -___ - -### hash - -• **hash**: `string` - -#### Inherited from - -[_Block](verida_vda_did._internal_._Block.md).[hash](verida_vda_did._internal_._Block.md#hash) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:35 - -___ - -### miner - -• **miner**: `string` - -#### Inherited from - -[_Block](verida_vda_did._internal_._Block.md).[miner](verida_vda_did._internal_._Block.md#miner) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:44 - -___ - -### nonce - -• **nonce**: `string` - -#### Inherited from - -[_Block](verida_vda_did._internal_._Block.md).[nonce](verida_vda_did._internal_._Block.md#nonce) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:39 - -___ - -### number - -• **number**: `number` - -#### Inherited from - -[_Block](verida_vda_did._internal_._Block.md).[number](verida_vda_did._internal_._Block.md#number) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:37 - -___ - -### parentHash - -• **parentHash**: `string` - -#### Inherited from - -[_Block](verida_vda_did._internal_._Block.md).[parentHash](verida_vda_did._internal_._Block.md#parenthash) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:36 - -___ - -### timestamp - -• **timestamp**: `number` - -#### Inherited from - -[_Block](verida_vda_did._internal_._Block.md).[timestamp](verida_vda_did._internal_._Block.md#timestamp) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:38 - -___ - -### transactions - -• **transactions**: `string`[] - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:49 diff --git a/docs/api/verida-js/interfaces/verida_vda_did._internal_.BlockWithTransactions.md b/docs/api/verida-js/interfaces/verida_vda_did._internal_.BlockWithTransactions.md deleted file mode 100644 index 98de40e..0000000 --- a/docs/api/verida-js/interfaces/verida_vda_did._internal_.BlockWithTransactions.md +++ /dev/null @@ -1,207 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-did](../modules/verida_vda_did.md) / [](../modules/verida_vda_did._internal_.md) / BlockWithTransactions - -# Interface: BlockWithTransactions - -[@verida/vda-did](../modules/verida_vda_did.md).[](../modules/verida_vda_did._internal_.md).BlockWithTransactions - -## Hierarchy - -- [`_Block`](verida_vda_did._internal_._Block.md) - - ↳ **`BlockWithTransactions`** - -## Table of contents - -### Properties - -- [\_difficulty](verida_vda_did._internal_.BlockWithTransactions.md#_difficulty) -- [baseFeePerGas](verida_vda_did._internal_.BlockWithTransactions.md#basefeepergas) -- [difficulty](verida_vda_did._internal_.BlockWithTransactions.md#difficulty) -- [extraData](verida_vda_did._internal_.BlockWithTransactions.md#extradata) -- [gasLimit](verida_vda_did._internal_.BlockWithTransactions.md#gaslimit) -- [gasUsed](verida_vda_did._internal_.BlockWithTransactions.md#gasused) -- [hash](verida_vda_did._internal_.BlockWithTransactions.md#hash) -- [miner](verida_vda_did._internal_.BlockWithTransactions.md#miner) -- [nonce](verida_vda_did._internal_.BlockWithTransactions.md#nonce) -- [number](verida_vda_did._internal_.BlockWithTransactions.md#number) -- [parentHash](verida_vda_did._internal_.BlockWithTransactions.md#parenthash) -- [timestamp](verida_vda_did._internal_.BlockWithTransactions.md#timestamp) -- [transactions](verida_vda_did._internal_.BlockWithTransactions.md#transactions) - -## Properties - -### \_difficulty - -• **\_difficulty**: [`BigNumber`](../classes/verida_vda_did._internal_.BigNumber.md) - -#### Inherited from - -[_Block](verida_vda_did._internal_._Block.md).[_difficulty](verida_vda_did._internal_._Block.md#_difficulty) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:41 - -___ - -### baseFeePerGas - -• `Optional` **baseFeePerGas**: ``null`` \| [`BigNumber`](../classes/verida_vda_did._internal_.BigNumber.md) - -#### Inherited from - -[_Block](verida_vda_did._internal_._Block.md).[baseFeePerGas](verida_vda_did._internal_._Block.md#basefeepergas) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:46 - -___ - -### difficulty - -• **difficulty**: `number` - -#### Inherited from - -[_Block](verida_vda_did._internal_._Block.md).[difficulty](verida_vda_did._internal_._Block.md#difficulty) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:40 - -___ - -### extraData - -• **extraData**: `string` - -#### Inherited from - -[_Block](verida_vda_did._internal_._Block.md).[extraData](verida_vda_did._internal_._Block.md#extradata) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:45 - -___ - -### gasLimit - -• **gasLimit**: [`BigNumber`](../classes/verida_vda_did._internal_.BigNumber.md) - -#### Inherited from - -[_Block](verida_vda_did._internal_._Block.md).[gasLimit](verida_vda_did._internal_._Block.md#gaslimit) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:42 - -___ - -### gasUsed - -• **gasUsed**: [`BigNumber`](../classes/verida_vda_did._internal_.BigNumber.md) - -#### Inherited from - -[_Block](verida_vda_did._internal_._Block.md).[gasUsed](verida_vda_did._internal_._Block.md#gasused) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:43 - -___ - -### hash - -• **hash**: `string` - -#### Inherited from - -[_Block](verida_vda_did._internal_._Block.md).[hash](verida_vda_did._internal_._Block.md#hash) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:35 - -___ - -### miner - -• **miner**: `string` - -#### Inherited from - -[_Block](verida_vda_did._internal_._Block.md).[miner](verida_vda_did._internal_._Block.md#miner) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:44 - -___ - -### nonce - -• **nonce**: `string` - -#### Inherited from - -[_Block](verida_vda_did._internal_._Block.md).[nonce](verida_vda_did._internal_._Block.md#nonce) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:39 - -___ - -### number - -• **number**: `number` - -#### Inherited from - -[_Block](verida_vda_did._internal_._Block.md).[number](verida_vda_did._internal_._Block.md#number) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:37 - -___ - -### parentHash - -• **parentHash**: `string` - -#### Inherited from - -[_Block](verida_vda_did._internal_._Block.md).[parentHash](verida_vda_did._internal_._Block.md#parenthash) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:36 - -___ - -### timestamp - -• **timestamp**: `number` - -#### Inherited from - -[_Block](verida_vda_did._internal_._Block.md).[timestamp](verida_vda_did._internal_._Block.md#timestamp) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:38 - -___ - -### transactions - -• **transactions**: [`TransactionResponse`](verida_vda_did._internal_.TransactionResponse.md)[] - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:52 diff --git a/docs/api/verida-js/interfaces/verida_vda_did._internal_.ConcatArray.md b/docs/api/verida-js/interfaces/verida_vda_did._internal_.ConcatArray.md deleted file mode 100644 index 3a60487..0000000 --- a/docs/api/verida-js/interfaces/verida_vda_did._internal_.ConcatArray.md +++ /dev/null @@ -1,77 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-did](../modules/verida_vda_did.md) / [](../modules/verida_vda_did._internal_.md) / ConcatArray - -# Interface: ConcatArray - -[@verida/vda-did](../modules/verida_vda_did.md).[](../modules/verida_vda_did._internal_.md).ConcatArray - -## Type parameters - -| Name | -| :------ | -| `T` | - -## Indexable - -▪ [n: `number`]: `T` - -## Table of contents - -### Properties - -- [length](verida_vda_did._internal_.ConcatArray.md#length) - -### Methods - -- [join](verida_vda_did._internal_.ConcatArray.md#join) -- [slice](verida_vda_did._internal_.ConcatArray.md#slice) - -## Properties - -### length - -• `Readonly` **length**: `number` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1214 - -## Methods - -### join - -▸ **join**(`separator?`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `separator?` | `string` | - -#### Returns - -`string` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1216 - -___ - -### slice - -▸ **slice**(`start?`, `end?`): `T`[] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `start?` | `number` | -| `end?` | `number` | - -#### Returns - -`T`[] - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1217 diff --git a/docs/api/verida-js/interfaces/verida_vda_did._internal_.Error.md b/docs/api/verida-js/interfaces/verida_vda_did._internal_.Error.md deleted file mode 100644 index 27cbe02..0000000 --- a/docs/api/verida-js/interfaces/verida_vda_did._internal_.Error.md +++ /dev/null @@ -1,43 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-did](../modules/verida_vda_did.md) / [](../modules/verida_vda_did._internal_.md) / Error - -# Interface: Error - -[@verida/vda-did](../modules/verida_vda_did.md).[](../modules/verida_vda_did._internal_.md).Error - -## Table of contents - -### Properties - -- [message](verida_vda_did._internal_.Error.md#message) -- [name](verida_vda_did._internal_.Error.md#name) -- [stack](verida_vda_did._internal_.Error.md#stack) - -## Properties - -### message - -• **message**: `string` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:974 - -___ - -### name - -• **name**: `string` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:973 - -___ - -### stack - -• `Optional` **stack**: `string` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:975 diff --git a/docs/api/verida-js/interfaces/verida_vda_did._internal_.Event.md b/docs/api/verida-js/interfaces/verida_vda_did._internal_.Event.md deleted file mode 100644 index 5edbf0b..0000000 --- a/docs/api/verida-js/interfaces/verida_vda_did._internal_.Event.md +++ /dev/null @@ -1,280 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-did](../modules/verida_vda_did.md) / [](../modules/verida_vda_did._internal_.md) / Event - -# Interface: Event - -[@verida/vda-did](../modules/verida_vda_did.md).[](../modules/verida_vda_did._internal_.md).Event - -## Hierarchy - -- [`Log`](verida_vda_did._internal_.Log.md) - - ↳ **`Event`** - -## Table of contents - -### Properties - -- [address](verida_vda_did._internal_.Event.md#address) -- [args](verida_vda_did._internal_.Event.md#args) -- [blockHash](verida_vda_did._internal_.Event.md#blockhash) -- [blockNumber](verida_vda_did._internal_.Event.md#blocknumber) -- [data](verida_vda_did._internal_.Event.md#data) -- [decodeError](verida_vda_did._internal_.Event.md#decodeerror) -- [event](verida_vda_did._internal_.Event.md#event) -- [eventSignature](verida_vda_did._internal_.Event.md#eventsignature) -- [logIndex](verida_vda_did._internal_.Event.md#logindex) -- [removed](verida_vda_did._internal_.Event.md#removed) -- [topics](verida_vda_did._internal_.Event.md#topics) -- [transactionHash](verida_vda_did._internal_.Event.md#transactionhash) -- [transactionIndex](verida_vda_did._internal_.Event.md#transactionindex) - -### Methods - -- [decode](verida_vda_did._internal_.Event.md#decode) -- [getBlock](verida_vda_did._internal_.Event.md#getblock) -- [getTransaction](verida_vda_did._internal_.Event.md#gettransaction) -- [getTransactionReceipt](verida_vda_did._internal_.Event.md#gettransactionreceipt) -- [removeListener](verida_vda_did._internal_.Event.md#removelistener) - -## Properties - -### address - -• **address**: `string` - -#### Inherited from - -[Log](verida_vda_did._internal_.Log.md).[address](verida_vda_did._internal_.Log.md#address) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:59 - -___ - -### args - -• `Optional` **args**: [`Result`](verida_vda_did._internal_.Result.md) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:49 - -___ - -### blockHash - -• **blockHash**: `string` - -#### Inherited from - -[Log](verida_vda_did._internal_.Log.md).[blockHash](verida_vda_did._internal_.Log.md#blockhash) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:56 - -___ - -### blockNumber - -• **blockNumber**: `number` - -#### Inherited from - -[Log](verida_vda_did._internal_.Log.md).[blockNumber](verida_vda_did._internal_.Log.md#blocknumber) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:55 - -___ - -### data - -• **data**: `string` - -#### Inherited from - -[Log](verida_vda_did._internal_.Log.md).[data](verida_vda_did._internal_.Log.md#data) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:60 - -___ - -### decodeError - -• `Optional` **decodeError**: [`Error`](../modules/verida_vda_did._internal_.md#error) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:50 - -___ - -### event - -• `Optional` **event**: `string` - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:47 - -___ - -### eventSignature - -• `Optional` **eventSignature**: `string` - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:48 - -___ - -### logIndex - -• **logIndex**: `number` - -#### Inherited from - -[Log](verida_vda_did._internal_.Log.md).[logIndex](verida_vda_did._internal_.Log.md#logindex) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:63 - -___ - -### removed - -• **removed**: `boolean` - -#### Inherited from - -[Log](verida_vda_did._internal_.Log.md).[removed](verida_vda_did._internal_.Log.md#removed) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:58 - -___ - -### topics - -• **topics**: `string`[] - -#### Inherited from - -[Log](verida_vda_did._internal_.Log.md).[topics](verida_vda_did._internal_.Log.md#topics) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:61 - -___ - -### transactionHash - -• **transactionHash**: `string` - -#### Inherited from - -[Log](verida_vda_did._internal_.Log.md).[transactionHash](verida_vda_did._internal_.Log.md#transactionhash) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:62 - -___ - -### transactionIndex - -• **transactionIndex**: `number` - -#### Inherited from - -[Log](verida_vda_did._internal_.Log.md).[transactionIndex](verida_vda_did._internal_.Log.md#transactionindex) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:57 - -## Methods - -### decode - -▸ `Optional` **decode**(`data`, `topics?`): `any` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `string` | -| `topics?` | `string`[] | - -#### Returns - -`any` - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:51 - -___ - -### getBlock - -▸ **getBlock**(): `Promise`<[`Block`](verida_vda_did._internal_.Block.md)\> - -#### Returns - -`Promise`<[`Block`](verida_vda_did._internal_.Block.md)\> - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:53 - -___ - -### getTransaction - -▸ **getTransaction**(): `Promise`<[`TransactionResponse`](verida_vda_did._internal_.TransactionResponse.md)\> - -#### Returns - -`Promise`<[`TransactionResponse`](verida_vda_did._internal_.TransactionResponse.md)\> - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:54 - -___ - -### getTransactionReceipt - -▸ **getTransactionReceipt**(): `Promise`<[`TransactionReceipt`](verida_vda_did._internal_.TransactionReceipt.md)\> - -#### Returns - -`Promise`<[`TransactionReceipt`](verida_vda_did._internal_.TransactionReceipt.md)\> - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:55 - -___ - -### removeListener - -▸ **removeListener**(): `void` - -#### Returns - -`void` - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:52 diff --git a/docs/api/verida-js/interfaces/verida_vda_did._internal_.EventFilter.md b/docs/api/verida-js/interfaces/verida_vda_did._internal_.EventFilter.md deleted file mode 100644 index 2cfe77b..0000000 --- a/docs/api/verida-js/interfaces/verida_vda_did._internal_.EventFilter.md +++ /dev/null @@ -1,38 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-did](../modules/verida_vda_did.md) / [](../modules/verida_vda_did._internal_.md) / EventFilter - -# Interface: EventFilter - -[@verida/vda-did](../modules/verida_vda_did.md).[](../modules/verida_vda_did._internal_.md).EventFilter - -## Hierarchy - -- **`EventFilter`** - - ↳ [`Filter`](verida_vda_did._internal_.Filter.md) - -## Table of contents - -### Properties - -- [address](verida_vda_did._internal_.EventFilter.md#address) -- [topics](verida_vda_did._internal_.EventFilter.md#topics) - -## Properties - -### address - -• `Optional` **address**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:91 - -___ - -### topics - -• `Optional` **topics**: (``null`` \| `string` \| `string`[])[] - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:92 diff --git a/docs/api/verida-js/interfaces/verida_vda_did._internal_.FeeData.md b/docs/api/verida-js/interfaces/verida_vda_did._internal_.FeeData.md deleted file mode 100644 index bd835df..0000000 --- a/docs/api/verida-js/interfaces/verida_vda_did._internal_.FeeData.md +++ /dev/null @@ -1,54 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-did](../modules/verida_vda_did.md) / [](../modules/verida_vda_did._internal_.md) / FeeData - -# Interface: FeeData - -[@verida/vda-did](../modules/verida_vda_did.md).[](../modules/verida_vda_did._internal_.md).FeeData - -## Table of contents - -### Properties - -- [gasPrice](verida_vda_did._internal_.FeeData.md#gasprice) -- [lastBaseFeePerGas](verida_vda_did._internal_.FeeData.md#lastbasefeepergas) -- [maxFeePerGas](verida_vda_did._internal_.FeeData.md#maxfeepergas) -- [maxPriorityFeePerGas](verida_vda_did._internal_.FeeData.md#maxpriorityfeepergas) - -## Properties - -### gasPrice - -• **gasPrice**: ``null`` \| [`BigNumber`](../classes/verida_vda_did._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:88 - -___ - -### lastBaseFeePerGas - -• **lastBaseFeePerGas**: ``null`` \| [`BigNumber`](../classes/verida_vda_did._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:85 - -___ - -### maxFeePerGas - -• **maxFeePerGas**: ``null`` \| [`BigNumber`](../classes/verida_vda_did._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:86 - -___ - -### maxPriorityFeePerGas - -• **maxPriorityFeePerGas**: ``null`` \| [`BigNumber`](../classes/verida_vda_did._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:87 diff --git a/docs/api/verida-js/interfaces/verida_vda_did._internal_.Filter.md b/docs/api/verida-js/interfaces/verida_vda_did._internal_.Filter.md deleted file mode 100644 index a089b62..0000000 --- a/docs/api/verida-js/interfaces/verida_vda_did._internal_.Filter.md +++ /dev/null @@ -1,68 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-did](../modules/verida_vda_did.md) / [](../modules/verida_vda_did._internal_.md) / Filter - -# Interface: Filter - -[@verida/vda-did](../modules/verida_vda_did.md).[](../modules/verida_vda_did._internal_.md).Filter - -## Hierarchy - -- [`EventFilter`](verida_vda_did._internal_.EventFilter.md) - - ↳ **`Filter`** - -## Table of contents - -### Properties - -- [address](verida_vda_did._internal_.Filter.md#address) -- [fromBlock](verida_vda_did._internal_.Filter.md#fromblock) -- [toBlock](verida_vda_did._internal_.Filter.md#toblock) -- [topics](verida_vda_did._internal_.Filter.md#topics) - -## Properties - -### address - -• `Optional` **address**: `string` - -#### Inherited from - -[EventFilter](verida_vda_did._internal_.EventFilter.md).[address](verida_vda_did._internal_.EventFilter.md#address) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:91 - -___ - -### fromBlock - -• `Optional` **fromBlock**: [`BlockTag`](../modules/verida_vda_did._internal_.md#blocktag) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:95 - -___ - -### toBlock - -• `Optional` **toBlock**: [`BlockTag`](../modules/verida_vda_did._internal_.md#blocktag) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:96 - -___ - -### topics - -• `Optional` **topics**: (``null`` \| `string` \| `string`[])[] - -#### Inherited from - -[EventFilter](verida_vda_did._internal_.EventFilter.md).[topics](verida_vda_did._internal_.EventFilter.md#topics) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:92 diff --git a/docs/api/verida-js/interfaces/verida_vda_did._internal_.Hexable.md b/docs/api/verida-js/interfaces/verida_vda_did._internal_.Hexable.md deleted file mode 100644 index 5e1467c..0000000 --- a/docs/api/verida-js/interfaces/verida_vda_did._internal_.Hexable.md +++ /dev/null @@ -1,29 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-did](../modules/verida_vda_did.md) / [](../modules/verida_vda_did._internal_.md) / Hexable - -# Interface: Hexable - -[@verida/vda-did](../modules/verida_vda_did.md).[](../modules/verida_vda_did._internal_.md).Hexable - -## Implemented by - -- [`BigNumber`](../classes/verida_vda_did._internal_.BigNumber.md) - -## Table of contents - -### Methods - -- [toHexString](verida_vda_did._internal_.Hexable.md#tohexstring) - -## Methods - -### toHexString - -▸ **toHexString**(): `string` - -#### Returns - -`string` - -#### Defined in - -node_modules/@ethersproject/bytes/lib/index.d.ts:8 diff --git a/docs/api/verida-js/interfaces/verida_vda_did._internal_.IDIDDocument.md b/docs/api/verida-js/interfaces/verida_vda_did._internal_.IDIDDocument.md deleted file mode 100644 index 9128309..0000000 --- a/docs/api/verida-js/interfaces/verida_vda_did._internal_.IDIDDocument.md +++ /dev/null @@ -1,364 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-did](../modules/verida_vda_did.md) / [](../modules/verida_vda_did._internal_.md) / IDIDDocument - -# Interface: IDIDDocument - -[@verida/vda-did](../modules/verida_vda_did.md).[](../modules/verida_vda_did._internal_.md).IDIDDocument - -## Implemented by - -- [`default`](../classes/verida_vda_did._internal_.default-1.md) - -## Table of contents - -### Accessors - -- [id](verida_vda_did._internal_.IDIDDocument.md#id) - -### Methods - -- [addContext](verida_vda_did._internal_.IDIDDocument.md#addcontext) -- [addContextAsymKey](verida_vda_did._internal_.IDIDDocument.md#addcontextasymkey) -- [addContextService](verida_vda_did._internal_.IDIDDocument.md#addcontextservice) -- [addContextSignKey](verida_vda_did._internal_.IDIDDocument.md#addcontextsignkey) -- [buildTimestamp](verida_vda_did._internal_.IDIDDocument.md#buildtimestamp) -- [export](verida_vda_did._internal_.IDIDDocument.md#export) -- [getErrors](verida_vda_did._internal_.IDIDDocument.md#geterrors) -- [import](verida_vda_did._internal_.IDIDDocument.md#import) -- [locateContextProof](verida_vda_did._internal_.IDIDDocument.md#locatecontextproof) -- [locateServiceEndpoint](verida_vda_did._internal_.IDIDDocument.md#locateserviceendpoint) -- [removeContext](verida_vda_did._internal_.IDIDDocument.md#removecontext) -- [setAttributes](verida_vda_did._internal_.IDIDDocument.md#setattributes) -- [signProof](verida_vda_did._internal_.IDIDDocument.md#signproof) -- [verifyContextSignature](verida_vda_did._internal_.IDIDDocument.md#verifycontextsignature) -- [verifyProof](verida_vda_did._internal_.IDIDDocument.md#verifyproof) -- [verifySig](verida_vda_did._internal_.IDIDDocument.md#verifysig) - -## Accessors - -### id - -• `get` **id**(): `string` - -#### Returns - -`string` - -#### Defined in - -packages/types/dist/IDIDDocument.d.ts:5 - -## Methods - -### addContext - -▸ **addContext**(`contextName`, `keyring`, `privateKey`, `endpoints`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | -| `keyring` | [`IKeyring`](verida_vda_did._internal_.IKeyring.md) | -| `privateKey` | `string` | -| `endpoints` | [`SecureContextEndpoints`](verida_vda_did._internal_.SecureContextEndpoints.md) | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -packages/types/dist/IDIDDocument.d.ts:7 - -___ - -### addContextAsymKey - -▸ **addContextAsymKey**(`contextHash`, `publicKeyHex`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextHash` | `string` | -| `publicKeyHex` | `string` | - -#### Returns - -`void` - -#### Defined in - -packages/types/dist/IDIDDocument.d.ts:14 - -___ - -### addContextService - -▸ **addContextService**(`contextHash`, `endpointType`, `serviceType`, `endpointUris`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextHash` | `string` | -| `endpointType` | [`SecureContextEndpointType`](../enums/verida_vda_did._internal_.SecureContextEndpointType.md) | -| `serviceType` | `string` | -| `endpointUris` | [`ServiceEndpoint`](../modules/verida_vda_did._internal_.md#serviceendpoint)[] | - -#### Returns - -`void` - -#### Defined in - -packages/types/dist/IDIDDocument.d.ts:12 - -___ - -### addContextSignKey - -▸ **addContextSignKey**(`contextHash`, `publicKeyHex`, `proof`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextHash` | `string` | -| `publicKeyHex` | `string` | -| `proof` | `string` | - -#### Returns - -`void` - -#### Defined in - -packages/types/dist/IDIDDocument.d.ts:13 - -___ - -### buildTimestamp - -▸ **buildTimestamp**(`date`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `date` | `Date` | - -#### Returns - -`string` - -#### Defined in - -packages/types/dist/IDIDDocument.d.ts:21 - -___ - -### export - -▸ **export**(): [`VeridaDocInterface`](verida_vda_did._internal_.VeridaDocInterface.md) - -#### Returns - -[`VeridaDocInterface`](verida_vda_did._internal_.VeridaDocInterface.md) - -#### Defined in - -packages/types/dist/IDIDDocument.d.ts:11 - -___ - -### getErrors - -▸ **getErrors**(): `string`[] - -#### Returns - -`string`[] - -#### Defined in - -packages/types/dist/IDIDDocument.d.ts:6 - -___ - -### import - -▸ **import**(`doc`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `doc` | [`VeridaDocInterface`](verida_vda_did._internal_.VeridaDocInterface.md) | - -#### Returns - -`void` - -#### Defined in - -packages/types/dist/IDIDDocument.d.ts:10 - -___ - -### locateContextProof - -▸ **locateContextProof**(`contextName`): `undefined` \| `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | - -#### Returns - -`undefined` \| `string` - -#### Defined in - -packages/types/dist/IDIDDocument.d.ts:18 - -___ - -### locateServiceEndpoint - -▸ **locateServiceEndpoint**(`contextName`, `endpointType`): `undefined` \| [`Service`](verida_vda_did._internal_.Service.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | -| `endpointType` | [`SecureContextEndpointType`](../enums/verida_vda_did._internal_.SecureContextEndpointType.md) | - -#### Returns - -`undefined` \| [`Service`](verida_vda_did._internal_.Service.md) - -#### Defined in - -packages/types/dist/IDIDDocument.d.ts:17 - -___ - -### removeContext - -▸ **removeContext**(`contextName`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | - -#### Returns - -`boolean` - -#### Defined in - -packages/types/dist/IDIDDocument.d.ts:8 - -___ - -### setAttributes - -▸ **setAttributes**(`attributes`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `attributes` | [`Record`](../modules/verida_vda_did._internal_.md#record)<`string`, `any`\> | - -#### Returns - -`void` - -#### Defined in - -packages/types/dist/IDIDDocument.d.ts:9 - -___ - -### signProof - -▸ **signProof**(`privateKey`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `privateKey` | `string` \| `Uint8Array` | - -#### Returns - -`void` - -#### Defined in - -packages/types/dist/IDIDDocument.d.ts:19 - -___ - -### verifyContextSignature - -▸ **verifyContextSignature**(`data`, `contextName`, `signature`, `contextIsHash`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `any` | -| `contextName` | `string` | -| `signature` | `string` | -| `contextIsHash` | `boolean` | - -#### Returns - -`boolean` - -#### Defined in - -packages/types/dist/IDIDDocument.d.ts:16 - -___ - -### verifyProof - -▸ **verifyProof**(): `boolean` - -#### Returns - -`boolean` - -#### Defined in - -packages/types/dist/IDIDDocument.d.ts:20 - -___ - -### verifySig - -▸ **verifySig**(`data`, `signature`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `any` | -| `signature` | `string` | - -#### Returns - -`boolean` - -#### Defined in - -packages/types/dist/IDIDDocument.d.ts:15 diff --git a/docs/api/verida-js/interfaces/verida_vda_did._internal_.IKeyring.md b/docs/api/verida-js/interfaces/verida_vda_did._internal_.IKeyring.md deleted file mode 100644 index 1c2d785..0000000 --- a/docs/api/verida-js/interfaces/verida_vda_did._internal_.IKeyring.md +++ /dev/null @@ -1,262 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-did](../modules/verida_vda_did.md) / [](../modules/verida_vda_did._internal_.md) / IKeyring - -# Interface: IKeyring - -[@verida/vda-did](../modules/verida_vda_did.md).[](../modules/verida_vda_did._internal_.md).IKeyring - -## Table of contents - -### Methods - -- [\_init](verida_vda_did._internal_.IKeyring.md#_init) -- [asymDecrypt](verida_vda_did._internal_.IKeyring.md#asymdecrypt) -- [asymEncrypt](verida_vda_did._internal_.IKeyring.md#asymencrypt) -- [buildSharedKeyEnd](verida_vda_did._internal_.IKeyring.md#buildsharedkeyend) -- [buildSharedKeyStart](verida_vda_did._internal_.IKeyring.md#buildsharedkeystart) -- [getKeys](verida_vda_did._internal_.IKeyring.md#getkeys) -- [getSeed](verida_vda_did._internal_.IKeyring.md#getseed) -- [getStorageContextKey](verida_vda_did._internal_.IKeyring.md#getstoragecontextkey) -- [publicKeys](verida_vda_did._internal_.IKeyring.md#publickeys) -- [sign](verida_vda_did._internal_.IKeyring.md#sign) -- [symDecrypt](verida_vda_did._internal_.IKeyring.md#symdecrypt) -- [symEncrypt](verida_vda_did._internal_.IKeyring.md#symencrypt) -- [verifySig](verida_vda_did._internal_.IKeyring.md#verifysig) - -## Methods - -### \_init - -▸ **_init**(): `Promise`<`void`\> - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:3 - -___ - -### asymDecrypt - -▸ **asymDecrypt**(`messageWithNonce`, `secretOrSharedKey`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `messageWithNonce` | `string` | -| `secretOrSharedKey` | `Uint8Array` | - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:10 - -___ - -### asymEncrypt - -▸ **asymEncrypt**(`data`, `secretOrSharedKey`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `string` | -| `secretOrSharedKey` | `Uint8Array` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:9 - -___ - -### buildSharedKeyEnd - -▸ **buildSharedKeyEnd**(`publicKey`): `Promise`<`Uint8Array`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `publicKey` | `Uint8Array` | - -#### Returns - -`Promise`<`Uint8Array`\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:12 - -___ - -### buildSharedKeyStart - -▸ **buildSharedKeyStart**(`privateKey`): `Promise`<`Uint8Array`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `privateKey` | `Uint8Array` | - -#### Returns - -`Promise`<`Uint8Array`\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:11 - -___ - -### getKeys - -▸ **getKeys**(): `Promise`<`any`\> - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:2 - -___ - -### getSeed - -▸ **getSeed**(): `string` - -#### Returns - -`string` - -#### Defined in - -packages/types/dist/IKeyring.d.ts:13 - -___ - -### getStorageContextKey - -▸ **getStorageContextKey**(`databaseName`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `databaseName` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:14 - -___ - -### publicKeys - -▸ **publicKeys**(): `Promise`<[`KeyringPublicKeys`](verida_vda_did._internal_.KeyringPublicKeys.md)\> - -#### Returns - -`Promise`<[`KeyringPublicKeys`](verida_vda_did._internal_.KeyringPublicKeys.md)\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:4 - -___ - -### sign - -▸ **sign**(`data`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `any` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:5 - -___ - -### symDecrypt - -▸ **symDecrypt**(`data`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `string` | - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:8 - -___ - -### symEncrypt - -▸ **symEncrypt**(`data`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:7 - -___ - -### verifySig - -▸ **verifySig**(`data`, `sig`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `string` | -| `sig` | `string` | - -#### Returns - -`Promise`<`boolean`\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:6 diff --git a/docs/api/verida-js/interfaces/verida_vda_did._internal_.IterableIterator.md b/docs/api/verida-js/interfaces/verida_vda_did._internal_.IterableIterator.md deleted file mode 100644 index 874498f..0000000 --- a/docs/api/verida-js/interfaces/verida_vda_did._internal_.IterableIterator.md +++ /dev/null @@ -1,112 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-did](../modules/verida_vda_did.md) / [](../modules/verida_vda_did._internal_.md) / IterableIterator - -# Interface: IterableIterator - -[@verida/vda-did](../modules/verida_vda_did.md).[](../modules/verida_vda_did._internal_.md).IterableIterator - -## Type parameters - -| Name | -| :------ | -| `T` | - -## Hierarchy - -- [`Iterator`](verida_vda_did._internal_.Iterator.md)<`T`\> - - ↳ **`IterableIterator`** - -## Table of contents - -### Methods - -- [[iterator]](verida_vda_did._internal_.IterableIterator.md#[iterator]) -- [next](verida_vda_did._internal_.IterableIterator.md#next) -- [return](verida_vda_did._internal_.IterableIterator.md#return) -- [throw](verida_vda_did._internal_.IterableIterator.md#throw) - -## Methods - -### [iterator] - -▸ **[iterator]**(): [`IterableIterator`](verida_vda_did._internal_.IterableIterator.md)<`T`\> - -#### Returns - -[`IterableIterator`](verida_vda_did._internal_.IterableIterator.md)<`T`\> - -#### Defined in - -node_modules/typescript/lib/lib.es2015.iterable.d.ts:55 - -___ - -### next - -▸ **next**(...`args`): [`IteratorResult`](../modules/verida_vda_did._internal_.md#iteratorresult)<`T`, `any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `...args` | [] \| [`undefined`] | - -#### Returns - -[`IteratorResult`](../modules/verida_vda_did._internal_.md#iteratorresult)<`T`, `any`\> - -#### Inherited from - -[Iterator](verida_vda_did._internal_.Iterator.md).[next](verida_vda_did._internal_.Iterator.md#next) - -#### Defined in - -node_modules/typescript/lib/lib.es2015.iterable.d.ts:45 - -___ - -### return - -▸ `Optional` **return**(`value?`): [`IteratorResult`](../modules/verida_vda_did._internal_.md#iteratorresult)<`T`, `any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value?` | `any` | - -#### Returns - -[`IteratorResult`](../modules/verida_vda_did._internal_.md#iteratorresult)<`T`, `any`\> - -#### Inherited from - -[Iterator](verida_vda_did._internal_.Iterator.md).[return](verida_vda_did._internal_.Iterator.md#return) - -#### Defined in - -node_modules/typescript/lib/lib.es2015.iterable.d.ts:46 - -___ - -### throw - -▸ `Optional` **throw**(`e?`): [`IteratorResult`](../modules/verida_vda_did._internal_.md#iteratorresult)<`T`, `any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `e?` | `any` | - -#### Returns - -[`IteratorResult`](../modules/verida_vda_did._internal_.md#iteratorresult)<`T`, `any`\> - -#### Inherited from - -[Iterator](verida_vda_did._internal_.Iterator.md).[throw](verida_vda_did._internal_.Iterator.md#throw) - -#### Defined in - -node_modules/typescript/lib/lib.es2015.iterable.d.ts:47 diff --git a/docs/api/verida-js/interfaces/verida_vda_did._internal_.Iterator.md b/docs/api/verida-js/interfaces/verida_vda_did._internal_.Iterator.md deleted file mode 100644 index ece2d90..0000000 --- a/docs/api/verida-js/interfaces/verida_vda_did._internal_.Iterator.md +++ /dev/null @@ -1,87 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-did](../modules/verida_vda_did.md) / [](../modules/verida_vda_did._internal_.md) / Iterator - -# Interface: Iterator - -[@verida/vda-did](../modules/verida_vda_did.md).[](../modules/verida_vda_did._internal_.md).Iterator - -## Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `T` | -| `TReturn` | `any` | -| `TNext` | `undefined` | - -## Hierarchy - -- **`Iterator`** - - ↳ [`IterableIterator`](verida_vda_did._internal_.IterableIterator.md) - -## Table of contents - -### Methods - -- [next](verida_vda_did._internal_.Iterator.md#next) -- [return](verida_vda_did._internal_.Iterator.md#return) -- [throw](verida_vda_did._internal_.Iterator.md#throw) - -## Methods - -### next - -▸ **next**(...`args`): [`IteratorResult`](../modules/verida_vda_did._internal_.md#iteratorresult)<`T`, `TReturn`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `...args` | [] \| [`TNext`] | - -#### Returns - -[`IteratorResult`](../modules/verida_vda_did._internal_.md#iteratorresult)<`T`, `TReturn`\> - -#### Defined in - -node_modules/typescript/lib/lib.es2015.iterable.d.ts:45 - -___ - -### return - -▸ `Optional` **return**(`value?`): [`IteratorResult`](../modules/verida_vda_did._internal_.md#iteratorresult)<`T`, `TReturn`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value?` | `TReturn` | - -#### Returns - -[`IteratorResult`](../modules/verida_vda_did._internal_.md#iteratorresult)<`T`, `TReturn`\> - -#### Defined in - -node_modules/typescript/lib/lib.es2015.iterable.d.ts:46 - -___ - -### throw - -▸ `Optional` **throw**(`e?`): [`IteratorResult`](../modules/verida_vda_did._internal_.md#iteratorresult)<`T`, `TReturn`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `e?` | `any` | - -#### Returns - -[`IteratorResult`](../modules/verida_vda_did._internal_.md#iteratorresult)<`T`, `TReturn`\> - -#### Defined in - -node_modules/typescript/lib/lib.es2015.iterable.d.ts:47 diff --git a/docs/api/verida-js/interfaces/verida_vda_did._internal_.IteratorReturnResult.md b/docs/api/verida-js/interfaces/verida_vda_did._internal_.IteratorReturnResult.md deleted file mode 100644 index b814c38..0000000 --- a/docs/api/verida-js/interfaces/verida_vda_did._internal_.IteratorReturnResult.md +++ /dev/null @@ -1,38 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-did](../modules/verida_vda_did.md) / [](../modules/verida_vda_did._internal_.md) / IteratorReturnResult - -# Interface: IteratorReturnResult - -[@verida/vda-did](../modules/verida_vda_did.md).[](../modules/verida_vda_did._internal_.md).IteratorReturnResult - -## Type parameters - -| Name | -| :------ | -| `TReturn` | - -## Table of contents - -### Properties - -- [done](verida_vda_did._internal_.IteratorReturnResult.md#done) -- [value](verida_vda_did._internal_.IteratorReturnResult.md#value) - -## Properties - -### done - -• **done**: ``true`` - -#### Defined in - -node_modules/typescript/lib/lib.es2015.iterable.d.ts:37 - -___ - -### value - -• **value**: `TReturn` - -#### Defined in - -node_modules/typescript/lib/lib.es2015.iterable.d.ts:38 diff --git a/docs/api/verida-js/interfaces/verida_vda_did._internal_.IteratorYieldResult.md b/docs/api/verida-js/interfaces/verida_vda_did._internal_.IteratorYieldResult.md deleted file mode 100644 index 7c08c66..0000000 --- a/docs/api/verida-js/interfaces/verida_vda_did._internal_.IteratorYieldResult.md +++ /dev/null @@ -1,38 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-did](../modules/verida_vda_did.md) / [](../modules/verida_vda_did._internal_.md) / IteratorYieldResult - -# Interface: IteratorYieldResult - -[@verida/vda-did](../modules/verida_vda_did.md).[](../modules/verida_vda_did._internal_.md).IteratorYieldResult - -## Type parameters - -| Name | -| :------ | -| `TYield` | - -## Table of contents - -### Properties - -- [done](verida_vda_did._internal_.IteratorYieldResult.md#done) -- [value](verida_vda_did._internal_.IteratorYieldResult.md#value) - -## Properties - -### done - -• `Optional` **done**: ``false`` - -#### Defined in - -node_modules/typescript/lib/lib.es2015.iterable.d.ts:32 - -___ - -### value - -• **value**: `TYield` - -#### Defined in - -node_modules/typescript/lib/lib.es2015.iterable.d.ts:33 diff --git a/docs/api/verida-js/interfaces/verida_vda_did._internal_.JsonFragment.md b/docs/api/verida-js/interfaces/verida_vda_did._internal_.JsonFragment.md deleted file mode 100644 index 4ce439a..0000000 --- a/docs/api/verida-js/interfaces/verida_vda_did._internal_.JsonFragment.md +++ /dev/null @@ -1,109 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-did](../modules/verida_vda_did.md) / [](../modules/verida_vda_did._internal_.md) / JsonFragment - -# Interface: JsonFragment - -[@verida/vda-did](../modules/verida_vda_did.md).[](../modules/verida_vda_did._internal_.md).JsonFragment - -## Table of contents - -### Properties - -- [anonymous](verida_vda_did._internal_.JsonFragment.md#anonymous) -- [constant](verida_vda_did._internal_.JsonFragment.md#constant) -- [gas](verida_vda_did._internal_.JsonFragment.md#gas) -- [inputs](verida_vda_did._internal_.JsonFragment.md#inputs) -- [name](verida_vda_did._internal_.JsonFragment.md#name) -- [outputs](verida_vda_did._internal_.JsonFragment.md#outputs) -- [payable](verida_vda_did._internal_.JsonFragment.md#payable) -- [stateMutability](verida_vda_did._internal_.JsonFragment.md#statemutability) -- [type](verida_vda_did._internal_.JsonFragment.md#type) - -## Properties - -### anonymous - -• `Optional` `Readonly` **anonymous**: `boolean` - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:12 - -___ - -### constant - -• `Optional` `Readonly` **constant**: `boolean` - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:14 - -___ - -### gas - -• `Optional` `Readonly` **gas**: `string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:18 - -___ - -### inputs - -• `Optional` `Readonly` **inputs**: readonly [`JsonFragmentType`](verida_vda_did._internal_.JsonFragmentType.md)[] - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:16 - -___ - -### name - -• `Optional` `Readonly` **name**: `string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:10 - -___ - -### outputs - -• `Optional` `Readonly` **outputs**: readonly [`JsonFragmentType`](verida_vda_did._internal_.JsonFragmentType.md)[] - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:17 - -___ - -### payable - -• `Optional` `Readonly` **payable**: `boolean` - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:13 - -___ - -### stateMutability - -• `Optional` `Readonly` **stateMutability**: `string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:15 - -___ - -### type - -• `Optional` `Readonly` **type**: `string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:11 diff --git a/docs/api/verida-js/interfaces/verida_vda_did._internal_.JsonFragmentType.md b/docs/api/verida-js/interfaces/verida_vda_did._internal_.JsonFragmentType.md deleted file mode 100644 index f3beecd..0000000 --- a/docs/api/verida-js/interfaces/verida_vda_did._internal_.JsonFragmentType.md +++ /dev/null @@ -1,65 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-did](../modules/verida_vda_did.md) / [](../modules/verida_vda_did._internal_.md) / JsonFragmentType - -# Interface: JsonFragmentType - -[@verida/vda-did](../modules/verida_vda_did.md).[](../modules/verida_vda_did._internal_.md).JsonFragmentType - -## Table of contents - -### Properties - -- [components](verida_vda_did._internal_.JsonFragmentType.md#components) -- [indexed](verida_vda_did._internal_.JsonFragmentType.md#indexed) -- [internalType](verida_vda_did._internal_.JsonFragmentType.md#internaltype) -- [name](verida_vda_did._internal_.JsonFragmentType.md#name) -- [type](verida_vda_did._internal_.JsonFragmentType.md#type) - -## Properties - -### components - -• `Optional` `Readonly` **components**: readonly [`JsonFragmentType`](verida_vda_did._internal_.JsonFragmentType.md)[] - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:7 - -___ - -### indexed - -• `Optional` `Readonly` **indexed**: `boolean` - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:4 - -___ - -### internalType - -• `Optional` `Readonly` **internalType**: `any` - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:6 - -___ - -### name - -• `Optional` `Readonly` **name**: `string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:3 - -___ - -### type - -• `Optional` `Readonly` **type**: `string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:5 diff --git a/docs/api/verida-js/interfaces/verida_vda_did._internal_.JsonWebKey.md b/docs/api/verida-js/interfaces/verida_vda_did._internal_.JsonWebKey.md deleted file mode 100644 index 51afa7b..0000000 --- a/docs/api/verida-js/interfaces/verida_vda_did._internal_.JsonWebKey.md +++ /dev/null @@ -1,145 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-did](../modules/verida_vda_did.md) / [](../modules/verida_vda_did._internal_.md) / JsonWebKey - -# Interface: JsonWebKey - -[@verida/vda-did](../modules/verida_vda_did.md).[](../modules/verida_vda_did._internal_.md).JsonWebKey - -Encapsulates a JSON web key type that includes only the public properties that -can be used in DID documents. - -The private properties are intentionally omitted to discourage the use -(and accidental disclosure) of private keys in DID documents. - -**`see`** [RFC7517 JsonWebKey (JWK)](https://www.rfc-editor.org/rfc/rfc7517) - -## Hierarchy - -- [`Extensible`](../modules/verida_vda_did._internal_.md#extensible) - - ↳ **`JsonWebKey`** - -## Table of contents - -### Properties - -- [alg](verida_vda_did._internal_.JsonWebKey.md#alg) -- [crv](verida_vda_did._internal_.JsonWebKey.md#crv) -- [e](verida_vda_did._internal_.JsonWebKey.md#e) -- [ext](verida_vda_did._internal_.JsonWebKey.md#ext) -- [key\_ops](verida_vda_did._internal_.JsonWebKey.md#key_ops) -- [kid](verida_vda_did._internal_.JsonWebKey.md#kid) -- [kty](verida_vda_did._internal_.JsonWebKey.md#kty) -- [n](verida_vda_did._internal_.JsonWebKey.md#n) -- [use](verida_vda_did._internal_.JsonWebKey.md#use) -- [x](verida_vda_did._internal_.JsonWebKey.md#x) -- [y](verida_vda_did._internal_.JsonWebKey.md#y) - -## Properties - -### alg - -• `Optional` **alg**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:103 - -___ - -### crv - -• `Optional` **crv**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:104 - -___ - -### e - -• `Optional` **e**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:105 - -___ - -### ext - -• `Optional` **ext**: `boolean` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:106 - -___ - -### key\_ops - -• `Optional` **key\_ops**: `string`[] - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:107 - -___ - -### kid - -• `Optional` **kid**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:108 - -___ - -### kty - -• **kty**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:109 - -___ - -### n - -• `Optional` **n**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:110 - -___ - -### use - -• `Optional` **use**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:111 - -___ - -### x - -• `Optional` **x**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:112 - -___ - -### y - -• `Optional` **y**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:113 diff --git a/docs/api/verida-js/interfaces/verida_vda_did._internal_.KeyringPublicKeys.md b/docs/api/verida-js/interfaces/verida_vda_did._internal_.KeyringPublicKeys.md deleted file mode 100644 index 3cba216..0000000 --- a/docs/api/verida-js/interfaces/verida_vda_did._internal_.KeyringPublicKeys.md +++ /dev/null @@ -1,76 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-did](../modules/verida_vda_did.md) / [](../modules/verida_vda_did._internal_.md) / KeyringPublicKeys - -# Interface: KeyringPublicKeys - -[@verida/vda-did](../modules/verida_vda_did.md).[](../modules/verida_vda_did._internal_.md).KeyringPublicKeys - -## Table of contents - -### Properties - -- [asymPublicKey](verida_vda_did._internal_.KeyringPublicKeys.md#asympublickey) -- [asymPublicKeyBase58](verida_vda_did._internal_.KeyringPublicKeys.md#asympublickeybase58) -- [asymPublicKeyHex](verida_vda_did._internal_.KeyringPublicKeys.md#asympublickeyhex) -- [signPublicKey](verida_vda_did._internal_.KeyringPublicKeys.md#signpublickey) -- [signPublicKeyBase58](verida_vda_did._internal_.KeyringPublicKeys.md#signpublickeybase58) -- [signPublicKeyHex](verida_vda_did._internal_.KeyringPublicKeys.md#signpublickeyhex) - -## Properties - -### asymPublicKey - -• **asymPublicKey**: `Uint8Array` - -#### Defined in - -packages/types/dist/IKeyring.d.ts:17 - -___ - -### asymPublicKeyBase58 - -• **asymPublicKeyBase58**: `string` - -#### Defined in - -packages/types/dist/IKeyring.d.ts:19 - -___ - -### asymPublicKeyHex - -• **asymPublicKeyHex**: `string` - -#### Defined in - -packages/types/dist/IKeyring.d.ts:18 - -___ - -### signPublicKey - -• **signPublicKey**: `Uint8Array` - -#### Defined in - -packages/types/dist/IKeyring.d.ts:20 - -___ - -### signPublicKeyBase58 - -• **signPublicKeyBase58**: `string` - -#### Defined in - -packages/types/dist/IKeyring.d.ts:22 - -___ - -### signPublicKeyHex - -• **signPublicKeyHex**: `string` - -#### Defined in - -packages/types/dist/IKeyring.d.ts:21 diff --git a/docs/api/verida-js/interfaces/verida_vda_did._internal_.Log.md b/docs/api/verida-js/interfaces/verida_vda_did._internal_.Log.md deleted file mode 100644 index 840e56d..0000000 --- a/docs/api/verida-js/interfaces/verida_vda_did._internal_.Log.md +++ /dev/null @@ -1,115 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-did](../modules/verida_vda_did.md) / [](../modules/verida_vda_did._internal_.md) / Log - -# Interface: Log - -[@verida/vda-did](../modules/verida_vda_did.md).[](../modules/verida_vda_did._internal_.md).Log - -## Hierarchy - -- **`Log`** - - ↳ [`Event`](verida_vda_did._internal_.Event.md) - -## Table of contents - -### Properties - -- [address](verida_vda_did._internal_.Log.md#address) -- [blockHash](verida_vda_did._internal_.Log.md#blockhash) -- [blockNumber](verida_vda_did._internal_.Log.md#blocknumber) -- [data](verida_vda_did._internal_.Log.md#data) -- [logIndex](verida_vda_did._internal_.Log.md#logindex) -- [removed](verida_vda_did._internal_.Log.md#removed) -- [topics](verida_vda_did._internal_.Log.md#topics) -- [transactionHash](verida_vda_did._internal_.Log.md#transactionhash) -- [transactionIndex](verida_vda_did._internal_.Log.md#transactionindex) - -## Properties - -### address - -• **address**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:59 - -___ - -### blockHash - -• **blockHash**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:56 - -___ - -### blockNumber - -• **blockNumber**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:55 - -___ - -### data - -• **data**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:60 - -___ - -### logIndex - -• **logIndex**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:63 - -___ - -### removed - -• **removed**: `boolean` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:58 - -___ - -### topics - -• **topics**: `string`[] - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:61 - -___ - -### transactionHash - -• **transactionHash**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:62 - -___ - -### transactionIndex - -• **transactionIndex**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:57 diff --git a/docs/api/verida-js/interfaces/verida_vda_did._internal_.LookupResponse.md b/docs/api/verida-js/interfaces/verida_vda_did._internal_.LookupResponse.md deleted file mode 100644 index 40dad7d..0000000 --- a/docs/api/verida-js/interfaces/verida_vda_did._internal_.LookupResponse.md +++ /dev/null @@ -1,32 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-did](../modules/verida_vda_did.md) / [](../modules/verida_vda_did._internal_.md) / LookupResponse - -# Interface: LookupResponse - -[@verida/vda-did](../modules/verida_vda_did.md).[](../modules/verida_vda_did._internal_.md).LookupResponse - -## Table of contents - -### Properties - -- [didController](verida_vda_did._internal_.LookupResponse.md#didcontroller) -- [endpoints](verida_vda_did._internal_.LookupResponse.md#endpoints) - -## Properties - -### didController - -• **didController**: `string` - -#### Defined in - -[packages/vda-did/src/blockchain/blockchainApi.ts:9](https://github.com/verida/verida-js/blob/5040472/packages/vda-did/src/blockchain/blockchainApi.ts#L9) - -___ - -### endpoints - -• **endpoints**: `string`[] - -#### Defined in - -[packages/vda-did/src/blockchain/blockchainApi.ts:10](https://github.com/verida/verida-js/blob/5040472/packages/vda-did/src/blockchain/blockchainApi.ts#L10) diff --git a/docs/api/verida-js/interfaces/verida_vda_did._internal_.OnceBlockable.md b/docs/api/verida-js/interfaces/verida_vda_did._internal_.OnceBlockable.md deleted file mode 100644 index 75171e7..0000000 --- a/docs/api/verida-js/interfaces/verida_vda_did._internal_.OnceBlockable.md +++ /dev/null @@ -1,36 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-did](../modules/verida_vda_did.md) / [](../modules/verida_vda_did._internal_.md) / OnceBlockable - -# Interface: OnceBlockable - -[@verida/vda-did](../modules/verida_vda_did.md).[](../modules/verida_vda_did._internal_.md).OnceBlockable - -## Implemented by - -- [`Provider`](../classes/verida_vda_did._internal_.Provider.md) - -## Table of contents - -### Methods - -- [once](verida_vda_did._internal_.OnceBlockable.md#once) - -## Methods - -### once - -▸ **once**(`eventName`, `handler`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | ``"block"`` | -| `handler` | () => `void` | - -#### Returns - -`void` - -#### Defined in - -node_modules/@ethersproject/web/lib/index.d.ts:19 diff --git a/docs/api/verida-js/interfaces/verida_vda_did._internal_.PopulatedTransaction.md b/docs/api/verida-js/interfaces/verida_vda_did._internal_.PopulatedTransaction.md deleted file mode 100644 index 4bcb445..0000000 --- a/docs/api/verida-js/interfaces/verida_vda_did._internal_.PopulatedTransaction.md +++ /dev/null @@ -1,164 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-did](../modules/verida_vda_did.md) / [](../modules/verida_vda_did._internal_.md) / PopulatedTransaction - -# Interface: PopulatedTransaction - -[@verida/vda-did](../modules/verida_vda_did.md).[](../modules/verida_vda_did._internal_.md).PopulatedTransaction - -## Table of contents - -### Properties - -- [accessList](verida_vda_did._internal_.PopulatedTransaction.md#accesslist) -- [ccipReadEnabled](verida_vda_did._internal_.PopulatedTransaction.md#ccipreadenabled) -- [chainId](verida_vda_did._internal_.PopulatedTransaction.md#chainid) -- [customData](verida_vda_did._internal_.PopulatedTransaction.md#customdata) -- [data](verida_vda_did._internal_.PopulatedTransaction.md#data) -- [from](verida_vda_did._internal_.PopulatedTransaction.md#from) -- [gasLimit](verida_vda_did._internal_.PopulatedTransaction.md#gaslimit) -- [gasPrice](verida_vda_did._internal_.PopulatedTransaction.md#gasprice) -- [maxFeePerGas](verida_vda_did._internal_.PopulatedTransaction.md#maxfeepergas) -- [maxPriorityFeePerGas](verida_vda_did._internal_.PopulatedTransaction.md#maxpriorityfeepergas) -- [nonce](verida_vda_did._internal_.PopulatedTransaction.md#nonce) -- [to](verida_vda_did._internal_.PopulatedTransaction.md#to) -- [type](verida_vda_did._internal_.PopulatedTransaction.md#type) -- [value](verida_vda_did._internal_.PopulatedTransaction.md#value) - -## Properties - -### accessList - -• `Optional` **accessList**: [`AccessList`](../modules/verida_vda_did._internal_.md#accesslist) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:35 - -___ - -### ccipReadEnabled - -• `Optional` **ccipReadEnabled**: `boolean` - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:39 - -___ - -### chainId - -• `Optional` **chainId**: `number` - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:33 - -___ - -### customData - -• `Optional` **customData**: [`Record`](../modules/verida_vda_did._internal_.md#record)<`string`, `any`\> - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:38 - -___ - -### data - -• `Optional` **data**: `string` - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:31 - -___ - -### from - -• `Optional` **from**: `string` - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:27 - -___ - -### gasLimit - -• `Optional` **gasLimit**: [`BigNumber`](../classes/verida_vda_did._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:29 - -___ - -### gasPrice - -• `Optional` **gasPrice**: [`BigNumber`](../classes/verida_vda_did._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:30 - -___ - -### maxFeePerGas - -• `Optional` **maxFeePerGas**: [`BigNumber`](../classes/verida_vda_did._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:36 - -___ - -### maxPriorityFeePerGas - -• `Optional` **maxPriorityFeePerGas**: [`BigNumber`](../classes/verida_vda_did._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:37 - -___ - -### nonce - -• `Optional` **nonce**: `number` - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:28 - -___ - -### to - -• `Optional` **to**: `string` - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:26 - -___ - -### type - -• `Optional` **type**: `number` - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:34 - -___ - -### value - -• `Optional` **value**: [`BigNumber`](../classes/verida_vda_did._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:32 diff --git a/docs/api/verida-js/interfaces/verida_vda_did._internal_.ProofInterface.md b/docs/api/verida-js/interfaces/verida_vda_did._internal_.ProofInterface.md deleted file mode 100644 index 901e2ce..0000000 --- a/docs/api/verida-js/interfaces/verida_vda_did._internal_.ProofInterface.md +++ /dev/null @@ -1,54 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-did](../modules/verida_vda_did.md) / [](../modules/verida_vda_did._internal_.md) / ProofInterface - -# Interface: ProofInterface - -[@verida/vda-did](../modules/verida_vda_did.md).[](../modules/verida_vda_did._internal_.md).ProofInterface - -## Table of contents - -### Properties - -- [proofPurpose](verida_vda_did._internal_.ProofInterface.md#proofpurpose) -- [proofValue](verida_vda_did._internal_.ProofInterface.md#proofvalue) -- [type](verida_vda_did._internal_.ProofInterface.md#type) -- [verificationMethod](verida_vda_did._internal_.ProofInterface.md#verificationmethod) - -## Properties - -### proofPurpose - -• **proofPurpose**: `string` - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:34 - -___ - -### proofValue - -• **proofValue**: `string` - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:35 - -___ - -### type - -• **type**: `string` - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:32 - -___ - -### verificationMethod - -• **verificationMethod**: `string` - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:33 diff --git a/docs/api/verida-js/interfaces/verida_vda_did._internal_.Result.md b/docs/api/verida-js/interfaces/verida_vda_did._internal_.Result.md deleted file mode 100644 index 9592f49..0000000 --- a/docs/api/verida-js/interfaces/verida_vda_did._internal_.Result.md +++ /dev/null @@ -1,869 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-did](../modules/verida_vda_did.md) / [](../modules/verida_vda_did._internal_.md) / Result - -# Interface: Result - -[@verida/vda-did](../modules/verida_vda_did.md).[](../modules/verida_vda_did._internal_.md).Result - -## Hierarchy - -- `ReadonlyArray`<`any`\> - - ↳ **`Result`** - -## Indexable - -▪ [key: `string`]: `any` - -## Table of contents - -### Properties - -- [length](verida_vda_did._internal_.Result.md#length) - -### Methods - -- [[iterator]](verida_vda_did._internal_.Result.md#[iterator]) -- [concat](verida_vda_did._internal_.Result.md#concat) -- [entries](verida_vda_did._internal_.Result.md#entries) -- [every](verida_vda_did._internal_.Result.md#every) -- [filter](verida_vda_did._internal_.Result.md#filter) -- [find](verida_vda_did._internal_.Result.md#find) -- [findIndex](verida_vda_did._internal_.Result.md#findindex) -- [flat](verida_vda_did._internal_.Result.md#flat) -- [flatMap](verida_vda_did._internal_.Result.md#flatmap) -- [forEach](verida_vda_did._internal_.Result.md#foreach) -- [includes](verida_vda_did._internal_.Result.md#includes) -- [indexOf](verida_vda_did._internal_.Result.md#indexof) -- [join](verida_vda_did._internal_.Result.md#join) -- [keys](verida_vda_did._internal_.Result.md#keys) -- [lastIndexOf](verida_vda_did._internal_.Result.md#lastindexof) -- [map](verida_vda_did._internal_.Result.md#map) -- [reduce](verida_vda_did._internal_.Result.md#reduce) -- [reduceRight](verida_vda_did._internal_.Result.md#reduceright) -- [slice](verida_vda_did._internal_.Result.md#slice) -- [some](verida_vda_did._internal_.Result.md#some) -- [toLocaleString](verida_vda_did._internal_.Result.md#tolocalestring) -- [toString](verida_vda_did._internal_.Result.md#tostring) -- [values](verida_vda_did._internal_.Result.md#values) - -## Properties - -### length - -• `Readonly` **length**: `number` - -Gets the length of the array. This is a number one higher than the highest element defined in an array. - -#### Inherited from - -ReadonlyArray.length - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1090 - -## Methods - -### [iterator] - -▸ **[iterator]**(): [`IterableIterator`](verida_vda_did._internal_.IterableIterator.md)<`any`\> - -Iterator of values in the array. - -#### Returns - -[`IterableIterator`](verida_vda_did._internal_.IterableIterator.md)<`any`\> - -#### Inherited from - -ReadonlyArray.\_\_@iterator@13541 - -#### Defined in - -node_modules/typescript/lib/lib.es2015.iterable.d.ts:96 - -___ - -### concat - -▸ **concat**(...`items`): `any`[] - -Combines two or more arrays. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `...items` | [`ConcatArray`](verida_vda_did._internal_.ConcatArray.md)<`any`\>[] | Additional items to add to the end of array1. | - -#### Returns - -`any`[] - -#### Inherited from - -ReadonlyArray.concat - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1103 - -▸ **concat**(...`items`): `any`[] - -Combines two or more arrays. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `...items` | `any`[] | Additional items to add to the end of array1. | - -#### Returns - -`any`[] - -#### Inherited from - -ReadonlyArray.concat - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1108 - -___ - -### entries - -▸ **entries**(): [`IterableIterator`](verida_vda_did._internal_.IterableIterator.md)<[`number`, `any`]\> - -Returns an iterable of key, value pairs for every entry in the array - -#### Returns - -[`IterableIterator`](verida_vda_did._internal_.IterableIterator.md)<[`number`, `any`]\> - -#### Inherited from - -ReadonlyArray.entries - -#### Defined in - -node_modules/typescript/lib/lib.es2015.iterable.d.ts:101 - -___ - -### every - -▸ **every**<`S`\>(`predicate`, `thisArg?`): this is readonly S[] - -Determines whether all the members of an array satisfy the specified test. - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `S` | extends `any` | - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `predicate` | (`value`: `any`, `index`: `number`, `array`: readonly `any`[]) => value is S | A function that accepts up to three arguments. The every method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value false, or until the end of the array. | -| `thisArg?` | `any` | An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value. | - -#### Returns - -this is readonly S[] - -#### Inherited from - -ReadonlyArray.every - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1140 - -▸ **every**(`predicate`, `thisArg?`): `boolean` - -Determines whether all the members of an array satisfy the specified test. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `predicate` | (`value`: `any`, `index`: `number`, `array`: readonly `any`[]) => `unknown` | A function that accepts up to three arguments. The every method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value false, or until the end of the array. | -| `thisArg?` | `any` | An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value. | - -#### Returns - -`boolean` - -#### Inherited from - -ReadonlyArray.every - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1149 - -___ - -### filter - -▸ **filter**<`S`\>(`predicate`, `thisArg?`): `S`[] - -Returns the elements of an array that meet the condition specified in a callback function. - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `S` | extends `any` | - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `predicate` | (`value`: `any`, `index`: `number`, `array`: readonly `any`[]) => value is S | A function that accepts up to three arguments. The filter method calls the predicate function one time for each element in the array. | -| `thisArg?` | `any` | An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value. | - -#### Returns - -`S`[] - -#### Inherited from - -ReadonlyArray.filter - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1176 - -▸ **filter**(`predicate`, `thisArg?`): `any`[] - -Returns the elements of an array that meet the condition specified in a callback function. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `predicate` | (`value`: `any`, `index`: `number`, `array`: readonly `any`[]) => `unknown` | A function that accepts up to three arguments. The filter method calls the predicate function one time for each element in the array. | -| `thisArg?` | `any` | An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value. | - -#### Returns - -`any`[] - -#### Inherited from - -ReadonlyArray.filter - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1182 - -___ - -### find - -▸ **find**<`S`\>(`predicate`, `thisArg?`): `undefined` \| `S` - -Returns the value of the first element in the array where predicate is true, and undefined -otherwise. - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `S` | extends `any` | - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `predicate` | (`value`: `any`, `index`: `number`, `obj`: readonly `any`[]) => value is S | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined. | -| `thisArg?` | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. | - -#### Returns - -`undefined` \| `S` - -#### Inherited from - -ReadonlyArray.find - -#### Defined in - -node_modules/typescript/lib/lib.es2015.core.d.ts:352 - -▸ **find**(`predicate`, `thisArg?`): `any` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `predicate` | (`value`: `any`, `index`: `number`, `obj`: readonly `any`[]) => `unknown` | -| `thisArg?` | `any` | - -#### Returns - -`any` - -#### Inherited from - -ReadonlyArray.find - -#### Defined in - -node_modules/typescript/lib/lib.es2015.core.d.ts:353 - -___ - -### findIndex - -▸ **findIndex**(`predicate`, `thisArg?`): `number` - -Returns the index of the first element in the array where predicate is true, and -1 -otherwise. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `predicate` | (`value`: `any`, `index`: `number`, `obj`: readonly `any`[]) => `unknown` | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1. | -| `thisArg?` | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. | - -#### Returns - -`number` - -#### Inherited from - -ReadonlyArray.findIndex - -#### Defined in - -node_modules/typescript/lib/lib.es2015.core.d.ts:364 - -___ - -### flat - -▸ **flat**<`A`, `D`\>(`depth?`): [`FlatArray`](../modules/verida_vda_did._internal_.md#flatarray)<`A`, `D`\>[] - -Returns a new array with all sub-array elements concatenated into it recursively up to the -specified depth. - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `A` | `A` | -| `D` | extends `number` = ``1`` | - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `depth?` | `D` | The maximum recursion depth | - -#### Returns - -[`FlatArray`](../modules/verida_vda_did._internal_.md#flatarray)<`A`, `D`\>[] - -#### Inherited from - -ReadonlyArray.flat - -#### Defined in - -node_modules/typescript/lib/lib.es2019.array.d.ts:52 - -___ - -### flatMap - -▸ **flatMap**<`U`, `This`\>(`callback`, `thisArg?`): `U`[] - -Calls a defined callback function on each element of an array. Then, flattens the result into -a new array. -This is identical to a map followed by flat with depth 1. - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `U` | `U` | -| `This` | `undefined` | - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `callback` | (`value`: `any`, `index`: `number`, `array`: `any`[]) => `U` \| readonly `U`[] | A function that accepts up to three arguments. The flatMap method calls the callback function one time for each element in the array. | -| `thisArg?` | `This` | An object to which the this keyword can refer in the callback function. If thisArg is omitted, undefined is used as the this value. | - -#### Returns - -`U`[] - -#### Inherited from - -ReadonlyArray.flatMap - -#### Defined in - -node_modules/typescript/lib/lib.es2019.array.d.ts:40 - -___ - -### forEach - -▸ **forEach**(`callbackfn`, `thisArg?`): `void` - -Performs the specified action for each element in an array. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `callbackfn` | (`value`: `any`, `index`: `number`, `array`: readonly `any`[]) => `void` | A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array. | -| `thisArg?` | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -#### Returns - -`void` - -#### Inherited from - -ReadonlyArray.forEach - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1164 - -___ - -### includes - -▸ **includes**(`searchElement`, `fromIndex?`): `boolean` - -Determines whether an array includes a certain element, returning true or false as appropriate. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `searchElement` | `any` | The element to search for. | -| `fromIndex?` | `number` | The position in this array at which to begin searching for searchElement. | - -#### Returns - -`boolean` - -#### Inherited from - -ReadonlyArray.includes - -#### Defined in - -node_modules/typescript/lib/lib.es2016.array.include.d.ts:36 - -___ - -### indexOf - -▸ **indexOf**(`searchElement`, `fromIndex?`): `number` - -Returns the index of the first occurrence of a value in an array. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `searchElement` | `any` | The value to locate in the array. | -| `fromIndex?` | `number` | The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0. | - -#### Returns - -`number` - -#### Inherited from - -ReadonlyArray.indexOf - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1125 - -___ - -### join - -▸ **join**(`separator?`): `string` - -Adds all the elements of an array separated by the specified separator string. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `separator?` | `string` | A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma. | - -#### Returns - -`string` - -#### Inherited from - -ReadonlyArray.join - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1113 - -___ - -### keys - -▸ **keys**(): [`IterableIterator`](verida_vda_did._internal_.IterableIterator.md)<`number`\> - -Returns an iterable of keys in the array - -#### Returns - -[`IterableIterator`](verida_vda_did._internal_.IterableIterator.md)<`number`\> - -#### Inherited from - -ReadonlyArray.keys - -#### Defined in - -node_modules/typescript/lib/lib.es2015.iterable.d.ts:106 - -___ - -### lastIndexOf - -▸ **lastIndexOf**(`searchElement`, `fromIndex?`): `number` - -Returns the index of the last occurrence of a specified value in an array. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `searchElement` | `any` | The value to locate in the array. | -| `fromIndex?` | `number` | The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array. | - -#### Returns - -`number` - -#### Inherited from - -ReadonlyArray.lastIndexOf - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1131 - -___ - -### map - -▸ **map**<`U`\>(`callbackfn`, `thisArg?`): `U`[] - -Calls a defined callback function on each element of an array, and returns an array that contains the results. - -#### Type parameters - -| Name | -| :------ | -| `U` | - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `callbackfn` | (`value`: `any`, `index`: `number`, `array`: readonly `any`[]) => `U` | A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array. | -| `thisArg?` | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -#### Returns - -`U`[] - -#### Inherited from - -ReadonlyArray.map - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1170 - -___ - -### reduce - -▸ **reduce**(`callbackfn`): `any` - -Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `callbackfn` | (`previousValue`: `any`, `currentValue`: `any`, `currentIndex`: `number`, `array`: readonly `any`[]) => `any` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. | - -#### Returns - -`any` - -#### Inherited from - -ReadonlyArray.reduce - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1188 - -▸ **reduce**(`callbackfn`, `initialValue`): `any` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `callbackfn` | (`previousValue`: `any`, `currentValue`: `any`, `currentIndex`: `number`, `array`: readonly `any`[]) => `any` | -| `initialValue` | `any` | - -#### Returns - -`any` - -#### Inherited from - -ReadonlyArray.reduce - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1189 - -▸ **reduce**<`U`\>(`callbackfn`, `initialValue`): `U` - -Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -#### Type parameters - -| Name | -| :------ | -| `U` | - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `callbackfn` | (`previousValue`: `U`, `currentValue`: `any`, `currentIndex`: `number`, `array`: readonly `any`[]) => `U` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. | -| `initialValue` | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. | - -#### Returns - -`U` - -#### Inherited from - -ReadonlyArray.reduce - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1195 - -___ - -### reduceRight - -▸ **reduceRight**(`callbackfn`): `any` - -Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `callbackfn` | (`previousValue`: `any`, `currentValue`: `any`, `currentIndex`: `number`, `array`: readonly `any`[]) => `any` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. | - -#### Returns - -`any` - -#### Inherited from - -ReadonlyArray.reduceRight - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1201 - -▸ **reduceRight**(`callbackfn`, `initialValue`): `any` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `callbackfn` | (`previousValue`: `any`, `currentValue`: `any`, `currentIndex`: `number`, `array`: readonly `any`[]) => `any` | -| `initialValue` | `any` | - -#### Returns - -`any` - -#### Inherited from - -ReadonlyArray.reduceRight - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1202 - -▸ **reduceRight**<`U`\>(`callbackfn`, `initialValue`): `U` - -Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -#### Type parameters - -| Name | -| :------ | -| `U` | - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `callbackfn` | (`previousValue`: `U`, `currentValue`: `any`, `currentIndex`: `number`, `array`: readonly `any`[]) => `U` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. | -| `initialValue` | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. | - -#### Returns - -`U` - -#### Inherited from - -ReadonlyArray.reduceRight - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1208 - -___ - -### slice - -▸ **slice**(`start?`, `end?`): `any`[] - -Returns a section of an array. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `start?` | `number` | The beginning of the specified portion of the array. | -| `end?` | `number` | The end of the specified portion of the array. This is exclusive of the element at the index 'end'. | - -#### Returns - -`any`[] - -#### Inherited from - -ReadonlyArray.slice - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1119 - -___ - -### some - -▸ **some**(`predicate`, `thisArg?`): `boolean` - -Determines whether the specified callback function returns true for any element of an array. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `predicate` | (`value`: `any`, `index`: `number`, `array`: readonly `any`[]) => `unknown` | A function that accepts up to three arguments. The some method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value true, or until the end of the array. | -| `thisArg?` | `any` | An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value. | - -#### Returns - -`boolean` - -#### Inherited from - -ReadonlyArray.some - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1158 - -___ - -### toLocaleString - -▸ **toLocaleString**(): `string` - -Returns a string representation of an array. The elements are converted to string using their toLocaleString methods. - -#### Returns - -`string` - -#### Inherited from - -ReadonlyArray.toLocaleString - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1098 - -___ - -### toString - -▸ **toString**(): `string` - -Returns a string representation of an array. - -#### Returns - -`string` - -#### Inherited from - -ReadonlyArray.toString - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1094 - -___ - -### values - -▸ **values**(): [`IterableIterator`](verida_vda_did._internal_.IterableIterator.md)<`any`\> - -Returns an iterable of values in the array - -#### Returns - -[`IterableIterator`](verida_vda_did._internal_.IterableIterator.md)<`any`\> - -#### Inherited from - -ReadonlyArray.values - -#### Defined in - -node_modules/typescript/lib/lib.es2015.iterable.d.ts:111 diff --git a/docs/api/verida-js/interfaces/verida_vda_did._internal_.SecureContextEndpoint.md b/docs/api/verida-js/interfaces/verida_vda_did._internal_.SecureContextEndpoint.md deleted file mode 100644 index 0d6bedf..0000000 --- a/docs/api/verida-js/interfaces/verida_vda_did._internal_.SecureContextEndpoint.md +++ /dev/null @@ -1,43 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-did](../modules/verida_vda_did.md) / [](../modules/verida_vda_did._internal_.md) / SecureContextEndpoint - -# Interface: SecureContextEndpoint - -[@verida/vda-did](../modules/verida_vda_did.md).[](../modules/verida_vda_did._internal_.md).SecureContextEndpoint - -## Table of contents - -### Properties - -- [config](verida_vda_did._internal_.SecureContextEndpoint.md#config) -- [endpointUri](verida_vda_did._internal_.SecureContextEndpoint.md#endpointuri) -- [type](verida_vda_did._internal_.SecureContextEndpoint.md#type) - -## Properties - -### config - -• `Optional` **config**: `object` - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:5 - -___ - -### endpointUri - -• **endpointUri**: [`ServiceEndpoint`](../modules/verida_vda_did._internal_.md#serviceendpoint)[] - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:4 - -___ - -### type - -• **type**: `string` - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:3 diff --git a/docs/api/verida-js/interfaces/verida_vda_did._internal_.SecureContextEndpoints.md b/docs/api/verida-js/interfaces/verida_vda_did._internal_.SecureContextEndpoints.md deleted file mode 100644 index 2b12a97..0000000 --- a/docs/api/verida-js/interfaces/verida_vda_did._internal_.SecureContextEndpoints.md +++ /dev/null @@ -1,54 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-did](../modules/verida_vda_did.md) / [](../modules/verida_vda_did._internal_.md) / SecureContextEndpoints - -# Interface: SecureContextEndpoints - -[@verida/vda-did](../modules/verida_vda_did.md).[](../modules/verida_vda_did._internal_.md).SecureContextEndpoints - -## Table of contents - -### Properties - -- [database](verida_vda_did._internal_.SecureContextEndpoints.md#database) -- [messaging](verida_vda_did._internal_.SecureContextEndpoints.md#messaging) -- [notification](verida_vda_did._internal_.SecureContextEndpoints.md#notification) -- [storage](verida_vda_did._internal_.SecureContextEndpoints.md#storage) - -## Properties - -### database - -• **database**: [`SecureContextEndpoint`](verida_vda_did._internal_.SecureContextEndpoint.md) - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:8 - -___ - -### messaging - -• **messaging**: [`SecureContextEndpoint`](verida_vda_did._internal_.SecureContextEndpoint.md) - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:9 - -___ - -### notification - -• `Optional` **notification**: [`SecureContextEndpoint`](verida_vda_did._internal_.SecureContextEndpoint.md) - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:11 - -___ - -### storage - -• `Optional` **storage**: [`SecureContextEndpoint`](verida_vda_did._internal_.SecureContextEndpoint.md) - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:10 diff --git a/docs/api/verida-js/interfaces/verida_vda_did._internal_.Service.md b/docs/api/verida-js/interfaces/verida_vda_did._internal_.Service.md deleted file mode 100644 index 8857496..0000000 --- a/docs/api/verida-js/interfaces/verida_vda_did._internal_.Service.md +++ /dev/null @@ -1,53 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-did](../modules/verida_vda_did.md) / [](../modules/verida_vda_did._internal_.md) / Service - -# Interface: Service - -[@verida/vda-did](../modules/verida_vda_did.md).[](../modules/verida_vda_did._internal_.md).Service - -Represents a Service entry in a [DID document](https://www.w3.org/TR/did-core/#did-document-properties). - -**`see`** [https://www.w3.org/TR/did-core/#services](https://www.w3.org/TR/did-core/#services) - -**`see`** [https://www.w3.org/TR/did-core/#service-properties](https://www.w3.org/TR/did-core/#service-properties) - -## Indexable - -▪ [x: `string`]: `any` - -## Table of contents - -### Properties - -- [id](verida_vda_did._internal_.Service.md#id) -- [serviceEndpoint](verida_vda_did._internal_.Service.md#serviceendpoint) -- [type](verida_vda_did._internal_.Service.md#type) - -## Properties - -### id - -• **id**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:81 - -___ - -### serviceEndpoint - -• **serviceEndpoint**: [`ServiceEndpoint`](../modules/verida_vda_did._internal_.md#serviceendpoint) \| [`ServiceEndpoint`](../modules/verida_vda_did._internal_.md#serviceendpoint)[] - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:83 - -___ - -### type - -• **type**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:82 diff --git a/docs/api/verida-js/interfaces/verida_vda_did._internal_.Transaction.md b/docs/api/verida-js/interfaces/verida_vda_did._internal_.Transaction.md deleted file mode 100644 index f2394cb..0000000 --- a/docs/api/verida-js/interfaces/verida_vda_did._internal_.Transaction.md +++ /dev/null @@ -1,192 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-did](../modules/verida_vda_did.md) / [](../modules/verida_vda_did._internal_.md) / Transaction - -# Interface: Transaction - -[@verida/vda-did](../modules/verida_vda_did.md).[](../modules/verida_vda_did._internal_.md).Transaction - -## Hierarchy - -- **`Transaction`** - - ↳ [`TransactionResponse`](verida_vda_did._internal_.TransactionResponse.md) - -## Table of contents - -### Properties - -- [accessList](verida_vda_did._internal_.Transaction.md#accesslist) -- [chainId](verida_vda_did._internal_.Transaction.md#chainid) -- [data](verida_vda_did._internal_.Transaction.md#data) -- [from](verida_vda_did._internal_.Transaction.md#from) -- [gasLimit](verida_vda_did._internal_.Transaction.md#gaslimit) -- [gasPrice](verida_vda_did._internal_.Transaction.md#gasprice) -- [hash](verida_vda_did._internal_.Transaction.md#hash) -- [maxFeePerGas](verida_vda_did._internal_.Transaction.md#maxfeepergas) -- [maxPriorityFeePerGas](verida_vda_did._internal_.Transaction.md#maxpriorityfeepergas) -- [nonce](verida_vda_did._internal_.Transaction.md#nonce) -- [r](verida_vda_did._internal_.Transaction.md#r) -- [s](verida_vda_did._internal_.Transaction.md#s) -- [to](verida_vda_did._internal_.Transaction.md#to) -- [type](verida_vda_did._internal_.Transaction.md#type) -- [v](verida_vda_did._internal_.Transaction.md#v) -- [value](verida_vda_did._internal_.Transaction.md#value) - -## Properties - -### accessList - -• `Optional` **accessList**: [`AccessList`](../modules/verida_vda_did._internal_.md#accesslist) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:40 - -___ - -### chainId - -• **chainId**: `number` - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:35 - -___ - -### data - -• **data**: `string` - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:33 - -___ - -### from - -• `Optional` **from**: `string` - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:29 - -___ - -### gasLimit - -• **gasLimit**: [`BigNumber`](../classes/verida_vda_did._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:31 - -___ - -### gasPrice - -• `Optional` **gasPrice**: [`BigNumber`](../classes/verida_vda_did._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:32 - -___ - -### hash - -• `Optional` **hash**: `string` - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:27 - -___ - -### maxFeePerGas - -• `Optional` **maxFeePerGas**: [`BigNumber`](../classes/verida_vda_did._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:42 - -___ - -### maxPriorityFeePerGas - -• `Optional` **maxPriorityFeePerGas**: [`BigNumber`](../classes/verida_vda_did._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:41 - -___ - -### nonce - -• **nonce**: `number` - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:30 - -___ - -### r - -• `Optional` **r**: `string` - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:36 - -___ - -### s - -• `Optional` **s**: `string` - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:37 - -___ - -### to - -• `Optional` **to**: `string` - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:28 - -___ - -### type - -• `Optional` **type**: ``null`` \| `number` - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:39 - -___ - -### v - -• `Optional` **v**: `number` - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:38 - -___ - -### value - -• **value**: [`BigNumber`](../classes/verida_vda_did._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:34 diff --git a/docs/api/verida-js/interfaces/verida_vda_did._internal_.TransactionReceipt.md b/docs/api/verida-js/interfaces/verida_vda_did._internal_.TransactionReceipt.md deleted file mode 100644 index f53c198..0000000 --- a/docs/api/verida-js/interfaces/verida_vda_did._internal_.TransactionReceipt.md +++ /dev/null @@ -1,197 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-did](../modules/verida_vda_did.md) / [](../modules/verida_vda_did._internal_.md) / TransactionReceipt - -# Interface: TransactionReceipt - -[@verida/vda-did](../modules/verida_vda_did.md).[](../modules/verida_vda_did._internal_.md).TransactionReceipt - -## Table of contents - -### Properties - -- [blockHash](verida_vda_did._internal_.TransactionReceipt.md#blockhash) -- [blockNumber](verida_vda_did._internal_.TransactionReceipt.md#blocknumber) -- [byzantium](verida_vda_did._internal_.TransactionReceipt.md#byzantium) -- [confirmations](verida_vda_did._internal_.TransactionReceipt.md#confirmations) -- [contractAddress](verida_vda_did._internal_.TransactionReceipt.md#contractaddress) -- [cumulativeGasUsed](verida_vda_did._internal_.TransactionReceipt.md#cumulativegasused) -- [effectiveGasPrice](verida_vda_did._internal_.TransactionReceipt.md#effectivegasprice) -- [from](verida_vda_did._internal_.TransactionReceipt.md#from) -- [gasUsed](verida_vda_did._internal_.TransactionReceipt.md#gasused) -- [logs](verida_vda_did._internal_.TransactionReceipt.md#logs) -- [logsBloom](verida_vda_did._internal_.TransactionReceipt.md#logsbloom) -- [root](verida_vda_did._internal_.TransactionReceipt.md#root) -- [status](verida_vda_did._internal_.TransactionReceipt.md#status) -- [to](verida_vda_did._internal_.TransactionReceipt.md#to) -- [transactionHash](verida_vda_did._internal_.TransactionReceipt.md#transactionhash) -- [transactionIndex](verida_vda_did._internal_.TransactionReceipt.md#transactionindex) -- [type](verida_vda_did._internal_.TransactionReceipt.md#type) - -## Properties - -### blockHash - -• **blockHash**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:73 - -___ - -### blockNumber - -• **blockNumber**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:76 - -___ - -### byzantium - -• **byzantium**: `boolean` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:80 - -___ - -### confirmations - -• **confirmations**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:77 - -___ - -### contractAddress - -• **contractAddress**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:68 - -___ - -### cumulativeGasUsed - -• **cumulativeGasUsed**: [`BigNumber`](../classes/verida_vda_did._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:78 - -___ - -### effectiveGasPrice - -• **effectiveGasPrice**: [`BigNumber`](../classes/verida_vda_did._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:79 - -___ - -### from - -• **from**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:67 - -___ - -### gasUsed - -• **gasUsed**: [`BigNumber`](../classes/verida_vda_did._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:71 - -___ - -### logs - -• **logs**: [`Log`](verida_vda_did._internal_.Log.md)[] - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:75 - -___ - -### logsBloom - -• **logsBloom**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:72 - -___ - -### root - -• `Optional` **root**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:70 - -___ - -### status - -• `Optional` **status**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:82 - -___ - -### to - -• **to**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:66 - -___ - -### transactionHash - -• **transactionHash**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:74 - -___ - -### transactionIndex - -• **transactionIndex**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:69 - -___ - -### type - -• **type**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:81 diff --git a/docs/api/verida-js/interfaces/verida_vda_did._internal_.TransactionResponse.md b/docs/api/verida-js/interfaces/verida_vda_did._internal_.TransactionResponse.md deleted file mode 100644 index 79c5293..0000000 --- a/docs/api/verida-js/interfaces/verida_vda_did._internal_.TransactionResponse.md +++ /dev/null @@ -1,335 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-did](../modules/verida_vda_did.md) / [](../modules/verida_vda_did._internal_.md) / TransactionResponse - -# Interface: TransactionResponse - -[@verida/vda-did](../modules/verida_vda_did.md).[](../modules/verida_vda_did._internal_.md).TransactionResponse - -## Hierarchy - -- [`Transaction`](verida_vda_did._internal_.Transaction.md) - - ↳ **`TransactionResponse`** - -## Table of contents - -### Properties - -- [accessList](verida_vda_did._internal_.TransactionResponse.md#accesslist) -- [blockHash](verida_vda_did._internal_.TransactionResponse.md#blockhash) -- [blockNumber](verida_vda_did._internal_.TransactionResponse.md#blocknumber) -- [chainId](verida_vda_did._internal_.TransactionResponse.md#chainid) -- [confirmations](verida_vda_did._internal_.TransactionResponse.md#confirmations) -- [data](verida_vda_did._internal_.TransactionResponse.md#data) -- [from](verida_vda_did._internal_.TransactionResponse.md#from) -- [gasLimit](verida_vda_did._internal_.TransactionResponse.md#gaslimit) -- [gasPrice](verida_vda_did._internal_.TransactionResponse.md#gasprice) -- [hash](verida_vda_did._internal_.TransactionResponse.md#hash) -- [maxFeePerGas](verida_vda_did._internal_.TransactionResponse.md#maxfeepergas) -- [maxPriorityFeePerGas](verida_vda_did._internal_.TransactionResponse.md#maxpriorityfeepergas) -- [nonce](verida_vda_did._internal_.TransactionResponse.md#nonce) -- [r](verida_vda_did._internal_.TransactionResponse.md#r) -- [raw](verida_vda_did._internal_.TransactionResponse.md#raw) -- [s](verida_vda_did._internal_.TransactionResponse.md#s) -- [timestamp](verida_vda_did._internal_.TransactionResponse.md#timestamp) -- [to](verida_vda_did._internal_.TransactionResponse.md#to) -- [type](verida_vda_did._internal_.TransactionResponse.md#type) -- [v](verida_vda_did._internal_.TransactionResponse.md#v) -- [value](verida_vda_did._internal_.TransactionResponse.md#value) - -### Methods - -- [wait](verida_vda_did._internal_.TransactionResponse.md#wait) - -## Properties - -### accessList - -• `Optional` **accessList**: [`AccessList`](../modules/verida_vda_did._internal_.md#accesslist) - -#### Inherited from - -[Transaction](verida_vda_did._internal_.Transaction.md).[accessList](verida_vda_did._internal_.Transaction.md#accesslist) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:40 - -___ - -### blockHash - -• `Optional` **blockHash**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:26 - -___ - -### blockNumber - -• `Optional` **blockNumber**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:25 - -___ - -### chainId - -• **chainId**: `number` - -#### Inherited from - -[Transaction](verida_vda_did._internal_.Transaction.md).[chainId](verida_vda_did._internal_.Transaction.md#chainid) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:35 - -___ - -### confirmations - -• **confirmations**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:28 - -___ - -### data - -• **data**: `string` - -#### Inherited from - -[Transaction](verida_vda_did._internal_.Transaction.md).[data](verida_vda_did._internal_.Transaction.md#data) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:33 - -___ - -### from - -• **from**: `string` - -#### Overrides - -[Transaction](verida_vda_did._internal_.Transaction.md).[from](verida_vda_did._internal_.Transaction.md#from) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:29 - -___ - -### gasLimit - -• **gasLimit**: [`BigNumber`](../classes/verida_vda_did._internal_.BigNumber.md) - -#### Inherited from - -[Transaction](verida_vda_did._internal_.Transaction.md).[gasLimit](verida_vda_did._internal_.Transaction.md#gaslimit) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:31 - -___ - -### gasPrice - -• `Optional` **gasPrice**: [`BigNumber`](../classes/verida_vda_did._internal_.BigNumber.md) - -#### Inherited from - -[Transaction](verida_vda_did._internal_.Transaction.md).[gasPrice](verida_vda_did._internal_.Transaction.md#gasprice) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:32 - -___ - -### hash - -• **hash**: `string` - -#### Overrides - -[Transaction](verida_vda_did._internal_.Transaction.md).[hash](verida_vda_did._internal_.Transaction.md#hash) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:24 - -___ - -### maxFeePerGas - -• `Optional` **maxFeePerGas**: [`BigNumber`](../classes/verida_vda_did._internal_.BigNumber.md) - -#### Inherited from - -[Transaction](verida_vda_did._internal_.Transaction.md).[maxFeePerGas](verida_vda_did._internal_.Transaction.md#maxfeepergas) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:42 - -___ - -### maxPriorityFeePerGas - -• `Optional` **maxPriorityFeePerGas**: [`BigNumber`](../classes/verida_vda_did._internal_.BigNumber.md) - -#### Inherited from - -[Transaction](verida_vda_did._internal_.Transaction.md).[maxPriorityFeePerGas](verida_vda_did._internal_.Transaction.md#maxpriorityfeepergas) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:41 - -___ - -### nonce - -• **nonce**: `number` - -#### Inherited from - -[Transaction](verida_vda_did._internal_.Transaction.md).[nonce](verida_vda_did._internal_.Transaction.md#nonce) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:30 - -___ - -### r - -• `Optional` **r**: `string` - -#### Inherited from - -[Transaction](verida_vda_did._internal_.Transaction.md).[r](verida_vda_did._internal_.Transaction.md#r) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:36 - -___ - -### raw - -• `Optional` **raw**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:30 - -___ - -### s - -• `Optional` **s**: `string` - -#### Inherited from - -[Transaction](verida_vda_did._internal_.Transaction.md).[s](verida_vda_did._internal_.Transaction.md#s) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:37 - -___ - -### timestamp - -• `Optional` **timestamp**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:27 - -___ - -### to - -• `Optional` **to**: `string` - -#### Inherited from - -[Transaction](verida_vda_did._internal_.Transaction.md).[to](verida_vda_did._internal_.Transaction.md#to) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:28 - -___ - -### type - -• `Optional` **type**: ``null`` \| `number` - -#### Inherited from - -[Transaction](verida_vda_did._internal_.Transaction.md).[type](verida_vda_did._internal_.Transaction.md#type) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:39 - -___ - -### v - -• `Optional` **v**: `number` - -#### Inherited from - -[Transaction](verida_vda_did._internal_.Transaction.md).[v](verida_vda_did._internal_.Transaction.md#v) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:38 - -___ - -### value - -• **value**: [`BigNumber`](../classes/verida_vda_did._internal_.BigNumber.md) - -#### Inherited from - -[Transaction](verida_vda_did._internal_.Transaction.md).[value](verida_vda_did._internal_.Transaction.md#value) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:34 - -## Methods - -### wait - -▸ **wait**(`confirmations?`): `Promise`<[`TransactionReceipt`](verida_vda_did._internal_.TransactionReceipt.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `confirmations?` | `number` | - -#### Returns - -`Promise`<[`TransactionReceipt`](verida_vda_did._internal_.TransactionReceipt.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:31 diff --git a/docs/api/verida-js/interfaces/verida_vda_did._internal_.VdaDidConfigurationOptions.md b/docs/api/verida-js/interfaces/verida_vda_did._internal_.VdaDidConfigurationOptions.md deleted file mode 100644 index 4a73927..0000000 --- a/docs/api/verida-js/interfaces/verida_vda_did._internal_.VdaDidConfigurationOptions.md +++ /dev/null @@ -1,105 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-did](../modules/verida_vda_did.md) / [](../modules/verida_vda_did._internal_.md) / VdaDidConfigurationOptions - -# Interface: VdaDidConfigurationOptions - -[@verida/vda-did](../modules/verida_vda_did.md).[](../modules/verida_vda_did._internal_.md).VdaDidConfigurationOptions - -Interface for VDA-DID instance creation. - -`signKey` or `signer` must be provided - -**`param`** DID - -**`param`** private key of DID's controller. Used to generate signature in transactions to chains - -**`param`** Signing function that accepts a private key and returns a signature in hex format - -**`param`** Target chain name or chain id. - -**`param`** : VDA-DID run mode. Values from vda-did-resolver - -**`param`** Web3 configuration depending on call type. Values from vda-did-resolver - -## Table of contents - -### Properties - -- [callType](verida_vda_did._internal_.VdaDidConfigurationOptions.md#calltype) -- [chainNameOrId](verida_vda_did._internal_.VdaDidConfigurationOptions.md#chainnameorid) -- [identifier](verida_vda_did._internal_.VdaDidConfigurationOptions.md#identifier) -- [signKey](verida_vda_did._internal_.VdaDidConfigurationOptions.md#signkey) -- [web3Options](verida_vda_did._internal_.VdaDidConfigurationOptions.md#web3options) - -### Methods - -- [signer](verida_vda_did._internal_.VdaDidConfigurationOptions.md#signer) - -## Properties - -### callType - -• **callType**: [`Web3CallType`](../modules/verida_vda_did._internal_.md#web3calltype) - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:106 - -___ - -### chainNameOrId - -• `Optional` **chainNameOrId**: `string` \| `number` - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:105 - -___ - -### identifier - -• **identifier**: `string` - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:102 - -___ - -### signKey - -• `Optional` **signKey**: `string` - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:103 - -___ - -### web3Options - -• **web3Options**: [`VeridaWeb3ConfigurationOptions`](../modules/verida_vda_did._internal_.md#veridaweb3configurationoptions) - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:107 - -## Methods - -### signer - -▸ `Optional` **signer**(`data`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `any` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:104 diff --git a/docs/api/verida-js/interfaces/verida_vda_did._internal_.VdaDidEndpointResponse.md b/docs/api/verida-js/interfaces/verida_vda_did._internal_.VdaDidEndpointResponse.md deleted file mode 100644 index 9aeb9b6..0000000 --- a/docs/api/verida-js/interfaces/verida_vda_did._internal_.VdaDidEndpointResponse.md +++ /dev/null @@ -1,32 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-did](../modules/verida_vda_did.md) / [](../modules/verida_vda_did._internal_.md) / VdaDidEndpointResponse - -# Interface: VdaDidEndpointResponse - -[@verida/vda-did](../modules/verida_vda_did.md).[](../modules/verida_vda_did._internal_.md).VdaDidEndpointResponse - -## Table of contents - -### Properties - -- [message](verida_vda_did._internal_.VdaDidEndpointResponse.md#message) -- [status](verida_vda_did._internal_.VdaDidEndpointResponse.md#status) - -## Properties - -### message - -• `Optional` **message**: `string` - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:111 - -___ - -### status - -• **status**: ``"success"`` \| ``"fail"`` - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:110 diff --git a/docs/api/verida-js/interfaces/verida_vda_did._internal_.VdaTransactionResult.md b/docs/api/verida-js/interfaces/verida_vda_did._internal_.VdaTransactionResult.md deleted file mode 100644 index c0c5241..0000000 --- a/docs/api/verida-js/interfaces/verida_vda_did._internal_.VdaTransactionResult.md +++ /dev/null @@ -1,43 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-did](../modules/verida_vda_did.md) / [](../modules/verida_vda_did._internal_.md) / VdaTransactionResult - -# Interface: VdaTransactionResult - -[@verida/vda-did](../modules/verida_vda_did.md).[](../modules/verida_vda_did._internal_.md).VdaTransactionResult - -## Table of contents - -### Properties - -- [data](verida_vda_did._internal_.VdaTransactionResult.md#data) -- [error](verida_vda_did._internal_.VdaTransactionResult.md#error) -- [success](verida_vda_did._internal_.VdaTransactionResult.md#success) - -## Properties - -### data - -• `Optional` **data**: `any` - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:124 - -___ - -### error - -• `Optional` **error**: `string` - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:125 - -___ - -### success - -• **success**: `boolean` - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:123 diff --git a/docs/api/verida-js/interfaces/verida_vda_did._internal_.VeridaDocInterface.md b/docs/api/verida-js/interfaces/verida_vda_did._internal_.VeridaDocInterface.md deleted file mode 100644 index 2d48f4d..0000000 --- a/docs/api/verida-js/interfaces/verida_vda_did._internal_.VeridaDocInterface.md +++ /dev/null @@ -1,233 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-did](../modules/verida_vda_did.md) / [](../modules/verida_vda_did._internal_.md) / VeridaDocInterface - -# Interface: VeridaDocInterface - -[@verida/vda-did](../modules/verida_vda_did.md).[](../modules/verida_vda_did._internal_.md).VeridaDocInterface - -## Hierarchy - -- [`DIDDocument`](../modules/verida_vda_did._internal_.md#diddocument) - - ↳ **`VeridaDocInterface`** - -## Table of contents - -### Properties - -- [@context](verida_vda_did._internal_.VeridaDocInterface.md#@context) -- [alsoKnownAs](verida_vda_did._internal_.VeridaDocInterface.md#alsoknownas) -- [assertionMethod](verida_vda_did._internal_.VeridaDocInterface.md#assertionmethod) -- [authentication](verida_vda_did._internal_.VeridaDocInterface.md#authentication) -- [capabilityDelegation](verida_vda_did._internal_.VeridaDocInterface.md#capabilitydelegation) -- [capabilityInvocation](verida_vda_did._internal_.VeridaDocInterface.md#capabilityinvocation) -- [controller](verida_vda_did._internal_.VeridaDocInterface.md#controller) -- [created](verida_vda_did._internal_.VeridaDocInterface.md#created) -- [deactivated](verida_vda_did._internal_.VeridaDocInterface.md#deactivated) -- [id](verida_vda_did._internal_.VeridaDocInterface.md#id) -- [keyAgreement](verida_vda_did._internal_.VeridaDocInterface.md#keyagreement) -- [proof](verida_vda_did._internal_.VeridaDocInterface.md#proof) -- [publicKey](verida_vda_did._internal_.VeridaDocInterface.md#publickey) -- [service](verida_vda_did._internal_.VeridaDocInterface.md#service) -- [updated](verida_vda_did._internal_.VeridaDocInterface.md#updated) -- [verificationMethod](verida_vda_did._internal_.VeridaDocInterface.md#verificationmethod) -- [versionId](verida_vda_did._internal_.VeridaDocInterface.md#versionid) - -## Properties - -### @context - -• `Optional` **@context**: `string` \| `string`[] - -#### Inherited from - -DocInterface.@context - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:61 - -___ - -### alsoKnownAs - -• `Optional` **alsoKnownAs**: `string`[] - -#### Inherited from - -DocInterface.alsoKnownAs - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:63 - -___ - -### assertionMethod - -• **assertionMethod**: `undefined` \| (`string` \| [`VerificationMethod`](verida_vda_did._internal_.VerificationMethod.md))[] - -#### Inherited from - -DocInterface.assertionMethod - -___ - -### authentication - -• **authentication**: `undefined` \| (`string` \| [`VerificationMethod`](verida_vda_did._internal_.VerificationMethod.md))[] - -#### Inherited from - -DocInterface.authentication - -___ - -### capabilityDelegation - -• **capabilityDelegation**: `undefined` \| (`string` \| [`VerificationMethod`](verida_vda_did._internal_.VerificationMethod.md))[] - -#### Inherited from - -DocInterface.capabilityDelegation - -___ - -### capabilityInvocation - -• **capabilityInvocation**: `undefined` \| (`string` \| [`VerificationMethod`](verida_vda_did._internal_.VerificationMethod.md))[] - -#### Inherited from - -DocInterface.capabilityInvocation - -___ - -### controller - -• `Optional` **controller**: `string` \| `string`[] - -#### Inherited from - -DocInterface.controller - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:64 - -___ - -### created - -• `Optional` **created**: `string` - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:39 - -___ - -### deactivated - -• `Optional` **deactivated**: `string` - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:41 - -___ - -### id - -• **id**: `string` - -#### Inherited from - -DocInterface.id - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:62 - -___ - -### keyAgreement - -• **keyAgreement**: `undefined` \| (`string` \| [`VerificationMethod`](verida_vda_did._internal_.VerificationMethod.md))[] - -#### Inherited from - -DocInterface.keyAgreement - -___ - -### proof - -• `Optional` **proof**: [`ProofInterface`](verida_vda_did._internal_.ProofInterface.md) - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:42 - -___ - -### publicKey - -• `Optional` **publicKey**: [`VerificationMethod`](verida_vda_did._internal_.VerificationMethod.md)[] - -**`deprecated`** - -#### Inherited from - -DocInterface.publicKey - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:70 - -___ - -### service - -• `Optional` **service**: [`Service`](verida_vda_did._internal_.Service.md)[] - -#### Inherited from - -DocInterface.service - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:66 - -___ - -### updated - -• `Optional` **updated**: `string` - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:40 - -___ - -### verificationMethod - -• `Optional` **verificationMethod**: [`VerificationMethod`](verida_vda_did._internal_.VerificationMethod.md)[] - -#### Inherited from - -DocInterface.verificationMethod - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:65 - -___ - -### versionId - -• **versionId**: `number` - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:38 diff --git a/docs/api/verida-js/interfaces/verida_vda_did._internal_.VerificationMethod.md b/docs/api/verida-js/interfaces/verida_vda_did._internal_.VerificationMethod.md deleted file mode 100644 index 999b8d2..0000000 --- a/docs/api/verida-js/interfaces/verida_vda_did._internal_.VerificationMethod.md +++ /dev/null @@ -1,129 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-did](../modules/verida_vda_did.md) / [](../modules/verida_vda_did._internal_.md) / VerificationMethod - -# Interface: VerificationMethod - -[@verida/vda-did](../modules/verida_vda_did.md).[](../modules/verida_vda_did._internal_.md).VerificationMethod - -Represents the properties of a Verification Method listed in a DID document. - -This data type includes public key representations that are no longer present in the spec but are still used by -several DID methods / resolvers and kept for backward compatibility. - -**`see`** [https://www.w3.org/TR/did-core/#verification-methods](https://www.w3.org/TR/did-core/#verification-methods) - -**`see`** [https://www.w3.org/TR/did-core/#verification-method-properties](https://www.w3.org/TR/did-core/#verification-method-properties) - -## Table of contents - -### Properties - -- [blockchainAccountId](verida_vda_did._internal_.VerificationMethod.md#blockchainaccountid) -- [controller](verida_vda_did._internal_.VerificationMethod.md#controller) -- [ethereumAddress](verida_vda_did._internal_.VerificationMethod.md#ethereumaddress) -- [id](verida_vda_did._internal_.VerificationMethod.md#id) -- [publicKeyBase58](verida_vda_did._internal_.VerificationMethod.md#publickeybase58) -- [publicKeyBase64](verida_vda_did._internal_.VerificationMethod.md#publickeybase64) -- [publicKeyHex](verida_vda_did._internal_.VerificationMethod.md#publickeyhex) -- [publicKeyJwk](verida_vda_did._internal_.VerificationMethod.md#publickeyjwk) -- [publicKeyMultibase](verida_vda_did._internal_.VerificationMethod.md#publickeymultibase) -- [type](verida_vda_did._internal_.VerificationMethod.md#type) - -## Properties - -### blockchainAccountId - -• `Optional` **blockchainAccountId**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:133 - -___ - -### controller - -• **controller**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:127 - -___ - -### ethereumAddress - -• `Optional` **ethereumAddress**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:134 - -___ - -### id - -• **id**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:125 - -___ - -### publicKeyBase58 - -• `Optional` **publicKeyBase58**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:128 - -___ - -### publicKeyBase64 - -• `Optional` **publicKeyBase64**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:129 - -___ - -### publicKeyHex - -• `Optional` **publicKeyHex**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:131 - -___ - -### publicKeyJwk - -• `Optional` **publicKeyJwk**: [`JsonWebKey`](verida_vda_did._internal_.JsonWebKey.md) - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:130 - -___ - -### publicKeyMultibase - -• `Optional` **publicKeyMultibase**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:132 - -___ - -### type - -• **type**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:126 diff --git a/docs/api/verida-js/interfaces/verida_vda_did._internal_.Web3ContractInfo.md b/docs/api/verida-js/interfaces/verida_vda_did._internal_.Web3ContractInfo.md deleted file mode 100644 index 7ed8cfc..0000000 --- a/docs/api/verida-js/interfaces/verida_vda_did._internal_.Web3ContractInfo.md +++ /dev/null @@ -1,45 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-did](../modules/verida_vda_did.md) / [](../modules/verida_vda_did._internal_.md) / Web3ContractInfo - -# Interface: Web3ContractInfo - -[@verida/vda-did](../modules/verida_vda_did.md).[](../modules/verida_vda_did._internal_.md).Web3ContractInfo - -Contract Info. Used for 'web3' mode - -## Table of contents - -### Properties - -- [abi](verida_vda_did._internal_.Web3ContractInfo.md#abi) -- [address](verida_vda_did._internal_.Web3ContractInfo.md#address) -- [logPerformance](verida_vda_did._internal_.Web3ContractInfo.md#logperformance) - -## Properties - -### abi - -• **abi**: `any` - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:8 - -___ - -### address - -• **address**: `string` - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:9 - -___ - -### logPerformance - -• `Optional` **logPerformance**: `boolean` - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:10 diff --git a/docs/api/verida-js/interfaces/verida_vda_did._internal_.Web3GasConfiguration.md b/docs/api/verida-js/interfaces/verida_vda_did._internal_.Web3GasConfiguration.md deleted file mode 100644 index b9c6999..0000000 --- a/docs/api/verida-js/interfaces/verida_vda_did._internal_.Web3GasConfiguration.md +++ /dev/null @@ -1,91 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-did](../modules/verida_vda_did.md) / [](../modules/verida_vda_did._internal_.md) / Web3GasConfiguration - -# Interface: Web3GasConfiguration - -[@verida/vda-did](../modules/verida_vda_did.md).[](../modules/verida_vda_did._internal_.md).Web3GasConfiguration - -Gas configuration - -eip1559Mode - optional - Once this parameter is set, all other parameters are not used. Gas information is pulled from network. - -maxFeePerGas - optional - Used for EIP1559 chains -maxPriorityFeePerGas - optional - Used for EIP1559 chains -gasLimit - optional - Used for non EIP1559 chains -gasPrice - optional - Used for non EIP1559 chains - -## Hierarchy - -- **`Web3GasConfiguration`** - - ↳ [`Web3SelfTransactionConfig`](verida_vda_did._internal_.Web3SelfTransactionConfig.md) - -## Table of contents - -### Properties - -- [eip1559Mode](verida_vda_did._internal_.Web3GasConfiguration.md#eip1559mode) -- [eip1559gasStationUrl](verida_vda_did._internal_.Web3GasConfiguration.md#eip1559gasstationurl) -- [gasLimit](verida_vda_did._internal_.Web3GasConfiguration.md#gaslimit) -- [gasPrice](verida_vda_did._internal_.Web3GasConfiguration.md#gasprice) -- [maxFeePerGas](verida_vda_did._internal_.Web3GasConfiguration.md#maxfeepergas) -- [maxPriorityFeePerGas](verida_vda_did._internal_.Web3GasConfiguration.md#maxpriorityfeepergas) - -## Properties - -### eip1559Mode - -• `Optional` **eip1559Mode**: [`EIP1559GasMode`](../modules/verida_vda_did._internal_.md#eip1559gasmode) - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:24 - -___ - -### eip1559gasStationUrl - -• `Optional` **eip1559gasStationUrl**: `string` - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:25 - -___ - -### gasLimit - -• `Optional` **gasLimit**: [`BigNumber`](../classes/verida_vda_did._internal_.BigNumber.md) - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:28 - -___ - -### gasPrice - -• `Optional` **gasPrice**: [`BigNumber`](../classes/verida_vda_did._internal_.BigNumber.md) - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:29 - -___ - -### maxFeePerGas - -• `Optional` **maxFeePerGas**: [`BigNumber`](../classes/verida_vda_did._internal_.BigNumber.md) - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:26 - -___ - -### maxPriorityFeePerGas - -• `Optional` **maxPriorityFeePerGas**: [`BigNumber`](../classes/verida_vda_did._internal_.BigNumber.md) - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:27 diff --git a/docs/api/verida-js/interfaces/verida_vda_did._internal_.Web3GaslessPostConfig.md b/docs/api/verida-js/interfaces/verida_vda_did._internal_.Web3GaslessPostConfig.md deleted file mode 100644 index 41f9d30..0000000 --- a/docs/api/verida-js/interfaces/verida_vda_did._internal_.Web3GaslessPostConfig.md +++ /dev/null @@ -1,37 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-did](../modules/verida_vda_did.md) / [](../modules/verida_vda_did._internal_.md) / Web3GaslessPostConfig - -# Interface: Web3GaslessPostConfig - -[@verida/vda-did](../modules/verida_vda_did.md).[](../modules/verida_vda_did._internal_.md).Web3GaslessPostConfig - -Configuration type for gasless post - -## Indexable - -▪ [key: `string`]: `any` - -## Table of contents - -### Properties - -- [headers](verida_vda_did._internal_.Web3GaslessPostConfig.md#headers) - -## Properties - -### headers - -• **headers**: `Object` - -#### Index signature - -▪ [key: `string`]: `any` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `user-agent` | `string` | - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:64 diff --git a/docs/api/verida-js/interfaces/verida_vda_did._internal_.Web3GaslessRequestConfig.md b/docs/api/verida-js/interfaces/verida_vda_did._internal_.Web3GaslessRequestConfig.md deleted file mode 100644 index 243622b..0000000 --- a/docs/api/verida-js/interfaces/verida_vda_did._internal_.Web3GaslessRequestConfig.md +++ /dev/null @@ -1,37 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-did](../modules/verida_vda_did.md) / [](../modules/verida_vda_did._internal_.md) / Web3GaslessRequestConfig - -# Interface: Web3GaslessRequestConfig - -[@verida/vda-did](../modules/verida_vda_did.md).[](../modules/verida_vda_did._internal_.md).Web3GaslessRequestConfig - -Configuration type for gasless request - -## Indexable - -▪ [key: `string`]: `any` - -## Table of contents - -### Properties - -- [headers](verida_vda_did._internal_.Web3GaslessRequestConfig.md#headers) - -## Properties - -### headers - -• **headers**: `Object` - -#### Index signature - -▪ [key: `string`]: `any` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `context-name` | `string` | - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:56 diff --git a/docs/api/verida-js/interfaces/verida_vda_did._internal_.Web3MetaTransactionConfig.md b/docs/api/verida-js/interfaces/verida_vda_did._internal_.Web3MetaTransactionConfig.md deleted file mode 100644 index 98189a3..0000000 --- a/docs/api/verida-js/interfaces/verida_vda_did._internal_.Web3MetaTransactionConfig.md +++ /dev/null @@ -1,45 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-did](../modules/verida_vda_did.md) / [](../modules/verida_vda_did._internal_.md) / Web3MetaTransactionConfig - -# Interface: Web3MetaTransactionConfig - -[@verida/vda-did](../modules/verida_vda_did.md).[](../modules/verida_vda_did._internal_.md).Web3MetaTransactionConfig - -Configuration type for gasless mode - -## Table of contents - -### Properties - -- [endpointUrl](verida_vda_did._internal_.Web3MetaTransactionConfig.md#endpointurl) -- [postConfig](verida_vda_did._internal_.Web3MetaTransactionConfig.md#postconfig) -- [serverConfig](verida_vda_did._internal_.Web3MetaTransactionConfig.md#serverconfig) - -## Properties - -### endpointUrl - -• **endpointUrl**: `string` - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:51 - -___ - -### postConfig - -• **postConfig**: [`Web3GaslessPostConfig`](verida_vda_did._internal_.Web3GaslessPostConfig.md) - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:50 - -___ - -### serverConfig - -• **serverConfig**: [`Web3GaslessRequestConfig`](verida_vda_did._internal_.Web3GaslessRequestConfig.md) - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:49 diff --git a/docs/api/verida-js/interfaces/verida_vda_did._internal_.Web3SelfTransactionConfig.md b/docs/api/verida-js/interfaces/verida_vda_did._internal_.Web3SelfTransactionConfig.md deleted file mode 100644 index 3edcb0d..0000000 --- a/docs/api/verida-js/interfaces/verida_vda_did._internal_.Web3SelfTransactionConfig.md +++ /dev/null @@ -1,179 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-did](../modules/verida_vda_did.md) / [](../modules/verida_vda_did._internal_.md) / Web3SelfTransactionConfig - -# Interface: Web3SelfTransactionConfig - -[@verida/vda-did](../modules/verida_vda_did.md).[](../modules/verida_vda_did._internal_.md).Web3SelfTransactionConfig - -Configuration type for Web3 mode - -signer - optional - a Signer that sign the blockchain transactions. If a 'signer' is not provided, then 'contract' with an attached signer need to be used to make transactions -provider - optional - a web3 provider. At least one of `signer`,`provider`, or `rpcUrl` is required -rpcUrl - optinal - a JSON-RPC URL that can be used to connect to an ethereum network. At least one of `signer`, `provider`, or `rpcUrl` is required -web3 - optional - Can use provider or web.currentProvider as a provider. - -## Hierarchy - -- [`Web3GasConfiguration`](verida_vda_did._internal_.Web3GasConfiguration.md) - - ↳ **`Web3SelfTransactionConfig`** - -## Table of contents - -### Properties - -- [eip1559Mode](verida_vda_did._internal_.Web3SelfTransactionConfig.md#eip1559mode) -- [eip1559gasStationUrl](verida_vda_did._internal_.Web3SelfTransactionConfig.md#eip1559gasstationurl) -- [gasLimit](verida_vda_did._internal_.Web3SelfTransactionConfig.md#gaslimit) -- [gasPrice](verida_vda_did._internal_.Web3SelfTransactionConfig.md#gasprice) -- [maxFeePerGas](verida_vda_did._internal_.Web3SelfTransactionConfig.md#maxfeepergas) -- [maxPriorityFeePerGas](verida_vda_did._internal_.Web3SelfTransactionConfig.md#maxpriorityfeepergas) -- [methodDefaults](verida_vda_did._internal_.Web3SelfTransactionConfig.md#methoddefaults) -- [privateKey](verida_vda_did._internal_.Web3SelfTransactionConfig.md#privatekey) -- [provider](verida_vda_did._internal_.Web3SelfTransactionConfig.md#provider) -- [rpcUrl](verida_vda_did._internal_.Web3SelfTransactionConfig.md#rpcurl) -- [signer](verida_vda_did._internal_.Web3SelfTransactionConfig.md#signer) -- [web3](verida_vda_did._internal_.Web3SelfTransactionConfig.md#web3) - -## Properties - -### eip1559Mode - -• `Optional` **eip1559Mode**: [`EIP1559GasMode`](../modules/verida_vda_did._internal_.md#eip1559gasmode) - -#### Inherited from - -[Web3GasConfiguration](verida_vda_did._internal_.Web3GasConfiguration.md).[eip1559Mode](verida_vda_did._internal_.Web3GasConfiguration.md#eip1559mode) - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:24 - -___ - -### eip1559gasStationUrl - -• `Optional` **eip1559gasStationUrl**: `string` - -#### Inherited from - -[Web3GasConfiguration](verida_vda_did._internal_.Web3GasConfiguration.md).[eip1559gasStationUrl](verida_vda_did._internal_.Web3GasConfiguration.md#eip1559gasstationurl) - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:25 - -___ - -### gasLimit - -• `Optional` **gasLimit**: [`BigNumber`](../classes/verida_vda_did._internal_.BigNumber.md) - -#### Inherited from - -[Web3GasConfiguration](verida_vda_did._internal_.Web3GasConfiguration.md).[gasLimit](verida_vda_did._internal_.Web3GasConfiguration.md#gaslimit) - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:28 - -___ - -### gasPrice - -• `Optional` **gasPrice**: [`BigNumber`](../classes/verida_vda_did._internal_.BigNumber.md) - -#### Inherited from - -[Web3GasConfiguration](verida_vda_did._internal_.Web3GasConfiguration.md).[gasPrice](verida_vda_did._internal_.Web3GasConfiguration.md#gasprice) - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:29 - -___ - -### maxFeePerGas - -• `Optional` **maxFeePerGas**: [`BigNumber`](../classes/verida_vda_did._internal_.BigNumber.md) - -#### Inherited from - -[Web3GasConfiguration](verida_vda_did._internal_.Web3GasConfiguration.md).[maxFeePerGas](verida_vda_did._internal_.Web3GasConfiguration.md#maxfeepergas) - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:26 - -___ - -### maxPriorityFeePerGas - -• `Optional` **maxPriorityFeePerGas**: [`BigNumber`](../classes/verida_vda_did._internal_.BigNumber.md) - -#### Inherited from - -[Web3GasConfiguration](verida_vda_did._internal_.Web3GasConfiguration.md).[maxPriorityFeePerGas](verida_vda_did._internal_.Web3GasConfiguration.md#maxpriorityfeepergas) - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:27 - -___ - -### methodDefaults - -• `Optional` **methodDefaults**: [`Record`](../modules/verida_vda_did._internal_.md#record)<`string`, [`Web3GasConfiguration`](verida_vda_did._internal_.Web3GasConfiguration.md)\> - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:45 - -___ - -### privateKey - -• `Optional` **privateKey**: `string` - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:41 - -___ - -### provider - -• `Optional` **provider**: [`Provider`](../classes/verida_vda_did._internal_.Provider.md) - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:42 - -___ - -### rpcUrl - -• `Optional` **rpcUrl**: `string` - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:43 - -___ - -### signer - -• `Optional` **signer**: [`Signer`](../classes/verida_vda_did._internal_.Signer.md) - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:40 - -___ - -### web3 - -• `Optional` **web3**: `any` - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:44 diff --git a/docs/api/verida-js/interfaces/verida_vda_did._internal_._Block.md b/docs/api/verida-js/interfaces/verida_vda_did._internal_._Block.md deleted file mode 100644 index c839307..0000000 --- a/docs/api/verida-js/interfaces/verida_vda_did._internal_._Block.md +++ /dev/null @@ -1,150 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-did](../modules/verida_vda_did.md) / [](../modules/verida_vda_did._internal_.md) / \_Block - -# Interface: \_Block - -[@verida/vda-did](../modules/verida_vda_did.md).[](../modules/verida_vda_did._internal_.md)._Block - -## Hierarchy - -- **`_Block`** - - ↳ [`Block`](verida_vda_did._internal_.Block.md) - - ↳ [`BlockWithTransactions`](verida_vda_did._internal_.BlockWithTransactions.md) - -## Table of contents - -### Properties - -- [\_difficulty](verida_vda_did._internal_._Block.md#_difficulty) -- [baseFeePerGas](verida_vda_did._internal_._Block.md#basefeepergas) -- [difficulty](verida_vda_did._internal_._Block.md#difficulty) -- [extraData](verida_vda_did._internal_._Block.md#extradata) -- [gasLimit](verida_vda_did._internal_._Block.md#gaslimit) -- [gasUsed](verida_vda_did._internal_._Block.md#gasused) -- [hash](verida_vda_did._internal_._Block.md#hash) -- [miner](verida_vda_did._internal_._Block.md#miner) -- [nonce](verida_vda_did._internal_._Block.md#nonce) -- [number](verida_vda_did._internal_._Block.md#number) -- [parentHash](verida_vda_did._internal_._Block.md#parenthash) -- [timestamp](verida_vda_did._internal_._Block.md#timestamp) - -## Properties - -### \_difficulty - -• **\_difficulty**: [`BigNumber`](../classes/verida_vda_did._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:41 - -___ - -### baseFeePerGas - -• `Optional` **baseFeePerGas**: ``null`` \| [`BigNumber`](../classes/verida_vda_did._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:46 - -___ - -### difficulty - -• **difficulty**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:40 - -___ - -### extraData - -• **extraData**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:45 - -___ - -### gasLimit - -• **gasLimit**: [`BigNumber`](../classes/verida_vda_did._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:42 - -___ - -### gasUsed - -• **gasUsed**: [`BigNumber`](../classes/verida_vda_did._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:43 - -___ - -### hash - -• **hash**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:35 - -___ - -### miner - -• **miner**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:44 - -___ - -### nonce - -• **nonce**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:39 - -___ - -### number - -• **number**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:37 - -___ - -### parentHash - -• **parentHash**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:36 - -___ - -### timestamp - -• **timestamp**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:38 diff --git a/docs/api/verida-js/interfaces/verida_vda_did_resolver._internal_.DIDDocumentMetadata.md b/docs/api/verida-js/interfaces/verida_vda_did_resolver._internal_.DIDDocumentMetadata.md deleted file mode 100644 index 64a4e61..0000000 --- a/docs/api/verida-js/interfaces/verida_vda_did_resolver._internal_.DIDDocumentMetadata.md +++ /dev/null @@ -1,108 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-did-resolver](../modules/verida_vda_did_resolver.md) / [](../modules/verida_vda_did_resolver._internal_.md) / DIDDocumentMetadata - -# Interface: DIDDocumentMetadata - -[@verida/vda-did-resolver](../modules/verida_vda_did_resolver.md).[](../modules/verida_vda_did_resolver._internal_.md).DIDDocumentMetadata - -Represents metadata about the DID document resulting from a [Resolvable.resolve](verida_vda_did_resolver._internal_.Resolvable.md#resolve) operation. - -**`see`** [https://www.w3.org/TR/did-core/#did-document-metadata](https://www.w3.org/TR/did-core/#did-document-metadata) - -## Hierarchy - -- [`Extensible`](../modules/verida_vda_did_resolver._internal_.md#extensible) - - ↳ **`DIDDocumentMetadata`** - -## Table of contents - -### Properties - -- [canonicalId](verida_vda_did_resolver._internal_.DIDDocumentMetadata.md#canonicalid) -- [created](verida_vda_did_resolver._internal_.DIDDocumentMetadata.md#created) -- [deactivated](verida_vda_did_resolver._internal_.DIDDocumentMetadata.md#deactivated) -- [equivalentId](verida_vda_did_resolver._internal_.DIDDocumentMetadata.md#equivalentid) -- [nextUpdate](verida_vda_did_resolver._internal_.DIDDocumentMetadata.md#nextupdate) -- [nextVersionId](verida_vda_did_resolver._internal_.DIDDocumentMetadata.md#nextversionid) -- [updated](verida_vda_did_resolver._internal_.DIDDocumentMetadata.md#updated) -- [versionId](verida_vda_did_resolver._internal_.DIDDocumentMetadata.md#versionid) - -## Properties - -### canonicalId - -• `Optional` **canonicalId**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:47 - -___ - -### created - -• `Optional` **created**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:40 - -___ - -### deactivated - -• `Optional` **deactivated**: `boolean` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:42 - -___ - -### equivalentId - -• `Optional` **equivalentId**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:46 - -___ - -### nextUpdate - -• `Optional` **nextUpdate**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:44 - -___ - -### nextVersionId - -• `Optional` **nextVersionId**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:45 - -___ - -### updated - -• `Optional` **updated**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:41 - -___ - -### versionId - -• `Optional` **versionId**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:43 diff --git a/docs/api/verida-js/interfaces/verida_vda_did_resolver._internal_.DIDResolutionMetadata.md b/docs/api/verida-js/interfaces/verida_vda_did_resolver._internal_.DIDResolutionMetadata.md deleted file mode 100644 index c78adb6..0000000 --- a/docs/api/verida-js/interfaces/verida_vda_did_resolver._internal_.DIDResolutionMetadata.md +++ /dev/null @@ -1,42 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-did-resolver](../modules/verida_vda_did_resolver.md) / [](../modules/verida_vda_did_resolver._internal_.md) / DIDResolutionMetadata - -# Interface: DIDResolutionMetadata - -[@verida/vda-did-resolver](../modules/verida_vda_did_resolver.md).[](../modules/verida_vda_did_resolver._internal_.md).DIDResolutionMetadata - -Encapsulates the resolution metadata resulting from a [Resolvable.resolve](verida_vda_did_resolver._internal_.Resolvable.md#resolve) operation. - -**`see`** [https://www.w3.org/TR/did-core/#did-resolution-metadata](https://www.w3.org/TR/did-core/#did-resolution-metadata) - -## Hierarchy - -- [`Extensible`](../modules/verida_vda_did_resolver._internal_.md#extensible) - - ↳ **`DIDResolutionMetadata`** - -## Table of contents - -### Properties - -- [contentType](verida_vda_did_resolver._internal_.DIDResolutionMetadata.md#contenttype) -- [error](verida_vda_did_resolver._internal_.DIDResolutionMetadata.md#error) - -## Properties - -### contentType - -• `Optional` **contentType**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:31 - -___ - -### error - -• `Optional` **error**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:32 diff --git a/docs/api/verida-js/interfaces/verida_vda_did_resolver._internal_.DIDResolutionOptions.md b/docs/api/verida-js/interfaces/verida_vda_did_resolver._internal_.DIDResolutionOptions.md deleted file mode 100644 index e5a2dd1..0000000 --- a/docs/api/verida-js/interfaces/verida_vda_did_resolver._internal_.DIDResolutionOptions.md +++ /dev/null @@ -1,31 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-did-resolver](../modules/verida_vda_did_resolver.md) / [](../modules/verida_vda_did_resolver._internal_.md) / DIDResolutionOptions - -# Interface: DIDResolutionOptions - -[@verida/vda-did-resolver](../modules/verida_vda_did_resolver.md).[](../modules/verida_vda_did_resolver._internal_.md).DIDResolutionOptions - -Describes the options forwarded to the resolver when executing a [Resolvable.resolve](verida_vda_did_resolver._internal_.Resolvable.md#resolve) operation. - -**`see`** [https://www.w3.org/TR/did-core/#did-resolution-options](https://www.w3.org/TR/did-core/#did-resolution-options) - -## Hierarchy - -- [`Extensible`](../modules/verida_vda_did_resolver._internal_.md#extensible) - - ↳ **`DIDResolutionOptions`** - -## Table of contents - -### Properties - -- [accept](verida_vda_did_resolver._internal_.DIDResolutionOptions.md#accept) - -## Properties - -### accept - -• `Optional` **accept**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:23 diff --git a/docs/api/verida-js/interfaces/verida_vda_did_resolver._internal_.DIDResolutionResult.md b/docs/api/verida-js/interfaces/verida_vda_did_resolver._internal_.DIDResolutionResult.md deleted file mode 100644 index f09c5e5..0000000 --- a/docs/api/verida-js/interfaces/verida_vda_did_resolver._internal_.DIDResolutionResult.md +++ /dev/null @@ -1,60 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-did-resolver](../modules/verida_vda_did_resolver.md) / [](../modules/verida_vda_did_resolver._internal_.md) / DIDResolutionResult - -# Interface: DIDResolutionResult - -[@verida/vda-did-resolver](../modules/verida_vda_did_resolver.md).[](../modules/verida_vda_did_resolver._internal_.md).DIDResolutionResult - -Defines the result of a DID resolution operation. - -**`see`** [Resolvable.resolve](verida_vda_did_resolver._internal_.Resolvable.md#resolve) - -**`see`** [https://www.w3.org/TR/did-core/#did-resolution](https://www.w3.org/TR/did-core/#did-resolution) - -## Table of contents - -### Properties - -- [@context](verida_vda_did_resolver._internal_.DIDResolutionResult.md#@context) -- [didDocument](verida_vda_did_resolver._internal_.DIDResolutionResult.md#diddocument) -- [didDocumentMetadata](verida_vda_did_resolver._internal_.DIDResolutionResult.md#diddocumentmetadata) -- [didResolutionMetadata](verida_vda_did_resolver._internal_.DIDResolutionResult.md#didresolutionmetadata) - -## Properties - -### @context - -• `Optional` **@context**: `string` \| `string`[] - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:12 - -___ - -### didDocument - -• **didDocument**: ``null`` \| [`DIDDocument`](../modules/verida_vda_did_resolver._internal_.md#diddocument) - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:14 - -___ - -### didDocumentMetadata - -• **didDocumentMetadata**: [`DIDDocumentMetadata`](verida_vda_did_resolver._internal_.DIDDocumentMetadata.md) - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:15 - -___ - -### didResolutionMetadata - -• **didResolutionMetadata**: [`DIDResolutionMetadata`](verida_vda_did_resolver._internal_.DIDResolutionMetadata.md) - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:13 diff --git a/docs/api/verida-js/interfaces/verida_vda_did_resolver._internal_.JsonWebKey.md b/docs/api/verida-js/interfaces/verida_vda_did_resolver._internal_.JsonWebKey.md deleted file mode 100644 index 30b7efd..0000000 --- a/docs/api/verida-js/interfaces/verida_vda_did_resolver._internal_.JsonWebKey.md +++ /dev/null @@ -1,145 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-did-resolver](../modules/verida_vda_did_resolver.md) / [](../modules/verida_vda_did_resolver._internal_.md) / JsonWebKey - -# Interface: JsonWebKey - -[@verida/vda-did-resolver](../modules/verida_vda_did_resolver.md).[](../modules/verida_vda_did_resolver._internal_.md).JsonWebKey - -Encapsulates a JSON web key type that includes only the public properties that -can be used in DID documents. - -The private properties are intentionally omitted to discourage the use -(and accidental disclosure) of private keys in DID documents. - -**`see`** [RFC7517 JsonWebKey (JWK)](https://www.rfc-editor.org/rfc/rfc7517) - -## Hierarchy - -- [`Extensible`](../modules/verida_vda_did_resolver._internal_.md#extensible) - - ↳ **`JsonWebKey`** - -## Table of contents - -### Properties - -- [alg](verida_vda_did_resolver._internal_.JsonWebKey.md#alg) -- [crv](verida_vda_did_resolver._internal_.JsonWebKey.md#crv) -- [e](verida_vda_did_resolver._internal_.JsonWebKey.md#e) -- [ext](verida_vda_did_resolver._internal_.JsonWebKey.md#ext) -- [key\_ops](verida_vda_did_resolver._internal_.JsonWebKey.md#key_ops) -- [kid](verida_vda_did_resolver._internal_.JsonWebKey.md#kid) -- [kty](verida_vda_did_resolver._internal_.JsonWebKey.md#kty) -- [n](verida_vda_did_resolver._internal_.JsonWebKey.md#n) -- [use](verida_vda_did_resolver._internal_.JsonWebKey.md#use) -- [x](verida_vda_did_resolver._internal_.JsonWebKey.md#x) -- [y](verida_vda_did_resolver._internal_.JsonWebKey.md#y) - -## Properties - -### alg - -• `Optional` **alg**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:103 - -___ - -### crv - -• `Optional` **crv**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:104 - -___ - -### e - -• `Optional` **e**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:105 - -___ - -### ext - -• `Optional` **ext**: `boolean` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:106 - -___ - -### key\_ops - -• `Optional` **key\_ops**: `string`[] - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:107 - -___ - -### kid - -• `Optional` **kid**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:108 - -___ - -### kty - -• **kty**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:109 - -___ - -### n - -• `Optional` **n**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:110 - -___ - -### use - -• `Optional` **use**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:111 - -___ - -### x - -• `Optional` **x**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:112 - -___ - -### y - -• `Optional` **y**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:113 diff --git a/docs/api/verida-js/interfaces/verida_vda_did_resolver._internal_.Params.md b/docs/api/verida-js/interfaces/verida_vda_did_resolver._internal_.Params.md deleted file mode 100644 index 8f4e960..0000000 --- a/docs/api/verida-js/interfaces/verida_vda_did_resolver._internal_.Params.md +++ /dev/null @@ -1,11 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-did-resolver](../modules/verida_vda_did_resolver.md) / [](../modules/verida_vda_did_resolver._internal_.md) / Params - -# Interface: Params - -[@verida/vda-did-resolver](../modules/verida_vda_did_resolver.md).[](../modules/verida_vda_did_resolver._internal_.md).Params - -URI params resulting from parsing a DID URI - -## Indexable - -▪ [index: `string`]: `string` diff --git a/docs/api/verida-js/interfaces/verida_vda_did_resolver._internal_.ParsedDID.md b/docs/api/verida-js/interfaces/verida_vda_did_resolver._internal_.ParsedDID.md deleted file mode 100644 index 7c6a543..0000000 --- a/docs/api/verida-js/interfaces/verida_vda_did_resolver._internal_.ParsedDID.md +++ /dev/null @@ -1,106 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-did-resolver](../modules/verida_vda_did_resolver.md) / [](../modules/verida_vda_did_resolver._internal_.md) / ParsedDID - -# Interface: ParsedDID - -[@verida/vda-did-resolver](../modules/verida_vda_did_resolver.md).[](../modules/verida_vda_did_resolver._internal_.md).ParsedDID - -An object containing the results of parsing a DID URI string. - -This is forwarded to implementations of particular DID resolvers when calling the `resolve` method. - -**`see`** [Resolver](../classes/verida_did_client._internal_.Resolver.md) - -**`see`** [Resolvable.resolve](verida_vda_did_resolver._internal_.Resolvable.md#resolve) - -## Table of contents - -### Properties - -- [did](verida_vda_did_resolver._internal_.ParsedDID.md#did) -- [didUrl](verida_vda_did_resolver._internal_.ParsedDID.md#didurl) -- [fragment](verida_vda_did_resolver._internal_.ParsedDID.md#fragment) -- [id](verida_vda_did_resolver._internal_.ParsedDID.md#id) -- [method](verida_vda_did_resolver._internal_.ParsedDID.md#method) -- [params](verida_vda_did_resolver._internal_.ParsedDID.md#params) -- [path](verida_vda_did_resolver._internal_.ParsedDID.md#path) -- [query](verida_vda_did_resolver._internal_.ParsedDID.md#query) - -## Properties - -### did - -• **did**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:151 - -___ - -### didUrl - -• **didUrl**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:152 - -___ - -### fragment - -• `Optional` **fragment**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:156 - -___ - -### id - -• **id**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:154 - -___ - -### method - -• **method**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:153 - -___ - -### params - -• `Optional` **params**: [`Params`](verida_vda_did_resolver._internal_.Params.md) - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:158 - -___ - -### path - -• `Optional` **path**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:155 - -___ - -### query - -• `Optional` **query**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:157 diff --git a/docs/api/verida-js/interfaces/verida_vda_did_resolver._internal_.Resolvable.md b/docs/api/verida-js/interfaces/verida_vda_did_resolver._internal_.Resolvable.md deleted file mode 100644 index be10853..0000000 --- a/docs/api/verida-js/interfaces/verida_vda_did_resolver._internal_.Resolvable.md +++ /dev/null @@ -1,34 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-did-resolver](../modules/verida_vda_did_resolver.md) / [](../modules/verida_vda_did_resolver._internal_.md) / Resolvable - -# Interface: Resolvable - -[@verida/vda-did-resolver](../modules/verida_vda_did_resolver.md).[](../modules/verida_vda_did_resolver._internal_.md).Resolvable - -The method signature implemented by this resolver. - -## Table of contents - -### Methods - -- [resolve](verida_vda_did_resolver._internal_.Resolvable.md#resolve) - -## Methods - -### resolve - -▸ **resolve**(`didUrl`, `options?`): `Promise`<[`DIDResolutionResult`](verida_vda_did_resolver._internal_.DIDResolutionResult.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `didUrl` | `string` | -| `options?` | [`DIDResolutionOptions`](verida_vda_did_resolver._internal_.DIDResolutionOptions.md) | - -#### Returns - -`Promise`<[`DIDResolutionResult`](verida_vda_did_resolver._internal_.DIDResolutionResult.md)\> - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:189 diff --git a/docs/api/verida-js/interfaces/verida_vda_did_resolver._internal_.Service.md b/docs/api/verida-js/interfaces/verida_vda_did_resolver._internal_.Service.md deleted file mode 100644 index 8c8299a..0000000 --- a/docs/api/verida-js/interfaces/verida_vda_did_resolver._internal_.Service.md +++ /dev/null @@ -1,53 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-did-resolver](../modules/verida_vda_did_resolver.md) / [](../modules/verida_vda_did_resolver._internal_.md) / Service - -# Interface: Service - -[@verida/vda-did-resolver](../modules/verida_vda_did_resolver.md).[](../modules/verida_vda_did_resolver._internal_.md).Service - -Represents a Service entry in a [DID document](https://www.w3.org/TR/did-core/#did-document-properties). - -**`see`** [https://www.w3.org/TR/did-core/#services](https://www.w3.org/TR/did-core/#services) - -**`see`** [https://www.w3.org/TR/did-core/#service-properties](https://www.w3.org/TR/did-core/#service-properties) - -## Indexable - -▪ [x: `string`]: `any` - -## Table of contents - -### Properties - -- [id](verida_vda_did_resolver._internal_.Service.md#id) -- [serviceEndpoint](verida_vda_did_resolver._internal_.Service.md#serviceendpoint) -- [type](verida_vda_did_resolver._internal_.Service.md#type) - -## Properties - -### id - -• **id**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:81 - -___ - -### serviceEndpoint - -• **serviceEndpoint**: [`ServiceEndpoint`](../modules/verida_vda_did_resolver._internal_.md#serviceendpoint) \| [`ServiceEndpoint`](../modules/verida_vda_did_resolver._internal_.md#serviceendpoint)[] - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:83 - -___ - -### type - -• **type**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:82 diff --git a/docs/api/verida-js/interfaces/verida_vda_did_resolver._internal_.VerificationMethod.md b/docs/api/verida-js/interfaces/verida_vda_did_resolver._internal_.VerificationMethod.md deleted file mode 100644 index b1dd071..0000000 --- a/docs/api/verida-js/interfaces/verida_vda_did_resolver._internal_.VerificationMethod.md +++ /dev/null @@ -1,129 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-did-resolver](../modules/verida_vda_did_resolver.md) / [](../modules/verida_vda_did_resolver._internal_.md) / VerificationMethod - -# Interface: VerificationMethod - -[@verida/vda-did-resolver](../modules/verida_vda_did_resolver.md).[](../modules/verida_vda_did_resolver._internal_.md).VerificationMethod - -Represents the properties of a Verification Method listed in a DID document. - -This data type includes public key representations that are no longer present in the spec but are still used by -several DID methods / resolvers and kept for backward compatibility. - -**`see`** [https://www.w3.org/TR/did-core/#verification-methods](https://www.w3.org/TR/did-core/#verification-methods) - -**`see`** [https://www.w3.org/TR/did-core/#verification-method-properties](https://www.w3.org/TR/did-core/#verification-method-properties) - -## Table of contents - -### Properties - -- [blockchainAccountId](verida_vda_did_resolver._internal_.VerificationMethod.md#blockchainaccountid) -- [controller](verida_vda_did_resolver._internal_.VerificationMethod.md#controller) -- [ethereumAddress](verida_vda_did_resolver._internal_.VerificationMethod.md#ethereumaddress) -- [id](verida_vda_did_resolver._internal_.VerificationMethod.md#id) -- [publicKeyBase58](verida_vda_did_resolver._internal_.VerificationMethod.md#publickeybase58) -- [publicKeyBase64](verida_vda_did_resolver._internal_.VerificationMethod.md#publickeybase64) -- [publicKeyHex](verida_vda_did_resolver._internal_.VerificationMethod.md#publickeyhex) -- [publicKeyJwk](verida_vda_did_resolver._internal_.VerificationMethod.md#publickeyjwk) -- [publicKeyMultibase](verida_vda_did_resolver._internal_.VerificationMethod.md#publickeymultibase) -- [type](verida_vda_did_resolver._internal_.VerificationMethod.md#type) - -## Properties - -### blockchainAccountId - -• `Optional` **blockchainAccountId**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:133 - -___ - -### controller - -• **controller**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:127 - -___ - -### ethereumAddress - -• `Optional` **ethereumAddress**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:134 - -___ - -### id - -• **id**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:125 - -___ - -### publicKeyBase58 - -• `Optional` **publicKeyBase58**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:128 - -___ - -### publicKeyBase64 - -• `Optional` **publicKeyBase64**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:129 - -___ - -### publicKeyHex - -• `Optional` **publicKeyHex**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:131 - -___ - -### publicKeyJwk - -• `Optional` **publicKeyJwk**: [`JsonWebKey`](verida_vda_did_resolver._internal_.JsonWebKey.md) - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:130 - -___ - -### publicKeyMultibase - -• `Optional` **publicKeyMultibase**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:132 - -___ - -### type - -• **type**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:126 diff --git a/docs/api/verida-js/interfaces/verida_vda_did_resolver._internal_.Web3ResolverConfigurationOptions.md b/docs/api/verida-js/interfaces/verida_vda_did_resolver._internal_.Web3ResolverConfigurationOptions.md deleted file mode 100644 index 59d1009..0000000 --- a/docs/api/verida-js/interfaces/verida_vda_did_resolver._internal_.Web3ResolverConfigurationOptions.md +++ /dev/null @@ -1,32 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-did-resolver](../modules/verida_vda_did_resolver.md) / [](../modules/verida_vda_did_resolver._internal_.md) / Web3ResolverConfigurationOptions - -# Interface: Web3ResolverConfigurationOptions - -[@verida/vda-did-resolver](../modules/verida_vda_did_resolver.md).[](../modules/verida_vda_did_resolver._internal_.md).Web3ResolverConfigurationOptions - -## Table of contents - -### Properties - -- [rpcUrl](verida_vda_did_resolver._internal_.Web3ResolverConfigurationOptions.md#rpcurl) -- [timeout](verida_vda_did_resolver._internal_.Web3ResolverConfigurationOptions.md#timeout) - -## Properties - -### rpcUrl - -• `Optional` **rpcUrl**: `string` - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:119 - -___ - -### timeout - -• `Optional` **timeout**: `number` - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:120 diff --git a/docs/api/verida-js/interfaces/verida_vda_name_client.NameClientConfig.md b/docs/api/verida-js/interfaces/verida_vda_name_client.NameClientConfig.md deleted file mode 100644 index b8d39c8..0000000 --- a/docs/api/verida-js/interfaces/verida_vda_name_client.NameClientConfig.md +++ /dev/null @@ -1,77 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-name-client](../modules/verida_vda_name_client.md) / NameClientConfig - -# Interface: NameClientConfig - -[@verida/vda-name-client](../modules/verida_vda_name_client.md).NameClientConfig - -Interface for vda-name-client instance creation. Same as VDA-DID configuration - -**`param`** DID - -**`param`** private key of DID. Used to generate signature in transactions to chains - -**`param`** Target chain name or chain id. - -**`param`** : VDA-DID run mode. Values from vda-did-resolver - -**`param`** Web3 configuration depending on call type. Values from vda-did-resolver - -## Table of contents - -### Properties - -- [callType](verida_vda_name_client.NameClientConfig.md#calltype) -- [did](verida_vda_name_client.NameClientConfig.md#did) -- [network](verida_vda_name_client.NameClientConfig.md#network) -- [signKey](verida_vda_name_client.NameClientConfig.md#signkey) -- [web3Options](verida_vda_name_client.NameClientConfig.md#web3options) - -## Properties - -### callType - -• `Optional` **callType**: [`Web3CallType`](../modules/verida_vda_name_client._internal_.md#web3calltype) - -#### Defined in - -[packages/vda-name-client/src/blockchain/blockchainApi.ts:28](https://github.com/verida/verida-js/blob/032961c/packages/vda-name-client/src/blockchain/blockchainApi.ts#L28) - -___ - -### did - -• `Optional` **did**: `string` - -#### Defined in - -[packages/vda-name-client/src/blockchain/blockchainApi.ts:26](https://github.com/verida/verida-js/blob/032961c/packages/vda-name-client/src/blockchain/blockchainApi.ts#L26) - -___ - -### network - -• **network**: [`EnvironmentType`](../enums/verida_vda_name_client._internal_.EnvironmentType.md) - -#### Defined in - -[packages/vda-name-client/src/blockchain/blockchainApi.ts:25](https://github.com/verida/verida-js/blob/032961c/packages/vda-name-client/src/blockchain/blockchainApi.ts#L25) - -___ - -### signKey - -• `Optional` **signKey**: `string` - -#### Defined in - -[packages/vda-name-client/src/blockchain/blockchainApi.ts:27](https://github.com/verida/verida-js/blob/032961c/packages/vda-name-client/src/blockchain/blockchainApi.ts#L27) - -___ - -### web3Options - -• `Optional` **web3Options**: [`Web3SelfTransactionConfig`](verida_vda_name_client._internal_.Web3SelfTransactionConfig.md) \| [`Web3MetaTransactionConfig`](verida_vda_name_client._internal_.Web3MetaTransactionConfig.md) - -#### Defined in - -[packages/vda-name-client/src/blockchain/blockchainApi.ts:29](https://github.com/verida/verida-js/blob/032961c/packages/vda-name-client/src/blockchain/blockchainApi.ts#L29) diff --git a/docs/api/verida-js/interfaces/verida_vda_name_client._internal_.ArrayLike.md b/docs/api/verida-js/interfaces/verida_vda_name_client._internal_.ArrayLike.md deleted file mode 100644 index e491c98..0000000 --- a/docs/api/verida-js/interfaces/verida_vda_name_client._internal_.ArrayLike.md +++ /dev/null @@ -1,31 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-name-client](../modules/verida_vda_name_client.md) / [](../modules/verida_vda_name_client._internal_.md) / ArrayLike - -# Interface: ArrayLike - -[@verida/vda-name-client](../modules/verida_vda_name_client.md).[](../modules/verida_vda_name_client._internal_.md).ArrayLike - -## Type parameters - -| Name | -| :------ | -| `T` | - -## Indexable - -▪ [n: `number`]: `T` - -## Table of contents - -### Properties - -- [length](verida_vda_name_client._internal_.ArrayLike.md#length) - -## Properties - -### length - -• `Readonly` **length**: `number` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1464 diff --git a/docs/api/verida-js/interfaces/verida_vda_name_client._internal_.Block.md b/docs/api/verida-js/interfaces/verida_vda_name_client._internal_.Block.md deleted file mode 100644 index c2a93a3..0000000 --- a/docs/api/verida-js/interfaces/verida_vda_name_client._internal_.Block.md +++ /dev/null @@ -1,207 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-name-client](../modules/verida_vda_name_client.md) / [](../modules/verida_vda_name_client._internal_.md) / Block - -# Interface: Block - -[@verida/vda-name-client](../modules/verida_vda_name_client.md).[](../modules/verida_vda_name_client._internal_.md).Block - -## Hierarchy - -- [`_Block`](verida_vda_name_client._internal_._Block.md) - - ↳ **`Block`** - -## Table of contents - -### Properties - -- [\_difficulty](verida_vda_name_client._internal_.Block.md#_difficulty) -- [baseFeePerGas](verida_vda_name_client._internal_.Block.md#basefeepergas) -- [difficulty](verida_vda_name_client._internal_.Block.md#difficulty) -- [extraData](verida_vda_name_client._internal_.Block.md#extradata) -- [gasLimit](verida_vda_name_client._internal_.Block.md#gaslimit) -- [gasUsed](verida_vda_name_client._internal_.Block.md#gasused) -- [hash](verida_vda_name_client._internal_.Block.md#hash) -- [miner](verida_vda_name_client._internal_.Block.md#miner) -- [nonce](verida_vda_name_client._internal_.Block.md#nonce) -- [number](verida_vda_name_client._internal_.Block.md#number) -- [parentHash](verida_vda_name_client._internal_.Block.md#parenthash) -- [timestamp](verida_vda_name_client._internal_.Block.md#timestamp) -- [transactions](verida_vda_name_client._internal_.Block.md#transactions) - -## Properties - -### \_difficulty - -• **\_difficulty**: [`BigNumber`](../classes/verida_vda_name_client._internal_.BigNumber.md) - -#### Inherited from - -[_Block](verida_vda_name_client._internal_._Block.md).[_difficulty](verida_vda_name_client._internal_._Block.md#_difficulty) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:41 - -___ - -### baseFeePerGas - -• `Optional` **baseFeePerGas**: ``null`` \| [`BigNumber`](../classes/verida_vda_name_client._internal_.BigNumber.md) - -#### Inherited from - -[_Block](verida_vda_name_client._internal_._Block.md).[baseFeePerGas](verida_vda_name_client._internal_._Block.md#basefeepergas) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:46 - -___ - -### difficulty - -• **difficulty**: `number` - -#### Inherited from - -[_Block](verida_vda_name_client._internal_._Block.md).[difficulty](verida_vda_name_client._internal_._Block.md#difficulty) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:40 - -___ - -### extraData - -• **extraData**: `string` - -#### Inherited from - -[_Block](verida_vda_name_client._internal_._Block.md).[extraData](verida_vda_name_client._internal_._Block.md#extradata) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:45 - -___ - -### gasLimit - -• **gasLimit**: [`BigNumber`](../classes/verida_vda_name_client._internal_.BigNumber.md) - -#### Inherited from - -[_Block](verida_vda_name_client._internal_._Block.md).[gasLimit](verida_vda_name_client._internal_._Block.md#gaslimit) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:42 - -___ - -### gasUsed - -• **gasUsed**: [`BigNumber`](../classes/verida_vda_name_client._internal_.BigNumber.md) - -#### Inherited from - -[_Block](verida_vda_name_client._internal_._Block.md).[gasUsed](verida_vda_name_client._internal_._Block.md#gasused) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:43 - -___ - -### hash - -• **hash**: `string` - -#### Inherited from - -[_Block](verida_vda_name_client._internal_._Block.md).[hash](verida_vda_name_client._internal_._Block.md#hash) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:35 - -___ - -### miner - -• **miner**: `string` - -#### Inherited from - -[_Block](verida_vda_name_client._internal_._Block.md).[miner](verida_vda_name_client._internal_._Block.md#miner) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:44 - -___ - -### nonce - -• **nonce**: `string` - -#### Inherited from - -[_Block](verida_vda_name_client._internal_._Block.md).[nonce](verida_vda_name_client._internal_._Block.md#nonce) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:39 - -___ - -### number - -• **number**: `number` - -#### Inherited from - -[_Block](verida_vda_name_client._internal_._Block.md).[number](verida_vda_name_client._internal_._Block.md#number) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:37 - -___ - -### parentHash - -• **parentHash**: `string` - -#### Inherited from - -[_Block](verida_vda_name_client._internal_._Block.md).[parentHash](verida_vda_name_client._internal_._Block.md#parenthash) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:36 - -___ - -### timestamp - -• **timestamp**: `number` - -#### Inherited from - -[_Block](verida_vda_name_client._internal_._Block.md).[timestamp](verida_vda_name_client._internal_._Block.md#timestamp) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:38 - -___ - -### transactions - -• **transactions**: `string`[] - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:49 diff --git a/docs/api/verida-js/interfaces/verida_vda_name_client._internal_.BlockWithTransactions.md b/docs/api/verida-js/interfaces/verida_vda_name_client._internal_.BlockWithTransactions.md deleted file mode 100644 index 2dc8b48..0000000 --- a/docs/api/verida-js/interfaces/verida_vda_name_client._internal_.BlockWithTransactions.md +++ /dev/null @@ -1,207 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-name-client](../modules/verida_vda_name_client.md) / [](../modules/verida_vda_name_client._internal_.md) / BlockWithTransactions - -# Interface: BlockWithTransactions - -[@verida/vda-name-client](../modules/verida_vda_name_client.md).[](../modules/verida_vda_name_client._internal_.md).BlockWithTransactions - -## Hierarchy - -- [`_Block`](verida_vda_name_client._internal_._Block.md) - - ↳ **`BlockWithTransactions`** - -## Table of contents - -### Properties - -- [\_difficulty](verida_vda_name_client._internal_.BlockWithTransactions.md#_difficulty) -- [baseFeePerGas](verida_vda_name_client._internal_.BlockWithTransactions.md#basefeepergas) -- [difficulty](verida_vda_name_client._internal_.BlockWithTransactions.md#difficulty) -- [extraData](verida_vda_name_client._internal_.BlockWithTransactions.md#extradata) -- [gasLimit](verida_vda_name_client._internal_.BlockWithTransactions.md#gaslimit) -- [gasUsed](verida_vda_name_client._internal_.BlockWithTransactions.md#gasused) -- [hash](verida_vda_name_client._internal_.BlockWithTransactions.md#hash) -- [miner](verida_vda_name_client._internal_.BlockWithTransactions.md#miner) -- [nonce](verida_vda_name_client._internal_.BlockWithTransactions.md#nonce) -- [number](verida_vda_name_client._internal_.BlockWithTransactions.md#number) -- [parentHash](verida_vda_name_client._internal_.BlockWithTransactions.md#parenthash) -- [timestamp](verida_vda_name_client._internal_.BlockWithTransactions.md#timestamp) -- [transactions](verida_vda_name_client._internal_.BlockWithTransactions.md#transactions) - -## Properties - -### \_difficulty - -• **\_difficulty**: [`BigNumber`](../classes/verida_vda_name_client._internal_.BigNumber.md) - -#### Inherited from - -[_Block](verida_vda_name_client._internal_._Block.md).[_difficulty](verida_vda_name_client._internal_._Block.md#_difficulty) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:41 - -___ - -### baseFeePerGas - -• `Optional` **baseFeePerGas**: ``null`` \| [`BigNumber`](../classes/verida_vda_name_client._internal_.BigNumber.md) - -#### Inherited from - -[_Block](verida_vda_name_client._internal_._Block.md).[baseFeePerGas](verida_vda_name_client._internal_._Block.md#basefeepergas) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:46 - -___ - -### difficulty - -• **difficulty**: `number` - -#### Inherited from - -[_Block](verida_vda_name_client._internal_._Block.md).[difficulty](verida_vda_name_client._internal_._Block.md#difficulty) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:40 - -___ - -### extraData - -• **extraData**: `string` - -#### Inherited from - -[_Block](verida_vda_name_client._internal_._Block.md).[extraData](verida_vda_name_client._internal_._Block.md#extradata) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:45 - -___ - -### gasLimit - -• **gasLimit**: [`BigNumber`](../classes/verida_vda_name_client._internal_.BigNumber.md) - -#### Inherited from - -[_Block](verida_vda_name_client._internal_._Block.md).[gasLimit](verida_vda_name_client._internal_._Block.md#gaslimit) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:42 - -___ - -### gasUsed - -• **gasUsed**: [`BigNumber`](../classes/verida_vda_name_client._internal_.BigNumber.md) - -#### Inherited from - -[_Block](verida_vda_name_client._internal_._Block.md).[gasUsed](verida_vda_name_client._internal_._Block.md#gasused) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:43 - -___ - -### hash - -• **hash**: `string` - -#### Inherited from - -[_Block](verida_vda_name_client._internal_._Block.md).[hash](verida_vda_name_client._internal_._Block.md#hash) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:35 - -___ - -### miner - -• **miner**: `string` - -#### Inherited from - -[_Block](verida_vda_name_client._internal_._Block.md).[miner](verida_vda_name_client._internal_._Block.md#miner) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:44 - -___ - -### nonce - -• **nonce**: `string` - -#### Inherited from - -[_Block](verida_vda_name_client._internal_._Block.md).[nonce](verida_vda_name_client._internal_._Block.md#nonce) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:39 - -___ - -### number - -• **number**: `number` - -#### Inherited from - -[_Block](verida_vda_name_client._internal_._Block.md).[number](verida_vda_name_client._internal_._Block.md#number) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:37 - -___ - -### parentHash - -• **parentHash**: `string` - -#### Inherited from - -[_Block](verida_vda_name_client._internal_._Block.md).[parentHash](verida_vda_name_client._internal_._Block.md#parenthash) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:36 - -___ - -### timestamp - -• **timestamp**: `number` - -#### Inherited from - -[_Block](verida_vda_name_client._internal_._Block.md).[timestamp](verida_vda_name_client._internal_._Block.md#timestamp) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:38 - -___ - -### transactions - -• **transactions**: [`TransactionResponse`](verida_vda_name_client._internal_.TransactionResponse.md)[] - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:52 diff --git a/docs/api/verida-js/interfaces/verida_vda_name_client._internal_.ConcatArray.md b/docs/api/verida-js/interfaces/verida_vda_name_client._internal_.ConcatArray.md deleted file mode 100644 index 98723b0..0000000 --- a/docs/api/verida-js/interfaces/verida_vda_name_client._internal_.ConcatArray.md +++ /dev/null @@ -1,77 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-name-client](../modules/verida_vda_name_client.md) / [](../modules/verida_vda_name_client._internal_.md) / ConcatArray - -# Interface: ConcatArray - -[@verida/vda-name-client](../modules/verida_vda_name_client.md).[](../modules/verida_vda_name_client._internal_.md).ConcatArray - -## Type parameters - -| Name | -| :------ | -| `T` | - -## Indexable - -▪ [n: `number`]: `T` - -## Table of contents - -### Properties - -- [length](verida_vda_name_client._internal_.ConcatArray.md#length) - -### Methods - -- [join](verida_vda_name_client._internal_.ConcatArray.md#join) -- [slice](verida_vda_name_client._internal_.ConcatArray.md#slice) - -## Properties - -### length - -• `Readonly` **length**: `number` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1214 - -## Methods - -### join - -▸ **join**(`separator?`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `separator?` | `string` | - -#### Returns - -`string` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1216 - -___ - -### slice - -▸ **slice**(`start?`, `end?`): `T`[] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `start?` | `number` | -| `end?` | `number` | - -#### Returns - -`T`[] - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1217 diff --git a/docs/api/verida-js/interfaces/verida_vda_name_client._internal_.Error.md b/docs/api/verida-js/interfaces/verida_vda_name_client._internal_.Error.md deleted file mode 100644 index 5f72b87..0000000 --- a/docs/api/verida-js/interfaces/verida_vda_name_client._internal_.Error.md +++ /dev/null @@ -1,43 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-name-client](../modules/verida_vda_name_client.md) / [](../modules/verida_vda_name_client._internal_.md) / Error - -# Interface: Error - -[@verida/vda-name-client](../modules/verida_vda_name_client.md).[](../modules/verida_vda_name_client._internal_.md).Error - -## Table of contents - -### Properties - -- [message](verida_vda_name_client._internal_.Error.md#message) -- [name](verida_vda_name_client._internal_.Error.md#name) -- [stack](verida_vda_name_client._internal_.Error.md#stack) - -## Properties - -### message - -• **message**: `string` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:974 - -___ - -### name - -• **name**: `string` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:973 - -___ - -### stack - -• `Optional` **stack**: `string` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:975 diff --git a/docs/api/verida-js/interfaces/verida_vda_name_client._internal_.Event.md b/docs/api/verida-js/interfaces/verida_vda_name_client._internal_.Event.md deleted file mode 100644 index 7495c71..0000000 --- a/docs/api/verida-js/interfaces/verida_vda_name_client._internal_.Event.md +++ /dev/null @@ -1,280 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-name-client](../modules/verida_vda_name_client.md) / [](../modules/verida_vda_name_client._internal_.md) / Event - -# Interface: Event - -[@verida/vda-name-client](../modules/verida_vda_name_client.md).[](../modules/verida_vda_name_client._internal_.md).Event - -## Hierarchy - -- [`Log`](verida_vda_name_client._internal_.Log.md) - - ↳ **`Event`** - -## Table of contents - -### Properties - -- [address](verida_vda_name_client._internal_.Event.md#address) -- [args](verida_vda_name_client._internal_.Event.md#args) -- [blockHash](verida_vda_name_client._internal_.Event.md#blockhash) -- [blockNumber](verida_vda_name_client._internal_.Event.md#blocknumber) -- [data](verida_vda_name_client._internal_.Event.md#data) -- [decodeError](verida_vda_name_client._internal_.Event.md#decodeerror) -- [event](verida_vda_name_client._internal_.Event.md#event) -- [eventSignature](verida_vda_name_client._internal_.Event.md#eventsignature) -- [logIndex](verida_vda_name_client._internal_.Event.md#logindex) -- [removed](verida_vda_name_client._internal_.Event.md#removed) -- [topics](verida_vda_name_client._internal_.Event.md#topics) -- [transactionHash](verida_vda_name_client._internal_.Event.md#transactionhash) -- [transactionIndex](verida_vda_name_client._internal_.Event.md#transactionindex) - -### Methods - -- [decode](verida_vda_name_client._internal_.Event.md#decode) -- [getBlock](verida_vda_name_client._internal_.Event.md#getblock) -- [getTransaction](verida_vda_name_client._internal_.Event.md#gettransaction) -- [getTransactionReceipt](verida_vda_name_client._internal_.Event.md#gettransactionreceipt) -- [removeListener](verida_vda_name_client._internal_.Event.md#removelistener) - -## Properties - -### address - -• **address**: `string` - -#### Inherited from - -[Log](verida_vda_name_client._internal_.Log.md).[address](verida_vda_name_client._internal_.Log.md#address) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:59 - -___ - -### args - -• `Optional` **args**: [`Result`](verida_vda_name_client._internal_.Result.md) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:49 - -___ - -### blockHash - -• **blockHash**: `string` - -#### Inherited from - -[Log](verida_vda_name_client._internal_.Log.md).[blockHash](verida_vda_name_client._internal_.Log.md#blockhash) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:56 - -___ - -### blockNumber - -• **blockNumber**: `number` - -#### Inherited from - -[Log](verida_vda_name_client._internal_.Log.md).[blockNumber](verida_vda_name_client._internal_.Log.md#blocknumber) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:55 - -___ - -### data - -• **data**: `string` - -#### Inherited from - -[Log](verida_vda_name_client._internal_.Log.md).[data](verida_vda_name_client._internal_.Log.md#data) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:60 - -___ - -### decodeError - -• `Optional` **decodeError**: [`Error`](../modules/verida_vda_name_client._internal_.md#error) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:50 - -___ - -### event - -• `Optional` **event**: `string` - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:47 - -___ - -### eventSignature - -• `Optional` **eventSignature**: `string` - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:48 - -___ - -### logIndex - -• **logIndex**: `number` - -#### Inherited from - -[Log](verida_vda_name_client._internal_.Log.md).[logIndex](verida_vda_name_client._internal_.Log.md#logindex) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:63 - -___ - -### removed - -• **removed**: `boolean` - -#### Inherited from - -[Log](verida_vda_name_client._internal_.Log.md).[removed](verida_vda_name_client._internal_.Log.md#removed) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:58 - -___ - -### topics - -• **topics**: `string`[] - -#### Inherited from - -[Log](verida_vda_name_client._internal_.Log.md).[topics](verida_vda_name_client._internal_.Log.md#topics) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:61 - -___ - -### transactionHash - -• **transactionHash**: `string` - -#### Inherited from - -[Log](verida_vda_name_client._internal_.Log.md).[transactionHash](verida_vda_name_client._internal_.Log.md#transactionhash) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:62 - -___ - -### transactionIndex - -• **transactionIndex**: `number` - -#### Inherited from - -[Log](verida_vda_name_client._internal_.Log.md).[transactionIndex](verida_vda_name_client._internal_.Log.md#transactionindex) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:57 - -## Methods - -### decode - -▸ `Optional` **decode**(`data`, `topics?`): `any` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `string` | -| `topics?` | `string`[] | - -#### Returns - -`any` - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:51 - -___ - -### getBlock - -▸ **getBlock**(): `Promise`<[`Block`](verida_vda_name_client._internal_.Block.md)\> - -#### Returns - -`Promise`<[`Block`](verida_vda_name_client._internal_.Block.md)\> - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:53 - -___ - -### getTransaction - -▸ **getTransaction**(): `Promise`<[`TransactionResponse`](verida_vda_name_client._internal_.TransactionResponse.md)\> - -#### Returns - -`Promise`<[`TransactionResponse`](verida_vda_name_client._internal_.TransactionResponse.md)\> - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:54 - -___ - -### getTransactionReceipt - -▸ **getTransactionReceipt**(): `Promise`<[`TransactionReceipt`](verida_vda_name_client._internal_.TransactionReceipt.md)\> - -#### Returns - -`Promise`<[`TransactionReceipt`](verida_vda_name_client._internal_.TransactionReceipt.md)\> - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:55 - -___ - -### removeListener - -▸ **removeListener**(): `void` - -#### Returns - -`void` - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:52 diff --git a/docs/api/verida-js/interfaces/verida_vda_name_client._internal_.EventFilter.md b/docs/api/verida-js/interfaces/verida_vda_name_client._internal_.EventFilter.md deleted file mode 100644 index 44bc314..0000000 --- a/docs/api/verida-js/interfaces/verida_vda_name_client._internal_.EventFilter.md +++ /dev/null @@ -1,38 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-name-client](../modules/verida_vda_name_client.md) / [](../modules/verida_vda_name_client._internal_.md) / EventFilter - -# Interface: EventFilter - -[@verida/vda-name-client](../modules/verida_vda_name_client.md).[](../modules/verida_vda_name_client._internal_.md).EventFilter - -## Hierarchy - -- **`EventFilter`** - - ↳ [`Filter`](verida_vda_name_client._internal_.Filter.md) - -## Table of contents - -### Properties - -- [address](verida_vda_name_client._internal_.EventFilter.md#address) -- [topics](verida_vda_name_client._internal_.EventFilter.md#topics) - -## Properties - -### address - -• `Optional` **address**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:91 - -___ - -### topics - -• `Optional` **topics**: (``null`` \| `string` \| `string`[])[] - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:92 diff --git a/docs/api/verida-js/interfaces/verida_vda_name_client._internal_.FeeData.md b/docs/api/verida-js/interfaces/verida_vda_name_client._internal_.FeeData.md deleted file mode 100644 index e505bf6..0000000 --- a/docs/api/verida-js/interfaces/verida_vda_name_client._internal_.FeeData.md +++ /dev/null @@ -1,54 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-name-client](../modules/verida_vda_name_client.md) / [](../modules/verida_vda_name_client._internal_.md) / FeeData - -# Interface: FeeData - -[@verida/vda-name-client](../modules/verida_vda_name_client.md).[](../modules/verida_vda_name_client._internal_.md).FeeData - -## Table of contents - -### Properties - -- [gasPrice](verida_vda_name_client._internal_.FeeData.md#gasprice) -- [lastBaseFeePerGas](verida_vda_name_client._internal_.FeeData.md#lastbasefeepergas) -- [maxFeePerGas](verida_vda_name_client._internal_.FeeData.md#maxfeepergas) -- [maxPriorityFeePerGas](verida_vda_name_client._internal_.FeeData.md#maxpriorityfeepergas) - -## Properties - -### gasPrice - -• **gasPrice**: ``null`` \| [`BigNumber`](../classes/verida_vda_name_client._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:88 - -___ - -### lastBaseFeePerGas - -• **lastBaseFeePerGas**: ``null`` \| [`BigNumber`](../classes/verida_vda_name_client._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:85 - -___ - -### maxFeePerGas - -• **maxFeePerGas**: ``null`` \| [`BigNumber`](../classes/verida_vda_name_client._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:86 - -___ - -### maxPriorityFeePerGas - -• **maxPriorityFeePerGas**: ``null`` \| [`BigNumber`](../classes/verida_vda_name_client._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:87 diff --git a/docs/api/verida-js/interfaces/verida_vda_name_client._internal_.Filter.md b/docs/api/verida-js/interfaces/verida_vda_name_client._internal_.Filter.md deleted file mode 100644 index 88de550..0000000 --- a/docs/api/verida-js/interfaces/verida_vda_name_client._internal_.Filter.md +++ /dev/null @@ -1,68 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-name-client](../modules/verida_vda_name_client.md) / [](../modules/verida_vda_name_client._internal_.md) / Filter - -# Interface: Filter - -[@verida/vda-name-client](../modules/verida_vda_name_client.md).[](../modules/verida_vda_name_client._internal_.md).Filter - -## Hierarchy - -- [`EventFilter`](verida_vda_name_client._internal_.EventFilter.md) - - ↳ **`Filter`** - -## Table of contents - -### Properties - -- [address](verida_vda_name_client._internal_.Filter.md#address) -- [fromBlock](verida_vda_name_client._internal_.Filter.md#fromblock) -- [toBlock](verida_vda_name_client._internal_.Filter.md#toblock) -- [topics](verida_vda_name_client._internal_.Filter.md#topics) - -## Properties - -### address - -• `Optional` **address**: `string` - -#### Inherited from - -[EventFilter](verida_vda_name_client._internal_.EventFilter.md).[address](verida_vda_name_client._internal_.EventFilter.md#address) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:91 - -___ - -### fromBlock - -• `Optional` **fromBlock**: [`BlockTag`](../modules/verida_vda_name_client._internal_.md#blocktag) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:95 - -___ - -### toBlock - -• `Optional` **toBlock**: [`BlockTag`](../modules/verida_vda_name_client._internal_.md#blocktag) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:96 - -___ - -### topics - -• `Optional` **topics**: (``null`` \| `string` \| `string`[])[] - -#### Inherited from - -[EventFilter](verida_vda_name_client._internal_.EventFilter.md).[topics](verida_vda_name_client._internal_.EventFilter.md#topics) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:92 diff --git a/docs/api/verida-js/interfaces/verida_vda_name_client._internal_.Hexable.md b/docs/api/verida-js/interfaces/verida_vda_name_client._internal_.Hexable.md deleted file mode 100644 index b3bb983..0000000 --- a/docs/api/verida-js/interfaces/verida_vda_name_client._internal_.Hexable.md +++ /dev/null @@ -1,29 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-name-client](../modules/verida_vda_name_client.md) / [](../modules/verida_vda_name_client._internal_.md) / Hexable - -# Interface: Hexable - -[@verida/vda-name-client](../modules/verida_vda_name_client.md).[](../modules/verida_vda_name_client._internal_.md).Hexable - -## Implemented by - -- [`BigNumber`](../classes/verida_vda_name_client._internal_.BigNumber.md) - -## Table of contents - -### Methods - -- [toHexString](verida_vda_name_client._internal_.Hexable.md#tohexstring) - -## Methods - -### toHexString - -▸ **toHexString**(): `string` - -#### Returns - -`string` - -#### Defined in - -node_modules/@ethersproject/bytes/lib/index.d.ts:8 diff --git a/docs/api/verida-js/interfaces/verida_vda_name_client._internal_.IterableIterator.md b/docs/api/verida-js/interfaces/verida_vda_name_client._internal_.IterableIterator.md deleted file mode 100644 index 7155d9b..0000000 --- a/docs/api/verida-js/interfaces/verida_vda_name_client._internal_.IterableIterator.md +++ /dev/null @@ -1,112 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-name-client](../modules/verida_vda_name_client.md) / [](../modules/verida_vda_name_client._internal_.md) / IterableIterator - -# Interface: IterableIterator - -[@verida/vda-name-client](../modules/verida_vda_name_client.md).[](../modules/verida_vda_name_client._internal_.md).IterableIterator - -## Type parameters - -| Name | -| :------ | -| `T` | - -## Hierarchy - -- [`Iterator`](verida_vda_name_client._internal_.Iterator.md)<`T`\> - - ↳ **`IterableIterator`** - -## Table of contents - -### Methods - -- [[iterator]](verida_vda_name_client._internal_.IterableIterator.md#[iterator]) -- [next](verida_vda_name_client._internal_.IterableIterator.md#next) -- [return](verida_vda_name_client._internal_.IterableIterator.md#return) -- [throw](verida_vda_name_client._internal_.IterableIterator.md#throw) - -## Methods - -### [iterator] - -▸ **[iterator]**(): [`IterableIterator`](verida_vda_name_client._internal_.IterableIterator.md)<`T`\> - -#### Returns - -[`IterableIterator`](verida_vda_name_client._internal_.IterableIterator.md)<`T`\> - -#### Defined in - -node_modules/typescript/lib/lib.es2015.iterable.d.ts:55 - -___ - -### next - -▸ **next**(...`args`): [`IteratorResult`](../modules/verida_vda_name_client._internal_.md#iteratorresult)<`T`, `any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `...args` | [] \| [`undefined`] | - -#### Returns - -[`IteratorResult`](../modules/verida_vda_name_client._internal_.md#iteratorresult)<`T`, `any`\> - -#### Inherited from - -[Iterator](verida_vda_name_client._internal_.Iterator.md).[next](verida_vda_name_client._internal_.Iterator.md#next) - -#### Defined in - -node_modules/typescript/lib/lib.es2015.iterable.d.ts:45 - -___ - -### return - -▸ `Optional` **return**(`value?`): [`IteratorResult`](../modules/verida_vda_name_client._internal_.md#iteratorresult)<`T`, `any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value?` | `any` | - -#### Returns - -[`IteratorResult`](../modules/verida_vda_name_client._internal_.md#iteratorresult)<`T`, `any`\> - -#### Inherited from - -[Iterator](verida_vda_name_client._internal_.Iterator.md).[return](verida_vda_name_client._internal_.Iterator.md#return) - -#### Defined in - -node_modules/typescript/lib/lib.es2015.iterable.d.ts:46 - -___ - -### throw - -▸ `Optional` **throw**(`e?`): [`IteratorResult`](../modules/verida_vda_name_client._internal_.md#iteratorresult)<`T`, `any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `e?` | `any` | - -#### Returns - -[`IteratorResult`](../modules/verida_vda_name_client._internal_.md#iteratorresult)<`T`, `any`\> - -#### Inherited from - -[Iterator](verida_vda_name_client._internal_.Iterator.md).[throw](verida_vda_name_client._internal_.Iterator.md#throw) - -#### Defined in - -node_modules/typescript/lib/lib.es2015.iterable.d.ts:47 diff --git a/docs/api/verida-js/interfaces/verida_vda_name_client._internal_.Iterator.md b/docs/api/verida-js/interfaces/verida_vda_name_client._internal_.Iterator.md deleted file mode 100644 index 729c8aa..0000000 --- a/docs/api/verida-js/interfaces/verida_vda_name_client._internal_.Iterator.md +++ /dev/null @@ -1,87 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-name-client](../modules/verida_vda_name_client.md) / [](../modules/verida_vda_name_client._internal_.md) / Iterator - -# Interface: Iterator - -[@verida/vda-name-client](../modules/verida_vda_name_client.md).[](../modules/verida_vda_name_client._internal_.md).Iterator - -## Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `T` | -| `TReturn` | `any` | -| `TNext` | `undefined` | - -## Hierarchy - -- **`Iterator`** - - ↳ [`IterableIterator`](verida_vda_name_client._internal_.IterableIterator.md) - -## Table of contents - -### Methods - -- [next](verida_vda_name_client._internal_.Iterator.md#next) -- [return](verida_vda_name_client._internal_.Iterator.md#return) -- [throw](verida_vda_name_client._internal_.Iterator.md#throw) - -## Methods - -### next - -▸ **next**(...`args`): [`IteratorResult`](../modules/verida_vda_name_client._internal_.md#iteratorresult)<`T`, `TReturn`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `...args` | [] \| [`TNext`] | - -#### Returns - -[`IteratorResult`](../modules/verida_vda_name_client._internal_.md#iteratorresult)<`T`, `TReturn`\> - -#### Defined in - -node_modules/typescript/lib/lib.es2015.iterable.d.ts:45 - -___ - -### return - -▸ `Optional` **return**(`value?`): [`IteratorResult`](../modules/verida_vda_name_client._internal_.md#iteratorresult)<`T`, `TReturn`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value?` | `TReturn` | - -#### Returns - -[`IteratorResult`](../modules/verida_vda_name_client._internal_.md#iteratorresult)<`T`, `TReturn`\> - -#### Defined in - -node_modules/typescript/lib/lib.es2015.iterable.d.ts:46 - -___ - -### throw - -▸ `Optional` **throw**(`e?`): [`IteratorResult`](../modules/verida_vda_name_client._internal_.md#iteratorresult)<`T`, `TReturn`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `e?` | `any` | - -#### Returns - -[`IteratorResult`](../modules/verida_vda_name_client._internal_.md#iteratorresult)<`T`, `TReturn`\> - -#### Defined in - -node_modules/typescript/lib/lib.es2015.iterable.d.ts:47 diff --git a/docs/api/verida-js/interfaces/verida_vda_name_client._internal_.IteratorReturnResult.md b/docs/api/verida-js/interfaces/verida_vda_name_client._internal_.IteratorReturnResult.md deleted file mode 100644 index 57730c4..0000000 --- a/docs/api/verida-js/interfaces/verida_vda_name_client._internal_.IteratorReturnResult.md +++ /dev/null @@ -1,38 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-name-client](../modules/verida_vda_name_client.md) / [](../modules/verida_vda_name_client._internal_.md) / IteratorReturnResult - -# Interface: IteratorReturnResult - -[@verida/vda-name-client](../modules/verida_vda_name_client.md).[](../modules/verida_vda_name_client._internal_.md).IteratorReturnResult - -## Type parameters - -| Name | -| :------ | -| `TReturn` | - -## Table of contents - -### Properties - -- [done](verida_vda_name_client._internal_.IteratorReturnResult.md#done) -- [value](verida_vda_name_client._internal_.IteratorReturnResult.md#value) - -## Properties - -### done - -• **done**: ``true`` - -#### Defined in - -node_modules/typescript/lib/lib.es2015.iterable.d.ts:37 - -___ - -### value - -• **value**: `TReturn` - -#### Defined in - -node_modules/typescript/lib/lib.es2015.iterable.d.ts:38 diff --git a/docs/api/verida-js/interfaces/verida_vda_name_client._internal_.IteratorYieldResult.md b/docs/api/verida-js/interfaces/verida_vda_name_client._internal_.IteratorYieldResult.md deleted file mode 100644 index 1b3ad37..0000000 --- a/docs/api/verida-js/interfaces/verida_vda_name_client._internal_.IteratorYieldResult.md +++ /dev/null @@ -1,38 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-name-client](../modules/verida_vda_name_client.md) / [](../modules/verida_vda_name_client._internal_.md) / IteratorYieldResult - -# Interface: IteratorYieldResult - -[@verida/vda-name-client](../modules/verida_vda_name_client.md).[](../modules/verida_vda_name_client._internal_.md).IteratorYieldResult - -## Type parameters - -| Name | -| :------ | -| `TYield` | - -## Table of contents - -### Properties - -- [done](verida_vda_name_client._internal_.IteratorYieldResult.md#done) -- [value](verida_vda_name_client._internal_.IteratorYieldResult.md#value) - -## Properties - -### done - -• `Optional` **done**: ``false`` - -#### Defined in - -node_modules/typescript/lib/lib.es2015.iterable.d.ts:32 - -___ - -### value - -• **value**: `TYield` - -#### Defined in - -node_modules/typescript/lib/lib.es2015.iterable.d.ts:33 diff --git a/docs/api/verida-js/interfaces/verida_vda_name_client._internal_.JsonFragment.md b/docs/api/verida-js/interfaces/verida_vda_name_client._internal_.JsonFragment.md deleted file mode 100644 index 20de336..0000000 --- a/docs/api/verida-js/interfaces/verida_vda_name_client._internal_.JsonFragment.md +++ /dev/null @@ -1,109 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-name-client](../modules/verida_vda_name_client.md) / [](../modules/verida_vda_name_client._internal_.md) / JsonFragment - -# Interface: JsonFragment - -[@verida/vda-name-client](../modules/verida_vda_name_client.md).[](../modules/verida_vda_name_client._internal_.md).JsonFragment - -## Table of contents - -### Properties - -- [anonymous](verida_vda_name_client._internal_.JsonFragment.md#anonymous) -- [constant](verida_vda_name_client._internal_.JsonFragment.md#constant) -- [gas](verida_vda_name_client._internal_.JsonFragment.md#gas) -- [inputs](verida_vda_name_client._internal_.JsonFragment.md#inputs) -- [name](verida_vda_name_client._internal_.JsonFragment.md#name) -- [outputs](verida_vda_name_client._internal_.JsonFragment.md#outputs) -- [payable](verida_vda_name_client._internal_.JsonFragment.md#payable) -- [stateMutability](verida_vda_name_client._internal_.JsonFragment.md#statemutability) -- [type](verida_vda_name_client._internal_.JsonFragment.md#type) - -## Properties - -### anonymous - -• `Optional` `Readonly` **anonymous**: `boolean` - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:12 - -___ - -### constant - -• `Optional` `Readonly` **constant**: `boolean` - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:14 - -___ - -### gas - -• `Optional` `Readonly` **gas**: `string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:18 - -___ - -### inputs - -• `Optional` `Readonly` **inputs**: readonly [`JsonFragmentType`](verida_vda_name_client._internal_.JsonFragmentType.md)[] - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:16 - -___ - -### name - -• `Optional` `Readonly` **name**: `string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:10 - -___ - -### outputs - -• `Optional` `Readonly` **outputs**: readonly [`JsonFragmentType`](verida_vda_name_client._internal_.JsonFragmentType.md)[] - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:17 - -___ - -### payable - -• `Optional` `Readonly` **payable**: `boolean` - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:13 - -___ - -### stateMutability - -• `Optional` `Readonly` **stateMutability**: `string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:15 - -___ - -### type - -• `Optional` `Readonly` **type**: `string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:11 diff --git a/docs/api/verida-js/interfaces/verida_vda_name_client._internal_.JsonFragmentType.md b/docs/api/verida-js/interfaces/verida_vda_name_client._internal_.JsonFragmentType.md deleted file mode 100644 index 9f6c414..0000000 --- a/docs/api/verida-js/interfaces/verida_vda_name_client._internal_.JsonFragmentType.md +++ /dev/null @@ -1,65 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-name-client](../modules/verida_vda_name_client.md) / [](../modules/verida_vda_name_client._internal_.md) / JsonFragmentType - -# Interface: JsonFragmentType - -[@verida/vda-name-client](../modules/verida_vda_name_client.md).[](../modules/verida_vda_name_client._internal_.md).JsonFragmentType - -## Table of contents - -### Properties - -- [components](verida_vda_name_client._internal_.JsonFragmentType.md#components) -- [indexed](verida_vda_name_client._internal_.JsonFragmentType.md#indexed) -- [internalType](verida_vda_name_client._internal_.JsonFragmentType.md#internaltype) -- [name](verida_vda_name_client._internal_.JsonFragmentType.md#name) -- [type](verida_vda_name_client._internal_.JsonFragmentType.md#type) - -## Properties - -### components - -• `Optional` `Readonly` **components**: readonly [`JsonFragmentType`](verida_vda_name_client._internal_.JsonFragmentType.md)[] - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:7 - -___ - -### indexed - -• `Optional` `Readonly` **indexed**: `boolean` - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:4 - -___ - -### internalType - -• `Optional` `Readonly` **internalType**: `any` - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:6 - -___ - -### name - -• `Optional` `Readonly` **name**: `string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:3 - -___ - -### type - -• `Optional` `Readonly` **type**: `string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:5 diff --git a/docs/api/verida-js/interfaces/verida_vda_name_client._internal_.Log.md b/docs/api/verida-js/interfaces/verida_vda_name_client._internal_.Log.md deleted file mode 100644 index 9b99eec..0000000 --- a/docs/api/verida-js/interfaces/verida_vda_name_client._internal_.Log.md +++ /dev/null @@ -1,115 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-name-client](../modules/verida_vda_name_client.md) / [](../modules/verida_vda_name_client._internal_.md) / Log - -# Interface: Log - -[@verida/vda-name-client](../modules/verida_vda_name_client.md).[](../modules/verida_vda_name_client._internal_.md).Log - -## Hierarchy - -- **`Log`** - - ↳ [`Event`](verida_vda_name_client._internal_.Event.md) - -## Table of contents - -### Properties - -- [address](verida_vda_name_client._internal_.Log.md#address) -- [blockHash](verida_vda_name_client._internal_.Log.md#blockhash) -- [blockNumber](verida_vda_name_client._internal_.Log.md#blocknumber) -- [data](verida_vda_name_client._internal_.Log.md#data) -- [logIndex](verida_vda_name_client._internal_.Log.md#logindex) -- [removed](verida_vda_name_client._internal_.Log.md#removed) -- [topics](verida_vda_name_client._internal_.Log.md#topics) -- [transactionHash](verida_vda_name_client._internal_.Log.md#transactionhash) -- [transactionIndex](verida_vda_name_client._internal_.Log.md#transactionindex) - -## Properties - -### address - -• **address**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:59 - -___ - -### blockHash - -• **blockHash**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:56 - -___ - -### blockNumber - -• **blockNumber**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:55 - -___ - -### data - -• **data**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:60 - -___ - -### logIndex - -• **logIndex**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:63 - -___ - -### removed - -• **removed**: `boolean` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:58 - -___ - -### topics - -• **topics**: `string`[] - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:61 - -___ - -### transactionHash - -• **transactionHash**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:62 - -___ - -### transactionIndex - -• **transactionIndex**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:57 diff --git a/docs/api/verida-js/interfaces/verida_vda_name_client._internal_.OnceBlockable.md b/docs/api/verida-js/interfaces/verida_vda_name_client._internal_.OnceBlockable.md deleted file mode 100644 index 60cb100..0000000 --- a/docs/api/verida-js/interfaces/verida_vda_name_client._internal_.OnceBlockable.md +++ /dev/null @@ -1,36 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-name-client](../modules/verida_vda_name_client.md) / [](../modules/verida_vda_name_client._internal_.md) / OnceBlockable - -# Interface: OnceBlockable - -[@verida/vda-name-client](../modules/verida_vda_name_client.md).[](../modules/verida_vda_name_client._internal_.md).OnceBlockable - -## Implemented by - -- [`Provider`](../classes/verida_vda_name_client._internal_.Provider.md) - -## Table of contents - -### Methods - -- [once](verida_vda_name_client._internal_.OnceBlockable.md#once) - -## Methods - -### once - -▸ **once**(`eventName`, `handler`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | ``"block"`` | -| `handler` | () => `void` | - -#### Returns - -`void` - -#### Defined in - -node_modules/@ethersproject/web/lib/index.d.ts:19 diff --git a/docs/api/verida-js/interfaces/verida_vda_name_client._internal_.PopulatedTransaction.md b/docs/api/verida-js/interfaces/verida_vda_name_client._internal_.PopulatedTransaction.md deleted file mode 100644 index 87578ef..0000000 --- a/docs/api/verida-js/interfaces/verida_vda_name_client._internal_.PopulatedTransaction.md +++ /dev/null @@ -1,164 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-name-client](../modules/verida_vda_name_client.md) / [](../modules/verida_vda_name_client._internal_.md) / PopulatedTransaction - -# Interface: PopulatedTransaction - -[@verida/vda-name-client](../modules/verida_vda_name_client.md).[](../modules/verida_vda_name_client._internal_.md).PopulatedTransaction - -## Table of contents - -### Properties - -- [accessList](verida_vda_name_client._internal_.PopulatedTransaction.md#accesslist) -- [ccipReadEnabled](verida_vda_name_client._internal_.PopulatedTransaction.md#ccipreadenabled) -- [chainId](verida_vda_name_client._internal_.PopulatedTransaction.md#chainid) -- [customData](verida_vda_name_client._internal_.PopulatedTransaction.md#customdata) -- [data](verida_vda_name_client._internal_.PopulatedTransaction.md#data) -- [from](verida_vda_name_client._internal_.PopulatedTransaction.md#from) -- [gasLimit](verida_vda_name_client._internal_.PopulatedTransaction.md#gaslimit) -- [gasPrice](verida_vda_name_client._internal_.PopulatedTransaction.md#gasprice) -- [maxFeePerGas](verida_vda_name_client._internal_.PopulatedTransaction.md#maxfeepergas) -- [maxPriorityFeePerGas](verida_vda_name_client._internal_.PopulatedTransaction.md#maxpriorityfeepergas) -- [nonce](verida_vda_name_client._internal_.PopulatedTransaction.md#nonce) -- [to](verida_vda_name_client._internal_.PopulatedTransaction.md#to) -- [type](verida_vda_name_client._internal_.PopulatedTransaction.md#type) -- [value](verida_vda_name_client._internal_.PopulatedTransaction.md#value) - -## Properties - -### accessList - -• `Optional` **accessList**: [`AccessList`](../modules/verida_vda_name_client._internal_.md#accesslist) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:35 - -___ - -### ccipReadEnabled - -• `Optional` **ccipReadEnabled**: `boolean` - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:39 - -___ - -### chainId - -• `Optional` **chainId**: `number` - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:33 - -___ - -### customData - -• `Optional` **customData**: [`Record`](../modules/verida_vda_name_client._internal_.md#record)<`string`, `any`\> - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:38 - -___ - -### data - -• `Optional` **data**: `string` - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:31 - -___ - -### from - -• `Optional` **from**: `string` - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:27 - -___ - -### gasLimit - -• `Optional` **gasLimit**: [`BigNumber`](../classes/verida_vda_name_client._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:29 - -___ - -### gasPrice - -• `Optional` **gasPrice**: [`BigNumber`](../classes/verida_vda_name_client._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:30 - -___ - -### maxFeePerGas - -• `Optional` **maxFeePerGas**: [`BigNumber`](../classes/verida_vda_name_client._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:36 - -___ - -### maxPriorityFeePerGas - -• `Optional` **maxPriorityFeePerGas**: [`BigNumber`](../classes/verida_vda_name_client._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:37 - -___ - -### nonce - -• `Optional` **nonce**: `number` - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:28 - -___ - -### to - -• `Optional` **to**: `string` - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:26 - -___ - -### type - -• `Optional` **type**: `number` - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:34 - -___ - -### value - -• `Optional` **value**: [`BigNumber`](../classes/verida_vda_name_client._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:32 diff --git a/docs/api/verida-js/interfaces/verida_vda_name_client._internal_.Result.md b/docs/api/verida-js/interfaces/verida_vda_name_client._internal_.Result.md deleted file mode 100644 index 4bc4abf..0000000 --- a/docs/api/verida-js/interfaces/verida_vda_name_client._internal_.Result.md +++ /dev/null @@ -1,869 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-name-client](../modules/verida_vda_name_client.md) / [](../modules/verida_vda_name_client._internal_.md) / Result - -# Interface: Result - -[@verida/vda-name-client](../modules/verida_vda_name_client.md).[](../modules/verida_vda_name_client._internal_.md).Result - -## Hierarchy - -- `ReadonlyArray`<`any`\> - - ↳ **`Result`** - -## Indexable - -▪ [key: `string`]: `any` - -## Table of contents - -### Properties - -- [length](verida_vda_name_client._internal_.Result.md#length) - -### Methods - -- [[iterator]](verida_vda_name_client._internal_.Result.md#[iterator]) -- [concat](verida_vda_name_client._internal_.Result.md#concat) -- [entries](verida_vda_name_client._internal_.Result.md#entries) -- [every](verida_vda_name_client._internal_.Result.md#every) -- [filter](verida_vda_name_client._internal_.Result.md#filter) -- [find](verida_vda_name_client._internal_.Result.md#find) -- [findIndex](verida_vda_name_client._internal_.Result.md#findindex) -- [flat](verida_vda_name_client._internal_.Result.md#flat) -- [flatMap](verida_vda_name_client._internal_.Result.md#flatmap) -- [forEach](verida_vda_name_client._internal_.Result.md#foreach) -- [includes](verida_vda_name_client._internal_.Result.md#includes) -- [indexOf](verida_vda_name_client._internal_.Result.md#indexof) -- [join](verida_vda_name_client._internal_.Result.md#join) -- [keys](verida_vda_name_client._internal_.Result.md#keys) -- [lastIndexOf](verida_vda_name_client._internal_.Result.md#lastindexof) -- [map](verida_vda_name_client._internal_.Result.md#map) -- [reduce](verida_vda_name_client._internal_.Result.md#reduce) -- [reduceRight](verida_vda_name_client._internal_.Result.md#reduceright) -- [slice](verida_vda_name_client._internal_.Result.md#slice) -- [some](verida_vda_name_client._internal_.Result.md#some) -- [toLocaleString](verida_vda_name_client._internal_.Result.md#tolocalestring) -- [toString](verida_vda_name_client._internal_.Result.md#tostring) -- [values](verida_vda_name_client._internal_.Result.md#values) - -## Properties - -### length - -• `Readonly` **length**: `number` - -Gets the length of the array. This is a number one higher than the highest element defined in an array. - -#### Inherited from - -ReadonlyArray.length - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1090 - -## Methods - -### [iterator] - -▸ **[iterator]**(): [`IterableIterator`](verida_vda_name_client._internal_.IterableIterator.md)<`any`\> - -Iterator of values in the array. - -#### Returns - -[`IterableIterator`](verida_vda_name_client._internal_.IterableIterator.md)<`any`\> - -#### Inherited from - -ReadonlyArray.\_\_@iterator@15306 - -#### Defined in - -node_modules/typescript/lib/lib.es2015.iterable.d.ts:96 - -___ - -### concat - -▸ **concat**(...`items`): `any`[] - -Combines two or more arrays. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `...items` | [`ConcatArray`](verida_vda_name_client._internal_.ConcatArray.md)<`any`\>[] | Additional items to add to the end of array1. | - -#### Returns - -`any`[] - -#### Inherited from - -ReadonlyArray.concat - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1103 - -▸ **concat**(...`items`): `any`[] - -Combines two or more arrays. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `...items` | `any`[] | Additional items to add to the end of array1. | - -#### Returns - -`any`[] - -#### Inherited from - -ReadonlyArray.concat - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1108 - -___ - -### entries - -▸ **entries**(): [`IterableIterator`](verida_vda_name_client._internal_.IterableIterator.md)<[`number`, `any`]\> - -Returns an iterable of key, value pairs for every entry in the array - -#### Returns - -[`IterableIterator`](verida_vda_name_client._internal_.IterableIterator.md)<[`number`, `any`]\> - -#### Inherited from - -ReadonlyArray.entries - -#### Defined in - -node_modules/typescript/lib/lib.es2015.iterable.d.ts:101 - -___ - -### every - -▸ **every**<`S`\>(`predicate`, `thisArg?`): this is readonly S[] - -Determines whether all the members of an array satisfy the specified test. - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `S` | extends `any` | - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `predicate` | (`value`: `any`, `index`: `number`, `array`: readonly `any`[]) => value is S | A function that accepts up to three arguments. The every method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value false, or until the end of the array. | -| `thisArg?` | `any` | An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value. | - -#### Returns - -this is readonly S[] - -#### Inherited from - -ReadonlyArray.every - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1140 - -▸ **every**(`predicate`, `thisArg?`): `boolean` - -Determines whether all the members of an array satisfy the specified test. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `predicate` | (`value`: `any`, `index`: `number`, `array`: readonly `any`[]) => `unknown` | A function that accepts up to three arguments. The every method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value false, or until the end of the array. | -| `thisArg?` | `any` | An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value. | - -#### Returns - -`boolean` - -#### Inherited from - -ReadonlyArray.every - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1149 - -___ - -### filter - -▸ **filter**<`S`\>(`predicate`, `thisArg?`): `S`[] - -Returns the elements of an array that meet the condition specified in a callback function. - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `S` | extends `any` | - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `predicate` | (`value`: `any`, `index`: `number`, `array`: readonly `any`[]) => value is S | A function that accepts up to three arguments. The filter method calls the predicate function one time for each element in the array. | -| `thisArg?` | `any` | An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value. | - -#### Returns - -`S`[] - -#### Inherited from - -ReadonlyArray.filter - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1176 - -▸ **filter**(`predicate`, `thisArg?`): `any`[] - -Returns the elements of an array that meet the condition specified in a callback function. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `predicate` | (`value`: `any`, `index`: `number`, `array`: readonly `any`[]) => `unknown` | A function that accepts up to three arguments. The filter method calls the predicate function one time for each element in the array. | -| `thisArg?` | `any` | An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value. | - -#### Returns - -`any`[] - -#### Inherited from - -ReadonlyArray.filter - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1182 - -___ - -### find - -▸ **find**<`S`\>(`predicate`, `thisArg?`): `undefined` \| `S` - -Returns the value of the first element in the array where predicate is true, and undefined -otherwise. - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `S` | extends `any` | - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `predicate` | (`value`: `any`, `index`: `number`, `obj`: readonly `any`[]) => value is S | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined. | -| `thisArg?` | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. | - -#### Returns - -`undefined` \| `S` - -#### Inherited from - -ReadonlyArray.find - -#### Defined in - -node_modules/typescript/lib/lib.es2015.core.d.ts:352 - -▸ **find**(`predicate`, `thisArg?`): `any` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `predicate` | (`value`: `any`, `index`: `number`, `obj`: readonly `any`[]) => `unknown` | -| `thisArg?` | `any` | - -#### Returns - -`any` - -#### Inherited from - -ReadonlyArray.find - -#### Defined in - -node_modules/typescript/lib/lib.es2015.core.d.ts:353 - -___ - -### findIndex - -▸ **findIndex**(`predicate`, `thisArg?`): `number` - -Returns the index of the first element in the array where predicate is true, and -1 -otherwise. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `predicate` | (`value`: `any`, `index`: `number`, `obj`: readonly `any`[]) => `unknown` | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1. | -| `thisArg?` | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. | - -#### Returns - -`number` - -#### Inherited from - -ReadonlyArray.findIndex - -#### Defined in - -node_modules/typescript/lib/lib.es2015.core.d.ts:364 - -___ - -### flat - -▸ **flat**<`A`, `D`\>(`depth?`): [`FlatArray`](../modules/verida_vda_name_client._internal_.md#flatarray)<`A`, `D`\>[] - -Returns a new array with all sub-array elements concatenated into it recursively up to the -specified depth. - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `A` | `A` | -| `D` | extends `number` = ``1`` | - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `depth?` | `D` | The maximum recursion depth | - -#### Returns - -[`FlatArray`](../modules/verida_vda_name_client._internal_.md#flatarray)<`A`, `D`\>[] - -#### Inherited from - -ReadonlyArray.flat - -#### Defined in - -node_modules/typescript/lib/lib.es2019.array.d.ts:52 - -___ - -### flatMap - -▸ **flatMap**<`U`, `This`\>(`callback`, `thisArg?`): `U`[] - -Calls a defined callback function on each element of an array. Then, flattens the result into -a new array. -This is identical to a map followed by flat with depth 1. - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `U` | `U` | -| `This` | `undefined` | - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `callback` | (`value`: `any`, `index`: `number`, `array`: `any`[]) => `U` \| readonly `U`[] | A function that accepts up to three arguments. The flatMap method calls the callback function one time for each element in the array. | -| `thisArg?` | `This` | An object to which the this keyword can refer in the callback function. If thisArg is omitted, undefined is used as the this value. | - -#### Returns - -`U`[] - -#### Inherited from - -ReadonlyArray.flatMap - -#### Defined in - -node_modules/typescript/lib/lib.es2019.array.d.ts:40 - -___ - -### forEach - -▸ **forEach**(`callbackfn`, `thisArg?`): `void` - -Performs the specified action for each element in an array. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `callbackfn` | (`value`: `any`, `index`: `number`, `array`: readonly `any`[]) => `void` | A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array. | -| `thisArg?` | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -#### Returns - -`void` - -#### Inherited from - -ReadonlyArray.forEach - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1164 - -___ - -### includes - -▸ **includes**(`searchElement`, `fromIndex?`): `boolean` - -Determines whether an array includes a certain element, returning true or false as appropriate. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `searchElement` | `any` | The element to search for. | -| `fromIndex?` | `number` | The position in this array at which to begin searching for searchElement. | - -#### Returns - -`boolean` - -#### Inherited from - -ReadonlyArray.includes - -#### Defined in - -node_modules/typescript/lib/lib.es2016.array.include.d.ts:36 - -___ - -### indexOf - -▸ **indexOf**(`searchElement`, `fromIndex?`): `number` - -Returns the index of the first occurrence of a value in an array. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `searchElement` | `any` | The value to locate in the array. | -| `fromIndex?` | `number` | The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0. | - -#### Returns - -`number` - -#### Inherited from - -ReadonlyArray.indexOf - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1125 - -___ - -### join - -▸ **join**(`separator?`): `string` - -Adds all the elements of an array separated by the specified separator string. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `separator?` | `string` | A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma. | - -#### Returns - -`string` - -#### Inherited from - -ReadonlyArray.join - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1113 - -___ - -### keys - -▸ **keys**(): [`IterableIterator`](verida_vda_name_client._internal_.IterableIterator.md)<`number`\> - -Returns an iterable of keys in the array - -#### Returns - -[`IterableIterator`](verida_vda_name_client._internal_.IterableIterator.md)<`number`\> - -#### Inherited from - -ReadonlyArray.keys - -#### Defined in - -node_modules/typescript/lib/lib.es2015.iterable.d.ts:106 - -___ - -### lastIndexOf - -▸ **lastIndexOf**(`searchElement`, `fromIndex?`): `number` - -Returns the index of the last occurrence of a specified value in an array. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `searchElement` | `any` | The value to locate in the array. | -| `fromIndex?` | `number` | The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array. | - -#### Returns - -`number` - -#### Inherited from - -ReadonlyArray.lastIndexOf - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1131 - -___ - -### map - -▸ **map**<`U`\>(`callbackfn`, `thisArg?`): `U`[] - -Calls a defined callback function on each element of an array, and returns an array that contains the results. - -#### Type parameters - -| Name | -| :------ | -| `U` | - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `callbackfn` | (`value`: `any`, `index`: `number`, `array`: readonly `any`[]) => `U` | A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array. | -| `thisArg?` | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -#### Returns - -`U`[] - -#### Inherited from - -ReadonlyArray.map - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1170 - -___ - -### reduce - -▸ **reduce**(`callbackfn`): `any` - -Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `callbackfn` | (`previousValue`: `any`, `currentValue`: `any`, `currentIndex`: `number`, `array`: readonly `any`[]) => `any` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. | - -#### Returns - -`any` - -#### Inherited from - -ReadonlyArray.reduce - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1188 - -▸ **reduce**(`callbackfn`, `initialValue`): `any` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `callbackfn` | (`previousValue`: `any`, `currentValue`: `any`, `currentIndex`: `number`, `array`: readonly `any`[]) => `any` | -| `initialValue` | `any` | - -#### Returns - -`any` - -#### Inherited from - -ReadonlyArray.reduce - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1189 - -▸ **reduce**<`U`\>(`callbackfn`, `initialValue`): `U` - -Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -#### Type parameters - -| Name | -| :------ | -| `U` | - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `callbackfn` | (`previousValue`: `U`, `currentValue`: `any`, `currentIndex`: `number`, `array`: readonly `any`[]) => `U` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. | -| `initialValue` | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. | - -#### Returns - -`U` - -#### Inherited from - -ReadonlyArray.reduce - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1195 - -___ - -### reduceRight - -▸ **reduceRight**(`callbackfn`): `any` - -Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `callbackfn` | (`previousValue`: `any`, `currentValue`: `any`, `currentIndex`: `number`, `array`: readonly `any`[]) => `any` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. | - -#### Returns - -`any` - -#### Inherited from - -ReadonlyArray.reduceRight - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1201 - -▸ **reduceRight**(`callbackfn`, `initialValue`): `any` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `callbackfn` | (`previousValue`: `any`, `currentValue`: `any`, `currentIndex`: `number`, `array`: readonly `any`[]) => `any` | -| `initialValue` | `any` | - -#### Returns - -`any` - -#### Inherited from - -ReadonlyArray.reduceRight - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1202 - -▸ **reduceRight**<`U`\>(`callbackfn`, `initialValue`): `U` - -Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -#### Type parameters - -| Name | -| :------ | -| `U` | - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `callbackfn` | (`previousValue`: `U`, `currentValue`: `any`, `currentIndex`: `number`, `array`: readonly `any`[]) => `U` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. | -| `initialValue` | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. | - -#### Returns - -`U` - -#### Inherited from - -ReadonlyArray.reduceRight - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1208 - -___ - -### slice - -▸ **slice**(`start?`, `end?`): `any`[] - -Returns a section of an array. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `start?` | `number` | The beginning of the specified portion of the array. | -| `end?` | `number` | The end of the specified portion of the array. This is exclusive of the element at the index 'end'. | - -#### Returns - -`any`[] - -#### Inherited from - -ReadonlyArray.slice - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1119 - -___ - -### some - -▸ **some**(`predicate`, `thisArg?`): `boolean` - -Determines whether the specified callback function returns true for any element of an array. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `predicate` | (`value`: `any`, `index`: `number`, `array`: readonly `any`[]) => `unknown` | A function that accepts up to three arguments. The some method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value true, or until the end of the array. | -| `thisArg?` | `any` | An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value. | - -#### Returns - -`boolean` - -#### Inherited from - -ReadonlyArray.some - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1158 - -___ - -### toLocaleString - -▸ **toLocaleString**(): `string` - -Returns a string representation of an array. The elements are converted to string using their toLocaleString methods. - -#### Returns - -`string` - -#### Inherited from - -ReadonlyArray.toLocaleString - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1098 - -___ - -### toString - -▸ **toString**(): `string` - -Returns a string representation of an array. - -#### Returns - -`string` - -#### Inherited from - -ReadonlyArray.toString - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1094 - -___ - -### values - -▸ **values**(): [`IterableIterator`](verida_vda_name_client._internal_.IterableIterator.md)<`any`\> - -Returns an iterable of values in the array - -#### Returns - -[`IterableIterator`](verida_vda_name_client._internal_.IterableIterator.md)<`any`\> - -#### Inherited from - -ReadonlyArray.values - -#### Defined in - -node_modules/typescript/lib/lib.es2015.iterable.d.ts:111 diff --git a/docs/api/verida-js/interfaces/verida_vda_name_client._internal_.Transaction.md b/docs/api/verida-js/interfaces/verida_vda_name_client._internal_.Transaction.md deleted file mode 100644 index 197cbff..0000000 --- a/docs/api/verida-js/interfaces/verida_vda_name_client._internal_.Transaction.md +++ /dev/null @@ -1,192 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-name-client](../modules/verida_vda_name_client.md) / [](../modules/verida_vda_name_client._internal_.md) / Transaction - -# Interface: Transaction - -[@verida/vda-name-client](../modules/verida_vda_name_client.md).[](../modules/verida_vda_name_client._internal_.md).Transaction - -## Hierarchy - -- **`Transaction`** - - ↳ [`TransactionResponse`](verida_vda_name_client._internal_.TransactionResponse.md) - -## Table of contents - -### Properties - -- [accessList](verida_vda_name_client._internal_.Transaction.md#accesslist) -- [chainId](verida_vda_name_client._internal_.Transaction.md#chainid) -- [data](verida_vda_name_client._internal_.Transaction.md#data) -- [from](verida_vda_name_client._internal_.Transaction.md#from) -- [gasLimit](verida_vda_name_client._internal_.Transaction.md#gaslimit) -- [gasPrice](verida_vda_name_client._internal_.Transaction.md#gasprice) -- [hash](verida_vda_name_client._internal_.Transaction.md#hash) -- [maxFeePerGas](verida_vda_name_client._internal_.Transaction.md#maxfeepergas) -- [maxPriorityFeePerGas](verida_vda_name_client._internal_.Transaction.md#maxpriorityfeepergas) -- [nonce](verida_vda_name_client._internal_.Transaction.md#nonce) -- [r](verida_vda_name_client._internal_.Transaction.md#r) -- [s](verida_vda_name_client._internal_.Transaction.md#s) -- [to](verida_vda_name_client._internal_.Transaction.md#to) -- [type](verida_vda_name_client._internal_.Transaction.md#type) -- [v](verida_vda_name_client._internal_.Transaction.md#v) -- [value](verida_vda_name_client._internal_.Transaction.md#value) - -## Properties - -### accessList - -• `Optional` **accessList**: [`AccessList`](../modules/verida_vda_name_client._internal_.md#accesslist) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:40 - -___ - -### chainId - -• **chainId**: `number` - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:35 - -___ - -### data - -• **data**: `string` - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:33 - -___ - -### from - -• `Optional` **from**: `string` - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:29 - -___ - -### gasLimit - -• **gasLimit**: [`BigNumber`](../classes/verida_vda_name_client._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:31 - -___ - -### gasPrice - -• `Optional` **gasPrice**: [`BigNumber`](../classes/verida_vda_name_client._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:32 - -___ - -### hash - -• `Optional` **hash**: `string` - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:27 - -___ - -### maxFeePerGas - -• `Optional` **maxFeePerGas**: [`BigNumber`](../classes/verida_vda_name_client._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:42 - -___ - -### maxPriorityFeePerGas - -• `Optional` **maxPriorityFeePerGas**: [`BigNumber`](../classes/verida_vda_name_client._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:41 - -___ - -### nonce - -• **nonce**: `number` - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:30 - -___ - -### r - -• `Optional` **r**: `string` - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:36 - -___ - -### s - -• `Optional` **s**: `string` - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:37 - -___ - -### to - -• `Optional` **to**: `string` - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:28 - -___ - -### type - -• `Optional` **type**: ``null`` \| `number` - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:39 - -___ - -### v - -• `Optional` **v**: `number` - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:38 - -___ - -### value - -• **value**: [`BigNumber`](../classes/verida_vda_name_client._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:34 diff --git a/docs/api/verida-js/interfaces/verida_vda_name_client._internal_.TransactionReceipt.md b/docs/api/verida-js/interfaces/verida_vda_name_client._internal_.TransactionReceipt.md deleted file mode 100644 index 5b47644..0000000 --- a/docs/api/verida-js/interfaces/verida_vda_name_client._internal_.TransactionReceipt.md +++ /dev/null @@ -1,197 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-name-client](../modules/verida_vda_name_client.md) / [](../modules/verida_vda_name_client._internal_.md) / TransactionReceipt - -# Interface: TransactionReceipt - -[@verida/vda-name-client](../modules/verida_vda_name_client.md).[](../modules/verida_vda_name_client._internal_.md).TransactionReceipt - -## Table of contents - -### Properties - -- [blockHash](verida_vda_name_client._internal_.TransactionReceipt.md#blockhash) -- [blockNumber](verida_vda_name_client._internal_.TransactionReceipt.md#blocknumber) -- [byzantium](verida_vda_name_client._internal_.TransactionReceipt.md#byzantium) -- [confirmations](verida_vda_name_client._internal_.TransactionReceipt.md#confirmations) -- [contractAddress](verida_vda_name_client._internal_.TransactionReceipt.md#contractaddress) -- [cumulativeGasUsed](verida_vda_name_client._internal_.TransactionReceipt.md#cumulativegasused) -- [effectiveGasPrice](verida_vda_name_client._internal_.TransactionReceipt.md#effectivegasprice) -- [from](verida_vda_name_client._internal_.TransactionReceipt.md#from) -- [gasUsed](verida_vda_name_client._internal_.TransactionReceipt.md#gasused) -- [logs](verida_vda_name_client._internal_.TransactionReceipt.md#logs) -- [logsBloom](verida_vda_name_client._internal_.TransactionReceipt.md#logsbloom) -- [root](verida_vda_name_client._internal_.TransactionReceipt.md#root) -- [status](verida_vda_name_client._internal_.TransactionReceipt.md#status) -- [to](verida_vda_name_client._internal_.TransactionReceipt.md#to) -- [transactionHash](verida_vda_name_client._internal_.TransactionReceipt.md#transactionhash) -- [transactionIndex](verida_vda_name_client._internal_.TransactionReceipt.md#transactionindex) -- [type](verida_vda_name_client._internal_.TransactionReceipt.md#type) - -## Properties - -### blockHash - -• **blockHash**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:73 - -___ - -### blockNumber - -• **blockNumber**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:76 - -___ - -### byzantium - -• **byzantium**: `boolean` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:80 - -___ - -### confirmations - -• **confirmations**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:77 - -___ - -### contractAddress - -• **contractAddress**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:68 - -___ - -### cumulativeGasUsed - -• **cumulativeGasUsed**: [`BigNumber`](../classes/verida_vda_name_client._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:78 - -___ - -### effectiveGasPrice - -• **effectiveGasPrice**: [`BigNumber`](../classes/verida_vda_name_client._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:79 - -___ - -### from - -• **from**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:67 - -___ - -### gasUsed - -• **gasUsed**: [`BigNumber`](../classes/verida_vda_name_client._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:71 - -___ - -### logs - -• **logs**: [`Log`](verida_vda_name_client._internal_.Log.md)[] - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:75 - -___ - -### logsBloom - -• **logsBloom**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:72 - -___ - -### root - -• `Optional` **root**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:70 - -___ - -### status - -• `Optional` **status**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:82 - -___ - -### to - -• **to**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:66 - -___ - -### transactionHash - -• **transactionHash**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:74 - -___ - -### transactionIndex - -• **transactionIndex**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:69 - -___ - -### type - -• **type**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:81 diff --git a/docs/api/verida-js/interfaces/verida_vda_name_client._internal_.TransactionResponse.md b/docs/api/verida-js/interfaces/verida_vda_name_client._internal_.TransactionResponse.md deleted file mode 100644 index b456121..0000000 --- a/docs/api/verida-js/interfaces/verida_vda_name_client._internal_.TransactionResponse.md +++ /dev/null @@ -1,335 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-name-client](../modules/verida_vda_name_client.md) / [](../modules/verida_vda_name_client._internal_.md) / TransactionResponse - -# Interface: TransactionResponse - -[@verida/vda-name-client](../modules/verida_vda_name_client.md).[](../modules/verida_vda_name_client._internal_.md).TransactionResponse - -## Hierarchy - -- [`Transaction`](verida_vda_name_client._internal_.Transaction.md) - - ↳ **`TransactionResponse`** - -## Table of contents - -### Properties - -- [accessList](verida_vda_name_client._internal_.TransactionResponse.md#accesslist) -- [blockHash](verida_vda_name_client._internal_.TransactionResponse.md#blockhash) -- [blockNumber](verida_vda_name_client._internal_.TransactionResponse.md#blocknumber) -- [chainId](verida_vda_name_client._internal_.TransactionResponse.md#chainid) -- [confirmations](verida_vda_name_client._internal_.TransactionResponse.md#confirmations) -- [data](verida_vda_name_client._internal_.TransactionResponse.md#data) -- [from](verida_vda_name_client._internal_.TransactionResponse.md#from) -- [gasLimit](verida_vda_name_client._internal_.TransactionResponse.md#gaslimit) -- [gasPrice](verida_vda_name_client._internal_.TransactionResponse.md#gasprice) -- [hash](verida_vda_name_client._internal_.TransactionResponse.md#hash) -- [maxFeePerGas](verida_vda_name_client._internal_.TransactionResponse.md#maxfeepergas) -- [maxPriorityFeePerGas](verida_vda_name_client._internal_.TransactionResponse.md#maxpriorityfeepergas) -- [nonce](verida_vda_name_client._internal_.TransactionResponse.md#nonce) -- [r](verida_vda_name_client._internal_.TransactionResponse.md#r) -- [raw](verida_vda_name_client._internal_.TransactionResponse.md#raw) -- [s](verida_vda_name_client._internal_.TransactionResponse.md#s) -- [timestamp](verida_vda_name_client._internal_.TransactionResponse.md#timestamp) -- [to](verida_vda_name_client._internal_.TransactionResponse.md#to) -- [type](verida_vda_name_client._internal_.TransactionResponse.md#type) -- [v](verida_vda_name_client._internal_.TransactionResponse.md#v) -- [value](verida_vda_name_client._internal_.TransactionResponse.md#value) - -### Methods - -- [wait](verida_vda_name_client._internal_.TransactionResponse.md#wait) - -## Properties - -### accessList - -• `Optional` **accessList**: [`AccessList`](../modules/verida_vda_name_client._internal_.md#accesslist) - -#### Inherited from - -[Transaction](verida_vda_name_client._internal_.Transaction.md).[accessList](verida_vda_name_client._internal_.Transaction.md#accesslist) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:40 - -___ - -### blockHash - -• `Optional` **blockHash**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:26 - -___ - -### blockNumber - -• `Optional` **blockNumber**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:25 - -___ - -### chainId - -• **chainId**: `number` - -#### Inherited from - -[Transaction](verida_vda_name_client._internal_.Transaction.md).[chainId](verida_vda_name_client._internal_.Transaction.md#chainid) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:35 - -___ - -### confirmations - -• **confirmations**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:28 - -___ - -### data - -• **data**: `string` - -#### Inherited from - -[Transaction](verida_vda_name_client._internal_.Transaction.md).[data](verida_vda_name_client._internal_.Transaction.md#data) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:33 - -___ - -### from - -• **from**: `string` - -#### Overrides - -[Transaction](verida_vda_name_client._internal_.Transaction.md).[from](verida_vda_name_client._internal_.Transaction.md#from) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:29 - -___ - -### gasLimit - -• **gasLimit**: [`BigNumber`](../classes/verida_vda_name_client._internal_.BigNumber.md) - -#### Inherited from - -[Transaction](verida_vda_name_client._internal_.Transaction.md).[gasLimit](verida_vda_name_client._internal_.Transaction.md#gaslimit) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:31 - -___ - -### gasPrice - -• `Optional` **gasPrice**: [`BigNumber`](../classes/verida_vda_name_client._internal_.BigNumber.md) - -#### Inherited from - -[Transaction](verida_vda_name_client._internal_.Transaction.md).[gasPrice](verida_vda_name_client._internal_.Transaction.md#gasprice) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:32 - -___ - -### hash - -• **hash**: `string` - -#### Overrides - -[Transaction](verida_vda_name_client._internal_.Transaction.md).[hash](verida_vda_name_client._internal_.Transaction.md#hash) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:24 - -___ - -### maxFeePerGas - -• `Optional` **maxFeePerGas**: [`BigNumber`](../classes/verida_vda_name_client._internal_.BigNumber.md) - -#### Inherited from - -[Transaction](verida_vda_name_client._internal_.Transaction.md).[maxFeePerGas](verida_vda_name_client._internal_.Transaction.md#maxfeepergas) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:42 - -___ - -### maxPriorityFeePerGas - -• `Optional` **maxPriorityFeePerGas**: [`BigNumber`](../classes/verida_vda_name_client._internal_.BigNumber.md) - -#### Inherited from - -[Transaction](verida_vda_name_client._internal_.Transaction.md).[maxPriorityFeePerGas](verida_vda_name_client._internal_.Transaction.md#maxpriorityfeepergas) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:41 - -___ - -### nonce - -• **nonce**: `number` - -#### Inherited from - -[Transaction](verida_vda_name_client._internal_.Transaction.md).[nonce](verida_vda_name_client._internal_.Transaction.md#nonce) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:30 - -___ - -### r - -• `Optional` **r**: `string` - -#### Inherited from - -[Transaction](verida_vda_name_client._internal_.Transaction.md).[r](verida_vda_name_client._internal_.Transaction.md#r) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:36 - -___ - -### raw - -• `Optional` **raw**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:30 - -___ - -### s - -• `Optional` **s**: `string` - -#### Inherited from - -[Transaction](verida_vda_name_client._internal_.Transaction.md).[s](verida_vda_name_client._internal_.Transaction.md#s) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:37 - -___ - -### timestamp - -• `Optional` **timestamp**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:27 - -___ - -### to - -• `Optional` **to**: `string` - -#### Inherited from - -[Transaction](verida_vda_name_client._internal_.Transaction.md).[to](verida_vda_name_client._internal_.Transaction.md#to) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:28 - -___ - -### type - -• `Optional` **type**: ``null`` \| `number` - -#### Inherited from - -[Transaction](verida_vda_name_client._internal_.Transaction.md).[type](verida_vda_name_client._internal_.Transaction.md#type) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:39 - -___ - -### v - -• `Optional` **v**: `number` - -#### Inherited from - -[Transaction](verida_vda_name_client._internal_.Transaction.md).[v](verida_vda_name_client._internal_.Transaction.md#v) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:38 - -___ - -### value - -• **value**: [`BigNumber`](../classes/verida_vda_name_client._internal_.BigNumber.md) - -#### Inherited from - -[Transaction](verida_vda_name_client._internal_.Transaction.md).[value](verida_vda_name_client._internal_.Transaction.md#value) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:34 - -## Methods - -### wait - -▸ **wait**(`confirmations?`): `Promise`<[`TransactionReceipt`](verida_vda_name_client._internal_.TransactionReceipt.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `confirmations?` | `number` | - -#### Returns - -`Promise`<[`TransactionReceipt`](verida_vda_name_client._internal_.TransactionReceipt.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:31 diff --git a/docs/api/verida-js/interfaces/verida_vda_name_client._internal_.VdaClientConfig.md b/docs/api/verida-js/interfaces/verida_vda_name_client._internal_.VdaClientConfig.md deleted file mode 100644 index f076949..0000000 --- a/docs/api/verida-js/interfaces/verida_vda_name_client._internal_.VdaClientConfig.md +++ /dev/null @@ -1,77 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-name-client](../modules/verida_vda_name_client.md) / [](../modules/verida_vda_name_client._internal_.md) / VdaClientConfig - -# Interface: VdaClientConfig - -[@verida/vda-name-client](../modules/verida_vda_name_client.md).[](../modules/verida_vda_name_client._internal_.md).VdaClientConfig - -Interface for vda-xxx-client instance creation. - -**`param`** DID - -**`param`** private key of DID. Used to generate signature in transactions to chains - -**`param`** Target chain name or chain id. - -**`param`** : VDA-DID run mode. Values from vda-did-resolver - -**`param`** Web3 configuration depending on call type. Values from vda-did-resolver - -## Table of contents - -### Properties - -- [callType](verida_vda_name_client._internal_.VdaClientConfig.md#calltype) -- [did](verida_vda_name_client._internal_.VdaClientConfig.md#did) -- [network](verida_vda_name_client._internal_.VdaClientConfig.md#network) -- [signKey](verida_vda_name_client._internal_.VdaClientConfig.md#signkey) -- [web3Options](verida_vda_name_client._internal_.VdaClientConfig.md#web3options) - -## Properties - -### callType - -• `Optional` **callType**: [`Web3CallType`](../modules/verida_vda_name_client._internal_.md#web3calltype) - -#### Defined in - -packages/types/dist/VdaClientConfig.d.ts:15 - -___ - -### did - -• `Optional` **did**: `string` - -#### Defined in - -packages/types/dist/VdaClientConfig.d.ts:13 - -___ - -### network - -• **network**: [`EnvironmentType`](../enums/verida_vda_name_client._internal_.EnvironmentType.md) - -#### Defined in - -packages/types/dist/VdaClientConfig.d.ts:12 - -___ - -### signKey - -• `Optional` **signKey**: `string` - -#### Defined in - -packages/types/dist/VdaClientConfig.d.ts:14 - -___ - -### web3Options - -• `Optional` **web3Options**: [`Web3SelfTransactionConfig`](verida_vda_name_client._internal_.Web3SelfTransactionConfig.md) \| [`Web3MetaTransactionConfig`](verida_vda_name_client._internal_.Web3MetaTransactionConfig.md) - -#### Defined in - -packages/types/dist/VdaClientConfig.d.ts:16 diff --git a/docs/api/verida-js/interfaces/verida_vda_name_client._internal_.VdaTransactionResult.md b/docs/api/verida-js/interfaces/verida_vda_name_client._internal_.VdaTransactionResult.md deleted file mode 100644 index 866fb47..0000000 --- a/docs/api/verida-js/interfaces/verida_vda_name_client._internal_.VdaTransactionResult.md +++ /dev/null @@ -1,43 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-name-client](../modules/verida_vda_name_client.md) / [](../modules/verida_vda_name_client._internal_.md) / VdaTransactionResult - -# Interface: VdaTransactionResult - -[@verida/vda-name-client](../modules/verida_vda_name_client.md).[](../modules/verida_vda_name_client._internal_.md).VdaTransactionResult - -## Table of contents - -### Properties - -- [data](verida_vda_name_client._internal_.VdaTransactionResult.md#data) -- [error](verida_vda_name_client._internal_.VdaTransactionResult.md#error) -- [success](verida_vda_name_client._internal_.VdaTransactionResult.md#success) - -## Properties - -### data - -• `Optional` **data**: `any` - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:124 - -___ - -### error - -• `Optional` **error**: `string` - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:125 - -___ - -### success - -• **success**: `boolean` - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:123 diff --git a/docs/api/verida-js/interfaces/verida_vda_name_client._internal_.Web3ContractInfo.md b/docs/api/verida-js/interfaces/verida_vda_name_client._internal_.Web3ContractInfo.md deleted file mode 100644 index 8ce3e8f..0000000 --- a/docs/api/verida-js/interfaces/verida_vda_name_client._internal_.Web3ContractInfo.md +++ /dev/null @@ -1,45 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-name-client](../modules/verida_vda_name_client.md) / [](../modules/verida_vda_name_client._internal_.md) / Web3ContractInfo - -# Interface: Web3ContractInfo - -[@verida/vda-name-client](../modules/verida_vda_name_client.md).[](../modules/verida_vda_name_client._internal_.md).Web3ContractInfo - -Contract Info. Used for 'web3' mode - -## Table of contents - -### Properties - -- [abi](verida_vda_name_client._internal_.Web3ContractInfo.md#abi) -- [address](verida_vda_name_client._internal_.Web3ContractInfo.md#address) -- [logPerformance](verida_vda_name_client._internal_.Web3ContractInfo.md#logperformance) - -## Properties - -### abi - -• **abi**: `any` - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:8 - -___ - -### address - -• **address**: `string` - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:9 - -___ - -### logPerformance - -• `Optional` **logPerformance**: `boolean` - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:10 diff --git a/docs/api/verida-js/interfaces/verida_vda_name_client._internal_.Web3GasConfiguration.md b/docs/api/verida-js/interfaces/verida_vda_name_client._internal_.Web3GasConfiguration.md deleted file mode 100644 index a099ea4..0000000 --- a/docs/api/verida-js/interfaces/verida_vda_name_client._internal_.Web3GasConfiguration.md +++ /dev/null @@ -1,91 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-name-client](../modules/verida_vda_name_client.md) / [](../modules/verida_vda_name_client._internal_.md) / Web3GasConfiguration - -# Interface: Web3GasConfiguration - -[@verida/vda-name-client](../modules/verida_vda_name_client.md).[](../modules/verida_vda_name_client._internal_.md).Web3GasConfiguration - -Gas configuration - -eip1559Mode - optional - Once this parameter is set, all other parameters are not used. Gas information is pulled from network. - -maxFeePerGas - optional - Used for EIP1559 chains -maxPriorityFeePerGas - optional - Used for EIP1559 chains -gasLimit - optional - Used for non EIP1559 chains -gasPrice - optional - Used for non EIP1559 chains - -## Hierarchy - -- **`Web3GasConfiguration`** - - ↳ [`Web3SelfTransactionConfig`](verida_vda_name_client._internal_.Web3SelfTransactionConfig.md) - -## Table of contents - -### Properties - -- [eip1559Mode](verida_vda_name_client._internal_.Web3GasConfiguration.md#eip1559mode) -- [eip1559gasStationUrl](verida_vda_name_client._internal_.Web3GasConfiguration.md#eip1559gasstationurl) -- [gasLimit](verida_vda_name_client._internal_.Web3GasConfiguration.md#gaslimit) -- [gasPrice](verida_vda_name_client._internal_.Web3GasConfiguration.md#gasprice) -- [maxFeePerGas](verida_vda_name_client._internal_.Web3GasConfiguration.md#maxfeepergas) -- [maxPriorityFeePerGas](verida_vda_name_client._internal_.Web3GasConfiguration.md#maxpriorityfeepergas) - -## Properties - -### eip1559Mode - -• `Optional` **eip1559Mode**: [`EIP1559GasMode`](../modules/verida_vda_name_client._internal_.md#eip1559gasmode) - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:24 - -___ - -### eip1559gasStationUrl - -• `Optional` **eip1559gasStationUrl**: `string` - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:25 - -___ - -### gasLimit - -• `Optional` **gasLimit**: [`BigNumber`](../classes/verida_vda_name_client._internal_.BigNumber.md) - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:28 - -___ - -### gasPrice - -• `Optional` **gasPrice**: [`BigNumber`](../classes/verida_vda_name_client._internal_.BigNumber.md) - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:29 - -___ - -### maxFeePerGas - -• `Optional` **maxFeePerGas**: [`BigNumber`](../classes/verida_vda_name_client._internal_.BigNumber.md) - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:26 - -___ - -### maxPriorityFeePerGas - -• `Optional` **maxPriorityFeePerGas**: [`BigNumber`](../classes/verida_vda_name_client._internal_.BigNumber.md) - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:27 diff --git a/docs/api/verida-js/interfaces/verida_vda_name_client._internal_.Web3GaslessPostConfig.md b/docs/api/verida-js/interfaces/verida_vda_name_client._internal_.Web3GaslessPostConfig.md deleted file mode 100644 index 276c549..0000000 --- a/docs/api/verida-js/interfaces/verida_vda_name_client._internal_.Web3GaslessPostConfig.md +++ /dev/null @@ -1,37 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-name-client](../modules/verida_vda_name_client.md) / [](../modules/verida_vda_name_client._internal_.md) / Web3GaslessPostConfig - -# Interface: Web3GaslessPostConfig - -[@verida/vda-name-client](../modules/verida_vda_name_client.md).[](../modules/verida_vda_name_client._internal_.md).Web3GaslessPostConfig - -Configuration type for gasless post - -## Indexable - -▪ [key: `string`]: `any` - -## Table of contents - -### Properties - -- [headers](verida_vda_name_client._internal_.Web3GaslessPostConfig.md#headers) - -## Properties - -### headers - -• **headers**: `Object` - -#### Index signature - -▪ [key: `string`]: `any` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `user-agent` | `string` | - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:64 diff --git a/docs/api/verida-js/interfaces/verida_vda_name_client._internal_.Web3GaslessRequestConfig.md b/docs/api/verida-js/interfaces/verida_vda_name_client._internal_.Web3GaslessRequestConfig.md deleted file mode 100644 index 3525b53..0000000 --- a/docs/api/verida-js/interfaces/verida_vda_name_client._internal_.Web3GaslessRequestConfig.md +++ /dev/null @@ -1,37 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-name-client](../modules/verida_vda_name_client.md) / [](../modules/verida_vda_name_client._internal_.md) / Web3GaslessRequestConfig - -# Interface: Web3GaslessRequestConfig - -[@verida/vda-name-client](../modules/verida_vda_name_client.md).[](../modules/verida_vda_name_client._internal_.md).Web3GaslessRequestConfig - -Configuration type for gasless request - -## Indexable - -▪ [key: `string`]: `any` - -## Table of contents - -### Properties - -- [headers](verida_vda_name_client._internal_.Web3GaslessRequestConfig.md#headers) - -## Properties - -### headers - -• **headers**: `Object` - -#### Index signature - -▪ [key: `string`]: `any` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `context-name` | `string` | - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:56 diff --git a/docs/api/verida-js/interfaces/verida_vda_name_client._internal_.Web3MetaTransactionConfig.md b/docs/api/verida-js/interfaces/verida_vda_name_client._internal_.Web3MetaTransactionConfig.md deleted file mode 100644 index 190ad0e..0000000 --- a/docs/api/verida-js/interfaces/verida_vda_name_client._internal_.Web3MetaTransactionConfig.md +++ /dev/null @@ -1,45 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-name-client](../modules/verida_vda_name_client.md) / [](../modules/verida_vda_name_client._internal_.md) / Web3MetaTransactionConfig - -# Interface: Web3MetaTransactionConfig - -[@verida/vda-name-client](../modules/verida_vda_name_client.md).[](../modules/verida_vda_name_client._internal_.md).Web3MetaTransactionConfig - -Configuration type for gasless mode - -## Table of contents - -### Properties - -- [endpointUrl](verida_vda_name_client._internal_.Web3MetaTransactionConfig.md#endpointurl) -- [postConfig](verida_vda_name_client._internal_.Web3MetaTransactionConfig.md#postconfig) -- [serverConfig](verida_vda_name_client._internal_.Web3MetaTransactionConfig.md#serverconfig) - -## Properties - -### endpointUrl - -• **endpointUrl**: `string` - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:51 - -___ - -### postConfig - -• **postConfig**: [`Web3GaslessPostConfig`](verida_vda_name_client._internal_.Web3GaslessPostConfig.md) - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:50 - -___ - -### serverConfig - -• **serverConfig**: [`Web3GaslessRequestConfig`](verida_vda_name_client._internal_.Web3GaslessRequestConfig.md) - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:49 diff --git a/docs/api/verida-js/interfaces/verida_vda_name_client._internal_.Web3SelfTransactionConfig.md b/docs/api/verida-js/interfaces/verida_vda_name_client._internal_.Web3SelfTransactionConfig.md deleted file mode 100644 index d5512f9..0000000 --- a/docs/api/verida-js/interfaces/verida_vda_name_client._internal_.Web3SelfTransactionConfig.md +++ /dev/null @@ -1,179 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-name-client](../modules/verida_vda_name_client.md) / [](../modules/verida_vda_name_client._internal_.md) / Web3SelfTransactionConfig - -# Interface: Web3SelfTransactionConfig - -[@verida/vda-name-client](../modules/verida_vda_name_client.md).[](../modules/verida_vda_name_client._internal_.md).Web3SelfTransactionConfig - -Configuration type for Web3 mode - -signer - optional - a Signer that sign the blockchain transactions. If a 'signer' is not provided, then 'contract' with an attached signer need to be used to make transactions -provider - optional - a web3 provider. At least one of `signer`,`provider`, or `rpcUrl` is required -rpcUrl - optinal - a JSON-RPC URL that can be used to connect to an ethereum network. At least one of `signer`, `provider`, or `rpcUrl` is required -web3 - optional - Can use provider or web.currentProvider as a provider. - -## Hierarchy - -- [`Web3GasConfiguration`](verida_vda_name_client._internal_.Web3GasConfiguration.md) - - ↳ **`Web3SelfTransactionConfig`** - -## Table of contents - -### Properties - -- [eip1559Mode](verida_vda_name_client._internal_.Web3SelfTransactionConfig.md#eip1559mode) -- [eip1559gasStationUrl](verida_vda_name_client._internal_.Web3SelfTransactionConfig.md#eip1559gasstationurl) -- [gasLimit](verida_vda_name_client._internal_.Web3SelfTransactionConfig.md#gaslimit) -- [gasPrice](verida_vda_name_client._internal_.Web3SelfTransactionConfig.md#gasprice) -- [maxFeePerGas](verida_vda_name_client._internal_.Web3SelfTransactionConfig.md#maxfeepergas) -- [maxPriorityFeePerGas](verida_vda_name_client._internal_.Web3SelfTransactionConfig.md#maxpriorityfeepergas) -- [methodDefaults](verida_vda_name_client._internal_.Web3SelfTransactionConfig.md#methoddefaults) -- [privateKey](verida_vda_name_client._internal_.Web3SelfTransactionConfig.md#privatekey) -- [provider](verida_vda_name_client._internal_.Web3SelfTransactionConfig.md#provider) -- [rpcUrl](verida_vda_name_client._internal_.Web3SelfTransactionConfig.md#rpcurl) -- [signer](verida_vda_name_client._internal_.Web3SelfTransactionConfig.md#signer) -- [web3](verida_vda_name_client._internal_.Web3SelfTransactionConfig.md#web3) - -## Properties - -### eip1559Mode - -• `Optional` **eip1559Mode**: [`EIP1559GasMode`](../modules/verida_vda_name_client._internal_.md#eip1559gasmode) - -#### Inherited from - -[Web3GasConfiguration](verida_vda_name_client._internal_.Web3GasConfiguration.md).[eip1559Mode](verida_vda_name_client._internal_.Web3GasConfiguration.md#eip1559mode) - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:24 - -___ - -### eip1559gasStationUrl - -• `Optional` **eip1559gasStationUrl**: `string` - -#### Inherited from - -[Web3GasConfiguration](verida_vda_name_client._internal_.Web3GasConfiguration.md).[eip1559gasStationUrl](verida_vda_name_client._internal_.Web3GasConfiguration.md#eip1559gasstationurl) - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:25 - -___ - -### gasLimit - -• `Optional` **gasLimit**: [`BigNumber`](../classes/verida_vda_name_client._internal_.BigNumber.md) - -#### Inherited from - -[Web3GasConfiguration](verida_vda_name_client._internal_.Web3GasConfiguration.md).[gasLimit](verida_vda_name_client._internal_.Web3GasConfiguration.md#gaslimit) - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:28 - -___ - -### gasPrice - -• `Optional` **gasPrice**: [`BigNumber`](../classes/verida_vda_name_client._internal_.BigNumber.md) - -#### Inherited from - -[Web3GasConfiguration](verida_vda_name_client._internal_.Web3GasConfiguration.md).[gasPrice](verida_vda_name_client._internal_.Web3GasConfiguration.md#gasprice) - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:29 - -___ - -### maxFeePerGas - -• `Optional` **maxFeePerGas**: [`BigNumber`](../classes/verida_vda_name_client._internal_.BigNumber.md) - -#### Inherited from - -[Web3GasConfiguration](verida_vda_name_client._internal_.Web3GasConfiguration.md).[maxFeePerGas](verida_vda_name_client._internal_.Web3GasConfiguration.md#maxfeepergas) - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:26 - -___ - -### maxPriorityFeePerGas - -• `Optional` **maxPriorityFeePerGas**: [`BigNumber`](../classes/verida_vda_name_client._internal_.BigNumber.md) - -#### Inherited from - -[Web3GasConfiguration](verida_vda_name_client._internal_.Web3GasConfiguration.md).[maxPriorityFeePerGas](verida_vda_name_client._internal_.Web3GasConfiguration.md#maxpriorityfeepergas) - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:27 - -___ - -### methodDefaults - -• `Optional` **methodDefaults**: [`Record`](../modules/verida_vda_name_client._internal_.md#record)<`string`, [`Web3GasConfiguration`](verida_vda_name_client._internal_.Web3GasConfiguration.md)\> - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:45 - -___ - -### privateKey - -• `Optional` **privateKey**: `string` - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:41 - -___ - -### provider - -• `Optional` **provider**: [`Provider`](../classes/verida_vda_name_client._internal_.Provider.md) - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:42 - -___ - -### rpcUrl - -• `Optional` **rpcUrl**: `string` - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:43 - -___ - -### signer - -• `Optional` **signer**: [`Signer`](../classes/verida_vda_name_client._internal_.Signer.md) - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:40 - -___ - -### web3 - -• `Optional` **web3**: `any` - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:44 diff --git a/docs/api/verida-js/interfaces/verida_vda_name_client._internal_._Block.md b/docs/api/verida-js/interfaces/verida_vda_name_client._internal_._Block.md deleted file mode 100644 index 3f0c459..0000000 --- a/docs/api/verida-js/interfaces/verida_vda_name_client._internal_._Block.md +++ /dev/null @@ -1,150 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-name-client](../modules/verida_vda_name_client.md) / [](../modules/verida_vda_name_client._internal_.md) / \_Block - -# Interface: \_Block - -[@verida/vda-name-client](../modules/verida_vda_name_client.md).[](../modules/verida_vda_name_client._internal_.md)._Block - -## Hierarchy - -- **`_Block`** - - ↳ [`Block`](verida_vda_name_client._internal_.Block.md) - - ↳ [`BlockWithTransactions`](verida_vda_name_client._internal_.BlockWithTransactions.md) - -## Table of contents - -### Properties - -- [\_difficulty](verida_vda_name_client._internal_._Block.md#_difficulty) -- [baseFeePerGas](verida_vda_name_client._internal_._Block.md#basefeepergas) -- [difficulty](verida_vda_name_client._internal_._Block.md#difficulty) -- [extraData](verida_vda_name_client._internal_._Block.md#extradata) -- [gasLimit](verida_vda_name_client._internal_._Block.md#gaslimit) -- [gasUsed](verida_vda_name_client._internal_._Block.md#gasused) -- [hash](verida_vda_name_client._internal_._Block.md#hash) -- [miner](verida_vda_name_client._internal_._Block.md#miner) -- [nonce](verida_vda_name_client._internal_._Block.md#nonce) -- [number](verida_vda_name_client._internal_._Block.md#number) -- [parentHash](verida_vda_name_client._internal_._Block.md#parenthash) -- [timestamp](verida_vda_name_client._internal_._Block.md#timestamp) - -## Properties - -### \_difficulty - -• **\_difficulty**: [`BigNumber`](../classes/verida_vda_name_client._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:41 - -___ - -### baseFeePerGas - -• `Optional` **baseFeePerGas**: ``null`` \| [`BigNumber`](../classes/verida_vda_name_client._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:46 - -___ - -### difficulty - -• **difficulty**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:40 - -___ - -### extraData - -• **extraData**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:45 - -___ - -### gasLimit - -• **gasLimit**: [`BigNumber`](../classes/verida_vda_name_client._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:42 - -___ - -### gasUsed - -• **gasUsed**: [`BigNumber`](../classes/verida_vda_name_client._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:43 - -___ - -### hash - -• **hash**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:35 - -___ - -### miner - -• **miner**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:44 - -___ - -### nonce - -• **nonce**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:39 - -___ - -### number - -• **number**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:37 - -___ - -### parentHash - -• **parentHash**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:36 - -___ - -### timestamp - -• **timestamp**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:38 diff --git a/docs/api/verida-js/interfaces/verida_vda_sbt_client.SBTClientConfig.md b/docs/api/verida-js/interfaces/verida_vda_sbt_client.SBTClientConfig.md deleted file mode 100644 index 78c5ca3..0000000 --- a/docs/api/verida-js/interfaces/verida_vda_sbt_client.SBTClientConfig.md +++ /dev/null @@ -1,77 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-sbt-client](../modules/verida_vda_sbt_client.md) / SBTClientConfig - -# Interface: SBTClientConfig - -[@verida/vda-sbt-client](../modules/verida_vda_sbt_client.md).SBTClientConfig - -Interface for vda-sbt-client instance creation. Same as VDA-DID configuration - -**`param`** @string DID - -**`param`** @string Private key of DID (hex string). Used to generate signature in transactions to chains - -**`param`** @string Target chain name or chain id. - -**`param`** @string 'web3' | 'gasless' - -**`param`** object Web3 configuration depending on call type. Same as vda-did-resolver - -## Table of contents - -### Properties - -- [callType](verida_vda_sbt_client.SBTClientConfig.md#calltype) -- [did](verida_vda_sbt_client.SBTClientConfig.md#did) -- [network](verida_vda_sbt_client.SBTClientConfig.md#network) -- [signKey](verida_vda_sbt_client.SBTClientConfig.md#signkey) -- [web3Options](verida_vda_sbt_client.SBTClientConfig.md#web3options) - -## Properties - -### callType - -• `Optional` **callType**: [`Web3CallType`](../modules/verida_vda_sbt_client._internal_.md#web3calltype) - -#### Defined in - -[packages/vda-sbt-client/src/blockchain/blockchainApi.ts:30](https://github.com/verida/verida-js/blob/032961c/packages/vda-sbt-client/src/blockchain/blockchainApi.ts#L30) - -___ - -### did - -• `Optional` **did**: `string` - -#### Defined in - -[packages/vda-sbt-client/src/blockchain/blockchainApi.ts:28](https://github.com/verida/verida-js/blob/032961c/packages/vda-sbt-client/src/blockchain/blockchainApi.ts#L28) - -___ - -### network - -• **network**: [`EnvironmentType`](../enums/verida_vda_sbt_client._internal_.EnvironmentType.md) - -#### Defined in - -[packages/vda-sbt-client/src/blockchain/blockchainApi.ts:27](https://github.com/verida/verida-js/blob/032961c/packages/vda-sbt-client/src/blockchain/blockchainApi.ts#L27) - -___ - -### signKey - -• `Optional` **signKey**: `string` - -#### Defined in - -[packages/vda-sbt-client/src/blockchain/blockchainApi.ts:29](https://github.com/verida/verida-js/blob/032961c/packages/vda-sbt-client/src/blockchain/blockchainApi.ts#L29) - -___ - -### web3Options - -• `Optional` **web3Options**: [`Web3SelfTransactionConfig`](verida_vda_sbt_client._internal_.Web3SelfTransactionConfig.md) \| [`Web3MetaTransactionConfig`](verida_vda_sbt_client._internal_.Web3MetaTransactionConfig.md) - -#### Defined in - -[packages/vda-sbt-client/src/blockchain/blockchainApi.ts:31](https://github.com/verida/verida-js/blob/032961c/packages/vda-sbt-client/src/blockchain/blockchainApi.ts#L31) diff --git a/docs/api/verida-js/interfaces/verida_vda_sbt_client._internal_.ArrayLike.md b/docs/api/verida-js/interfaces/verida_vda_sbt_client._internal_.ArrayLike.md deleted file mode 100644 index 2895e35..0000000 --- a/docs/api/verida-js/interfaces/verida_vda_sbt_client._internal_.ArrayLike.md +++ /dev/null @@ -1,31 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-sbt-client](../modules/verida_vda_sbt_client.md) / [](../modules/verida_vda_sbt_client._internal_.md) / ArrayLike - -# Interface: ArrayLike - -[@verida/vda-sbt-client](../modules/verida_vda_sbt_client.md).[](../modules/verida_vda_sbt_client._internal_.md).ArrayLike - -## Type parameters - -| Name | -| :------ | -| `T` | - -## Indexable - -▪ [n: `number`]: `T` - -## Table of contents - -### Properties - -- [length](verida_vda_sbt_client._internal_.ArrayLike.md#length) - -## Properties - -### length - -• `Readonly` **length**: `number` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1464 diff --git a/docs/api/verida-js/interfaces/verida_vda_sbt_client._internal_.Block.md b/docs/api/verida-js/interfaces/verida_vda_sbt_client._internal_.Block.md deleted file mode 100644 index 4bbe267..0000000 --- a/docs/api/verida-js/interfaces/verida_vda_sbt_client._internal_.Block.md +++ /dev/null @@ -1,207 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-sbt-client](../modules/verida_vda_sbt_client.md) / [](../modules/verida_vda_sbt_client._internal_.md) / Block - -# Interface: Block - -[@verida/vda-sbt-client](../modules/verida_vda_sbt_client.md).[](../modules/verida_vda_sbt_client._internal_.md).Block - -## Hierarchy - -- [`_Block`](verida_vda_sbt_client._internal_._Block.md) - - ↳ **`Block`** - -## Table of contents - -### Properties - -- [\_difficulty](verida_vda_sbt_client._internal_.Block.md#_difficulty) -- [baseFeePerGas](verida_vda_sbt_client._internal_.Block.md#basefeepergas) -- [difficulty](verida_vda_sbt_client._internal_.Block.md#difficulty) -- [extraData](verida_vda_sbt_client._internal_.Block.md#extradata) -- [gasLimit](verida_vda_sbt_client._internal_.Block.md#gaslimit) -- [gasUsed](verida_vda_sbt_client._internal_.Block.md#gasused) -- [hash](verida_vda_sbt_client._internal_.Block.md#hash) -- [miner](verida_vda_sbt_client._internal_.Block.md#miner) -- [nonce](verida_vda_sbt_client._internal_.Block.md#nonce) -- [number](verida_vda_sbt_client._internal_.Block.md#number) -- [parentHash](verida_vda_sbt_client._internal_.Block.md#parenthash) -- [timestamp](verida_vda_sbt_client._internal_.Block.md#timestamp) -- [transactions](verida_vda_sbt_client._internal_.Block.md#transactions) - -## Properties - -### \_difficulty - -• **\_difficulty**: [`BigNumber`](../classes/verida_vda_sbt_client._internal_.BigNumber.md) - -#### Inherited from - -[_Block](verida_vda_sbt_client._internal_._Block.md).[_difficulty](verida_vda_sbt_client._internal_._Block.md#_difficulty) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:41 - -___ - -### baseFeePerGas - -• `Optional` **baseFeePerGas**: ``null`` \| [`BigNumber`](../classes/verida_vda_sbt_client._internal_.BigNumber.md) - -#### Inherited from - -[_Block](verida_vda_sbt_client._internal_._Block.md).[baseFeePerGas](verida_vda_sbt_client._internal_._Block.md#basefeepergas) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:46 - -___ - -### difficulty - -• **difficulty**: `number` - -#### Inherited from - -[_Block](verida_vda_sbt_client._internal_._Block.md).[difficulty](verida_vda_sbt_client._internal_._Block.md#difficulty) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:40 - -___ - -### extraData - -• **extraData**: `string` - -#### Inherited from - -[_Block](verida_vda_sbt_client._internal_._Block.md).[extraData](verida_vda_sbt_client._internal_._Block.md#extradata) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:45 - -___ - -### gasLimit - -• **gasLimit**: [`BigNumber`](../classes/verida_vda_sbt_client._internal_.BigNumber.md) - -#### Inherited from - -[_Block](verida_vda_sbt_client._internal_._Block.md).[gasLimit](verida_vda_sbt_client._internal_._Block.md#gaslimit) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:42 - -___ - -### gasUsed - -• **gasUsed**: [`BigNumber`](../classes/verida_vda_sbt_client._internal_.BigNumber.md) - -#### Inherited from - -[_Block](verida_vda_sbt_client._internal_._Block.md).[gasUsed](verida_vda_sbt_client._internal_._Block.md#gasused) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:43 - -___ - -### hash - -• **hash**: `string` - -#### Inherited from - -[_Block](verida_vda_sbt_client._internal_._Block.md).[hash](verida_vda_sbt_client._internal_._Block.md#hash) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:35 - -___ - -### miner - -• **miner**: `string` - -#### Inherited from - -[_Block](verida_vda_sbt_client._internal_._Block.md).[miner](verida_vda_sbt_client._internal_._Block.md#miner) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:44 - -___ - -### nonce - -• **nonce**: `string` - -#### Inherited from - -[_Block](verida_vda_sbt_client._internal_._Block.md).[nonce](verida_vda_sbt_client._internal_._Block.md#nonce) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:39 - -___ - -### number - -• **number**: `number` - -#### Inherited from - -[_Block](verida_vda_sbt_client._internal_._Block.md).[number](verida_vda_sbt_client._internal_._Block.md#number) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:37 - -___ - -### parentHash - -• **parentHash**: `string` - -#### Inherited from - -[_Block](verida_vda_sbt_client._internal_._Block.md).[parentHash](verida_vda_sbt_client._internal_._Block.md#parenthash) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:36 - -___ - -### timestamp - -• **timestamp**: `number` - -#### Inherited from - -[_Block](verida_vda_sbt_client._internal_._Block.md).[timestamp](verida_vda_sbt_client._internal_._Block.md#timestamp) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:38 - -___ - -### transactions - -• **transactions**: `string`[] - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:49 diff --git a/docs/api/verida-js/interfaces/verida_vda_sbt_client._internal_.BlockWithTransactions.md b/docs/api/verida-js/interfaces/verida_vda_sbt_client._internal_.BlockWithTransactions.md deleted file mode 100644 index 657dd7e..0000000 --- a/docs/api/verida-js/interfaces/verida_vda_sbt_client._internal_.BlockWithTransactions.md +++ /dev/null @@ -1,207 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-sbt-client](../modules/verida_vda_sbt_client.md) / [](../modules/verida_vda_sbt_client._internal_.md) / BlockWithTransactions - -# Interface: BlockWithTransactions - -[@verida/vda-sbt-client](../modules/verida_vda_sbt_client.md).[](../modules/verida_vda_sbt_client._internal_.md).BlockWithTransactions - -## Hierarchy - -- [`_Block`](verida_vda_sbt_client._internal_._Block.md) - - ↳ **`BlockWithTransactions`** - -## Table of contents - -### Properties - -- [\_difficulty](verida_vda_sbt_client._internal_.BlockWithTransactions.md#_difficulty) -- [baseFeePerGas](verida_vda_sbt_client._internal_.BlockWithTransactions.md#basefeepergas) -- [difficulty](verida_vda_sbt_client._internal_.BlockWithTransactions.md#difficulty) -- [extraData](verida_vda_sbt_client._internal_.BlockWithTransactions.md#extradata) -- [gasLimit](verida_vda_sbt_client._internal_.BlockWithTransactions.md#gaslimit) -- [gasUsed](verida_vda_sbt_client._internal_.BlockWithTransactions.md#gasused) -- [hash](verida_vda_sbt_client._internal_.BlockWithTransactions.md#hash) -- [miner](verida_vda_sbt_client._internal_.BlockWithTransactions.md#miner) -- [nonce](verida_vda_sbt_client._internal_.BlockWithTransactions.md#nonce) -- [number](verida_vda_sbt_client._internal_.BlockWithTransactions.md#number) -- [parentHash](verida_vda_sbt_client._internal_.BlockWithTransactions.md#parenthash) -- [timestamp](verida_vda_sbt_client._internal_.BlockWithTransactions.md#timestamp) -- [transactions](verida_vda_sbt_client._internal_.BlockWithTransactions.md#transactions) - -## Properties - -### \_difficulty - -• **\_difficulty**: [`BigNumber`](../classes/verida_vda_sbt_client._internal_.BigNumber.md) - -#### Inherited from - -[_Block](verida_vda_sbt_client._internal_._Block.md).[_difficulty](verida_vda_sbt_client._internal_._Block.md#_difficulty) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:41 - -___ - -### baseFeePerGas - -• `Optional` **baseFeePerGas**: ``null`` \| [`BigNumber`](../classes/verida_vda_sbt_client._internal_.BigNumber.md) - -#### Inherited from - -[_Block](verida_vda_sbt_client._internal_._Block.md).[baseFeePerGas](verida_vda_sbt_client._internal_._Block.md#basefeepergas) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:46 - -___ - -### difficulty - -• **difficulty**: `number` - -#### Inherited from - -[_Block](verida_vda_sbt_client._internal_._Block.md).[difficulty](verida_vda_sbt_client._internal_._Block.md#difficulty) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:40 - -___ - -### extraData - -• **extraData**: `string` - -#### Inherited from - -[_Block](verida_vda_sbt_client._internal_._Block.md).[extraData](verida_vda_sbt_client._internal_._Block.md#extradata) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:45 - -___ - -### gasLimit - -• **gasLimit**: [`BigNumber`](../classes/verida_vda_sbt_client._internal_.BigNumber.md) - -#### Inherited from - -[_Block](verida_vda_sbt_client._internal_._Block.md).[gasLimit](verida_vda_sbt_client._internal_._Block.md#gaslimit) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:42 - -___ - -### gasUsed - -• **gasUsed**: [`BigNumber`](../classes/verida_vda_sbt_client._internal_.BigNumber.md) - -#### Inherited from - -[_Block](verida_vda_sbt_client._internal_._Block.md).[gasUsed](verida_vda_sbt_client._internal_._Block.md#gasused) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:43 - -___ - -### hash - -• **hash**: `string` - -#### Inherited from - -[_Block](verida_vda_sbt_client._internal_._Block.md).[hash](verida_vda_sbt_client._internal_._Block.md#hash) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:35 - -___ - -### miner - -• **miner**: `string` - -#### Inherited from - -[_Block](verida_vda_sbt_client._internal_._Block.md).[miner](verida_vda_sbt_client._internal_._Block.md#miner) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:44 - -___ - -### nonce - -• **nonce**: `string` - -#### Inherited from - -[_Block](verida_vda_sbt_client._internal_._Block.md).[nonce](verida_vda_sbt_client._internal_._Block.md#nonce) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:39 - -___ - -### number - -• **number**: `number` - -#### Inherited from - -[_Block](verida_vda_sbt_client._internal_._Block.md).[number](verida_vda_sbt_client._internal_._Block.md#number) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:37 - -___ - -### parentHash - -• **parentHash**: `string` - -#### Inherited from - -[_Block](verida_vda_sbt_client._internal_._Block.md).[parentHash](verida_vda_sbt_client._internal_._Block.md#parenthash) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:36 - -___ - -### timestamp - -• **timestamp**: `number` - -#### Inherited from - -[_Block](verida_vda_sbt_client._internal_._Block.md).[timestamp](verida_vda_sbt_client._internal_._Block.md#timestamp) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:38 - -___ - -### transactions - -• **transactions**: [`TransactionResponse`](verida_vda_sbt_client._internal_.TransactionResponse.md)[] - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:52 diff --git a/docs/api/verida-js/interfaces/verida_vda_sbt_client._internal_.ConcatArray.md b/docs/api/verida-js/interfaces/verida_vda_sbt_client._internal_.ConcatArray.md deleted file mode 100644 index 54a0ce7..0000000 --- a/docs/api/verida-js/interfaces/verida_vda_sbt_client._internal_.ConcatArray.md +++ /dev/null @@ -1,77 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-sbt-client](../modules/verida_vda_sbt_client.md) / [](../modules/verida_vda_sbt_client._internal_.md) / ConcatArray - -# Interface: ConcatArray - -[@verida/vda-sbt-client](../modules/verida_vda_sbt_client.md).[](../modules/verida_vda_sbt_client._internal_.md).ConcatArray - -## Type parameters - -| Name | -| :------ | -| `T` | - -## Indexable - -▪ [n: `number`]: `T` - -## Table of contents - -### Properties - -- [length](verida_vda_sbt_client._internal_.ConcatArray.md#length) - -### Methods - -- [join](verida_vda_sbt_client._internal_.ConcatArray.md#join) -- [slice](verida_vda_sbt_client._internal_.ConcatArray.md#slice) - -## Properties - -### length - -• `Readonly` **length**: `number` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1214 - -## Methods - -### join - -▸ **join**(`separator?`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `separator?` | `string` | - -#### Returns - -`string` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1216 - -___ - -### slice - -▸ **slice**(`start?`, `end?`): `T`[] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `start?` | `number` | -| `end?` | `number` | - -#### Returns - -`T`[] - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1217 diff --git a/docs/api/verida-js/interfaces/verida_vda_sbt_client._internal_.Error.md b/docs/api/verida-js/interfaces/verida_vda_sbt_client._internal_.Error.md deleted file mode 100644 index ce2e88f..0000000 --- a/docs/api/verida-js/interfaces/verida_vda_sbt_client._internal_.Error.md +++ /dev/null @@ -1,43 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-sbt-client](../modules/verida_vda_sbt_client.md) / [](../modules/verida_vda_sbt_client._internal_.md) / Error - -# Interface: Error - -[@verida/vda-sbt-client](../modules/verida_vda_sbt_client.md).[](../modules/verida_vda_sbt_client._internal_.md).Error - -## Table of contents - -### Properties - -- [message](verida_vda_sbt_client._internal_.Error.md#message) -- [name](verida_vda_sbt_client._internal_.Error.md#name) -- [stack](verida_vda_sbt_client._internal_.Error.md#stack) - -## Properties - -### message - -• **message**: `string` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:974 - -___ - -### name - -• **name**: `string` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:973 - -___ - -### stack - -• `Optional` **stack**: `string` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:975 diff --git a/docs/api/verida-js/interfaces/verida_vda_sbt_client._internal_.Event.md b/docs/api/verida-js/interfaces/verida_vda_sbt_client._internal_.Event.md deleted file mode 100644 index 7d22b71..0000000 --- a/docs/api/verida-js/interfaces/verida_vda_sbt_client._internal_.Event.md +++ /dev/null @@ -1,280 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-sbt-client](../modules/verida_vda_sbt_client.md) / [](../modules/verida_vda_sbt_client._internal_.md) / Event - -# Interface: Event - -[@verida/vda-sbt-client](../modules/verida_vda_sbt_client.md).[](../modules/verida_vda_sbt_client._internal_.md).Event - -## Hierarchy - -- [`Log`](verida_vda_sbt_client._internal_.Log.md) - - ↳ **`Event`** - -## Table of contents - -### Properties - -- [address](verida_vda_sbt_client._internal_.Event.md#address) -- [args](verida_vda_sbt_client._internal_.Event.md#args) -- [blockHash](verida_vda_sbt_client._internal_.Event.md#blockhash) -- [blockNumber](verida_vda_sbt_client._internal_.Event.md#blocknumber) -- [data](verida_vda_sbt_client._internal_.Event.md#data) -- [decodeError](verida_vda_sbt_client._internal_.Event.md#decodeerror) -- [event](verida_vda_sbt_client._internal_.Event.md#event) -- [eventSignature](verida_vda_sbt_client._internal_.Event.md#eventsignature) -- [logIndex](verida_vda_sbt_client._internal_.Event.md#logindex) -- [removed](verida_vda_sbt_client._internal_.Event.md#removed) -- [topics](verida_vda_sbt_client._internal_.Event.md#topics) -- [transactionHash](verida_vda_sbt_client._internal_.Event.md#transactionhash) -- [transactionIndex](verida_vda_sbt_client._internal_.Event.md#transactionindex) - -### Methods - -- [decode](verida_vda_sbt_client._internal_.Event.md#decode) -- [getBlock](verida_vda_sbt_client._internal_.Event.md#getblock) -- [getTransaction](verida_vda_sbt_client._internal_.Event.md#gettransaction) -- [getTransactionReceipt](verida_vda_sbt_client._internal_.Event.md#gettransactionreceipt) -- [removeListener](verida_vda_sbt_client._internal_.Event.md#removelistener) - -## Properties - -### address - -• **address**: `string` - -#### Inherited from - -[Log](verida_vda_sbt_client._internal_.Log.md).[address](verida_vda_sbt_client._internal_.Log.md#address) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:59 - -___ - -### args - -• `Optional` **args**: [`Result`](verida_vda_sbt_client._internal_.Result.md) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:49 - -___ - -### blockHash - -• **blockHash**: `string` - -#### Inherited from - -[Log](verida_vda_sbt_client._internal_.Log.md).[blockHash](verida_vda_sbt_client._internal_.Log.md#blockhash) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:56 - -___ - -### blockNumber - -• **blockNumber**: `number` - -#### Inherited from - -[Log](verida_vda_sbt_client._internal_.Log.md).[blockNumber](verida_vda_sbt_client._internal_.Log.md#blocknumber) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:55 - -___ - -### data - -• **data**: `string` - -#### Inherited from - -[Log](verida_vda_sbt_client._internal_.Log.md).[data](verida_vda_sbt_client._internal_.Log.md#data) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:60 - -___ - -### decodeError - -• `Optional` **decodeError**: [`Error`](../modules/verida_vda_sbt_client._internal_.md#error) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:50 - -___ - -### event - -• `Optional` **event**: `string` - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:47 - -___ - -### eventSignature - -• `Optional` **eventSignature**: `string` - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:48 - -___ - -### logIndex - -• **logIndex**: `number` - -#### Inherited from - -[Log](verida_vda_sbt_client._internal_.Log.md).[logIndex](verida_vda_sbt_client._internal_.Log.md#logindex) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:63 - -___ - -### removed - -• **removed**: `boolean` - -#### Inherited from - -[Log](verida_vda_sbt_client._internal_.Log.md).[removed](verida_vda_sbt_client._internal_.Log.md#removed) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:58 - -___ - -### topics - -• **topics**: `string`[] - -#### Inherited from - -[Log](verida_vda_sbt_client._internal_.Log.md).[topics](verida_vda_sbt_client._internal_.Log.md#topics) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:61 - -___ - -### transactionHash - -• **transactionHash**: `string` - -#### Inherited from - -[Log](verida_vda_sbt_client._internal_.Log.md).[transactionHash](verida_vda_sbt_client._internal_.Log.md#transactionhash) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:62 - -___ - -### transactionIndex - -• **transactionIndex**: `number` - -#### Inherited from - -[Log](verida_vda_sbt_client._internal_.Log.md).[transactionIndex](verida_vda_sbt_client._internal_.Log.md#transactionindex) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:57 - -## Methods - -### decode - -▸ `Optional` **decode**(`data`, `topics?`): `any` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `string` | -| `topics?` | `string`[] | - -#### Returns - -`any` - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:51 - -___ - -### getBlock - -▸ **getBlock**(): `Promise`<[`Block`](verida_vda_sbt_client._internal_.Block.md)\> - -#### Returns - -`Promise`<[`Block`](verida_vda_sbt_client._internal_.Block.md)\> - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:53 - -___ - -### getTransaction - -▸ **getTransaction**(): `Promise`<[`TransactionResponse`](verida_vda_sbt_client._internal_.TransactionResponse.md)\> - -#### Returns - -`Promise`<[`TransactionResponse`](verida_vda_sbt_client._internal_.TransactionResponse.md)\> - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:54 - -___ - -### getTransactionReceipt - -▸ **getTransactionReceipt**(): `Promise`<[`TransactionReceipt`](verida_vda_sbt_client._internal_.TransactionReceipt.md)\> - -#### Returns - -`Promise`<[`TransactionReceipt`](verida_vda_sbt_client._internal_.TransactionReceipt.md)\> - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:55 - -___ - -### removeListener - -▸ **removeListener**(): `void` - -#### Returns - -`void` - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:52 diff --git a/docs/api/verida-js/interfaces/verida_vda_sbt_client._internal_.EventFilter.md b/docs/api/verida-js/interfaces/verida_vda_sbt_client._internal_.EventFilter.md deleted file mode 100644 index cc2ec04..0000000 --- a/docs/api/verida-js/interfaces/verida_vda_sbt_client._internal_.EventFilter.md +++ /dev/null @@ -1,38 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-sbt-client](../modules/verida_vda_sbt_client.md) / [](../modules/verida_vda_sbt_client._internal_.md) / EventFilter - -# Interface: EventFilter - -[@verida/vda-sbt-client](../modules/verida_vda_sbt_client.md).[](../modules/verida_vda_sbt_client._internal_.md).EventFilter - -## Hierarchy - -- **`EventFilter`** - - ↳ [`Filter`](verida_vda_sbt_client._internal_.Filter.md) - -## Table of contents - -### Properties - -- [address](verida_vda_sbt_client._internal_.EventFilter.md#address) -- [topics](verida_vda_sbt_client._internal_.EventFilter.md#topics) - -## Properties - -### address - -• `Optional` **address**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:91 - -___ - -### topics - -• `Optional` **topics**: (``null`` \| `string` \| `string`[])[] - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:92 diff --git a/docs/api/verida-js/interfaces/verida_vda_sbt_client._internal_.FeeData.md b/docs/api/verida-js/interfaces/verida_vda_sbt_client._internal_.FeeData.md deleted file mode 100644 index 895d5d5..0000000 --- a/docs/api/verida-js/interfaces/verida_vda_sbt_client._internal_.FeeData.md +++ /dev/null @@ -1,54 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-sbt-client](../modules/verida_vda_sbt_client.md) / [](../modules/verida_vda_sbt_client._internal_.md) / FeeData - -# Interface: FeeData - -[@verida/vda-sbt-client](../modules/verida_vda_sbt_client.md).[](../modules/verida_vda_sbt_client._internal_.md).FeeData - -## Table of contents - -### Properties - -- [gasPrice](verida_vda_sbt_client._internal_.FeeData.md#gasprice) -- [lastBaseFeePerGas](verida_vda_sbt_client._internal_.FeeData.md#lastbasefeepergas) -- [maxFeePerGas](verida_vda_sbt_client._internal_.FeeData.md#maxfeepergas) -- [maxPriorityFeePerGas](verida_vda_sbt_client._internal_.FeeData.md#maxpriorityfeepergas) - -## Properties - -### gasPrice - -• **gasPrice**: ``null`` \| [`BigNumber`](../classes/verida_vda_sbt_client._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:88 - -___ - -### lastBaseFeePerGas - -• **lastBaseFeePerGas**: ``null`` \| [`BigNumber`](../classes/verida_vda_sbt_client._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:85 - -___ - -### maxFeePerGas - -• **maxFeePerGas**: ``null`` \| [`BigNumber`](../classes/verida_vda_sbt_client._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:86 - -___ - -### maxPriorityFeePerGas - -• **maxPriorityFeePerGas**: ``null`` \| [`BigNumber`](../classes/verida_vda_sbt_client._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:87 diff --git a/docs/api/verida-js/interfaces/verida_vda_sbt_client._internal_.Filter.md b/docs/api/verida-js/interfaces/verida_vda_sbt_client._internal_.Filter.md deleted file mode 100644 index bd80fac..0000000 --- a/docs/api/verida-js/interfaces/verida_vda_sbt_client._internal_.Filter.md +++ /dev/null @@ -1,68 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-sbt-client](../modules/verida_vda_sbt_client.md) / [](../modules/verida_vda_sbt_client._internal_.md) / Filter - -# Interface: Filter - -[@verida/vda-sbt-client](../modules/verida_vda_sbt_client.md).[](../modules/verida_vda_sbt_client._internal_.md).Filter - -## Hierarchy - -- [`EventFilter`](verida_vda_sbt_client._internal_.EventFilter.md) - - ↳ **`Filter`** - -## Table of contents - -### Properties - -- [address](verida_vda_sbt_client._internal_.Filter.md#address) -- [fromBlock](verida_vda_sbt_client._internal_.Filter.md#fromblock) -- [toBlock](verida_vda_sbt_client._internal_.Filter.md#toblock) -- [topics](verida_vda_sbt_client._internal_.Filter.md#topics) - -## Properties - -### address - -• `Optional` **address**: `string` - -#### Inherited from - -[EventFilter](verida_vda_sbt_client._internal_.EventFilter.md).[address](verida_vda_sbt_client._internal_.EventFilter.md#address) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:91 - -___ - -### fromBlock - -• `Optional` **fromBlock**: [`BlockTag`](../modules/verida_vda_sbt_client._internal_.md#blocktag) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:95 - -___ - -### toBlock - -• `Optional` **toBlock**: [`BlockTag`](../modules/verida_vda_sbt_client._internal_.md#blocktag) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:96 - -___ - -### topics - -• `Optional` **topics**: (``null`` \| `string` \| `string`[])[] - -#### Inherited from - -[EventFilter](verida_vda_sbt_client._internal_.EventFilter.md).[topics](verida_vda_sbt_client._internal_.EventFilter.md#topics) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:92 diff --git a/docs/api/verida-js/interfaces/verida_vda_sbt_client._internal_.Hexable.md b/docs/api/verida-js/interfaces/verida_vda_sbt_client._internal_.Hexable.md deleted file mode 100644 index 60671aa..0000000 --- a/docs/api/verida-js/interfaces/verida_vda_sbt_client._internal_.Hexable.md +++ /dev/null @@ -1,29 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-sbt-client](../modules/verida_vda_sbt_client.md) / [](../modules/verida_vda_sbt_client._internal_.md) / Hexable - -# Interface: Hexable - -[@verida/vda-sbt-client](../modules/verida_vda_sbt_client.md).[](../modules/verida_vda_sbt_client._internal_.md).Hexable - -## Implemented by - -- [`BigNumber`](../classes/verida_vda_sbt_client._internal_.BigNumber.md) - -## Table of contents - -### Methods - -- [toHexString](verida_vda_sbt_client._internal_.Hexable.md#tohexstring) - -## Methods - -### toHexString - -▸ **toHexString**(): `string` - -#### Returns - -`string` - -#### Defined in - -node_modules/@ethersproject/bytes/lib/index.d.ts:8 diff --git a/docs/api/verida-js/interfaces/verida_vda_sbt_client._internal_.IterableIterator.md b/docs/api/verida-js/interfaces/verida_vda_sbt_client._internal_.IterableIterator.md deleted file mode 100644 index d1f8fe2..0000000 --- a/docs/api/verida-js/interfaces/verida_vda_sbt_client._internal_.IterableIterator.md +++ /dev/null @@ -1,112 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-sbt-client](../modules/verida_vda_sbt_client.md) / [](../modules/verida_vda_sbt_client._internal_.md) / IterableIterator - -# Interface: IterableIterator - -[@verida/vda-sbt-client](../modules/verida_vda_sbt_client.md).[](../modules/verida_vda_sbt_client._internal_.md).IterableIterator - -## Type parameters - -| Name | -| :------ | -| `T` | - -## Hierarchy - -- [`Iterator`](verida_vda_sbt_client._internal_.Iterator.md)<`T`\> - - ↳ **`IterableIterator`** - -## Table of contents - -### Methods - -- [[iterator]](verida_vda_sbt_client._internal_.IterableIterator.md#[iterator]) -- [next](verida_vda_sbt_client._internal_.IterableIterator.md#next) -- [return](verida_vda_sbt_client._internal_.IterableIterator.md#return) -- [throw](verida_vda_sbt_client._internal_.IterableIterator.md#throw) - -## Methods - -### [iterator] - -▸ **[iterator]**(): [`IterableIterator`](verida_vda_sbt_client._internal_.IterableIterator.md)<`T`\> - -#### Returns - -[`IterableIterator`](verida_vda_sbt_client._internal_.IterableIterator.md)<`T`\> - -#### Defined in - -node_modules/typescript/lib/lib.es2015.iterable.d.ts:55 - -___ - -### next - -▸ **next**(...`args`): [`IteratorResult`](../modules/verida_vda_sbt_client._internal_.md#iteratorresult)<`T`, `any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `...args` | [] \| [`undefined`] | - -#### Returns - -[`IteratorResult`](../modules/verida_vda_sbt_client._internal_.md#iteratorresult)<`T`, `any`\> - -#### Inherited from - -[Iterator](verida_vda_sbt_client._internal_.Iterator.md).[next](verida_vda_sbt_client._internal_.Iterator.md#next) - -#### Defined in - -node_modules/typescript/lib/lib.es2015.iterable.d.ts:45 - -___ - -### return - -▸ `Optional` **return**(`value?`): [`IteratorResult`](../modules/verida_vda_sbt_client._internal_.md#iteratorresult)<`T`, `any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value?` | `any` | - -#### Returns - -[`IteratorResult`](../modules/verida_vda_sbt_client._internal_.md#iteratorresult)<`T`, `any`\> - -#### Inherited from - -[Iterator](verida_vda_sbt_client._internal_.Iterator.md).[return](verida_vda_sbt_client._internal_.Iterator.md#return) - -#### Defined in - -node_modules/typescript/lib/lib.es2015.iterable.d.ts:46 - -___ - -### throw - -▸ `Optional` **throw**(`e?`): [`IteratorResult`](../modules/verida_vda_sbt_client._internal_.md#iteratorresult)<`T`, `any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `e?` | `any` | - -#### Returns - -[`IteratorResult`](../modules/verida_vda_sbt_client._internal_.md#iteratorresult)<`T`, `any`\> - -#### Inherited from - -[Iterator](verida_vda_sbt_client._internal_.Iterator.md).[throw](verida_vda_sbt_client._internal_.Iterator.md#throw) - -#### Defined in - -node_modules/typescript/lib/lib.es2015.iterable.d.ts:47 diff --git a/docs/api/verida-js/interfaces/verida_vda_sbt_client._internal_.Iterator.md b/docs/api/verida-js/interfaces/verida_vda_sbt_client._internal_.Iterator.md deleted file mode 100644 index 30c9303..0000000 --- a/docs/api/verida-js/interfaces/verida_vda_sbt_client._internal_.Iterator.md +++ /dev/null @@ -1,87 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-sbt-client](../modules/verida_vda_sbt_client.md) / [](../modules/verida_vda_sbt_client._internal_.md) / Iterator - -# Interface: Iterator - -[@verida/vda-sbt-client](../modules/verida_vda_sbt_client.md).[](../modules/verida_vda_sbt_client._internal_.md).Iterator - -## Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `T` | -| `TReturn` | `any` | -| `TNext` | `undefined` | - -## Hierarchy - -- **`Iterator`** - - ↳ [`IterableIterator`](verida_vda_sbt_client._internal_.IterableIterator.md) - -## Table of contents - -### Methods - -- [next](verida_vda_sbt_client._internal_.Iterator.md#next) -- [return](verida_vda_sbt_client._internal_.Iterator.md#return) -- [throw](verida_vda_sbt_client._internal_.Iterator.md#throw) - -## Methods - -### next - -▸ **next**(...`args`): [`IteratorResult`](../modules/verida_vda_sbt_client._internal_.md#iteratorresult)<`T`, `TReturn`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `...args` | [] \| [`TNext`] | - -#### Returns - -[`IteratorResult`](../modules/verida_vda_sbt_client._internal_.md#iteratorresult)<`T`, `TReturn`\> - -#### Defined in - -node_modules/typescript/lib/lib.es2015.iterable.d.ts:45 - -___ - -### return - -▸ `Optional` **return**(`value?`): [`IteratorResult`](../modules/verida_vda_sbt_client._internal_.md#iteratorresult)<`T`, `TReturn`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value?` | `TReturn` | - -#### Returns - -[`IteratorResult`](../modules/verida_vda_sbt_client._internal_.md#iteratorresult)<`T`, `TReturn`\> - -#### Defined in - -node_modules/typescript/lib/lib.es2015.iterable.d.ts:46 - -___ - -### throw - -▸ `Optional` **throw**(`e?`): [`IteratorResult`](../modules/verida_vda_sbt_client._internal_.md#iteratorresult)<`T`, `TReturn`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `e?` | `any` | - -#### Returns - -[`IteratorResult`](../modules/verida_vda_sbt_client._internal_.md#iteratorresult)<`T`, `TReturn`\> - -#### Defined in - -node_modules/typescript/lib/lib.es2015.iterable.d.ts:47 diff --git a/docs/api/verida-js/interfaces/verida_vda_sbt_client._internal_.IteratorReturnResult.md b/docs/api/verida-js/interfaces/verida_vda_sbt_client._internal_.IteratorReturnResult.md deleted file mode 100644 index 59ba6a5..0000000 --- a/docs/api/verida-js/interfaces/verida_vda_sbt_client._internal_.IteratorReturnResult.md +++ /dev/null @@ -1,38 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-sbt-client](../modules/verida_vda_sbt_client.md) / [](../modules/verida_vda_sbt_client._internal_.md) / IteratorReturnResult - -# Interface: IteratorReturnResult - -[@verida/vda-sbt-client](../modules/verida_vda_sbt_client.md).[](../modules/verida_vda_sbt_client._internal_.md).IteratorReturnResult - -## Type parameters - -| Name | -| :------ | -| `TReturn` | - -## Table of contents - -### Properties - -- [done](verida_vda_sbt_client._internal_.IteratorReturnResult.md#done) -- [value](verida_vda_sbt_client._internal_.IteratorReturnResult.md#value) - -## Properties - -### done - -• **done**: ``true`` - -#### Defined in - -node_modules/typescript/lib/lib.es2015.iterable.d.ts:37 - -___ - -### value - -• **value**: `TReturn` - -#### Defined in - -node_modules/typescript/lib/lib.es2015.iterable.d.ts:38 diff --git a/docs/api/verida-js/interfaces/verida_vda_sbt_client._internal_.IteratorYieldResult.md b/docs/api/verida-js/interfaces/verida_vda_sbt_client._internal_.IteratorYieldResult.md deleted file mode 100644 index 121eef1..0000000 --- a/docs/api/verida-js/interfaces/verida_vda_sbt_client._internal_.IteratorYieldResult.md +++ /dev/null @@ -1,38 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-sbt-client](../modules/verida_vda_sbt_client.md) / [](../modules/verida_vda_sbt_client._internal_.md) / IteratorYieldResult - -# Interface: IteratorYieldResult - -[@verida/vda-sbt-client](../modules/verida_vda_sbt_client.md).[](../modules/verida_vda_sbt_client._internal_.md).IteratorYieldResult - -## Type parameters - -| Name | -| :------ | -| `TYield` | - -## Table of contents - -### Properties - -- [done](verida_vda_sbt_client._internal_.IteratorYieldResult.md#done) -- [value](verida_vda_sbt_client._internal_.IteratorYieldResult.md#value) - -## Properties - -### done - -• `Optional` **done**: ``false`` - -#### Defined in - -node_modules/typescript/lib/lib.es2015.iterable.d.ts:32 - -___ - -### value - -• **value**: `TYield` - -#### Defined in - -node_modules/typescript/lib/lib.es2015.iterable.d.ts:33 diff --git a/docs/api/verida-js/interfaces/verida_vda_sbt_client._internal_.JsonFragment.md b/docs/api/verida-js/interfaces/verida_vda_sbt_client._internal_.JsonFragment.md deleted file mode 100644 index ae53a91..0000000 --- a/docs/api/verida-js/interfaces/verida_vda_sbt_client._internal_.JsonFragment.md +++ /dev/null @@ -1,109 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-sbt-client](../modules/verida_vda_sbt_client.md) / [](../modules/verida_vda_sbt_client._internal_.md) / JsonFragment - -# Interface: JsonFragment - -[@verida/vda-sbt-client](../modules/verida_vda_sbt_client.md).[](../modules/verida_vda_sbt_client._internal_.md).JsonFragment - -## Table of contents - -### Properties - -- [anonymous](verida_vda_sbt_client._internal_.JsonFragment.md#anonymous) -- [constant](verida_vda_sbt_client._internal_.JsonFragment.md#constant) -- [gas](verida_vda_sbt_client._internal_.JsonFragment.md#gas) -- [inputs](verida_vda_sbt_client._internal_.JsonFragment.md#inputs) -- [name](verida_vda_sbt_client._internal_.JsonFragment.md#name) -- [outputs](verida_vda_sbt_client._internal_.JsonFragment.md#outputs) -- [payable](verida_vda_sbt_client._internal_.JsonFragment.md#payable) -- [stateMutability](verida_vda_sbt_client._internal_.JsonFragment.md#statemutability) -- [type](verida_vda_sbt_client._internal_.JsonFragment.md#type) - -## Properties - -### anonymous - -• `Optional` `Readonly` **anonymous**: `boolean` - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:12 - -___ - -### constant - -• `Optional` `Readonly` **constant**: `boolean` - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:14 - -___ - -### gas - -• `Optional` `Readonly` **gas**: `string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:18 - -___ - -### inputs - -• `Optional` `Readonly` **inputs**: readonly [`JsonFragmentType`](verida_vda_sbt_client._internal_.JsonFragmentType.md)[] - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:16 - -___ - -### name - -• `Optional` `Readonly` **name**: `string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:10 - -___ - -### outputs - -• `Optional` `Readonly` **outputs**: readonly [`JsonFragmentType`](verida_vda_sbt_client._internal_.JsonFragmentType.md)[] - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:17 - -___ - -### payable - -• `Optional` `Readonly` **payable**: `boolean` - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:13 - -___ - -### stateMutability - -• `Optional` `Readonly` **stateMutability**: `string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:15 - -___ - -### type - -• `Optional` `Readonly` **type**: `string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:11 diff --git a/docs/api/verida-js/interfaces/verida_vda_sbt_client._internal_.JsonFragmentType.md b/docs/api/verida-js/interfaces/verida_vda_sbt_client._internal_.JsonFragmentType.md deleted file mode 100644 index 5a2f447..0000000 --- a/docs/api/verida-js/interfaces/verida_vda_sbt_client._internal_.JsonFragmentType.md +++ /dev/null @@ -1,65 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-sbt-client](../modules/verida_vda_sbt_client.md) / [](../modules/verida_vda_sbt_client._internal_.md) / JsonFragmentType - -# Interface: JsonFragmentType - -[@verida/vda-sbt-client](../modules/verida_vda_sbt_client.md).[](../modules/verida_vda_sbt_client._internal_.md).JsonFragmentType - -## Table of contents - -### Properties - -- [components](verida_vda_sbt_client._internal_.JsonFragmentType.md#components) -- [indexed](verida_vda_sbt_client._internal_.JsonFragmentType.md#indexed) -- [internalType](verida_vda_sbt_client._internal_.JsonFragmentType.md#internaltype) -- [name](verida_vda_sbt_client._internal_.JsonFragmentType.md#name) -- [type](verida_vda_sbt_client._internal_.JsonFragmentType.md#type) - -## Properties - -### components - -• `Optional` `Readonly` **components**: readonly [`JsonFragmentType`](verida_vda_sbt_client._internal_.JsonFragmentType.md)[] - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:7 - -___ - -### indexed - -• `Optional` `Readonly` **indexed**: `boolean` - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:4 - -___ - -### internalType - -• `Optional` `Readonly` **internalType**: `any` - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:6 - -___ - -### name - -• `Optional` `Readonly` **name**: `string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:3 - -___ - -### type - -• `Optional` `Readonly` **type**: `string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:5 diff --git a/docs/api/verida-js/interfaces/verida_vda_sbt_client._internal_.Log.md b/docs/api/verida-js/interfaces/verida_vda_sbt_client._internal_.Log.md deleted file mode 100644 index 0f1b630..0000000 --- a/docs/api/verida-js/interfaces/verida_vda_sbt_client._internal_.Log.md +++ /dev/null @@ -1,115 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-sbt-client](../modules/verida_vda_sbt_client.md) / [](../modules/verida_vda_sbt_client._internal_.md) / Log - -# Interface: Log - -[@verida/vda-sbt-client](../modules/verida_vda_sbt_client.md).[](../modules/verida_vda_sbt_client._internal_.md).Log - -## Hierarchy - -- **`Log`** - - ↳ [`Event`](verida_vda_sbt_client._internal_.Event.md) - -## Table of contents - -### Properties - -- [address](verida_vda_sbt_client._internal_.Log.md#address) -- [blockHash](verida_vda_sbt_client._internal_.Log.md#blockhash) -- [blockNumber](verida_vda_sbt_client._internal_.Log.md#blocknumber) -- [data](verida_vda_sbt_client._internal_.Log.md#data) -- [logIndex](verida_vda_sbt_client._internal_.Log.md#logindex) -- [removed](verida_vda_sbt_client._internal_.Log.md#removed) -- [topics](verida_vda_sbt_client._internal_.Log.md#topics) -- [transactionHash](verida_vda_sbt_client._internal_.Log.md#transactionhash) -- [transactionIndex](verida_vda_sbt_client._internal_.Log.md#transactionindex) - -## Properties - -### address - -• **address**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:59 - -___ - -### blockHash - -• **blockHash**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:56 - -___ - -### blockNumber - -• **blockNumber**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:55 - -___ - -### data - -• **data**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:60 - -___ - -### logIndex - -• **logIndex**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:63 - -___ - -### removed - -• **removed**: `boolean` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:58 - -___ - -### topics - -• **topics**: `string`[] - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:61 - -___ - -### transactionHash - -• **transactionHash**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:62 - -___ - -### transactionIndex - -• **transactionIndex**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:57 diff --git a/docs/api/verida-js/interfaces/verida_vda_sbt_client._internal_.OnceBlockable.md b/docs/api/verida-js/interfaces/verida_vda_sbt_client._internal_.OnceBlockable.md deleted file mode 100644 index babd42f..0000000 --- a/docs/api/verida-js/interfaces/verida_vda_sbt_client._internal_.OnceBlockable.md +++ /dev/null @@ -1,36 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-sbt-client](../modules/verida_vda_sbt_client.md) / [](../modules/verida_vda_sbt_client._internal_.md) / OnceBlockable - -# Interface: OnceBlockable - -[@verida/vda-sbt-client](../modules/verida_vda_sbt_client.md).[](../modules/verida_vda_sbt_client._internal_.md).OnceBlockable - -## Implemented by - -- [`Provider`](../classes/verida_vda_sbt_client._internal_.Provider.md) - -## Table of contents - -### Methods - -- [once](verida_vda_sbt_client._internal_.OnceBlockable.md#once) - -## Methods - -### once - -▸ **once**(`eventName`, `handler`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | ``"block"`` | -| `handler` | () => `void` | - -#### Returns - -`void` - -#### Defined in - -node_modules/@ethersproject/web/lib/index.d.ts:19 diff --git a/docs/api/verida-js/interfaces/verida_vda_sbt_client._internal_.PopulatedTransaction.md b/docs/api/verida-js/interfaces/verida_vda_sbt_client._internal_.PopulatedTransaction.md deleted file mode 100644 index 643bf0e..0000000 --- a/docs/api/verida-js/interfaces/verida_vda_sbt_client._internal_.PopulatedTransaction.md +++ /dev/null @@ -1,164 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-sbt-client](../modules/verida_vda_sbt_client.md) / [](../modules/verida_vda_sbt_client._internal_.md) / PopulatedTransaction - -# Interface: PopulatedTransaction - -[@verida/vda-sbt-client](../modules/verida_vda_sbt_client.md).[](../modules/verida_vda_sbt_client._internal_.md).PopulatedTransaction - -## Table of contents - -### Properties - -- [accessList](verida_vda_sbt_client._internal_.PopulatedTransaction.md#accesslist) -- [ccipReadEnabled](verida_vda_sbt_client._internal_.PopulatedTransaction.md#ccipreadenabled) -- [chainId](verida_vda_sbt_client._internal_.PopulatedTransaction.md#chainid) -- [customData](verida_vda_sbt_client._internal_.PopulatedTransaction.md#customdata) -- [data](verida_vda_sbt_client._internal_.PopulatedTransaction.md#data) -- [from](verida_vda_sbt_client._internal_.PopulatedTransaction.md#from) -- [gasLimit](verida_vda_sbt_client._internal_.PopulatedTransaction.md#gaslimit) -- [gasPrice](verida_vda_sbt_client._internal_.PopulatedTransaction.md#gasprice) -- [maxFeePerGas](verida_vda_sbt_client._internal_.PopulatedTransaction.md#maxfeepergas) -- [maxPriorityFeePerGas](verida_vda_sbt_client._internal_.PopulatedTransaction.md#maxpriorityfeepergas) -- [nonce](verida_vda_sbt_client._internal_.PopulatedTransaction.md#nonce) -- [to](verida_vda_sbt_client._internal_.PopulatedTransaction.md#to) -- [type](verida_vda_sbt_client._internal_.PopulatedTransaction.md#type) -- [value](verida_vda_sbt_client._internal_.PopulatedTransaction.md#value) - -## Properties - -### accessList - -• `Optional` **accessList**: [`AccessList`](../modules/verida_vda_sbt_client._internal_.md#accesslist) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:35 - -___ - -### ccipReadEnabled - -• `Optional` **ccipReadEnabled**: `boolean` - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:39 - -___ - -### chainId - -• `Optional` **chainId**: `number` - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:33 - -___ - -### customData - -• `Optional` **customData**: [`Record`](../modules/verida_vda_sbt_client._internal_.md#record)<`string`, `any`\> - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:38 - -___ - -### data - -• `Optional` **data**: `string` - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:31 - -___ - -### from - -• `Optional` **from**: `string` - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:27 - -___ - -### gasLimit - -• `Optional` **gasLimit**: [`BigNumber`](../classes/verida_vda_sbt_client._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:29 - -___ - -### gasPrice - -• `Optional` **gasPrice**: [`BigNumber`](../classes/verida_vda_sbt_client._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:30 - -___ - -### maxFeePerGas - -• `Optional` **maxFeePerGas**: [`BigNumber`](../classes/verida_vda_sbt_client._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:36 - -___ - -### maxPriorityFeePerGas - -• `Optional` **maxPriorityFeePerGas**: [`BigNumber`](../classes/verida_vda_sbt_client._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:37 - -___ - -### nonce - -• `Optional` **nonce**: `number` - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:28 - -___ - -### to - -• `Optional` **to**: `string` - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:26 - -___ - -### type - -• `Optional` **type**: `number` - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:34 - -___ - -### value - -• `Optional` **value**: [`BigNumber`](../classes/verida_vda_sbt_client._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:32 diff --git a/docs/api/verida-js/interfaces/verida_vda_sbt_client._internal_.Result.md b/docs/api/verida-js/interfaces/verida_vda_sbt_client._internal_.Result.md deleted file mode 100644 index 54eebf5..0000000 --- a/docs/api/verida-js/interfaces/verida_vda_sbt_client._internal_.Result.md +++ /dev/null @@ -1,869 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-sbt-client](../modules/verida_vda_sbt_client.md) / [](../modules/verida_vda_sbt_client._internal_.md) / Result - -# Interface: Result - -[@verida/vda-sbt-client](../modules/verida_vda_sbt_client.md).[](../modules/verida_vda_sbt_client._internal_.md).Result - -## Hierarchy - -- `ReadonlyArray`<`any`\> - - ↳ **`Result`** - -## Indexable - -▪ [key: `string`]: `any` - -## Table of contents - -### Properties - -- [length](verida_vda_sbt_client._internal_.Result.md#length) - -### Methods - -- [[iterator]](verida_vda_sbt_client._internal_.Result.md#[iterator]) -- [concat](verida_vda_sbt_client._internal_.Result.md#concat) -- [entries](verida_vda_sbt_client._internal_.Result.md#entries) -- [every](verida_vda_sbt_client._internal_.Result.md#every) -- [filter](verida_vda_sbt_client._internal_.Result.md#filter) -- [find](verida_vda_sbt_client._internal_.Result.md#find) -- [findIndex](verida_vda_sbt_client._internal_.Result.md#findindex) -- [flat](verida_vda_sbt_client._internal_.Result.md#flat) -- [flatMap](verida_vda_sbt_client._internal_.Result.md#flatmap) -- [forEach](verida_vda_sbt_client._internal_.Result.md#foreach) -- [includes](verida_vda_sbt_client._internal_.Result.md#includes) -- [indexOf](verida_vda_sbt_client._internal_.Result.md#indexof) -- [join](verida_vda_sbt_client._internal_.Result.md#join) -- [keys](verida_vda_sbt_client._internal_.Result.md#keys) -- [lastIndexOf](verida_vda_sbt_client._internal_.Result.md#lastindexof) -- [map](verida_vda_sbt_client._internal_.Result.md#map) -- [reduce](verida_vda_sbt_client._internal_.Result.md#reduce) -- [reduceRight](verida_vda_sbt_client._internal_.Result.md#reduceright) -- [slice](verida_vda_sbt_client._internal_.Result.md#slice) -- [some](verida_vda_sbt_client._internal_.Result.md#some) -- [toLocaleString](verida_vda_sbt_client._internal_.Result.md#tolocalestring) -- [toString](verida_vda_sbt_client._internal_.Result.md#tostring) -- [values](verida_vda_sbt_client._internal_.Result.md#values) - -## Properties - -### length - -• `Readonly` **length**: `number` - -Gets the length of the array. This is a number one higher than the highest element defined in an array. - -#### Inherited from - -ReadonlyArray.length - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1090 - -## Methods - -### [iterator] - -▸ **[iterator]**(): [`IterableIterator`](verida_vda_sbt_client._internal_.IterableIterator.md)<`any`\> - -Iterator of values in the array. - -#### Returns - -[`IterableIterator`](verida_vda_sbt_client._internal_.IterableIterator.md)<`any`\> - -#### Inherited from - -ReadonlyArray.\_\_@iterator@16653 - -#### Defined in - -node_modules/typescript/lib/lib.es2015.iterable.d.ts:96 - -___ - -### concat - -▸ **concat**(...`items`): `any`[] - -Combines two or more arrays. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `...items` | [`ConcatArray`](verida_vda_sbt_client._internal_.ConcatArray.md)<`any`\>[] | Additional items to add to the end of array1. | - -#### Returns - -`any`[] - -#### Inherited from - -ReadonlyArray.concat - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1103 - -▸ **concat**(...`items`): `any`[] - -Combines two or more arrays. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `...items` | `any`[] | Additional items to add to the end of array1. | - -#### Returns - -`any`[] - -#### Inherited from - -ReadonlyArray.concat - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1108 - -___ - -### entries - -▸ **entries**(): [`IterableIterator`](verida_vda_sbt_client._internal_.IterableIterator.md)<[`number`, `any`]\> - -Returns an iterable of key, value pairs for every entry in the array - -#### Returns - -[`IterableIterator`](verida_vda_sbt_client._internal_.IterableIterator.md)<[`number`, `any`]\> - -#### Inherited from - -ReadonlyArray.entries - -#### Defined in - -node_modules/typescript/lib/lib.es2015.iterable.d.ts:101 - -___ - -### every - -▸ **every**<`S`\>(`predicate`, `thisArg?`): this is readonly S[] - -Determines whether all the members of an array satisfy the specified test. - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `S` | extends `any` | - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `predicate` | (`value`: `any`, `index`: `number`, `array`: readonly `any`[]) => value is S | A function that accepts up to three arguments. The every method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value false, or until the end of the array. | -| `thisArg?` | `any` | An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value. | - -#### Returns - -this is readonly S[] - -#### Inherited from - -ReadonlyArray.every - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1140 - -▸ **every**(`predicate`, `thisArg?`): `boolean` - -Determines whether all the members of an array satisfy the specified test. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `predicate` | (`value`: `any`, `index`: `number`, `array`: readonly `any`[]) => `unknown` | A function that accepts up to three arguments. The every method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value false, or until the end of the array. | -| `thisArg?` | `any` | An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value. | - -#### Returns - -`boolean` - -#### Inherited from - -ReadonlyArray.every - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1149 - -___ - -### filter - -▸ **filter**<`S`\>(`predicate`, `thisArg?`): `S`[] - -Returns the elements of an array that meet the condition specified in a callback function. - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `S` | extends `any` | - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `predicate` | (`value`: `any`, `index`: `number`, `array`: readonly `any`[]) => value is S | A function that accepts up to three arguments. The filter method calls the predicate function one time for each element in the array. | -| `thisArg?` | `any` | An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value. | - -#### Returns - -`S`[] - -#### Inherited from - -ReadonlyArray.filter - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1176 - -▸ **filter**(`predicate`, `thisArg?`): `any`[] - -Returns the elements of an array that meet the condition specified in a callback function. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `predicate` | (`value`: `any`, `index`: `number`, `array`: readonly `any`[]) => `unknown` | A function that accepts up to three arguments. The filter method calls the predicate function one time for each element in the array. | -| `thisArg?` | `any` | An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value. | - -#### Returns - -`any`[] - -#### Inherited from - -ReadonlyArray.filter - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1182 - -___ - -### find - -▸ **find**<`S`\>(`predicate`, `thisArg?`): `undefined` \| `S` - -Returns the value of the first element in the array where predicate is true, and undefined -otherwise. - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `S` | extends `any` | - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `predicate` | (`value`: `any`, `index`: `number`, `obj`: readonly `any`[]) => value is S | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined. | -| `thisArg?` | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. | - -#### Returns - -`undefined` \| `S` - -#### Inherited from - -ReadonlyArray.find - -#### Defined in - -node_modules/typescript/lib/lib.es2015.core.d.ts:352 - -▸ **find**(`predicate`, `thisArg?`): `any` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `predicate` | (`value`: `any`, `index`: `number`, `obj`: readonly `any`[]) => `unknown` | -| `thisArg?` | `any` | - -#### Returns - -`any` - -#### Inherited from - -ReadonlyArray.find - -#### Defined in - -node_modules/typescript/lib/lib.es2015.core.d.ts:353 - -___ - -### findIndex - -▸ **findIndex**(`predicate`, `thisArg?`): `number` - -Returns the index of the first element in the array where predicate is true, and -1 -otherwise. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `predicate` | (`value`: `any`, `index`: `number`, `obj`: readonly `any`[]) => `unknown` | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1. | -| `thisArg?` | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. | - -#### Returns - -`number` - -#### Inherited from - -ReadonlyArray.findIndex - -#### Defined in - -node_modules/typescript/lib/lib.es2015.core.d.ts:364 - -___ - -### flat - -▸ **flat**<`A`, `D`\>(`depth?`): [`FlatArray`](../modules/verida_vda_sbt_client._internal_.md#flatarray)<`A`, `D`\>[] - -Returns a new array with all sub-array elements concatenated into it recursively up to the -specified depth. - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `A` | `A` | -| `D` | extends `number` = ``1`` | - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `depth?` | `D` | The maximum recursion depth | - -#### Returns - -[`FlatArray`](../modules/verida_vda_sbt_client._internal_.md#flatarray)<`A`, `D`\>[] - -#### Inherited from - -ReadonlyArray.flat - -#### Defined in - -node_modules/typescript/lib/lib.es2019.array.d.ts:52 - -___ - -### flatMap - -▸ **flatMap**<`U`, `This`\>(`callback`, `thisArg?`): `U`[] - -Calls a defined callback function on each element of an array. Then, flattens the result into -a new array. -This is identical to a map followed by flat with depth 1. - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `U` | `U` | -| `This` | `undefined` | - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `callback` | (`value`: `any`, `index`: `number`, `array`: `any`[]) => `U` \| readonly `U`[] | A function that accepts up to three arguments. The flatMap method calls the callback function one time for each element in the array. | -| `thisArg?` | `This` | An object to which the this keyword can refer in the callback function. If thisArg is omitted, undefined is used as the this value. | - -#### Returns - -`U`[] - -#### Inherited from - -ReadonlyArray.flatMap - -#### Defined in - -node_modules/typescript/lib/lib.es2019.array.d.ts:40 - -___ - -### forEach - -▸ **forEach**(`callbackfn`, `thisArg?`): `void` - -Performs the specified action for each element in an array. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `callbackfn` | (`value`: `any`, `index`: `number`, `array`: readonly `any`[]) => `void` | A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array. | -| `thisArg?` | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -#### Returns - -`void` - -#### Inherited from - -ReadonlyArray.forEach - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1164 - -___ - -### includes - -▸ **includes**(`searchElement`, `fromIndex?`): `boolean` - -Determines whether an array includes a certain element, returning true or false as appropriate. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `searchElement` | `any` | The element to search for. | -| `fromIndex?` | `number` | The position in this array at which to begin searching for searchElement. | - -#### Returns - -`boolean` - -#### Inherited from - -ReadonlyArray.includes - -#### Defined in - -node_modules/typescript/lib/lib.es2016.array.include.d.ts:36 - -___ - -### indexOf - -▸ **indexOf**(`searchElement`, `fromIndex?`): `number` - -Returns the index of the first occurrence of a value in an array. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `searchElement` | `any` | The value to locate in the array. | -| `fromIndex?` | `number` | The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0. | - -#### Returns - -`number` - -#### Inherited from - -ReadonlyArray.indexOf - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1125 - -___ - -### join - -▸ **join**(`separator?`): `string` - -Adds all the elements of an array separated by the specified separator string. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `separator?` | `string` | A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma. | - -#### Returns - -`string` - -#### Inherited from - -ReadonlyArray.join - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1113 - -___ - -### keys - -▸ **keys**(): [`IterableIterator`](verida_vda_sbt_client._internal_.IterableIterator.md)<`number`\> - -Returns an iterable of keys in the array - -#### Returns - -[`IterableIterator`](verida_vda_sbt_client._internal_.IterableIterator.md)<`number`\> - -#### Inherited from - -ReadonlyArray.keys - -#### Defined in - -node_modules/typescript/lib/lib.es2015.iterable.d.ts:106 - -___ - -### lastIndexOf - -▸ **lastIndexOf**(`searchElement`, `fromIndex?`): `number` - -Returns the index of the last occurrence of a specified value in an array. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `searchElement` | `any` | The value to locate in the array. | -| `fromIndex?` | `number` | The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array. | - -#### Returns - -`number` - -#### Inherited from - -ReadonlyArray.lastIndexOf - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1131 - -___ - -### map - -▸ **map**<`U`\>(`callbackfn`, `thisArg?`): `U`[] - -Calls a defined callback function on each element of an array, and returns an array that contains the results. - -#### Type parameters - -| Name | -| :------ | -| `U` | - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `callbackfn` | (`value`: `any`, `index`: `number`, `array`: readonly `any`[]) => `U` | A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array. | -| `thisArg?` | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -#### Returns - -`U`[] - -#### Inherited from - -ReadonlyArray.map - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1170 - -___ - -### reduce - -▸ **reduce**(`callbackfn`): `any` - -Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `callbackfn` | (`previousValue`: `any`, `currentValue`: `any`, `currentIndex`: `number`, `array`: readonly `any`[]) => `any` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. | - -#### Returns - -`any` - -#### Inherited from - -ReadonlyArray.reduce - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1188 - -▸ **reduce**(`callbackfn`, `initialValue`): `any` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `callbackfn` | (`previousValue`: `any`, `currentValue`: `any`, `currentIndex`: `number`, `array`: readonly `any`[]) => `any` | -| `initialValue` | `any` | - -#### Returns - -`any` - -#### Inherited from - -ReadonlyArray.reduce - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1189 - -▸ **reduce**<`U`\>(`callbackfn`, `initialValue`): `U` - -Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -#### Type parameters - -| Name | -| :------ | -| `U` | - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `callbackfn` | (`previousValue`: `U`, `currentValue`: `any`, `currentIndex`: `number`, `array`: readonly `any`[]) => `U` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. | -| `initialValue` | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. | - -#### Returns - -`U` - -#### Inherited from - -ReadonlyArray.reduce - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1195 - -___ - -### reduceRight - -▸ **reduceRight**(`callbackfn`): `any` - -Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `callbackfn` | (`previousValue`: `any`, `currentValue`: `any`, `currentIndex`: `number`, `array`: readonly `any`[]) => `any` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. | - -#### Returns - -`any` - -#### Inherited from - -ReadonlyArray.reduceRight - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1201 - -▸ **reduceRight**(`callbackfn`, `initialValue`): `any` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `callbackfn` | (`previousValue`: `any`, `currentValue`: `any`, `currentIndex`: `number`, `array`: readonly `any`[]) => `any` | -| `initialValue` | `any` | - -#### Returns - -`any` - -#### Inherited from - -ReadonlyArray.reduceRight - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1202 - -▸ **reduceRight**<`U`\>(`callbackfn`, `initialValue`): `U` - -Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -#### Type parameters - -| Name | -| :------ | -| `U` | - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `callbackfn` | (`previousValue`: `U`, `currentValue`: `any`, `currentIndex`: `number`, `array`: readonly `any`[]) => `U` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. | -| `initialValue` | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. | - -#### Returns - -`U` - -#### Inherited from - -ReadonlyArray.reduceRight - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1208 - -___ - -### slice - -▸ **slice**(`start?`, `end?`): `any`[] - -Returns a section of an array. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `start?` | `number` | The beginning of the specified portion of the array. | -| `end?` | `number` | The end of the specified portion of the array. This is exclusive of the element at the index 'end'. | - -#### Returns - -`any`[] - -#### Inherited from - -ReadonlyArray.slice - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1119 - -___ - -### some - -▸ **some**(`predicate`, `thisArg?`): `boolean` - -Determines whether the specified callback function returns true for any element of an array. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `predicate` | (`value`: `any`, `index`: `number`, `array`: readonly `any`[]) => `unknown` | A function that accepts up to three arguments. The some method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value true, or until the end of the array. | -| `thisArg?` | `any` | An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value. | - -#### Returns - -`boolean` - -#### Inherited from - -ReadonlyArray.some - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1158 - -___ - -### toLocaleString - -▸ **toLocaleString**(): `string` - -Returns a string representation of an array. The elements are converted to string using their toLocaleString methods. - -#### Returns - -`string` - -#### Inherited from - -ReadonlyArray.toLocaleString - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1098 - -___ - -### toString - -▸ **toString**(): `string` - -Returns a string representation of an array. - -#### Returns - -`string` - -#### Inherited from - -ReadonlyArray.toString - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1094 - -___ - -### values - -▸ **values**(): [`IterableIterator`](verida_vda_sbt_client._internal_.IterableIterator.md)<`any`\> - -Returns an iterable of values in the array - -#### Returns - -[`IterableIterator`](verida_vda_sbt_client._internal_.IterableIterator.md)<`any`\> - -#### Inherited from - -ReadonlyArray.values - -#### Defined in - -node_modules/typescript/lib/lib.es2015.iterable.d.ts:111 diff --git a/docs/api/verida-js/interfaces/verida_vda_sbt_client._internal_.Transaction.md b/docs/api/verida-js/interfaces/verida_vda_sbt_client._internal_.Transaction.md deleted file mode 100644 index be75ccb..0000000 --- a/docs/api/verida-js/interfaces/verida_vda_sbt_client._internal_.Transaction.md +++ /dev/null @@ -1,192 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-sbt-client](../modules/verida_vda_sbt_client.md) / [](../modules/verida_vda_sbt_client._internal_.md) / Transaction - -# Interface: Transaction - -[@verida/vda-sbt-client](../modules/verida_vda_sbt_client.md).[](../modules/verida_vda_sbt_client._internal_.md).Transaction - -## Hierarchy - -- **`Transaction`** - - ↳ [`TransactionResponse`](verida_vda_sbt_client._internal_.TransactionResponse.md) - -## Table of contents - -### Properties - -- [accessList](verida_vda_sbt_client._internal_.Transaction.md#accesslist) -- [chainId](verida_vda_sbt_client._internal_.Transaction.md#chainid) -- [data](verida_vda_sbt_client._internal_.Transaction.md#data) -- [from](verida_vda_sbt_client._internal_.Transaction.md#from) -- [gasLimit](verida_vda_sbt_client._internal_.Transaction.md#gaslimit) -- [gasPrice](verida_vda_sbt_client._internal_.Transaction.md#gasprice) -- [hash](verida_vda_sbt_client._internal_.Transaction.md#hash) -- [maxFeePerGas](verida_vda_sbt_client._internal_.Transaction.md#maxfeepergas) -- [maxPriorityFeePerGas](verida_vda_sbt_client._internal_.Transaction.md#maxpriorityfeepergas) -- [nonce](verida_vda_sbt_client._internal_.Transaction.md#nonce) -- [r](verida_vda_sbt_client._internal_.Transaction.md#r) -- [s](verida_vda_sbt_client._internal_.Transaction.md#s) -- [to](verida_vda_sbt_client._internal_.Transaction.md#to) -- [type](verida_vda_sbt_client._internal_.Transaction.md#type) -- [v](verida_vda_sbt_client._internal_.Transaction.md#v) -- [value](verida_vda_sbt_client._internal_.Transaction.md#value) - -## Properties - -### accessList - -• `Optional` **accessList**: [`AccessList`](../modules/verida_vda_sbt_client._internal_.md#accesslist) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:40 - -___ - -### chainId - -• **chainId**: `number` - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:35 - -___ - -### data - -• **data**: `string` - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:33 - -___ - -### from - -• `Optional` **from**: `string` - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:29 - -___ - -### gasLimit - -• **gasLimit**: [`BigNumber`](../classes/verida_vda_sbt_client._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:31 - -___ - -### gasPrice - -• `Optional` **gasPrice**: [`BigNumber`](../classes/verida_vda_sbt_client._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:32 - -___ - -### hash - -• `Optional` **hash**: `string` - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:27 - -___ - -### maxFeePerGas - -• `Optional` **maxFeePerGas**: [`BigNumber`](../classes/verida_vda_sbt_client._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:42 - -___ - -### maxPriorityFeePerGas - -• `Optional` **maxPriorityFeePerGas**: [`BigNumber`](../classes/verida_vda_sbt_client._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:41 - -___ - -### nonce - -• **nonce**: `number` - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:30 - -___ - -### r - -• `Optional` **r**: `string` - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:36 - -___ - -### s - -• `Optional` **s**: `string` - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:37 - -___ - -### to - -• `Optional` **to**: `string` - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:28 - -___ - -### type - -• `Optional` **type**: ``null`` \| `number` - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:39 - -___ - -### v - -• `Optional` **v**: `number` - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:38 - -___ - -### value - -• **value**: [`BigNumber`](../classes/verida_vda_sbt_client._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:34 diff --git a/docs/api/verida-js/interfaces/verida_vda_sbt_client._internal_.TransactionReceipt.md b/docs/api/verida-js/interfaces/verida_vda_sbt_client._internal_.TransactionReceipt.md deleted file mode 100644 index 7d295c6..0000000 --- a/docs/api/verida-js/interfaces/verida_vda_sbt_client._internal_.TransactionReceipt.md +++ /dev/null @@ -1,197 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-sbt-client](../modules/verida_vda_sbt_client.md) / [](../modules/verida_vda_sbt_client._internal_.md) / TransactionReceipt - -# Interface: TransactionReceipt - -[@verida/vda-sbt-client](../modules/verida_vda_sbt_client.md).[](../modules/verida_vda_sbt_client._internal_.md).TransactionReceipt - -## Table of contents - -### Properties - -- [blockHash](verida_vda_sbt_client._internal_.TransactionReceipt.md#blockhash) -- [blockNumber](verida_vda_sbt_client._internal_.TransactionReceipt.md#blocknumber) -- [byzantium](verida_vda_sbt_client._internal_.TransactionReceipt.md#byzantium) -- [confirmations](verida_vda_sbt_client._internal_.TransactionReceipt.md#confirmations) -- [contractAddress](verida_vda_sbt_client._internal_.TransactionReceipt.md#contractaddress) -- [cumulativeGasUsed](verida_vda_sbt_client._internal_.TransactionReceipt.md#cumulativegasused) -- [effectiveGasPrice](verida_vda_sbt_client._internal_.TransactionReceipt.md#effectivegasprice) -- [from](verida_vda_sbt_client._internal_.TransactionReceipt.md#from) -- [gasUsed](verida_vda_sbt_client._internal_.TransactionReceipt.md#gasused) -- [logs](verida_vda_sbt_client._internal_.TransactionReceipt.md#logs) -- [logsBloom](verida_vda_sbt_client._internal_.TransactionReceipt.md#logsbloom) -- [root](verida_vda_sbt_client._internal_.TransactionReceipt.md#root) -- [status](verida_vda_sbt_client._internal_.TransactionReceipt.md#status) -- [to](verida_vda_sbt_client._internal_.TransactionReceipt.md#to) -- [transactionHash](verida_vda_sbt_client._internal_.TransactionReceipt.md#transactionhash) -- [transactionIndex](verida_vda_sbt_client._internal_.TransactionReceipt.md#transactionindex) -- [type](verida_vda_sbt_client._internal_.TransactionReceipt.md#type) - -## Properties - -### blockHash - -• **blockHash**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:73 - -___ - -### blockNumber - -• **blockNumber**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:76 - -___ - -### byzantium - -• **byzantium**: `boolean` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:80 - -___ - -### confirmations - -• **confirmations**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:77 - -___ - -### contractAddress - -• **contractAddress**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:68 - -___ - -### cumulativeGasUsed - -• **cumulativeGasUsed**: [`BigNumber`](../classes/verida_vda_sbt_client._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:78 - -___ - -### effectiveGasPrice - -• **effectiveGasPrice**: [`BigNumber`](../classes/verida_vda_sbt_client._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:79 - -___ - -### from - -• **from**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:67 - -___ - -### gasUsed - -• **gasUsed**: [`BigNumber`](../classes/verida_vda_sbt_client._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:71 - -___ - -### logs - -• **logs**: [`Log`](verida_vda_sbt_client._internal_.Log.md)[] - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:75 - -___ - -### logsBloom - -• **logsBloom**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:72 - -___ - -### root - -• `Optional` **root**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:70 - -___ - -### status - -• `Optional` **status**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:82 - -___ - -### to - -• **to**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:66 - -___ - -### transactionHash - -• **transactionHash**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:74 - -___ - -### transactionIndex - -• **transactionIndex**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:69 - -___ - -### type - -• **type**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:81 diff --git a/docs/api/verida-js/interfaces/verida_vda_sbt_client._internal_.TransactionResponse.md b/docs/api/verida-js/interfaces/verida_vda_sbt_client._internal_.TransactionResponse.md deleted file mode 100644 index b679cc6..0000000 --- a/docs/api/verida-js/interfaces/verida_vda_sbt_client._internal_.TransactionResponse.md +++ /dev/null @@ -1,335 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-sbt-client](../modules/verida_vda_sbt_client.md) / [](../modules/verida_vda_sbt_client._internal_.md) / TransactionResponse - -# Interface: TransactionResponse - -[@verida/vda-sbt-client](../modules/verida_vda_sbt_client.md).[](../modules/verida_vda_sbt_client._internal_.md).TransactionResponse - -## Hierarchy - -- [`Transaction`](verida_vda_sbt_client._internal_.Transaction.md) - - ↳ **`TransactionResponse`** - -## Table of contents - -### Properties - -- [accessList](verida_vda_sbt_client._internal_.TransactionResponse.md#accesslist) -- [blockHash](verida_vda_sbt_client._internal_.TransactionResponse.md#blockhash) -- [blockNumber](verida_vda_sbt_client._internal_.TransactionResponse.md#blocknumber) -- [chainId](verida_vda_sbt_client._internal_.TransactionResponse.md#chainid) -- [confirmations](verida_vda_sbt_client._internal_.TransactionResponse.md#confirmations) -- [data](verida_vda_sbt_client._internal_.TransactionResponse.md#data) -- [from](verida_vda_sbt_client._internal_.TransactionResponse.md#from) -- [gasLimit](verida_vda_sbt_client._internal_.TransactionResponse.md#gaslimit) -- [gasPrice](verida_vda_sbt_client._internal_.TransactionResponse.md#gasprice) -- [hash](verida_vda_sbt_client._internal_.TransactionResponse.md#hash) -- [maxFeePerGas](verida_vda_sbt_client._internal_.TransactionResponse.md#maxfeepergas) -- [maxPriorityFeePerGas](verida_vda_sbt_client._internal_.TransactionResponse.md#maxpriorityfeepergas) -- [nonce](verida_vda_sbt_client._internal_.TransactionResponse.md#nonce) -- [r](verida_vda_sbt_client._internal_.TransactionResponse.md#r) -- [raw](verida_vda_sbt_client._internal_.TransactionResponse.md#raw) -- [s](verida_vda_sbt_client._internal_.TransactionResponse.md#s) -- [timestamp](verida_vda_sbt_client._internal_.TransactionResponse.md#timestamp) -- [to](verida_vda_sbt_client._internal_.TransactionResponse.md#to) -- [type](verida_vda_sbt_client._internal_.TransactionResponse.md#type) -- [v](verida_vda_sbt_client._internal_.TransactionResponse.md#v) -- [value](verida_vda_sbt_client._internal_.TransactionResponse.md#value) - -### Methods - -- [wait](verida_vda_sbt_client._internal_.TransactionResponse.md#wait) - -## Properties - -### accessList - -• `Optional` **accessList**: [`AccessList`](../modules/verida_vda_sbt_client._internal_.md#accesslist) - -#### Inherited from - -[Transaction](verida_vda_sbt_client._internal_.Transaction.md).[accessList](verida_vda_sbt_client._internal_.Transaction.md#accesslist) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:40 - -___ - -### blockHash - -• `Optional` **blockHash**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:26 - -___ - -### blockNumber - -• `Optional` **blockNumber**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:25 - -___ - -### chainId - -• **chainId**: `number` - -#### Inherited from - -[Transaction](verida_vda_sbt_client._internal_.Transaction.md).[chainId](verida_vda_sbt_client._internal_.Transaction.md#chainid) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:35 - -___ - -### confirmations - -• **confirmations**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:28 - -___ - -### data - -• **data**: `string` - -#### Inherited from - -[Transaction](verida_vda_sbt_client._internal_.Transaction.md).[data](verida_vda_sbt_client._internal_.Transaction.md#data) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:33 - -___ - -### from - -• **from**: `string` - -#### Overrides - -[Transaction](verida_vda_sbt_client._internal_.Transaction.md).[from](verida_vda_sbt_client._internal_.Transaction.md#from) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:29 - -___ - -### gasLimit - -• **gasLimit**: [`BigNumber`](../classes/verida_vda_sbt_client._internal_.BigNumber.md) - -#### Inherited from - -[Transaction](verida_vda_sbt_client._internal_.Transaction.md).[gasLimit](verida_vda_sbt_client._internal_.Transaction.md#gaslimit) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:31 - -___ - -### gasPrice - -• `Optional` **gasPrice**: [`BigNumber`](../classes/verida_vda_sbt_client._internal_.BigNumber.md) - -#### Inherited from - -[Transaction](verida_vda_sbt_client._internal_.Transaction.md).[gasPrice](verida_vda_sbt_client._internal_.Transaction.md#gasprice) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:32 - -___ - -### hash - -• **hash**: `string` - -#### Overrides - -[Transaction](verida_vda_sbt_client._internal_.Transaction.md).[hash](verida_vda_sbt_client._internal_.Transaction.md#hash) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:24 - -___ - -### maxFeePerGas - -• `Optional` **maxFeePerGas**: [`BigNumber`](../classes/verida_vda_sbt_client._internal_.BigNumber.md) - -#### Inherited from - -[Transaction](verida_vda_sbt_client._internal_.Transaction.md).[maxFeePerGas](verida_vda_sbt_client._internal_.Transaction.md#maxfeepergas) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:42 - -___ - -### maxPriorityFeePerGas - -• `Optional` **maxPriorityFeePerGas**: [`BigNumber`](../classes/verida_vda_sbt_client._internal_.BigNumber.md) - -#### Inherited from - -[Transaction](verida_vda_sbt_client._internal_.Transaction.md).[maxPriorityFeePerGas](verida_vda_sbt_client._internal_.Transaction.md#maxpriorityfeepergas) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:41 - -___ - -### nonce - -• **nonce**: `number` - -#### Inherited from - -[Transaction](verida_vda_sbt_client._internal_.Transaction.md).[nonce](verida_vda_sbt_client._internal_.Transaction.md#nonce) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:30 - -___ - -### r - -• `Optional` **r**: `string` - -#### Inherited from - -[Transaction](verida_vda_sbt_client._internal_.Transaction.md).[r](verida_vda_sbt_client._internal_.Transaction.md#r) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:36 - -___ - -### raw - -• `Optional` **raw**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:30 - -___ - -### s - -• `Optional` **s**: `string` - -#### Inherited from - -[Transaction](verida_vda_sbt_client._internal_.Transaction.md).[s](verida_vda_sbt_client._internal_.Transaction.md#s) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:37 - -___ - -### timestamp - -• `Optional` **timestamp**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:27 - -___ - -### to - -• `Optional` **to**: `string` - -#### Inherited from - -[Transaction](verida_vda_sbt_client._internal_.Transaction.md).[to](verida_vda_sbt_client._internal_.Transaction.md#to) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:28 - -___ - -### type - -• `Optional` **type**: ``null`` \| `number` - -#### Inherited from - -[Transaction](verida_vda_sbt_client._internal_.Transaction.md).[type](verida_vda_sbt_client._internal_.Transaction.md#type) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:39 - -___ - -### v - -• `Optional` **v**: `number` - -#### Inherited from - -[Transaction](verida_vda_sbt_client._internal_.Transaction.md).[v](verida_vda_sbt_client._internal_.Transaction.md#v) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:38 - -___ - -### value - -• **value**: [`BigNumber`](../classes/verida_vda_sbt_client._internal_.BigNumber.md) - -#### Inherited from - -[Transaction](verida_vda_sbt_client._internal_.Transaction.md).[value](verida_vda_sbt_client._internal_.Transaction.md#value) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:34 - -## Methods - -### wait - -▸ **wait**(`confirmations?`): `Promise`<[`TransactionReceipt`](verida_vda_sbt_client._internal_.TransactionReceipt.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `confirmations?` | `number` | - -#### Returns - -`Promise`<[`TransactionReceipt`](verida_vda_sbt_client._internal_.TransactionReceipt.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:31 diff --git a/docs/api/verida-js/interfaces/verida_vda_sbt_client._internal_.VdaClientConfig.md b/docs/api/verida-js/interfaces/verida_vda_sbt_client._internal_.VdaClientConfig.md deleted file mode 100644 index 3375059..0000000 --- a/docs/api/verida-js/interfaces/verida_vda_sbt_client._internal_.VdaClientConfig.md +++ /dev/null @@ -1,77 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-sbt-client](../modules/verida_vda_sbt_client.md) / [](../modules/verida_vda_sbt_client._internal_.md) / VdaClientConfig - -# Interface: VdaClientConfig - -[@verida/vda-sbt-client](../modules/verida_vda_sbt_client.md).[](../modules/verida_vda_sbt_client._internal_.md).VdaClientConfig - -Interface for vda-xxx-client instance creation. - -**`param`** DID - -**`param`** private key of DID. Used to generate signature in transactions to chains - -**`param`** Target chain name or chain id. - -**`param`** : VDA-DID run mode. Values from vda-did-resolver - -**`param`** Web3 configuration depending on call type. Values from vda-did-resolver - -## Table of contents - -### Properties - -- [callType](verida_vda_sbt_client._internal_.VdaClientConfig.md#calltype) -- [did](verida_vda_sbt_client._internal_.VdaClientConfig.md#did) -- [network](verida_vda_sbt_client._internal_.VdaClientConfig.md#network) -- [signKey](verida_vda_sbt_client._internal_.VdaClientConfig.md#signkey) -- [web3Options](verida_vda_sbt_client._internal_.VdaClientConfig.md#web3options) - -## Properties - -### callType - -• `Optional` **callType**: [`Web3CallType`](../modules/verida_vda_sbt_client._internal_.md#web3calltype) - -#### Defined in - -packages/types/dist/VdaClientConfig.d.ts:15 - -___ - -### did - -• `Optional` **did**: `string` - -#### Defined in - -packages/types/dist/VdaClientConfig.d.ts:13 - -___ - -### network - -• **network**: [`EnvironmentType`](../enums/verida_vda_sbt_client._internal_.EnvironmentType.md) - -#### Defined in - -packages/types/dist/VdaClientConfig.d.ts:12 - -___ - -### signKey - -• `Optional` **signKey**: `string` - -#### Defined in - -packages/types/dist/VdaClientConfig.d.ts:14 - -___ - -### web3Options - -• `Optional` **web3Options**: [`Web3SelfTransactionConfig`](verida_vda_sbt_client._internal_.Web3SelfTransactionConfig.md) \| [`Web3MetaTransactionConfig`](verida_vda_sbt_client._internal_.Web3MetaTransactionConfig.md) - -#### Defined in - -packages/types/dist/VdaClientConfig.d.ts:16 diff --git a/docs/api/verida-js/interfaces/verida_vda_sbt_client._internal_.VdaTransactionResult.md b/docs/api/verida-js/interfaces/verida_vda_sbt_client._internal_.VdaTransactionResult.md deleted file mode 100644 index 840c03c..0000000 --- a/docs/api/verida-js/interfaces/verida_vda_sbt_client._internal_.VdaTransactionResult.md +++ /dev/null @@ -1,43 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-sbt-client](../modules/verida_vda_sbt_client.md) / [](../modules/verida_vda_sbt_client._internal_.md) / VdaTransactionResult - -# Interface: VdaTransactionResult - -[@verida/vda-sbt-client](../modules/verida_vda_sbt_client.md).[](../modules/verida_vda_sbt_client._internal_.md).VdaTransactionResult - -## Table of contents - -### Properties - -- [data](verida_vda_sbt_client._internal_.VdaTransactionResult.md#data) -- [error](verida_vda_sbt_client._internal_.VdaTransactionResult.md#error) -- [success](verida_vda_sbt_client._internal_.VdaTransactionResult.md#success) - -## Properties - -### data - -• `Optional` **data**: `any` - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:124 - -___ - -### error - -• `Optional` **error**: `string` - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:125 - -___ - -### success - -• **success**: `boolean` - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:123 diff --git a/docs/api/verida-js/interfaces/verida_vda_sbt_client._internal_.Web3ContractInfo.md b/docs/api/verida-js/interfaces/verida_vda_sbt_client._internal_.Web3ContractInfo.md deleted file mode 100644 index 6fea60e..0000000 --- a/docs/api/verida-js/interfaces/verida_vda_sbt_client._internal_.Web3ContractInfo.md +++ /dev/null @@ -1,45 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-sbt-client](../modules/verida_vda_sbt_client.md) / [](../modules/verida_vda_sbt_client._internal_.md) / Web3ContractInfo - -# Interface: Web3ContractInfo - -[@verida/vda-sbt-client](../modules/verida_vda_sbt_client.md).[](../modules/verida_vda_sbt_client._internal_.md).Web3ContractInfo - -Contract Info. Used for 'web3' mode - -## Table of contents - -### Properties - -- [abi](verida_vda_sbt_client._internal_.Web3ContractInfo.md#abi) -- [address](verida_vda_sbt_client._internal_.Web3ContractInfo.md#address) -- [logPerformance](verida_vda_sbt_client._internal_.Web3ContractInfo.md#logperformance) - -## Properties - -### abi - -• **abi**: `any` - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:8 - -___ - -### address - -• **address**: `string` - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:9 - -___ - -### logPerformance - -• `Optional` **logPerformance**: `boolean` - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:10 diff --git a/docs/api/verida-js/interfaces/verida_vda_sbt_client._internal_.Web3GasConfiguration.md b/docs/api/verida-js/interfaces/verida_vda_sbt_client._internal_.Web3GasConfiguration.md deleted file mode 100644 index e63bf1e..0000000 --- a/docs/api/verida-js/interfaces/verida_vda_sbt_client._internal_.Web3GasConfiguration.md +++ /dev/null @@ -1,91 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-sbt-client](../modules/verida_vda_sbt_client.md) / [](../modules/verida_vda_sbt_client._internal_.md) / Web3GasConfiguration - -# Interface: Web3GasConfiguration - -[@verida/vda-sbt-client](../modules/verida_vda_sbt_client.md).[](../modules/verida_vda_sbt_client._internal_.md).Web3GasConfiguration - -Gas configuration - -eip1559Mode - optional - Once this parameter is set, all other parameters are not used. Gas information is pulled from network. - -maxFeePerGas - optional - Used for EIP1559 chains -maxPriorityFeePerGas - optional - Used for EIP1559 chains -gasLimit - optional - Used for non EIP1559 chains -gasPrice - optional - Used for non EIP1559 chains - -## Hierarchy - -- **`Web3GasConfiguration`** - - ↳ [`Web3SelfTransactionConfig`](verida_vda_sbt_client._internal_.Web3SelfTransactionConfig.md) - -## Table of contents - -### Properties - -- [eip1559Mode](verida_vda_sbt_client._internal_.Web3GasConfiguration.md#eip1559mode) -- [eip1559gasStationUrl](verida_vda_sbt_client._internal_.Web3GasConfiguration.md#eip1559gasstationurl) -- [gasLimit](verida_vda_sbt_client._internal_.Web3GasConfiguration.md#gaslimit) -- [gasPrice](verida_vda_sbt_client._internal_.Web3GasConfiguration.md#gasprice) -- [maxFeePerGas](verida_vda_sbt_client._internal_.Web3GasConfiguration.md#maxfeepergas) -- [maxPriorityFeePerGas](verida_vda_sbt_client._internal_.Web3GasConfiguration.md#maxpriorityfeepergas) - -## Properties - -### eip1559Mode - -• `Optional` **eip1559Mode**: [`EIP1559GasMode`](../modules/verida_vda_sbt_client._internal_.md#eip1559gasmode) - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:24 - -___ - -### eip1559gasStationUrl - -• `Optional` **eip1559gasStationUrl**: `string` - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:25 - -___ - -### gasLimit - -• `Optional` **gasLimit**: [`BigNumber`](../classes/verida_vda_sbt_client._internal_.BigNumber.md) - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:28 - -___ - -### gasPrice - -• `Optional` **gasPrice**: [`BigNumber`](../classes/verida_vda_sbt_client._internal_.BigNumber.md) - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:29 - -___ - -### maxFeePerGas - -• `Optional` **maxFeePerGas**: [`BigNumber`](../classes/verida_vda_sbt_client._internal_.BigNumber.md) - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:26 - -___ - -### maxPriorityFeePerGas - -• `Optional` **maxPriorityFeePerGas**: [`BigNumber`](../classes/verida_vda_sbt_client._internal_.BigNumber.md) - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:27 diff --git a/docs/api/verida-js/interfaces/verida_vda_sbt_client._internal_.Web3GaslessPostConfig.md b/docs/api/verida-js/interfaces/verida_vda_sbt_client._internal_.Web3GaslessPostConfig.md deleted file mode 100644 index 7826790..0000000 --- a/docs/api/verida-js/interfaces/verida_vda_sbt_client._internal_.Web3GaslessPostConfig.md +++ /dev/null @@ -1,37 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-sbt-client](../modules/verida_vda_sbt_client.md) / [](../modules/verida_vda_sbt_client._internal_.md) / Web3GaslessPostConfig - -# Interface: Web3GaslessPostConfig - -[@verida/vda-sbt-client](../modules/verida_vda_sbt_client.md).[](../modules/verida_vda_sbt_client._internal_.md).Web3GaslessPostConfig - -Configuration type for gasless post - -## Indexable - -▪ [key: `string`]: `any` - -## Table of contents - -### Properties - -- [headers](verida_vda_sbt_client._internal_.Web3GaslessPostConfig.md#headers) - -## Properties - -### headers - -• **headers**: `Object` - -#### Index signature - -▪ [key: `string`]: `any` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `user-agent` | `string` | - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:64 diff --git a/docs/api/verida-js/interfaces/verida_vda_sbt_client._internal_.Web3GaslessRequestConfig.md b/docs/api/verida-js/interfaces/verida_vda_sbt_client._internal_.Web3GaslessRequestConfig.md deleted file mode 100644 index 088aaf8..0000000 --- a/docs/api/verida-js/interfaces/verida_vda_sbt_client._internal_.Web3GaslessRequestConfig.md +++ /dev/null @@ -1,37 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-sbt-client](../modules/verida_vda_sbt_client.md) / [](../modules/verida_vda_sbt_client._internal_.md) / Web3GaslessRequestConfig - -# Interface: Web3GaslessRequestConfig - -[@verida/vda-sbt-client](../modules/verida_vda_sbt_client.md).[](../modules/verida_vda_sbt_client._internal_.md).Web3GaslessRequestConfig - -Configuration type for gasless request - -## Indexable - -▪ [key: `string`]: `any` - -## Table of contents - -### Properties - -- [headers](verida_vda_sbt_client._internal_.Web3GaslessRequestConfig.md#headers) - -## Properties - -### headers - -• **headers**: `Object` - -#### Index signature - -▪ [key: `string`]: `any` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `context-name` | `string` | - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:56 diff --git a/docs/api/verida-js/interfaces/verida_vda_sbt_client._internal_.Web3MetaTransactionConfig.md b/docs/api/verida-js/interfaces/verida_vda_sbt_client._internal_.Web3MetaTransactionConfig.md deleted file mode 100644 index 9c72838..0000000 --- a/docs/api/verida-js/interfaces/verida_vda_sbt_client._internal_.Web3MetaTransactionConfig.md +++ /dev/null @@ -1,45 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-sbt-client](../modules/verida_vda_sbt_client.md) / [](../modules/verida_vda_sbt_client._internal_.md) / Web3MetaTransactionConfig - -# Interface: Web3MetaTransactionConfig - -[@verida/vda-sbt-client](../modules/verida_vda_sbt_client.md).[](../modules/verida_vda_sbt_client._internal_.md).Web3MetaTransactionConfig - -Configuration type for gasless mode - -## Table of contents - -### Properties - -- [endpointUrl](verida_vda_sbt_client._internal_.Web3MetaTransactionConfig.md#endpointurl) -- [postConfig](verida_vda_sbt_client._internal_.Web3MetaTransactionConfig.md#postconfig) -- [serverConfig](verida_vda_sbt_client._internal_.Web3MetaTransactionConfig.md#serverconfig) - -## Properties - -### endpointUrl - -• **endpointUrl**: `string` - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:51 - -___ - -### postConfig - -• **postConfig**: [`Web3GaslessPostConfig`](verida_vda_sbt_client._internal_.Web3GaslessPostConfig.md) - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:50 - -___ - -### serverConfig - -• **serverConfig**: [`Web3GaslessRequestConfig`](verida_vda_sbt_client._internal_.Web3GaslessRequestConfig.md) - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:49 diff --git a/docs/api/verida-js/interfaces/verida_vda_sbt_client._internal_.Web3SelfTransactionConfig.md b/docs/api/verida-js/interfaces/verida_vda_sbt_client._internal_.Web3SelfTransactionConfig.md deleted file mode 100644 index 62ba6b1..0000000 --- a/docs/api/verida-js/interfaces/verida_vda_sbt_client._internal_.Web3SelfTransactionConfig.md +++ /dev/null @@ -1,179 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-sbt-client](../modules/verida_vda_sbt_client.md) / [](../modules/verida_vda_sbt_client._internal_.md) / Web3SelfTransactionConfig - -# Interface: Web3SelfTransactionConfig - -[@verida/vda-sbt-client](../modules/verida_vda_sbt_client.md).[](../modules/verida_vda_sbt_client._internal_.md).Web3SelfTransactionConfig - -Configuration type for Web3 mode - -signer - optional - a Signer that sign the blockchain transactions. If a 'signer' is not provided, then 'contract' with an attached signer need to be used to make transactions -provider - optional - a web3 provider. At least one of `signer`,`provider`, or `rpcUrl` is required -rpcUrl - optinal - a JSON-RPC URL that can be used to connect to an ethereum network. At least one of `signer`, `provider`, or `rpcUrl` is required -web3 - optional - Can use provider or web.currentProvider as a provider. - -## Hierarchy - -- [`Web3GasConfiguration`](verida_vda_sbt_client._internal_.Web3GasConfiguration.md) - - ↳ **`Web3SelfTransactionConfig`** - -## Table of contents - -### Properties - -- [eip1559Mode](verida_vda_sbt_client._internal_.Web3SelfTransactionConfig.md#eip1559mode) -- [eip1559gasStationUrl](verida_vda_sbt_client._internal_.Web3SelfTransactionConfig.md#eip1559gasstationurl) -- [gasLimit](verida_vda_sbt_client._internal_.Web3SelfTransactionConfig.md#gaslimit) -- [gasPrice](verida_vda_sbt_client._internal_.Web3SelfTransactionConfig.md#gasprice) -- [maxFeePerGas](verida_vda_sbt_client._internal_.Web3SelfTransactionConfig.md#maxfeepergas) -- [maxPriorityFeePerGas](verida_vda_sbt_client._internal_.Web3SelfTransactionConfig.md#maxpriorityfeepergas) -- [methodDefaults](verida_vda_sbt_client._internal_.Web3SelfTransactionConfig.md#methoddefaults) -- [privateKey](verida_vda_sbt_client._internal_.Web3SelfTransactionConfig.md#privatekey) -- [provider](verida_vda_sbt_client._internal_.Web3SelfTransactionConfig.md#provider) -- [rpcUrl](verida_vda_sbt_client._internal_.Web3SelfTransactionConfig.md#rpcurl) -- [signer](verida_vda_sbt_client._internal_.Web3SelfTransactionConfig.md#signer) -- [web3](verida_vda_sbt_client._internal_.Web3SelfTransactionConfig.md#web3) - -## Properties - -### eip1559Mode - -• `Optional` **eip1559Mode**: [`EIP1559GasMode`](../modules/verida_vda_sbt_client._internal_.md#eip1559gasmode) - -#### Inherited from - -[Web3GasConfiguration](verida_vda_sbt_client._internal_.Web3GasConfiguration.md).[eip1559Mode](verida_vda_sbt_client._internal_.Web3GasConfiguration.md#eip1559mode) - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:24 - -___ - -### eip1559gasStationUrl - -• `Optional` **eip1559gasStationUrl**: `string` - -#### Inherited from - -[Web3GasConfiguration](verida_vda_sbt_client._internal_.Web3GasConfiguration.md).[eip1559gasStationUrl](verida_vda_sbt_client._internal_.Web3GasConfiguration.md#eip1559gasstationurl) - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:25 - -___ - -### gasLimit - -• `Optional` **gasLimit**: [`BigNumber`](../classes/verida_vda_sbt_client._internal_.BigNumber.md) - -#### Inherited from - -[Web3GasConfiguration](verida_vda_sbt_client._internal_.Web3GasConfiguration.md).[gasLimit](verida_vda_sbt_client._internal_.Web3GasConfiguration.md#gaslimit) - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:28 - -___ - -### gasPrice - -• `Optional` **gasPrice**: [`BigNumber`](../classes/verida_vda_sbt_client._internal_.BigNumber.md) - -#### Inherited from - -[Web3GasConfiguration](verida_vda_sbt_client._internal_.Web3GasConfiguration.md).[gasPrice](verida_vda_sbt_client._internal_.Web3GasConfiguration.md#gasprice) - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:29 - -___ - -### maxFeePerGas - -• `Optional` **maxFeePerGas**: [`BigNumber`](../classes/verida_vda_sbt_client._internal_.BigNumber.md) - -#### Inherited from - -[Web3GasConfiguration](verida_vda_sbt_client._internal_.Web3GasConfiguration.md).[maxFeePerGas](verida_vda_sbt_client._internal_.Web3GasConfiguration.md#maxfeepergas) - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:26 - -___ - -### maxPriorityFeePerGas - -• `Optional` **maxPriorityFeePerGas**: [`BigNumber`](../classes/verida_vda_sbt_client._internal_.BigNumber.md) - -#### Inherited from - -[Web3GasConfiguration](verida_vda_sbt_client._internal_.Web3GasConfiguration.md).[maxPriorityFeePerGas](verida_vda_sbt_client._internal_.Web3GasConfiguration.md#maxpriorityfeepergas) - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:27 - -___ - -### methodDefaults - -• `Optional` **methodDefaults**: [`Record`](../modules/verida_vda_sbt_client._internal_.md#record)<`string`, [`Web3GasConfiguration`](verida_vda_sbt_client._internal_.Web3GasConfiguration.md)\> - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:45 - -___ - -### privateKey - -• `Optional` **privateKey**: `string` - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:41 - -___ - -### provider - -• `Optional` **provider**: [`Provider`](../classes/verida_vda_sbt_client._internal_.Provider.md) - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:42 - -___ - -### rpcUrl - -• `Optional` **rpcUrl**: `string` - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:43 - -___ - -### signer - -• `Optional` **signer**: [`Signer`](../classes/verida_vda_sbt_client._internal_.Signer.md) - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:40 - -___ - -### web3 - -• `Optional` **web3**: `any` - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:44 diff --git a/docs/api/verida-js/interfaces/verida_vda_sbt_client._internal_._Block.md b/docs/api/verida-js/interfaces/verida_vda_sbt_client._internal_._Block.md deleted file mode 100644 index ffc017c..0000000 --- a/docs/api/verida-js/interfaces/verida_vda_sbt_client._internal_._Block.md +++ /dev/null @@ -1,150 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-sbt-client](../modules/verida_vda_sbt_client.md) / [](../modules/verida_vda_sbt_client._internal_.md) / \_Block - -# Interface: \_Block - -[@verida/vda-sbt-client](../modules/verida_vda_sbt_client.md).[](../modules/verida_vda_sbt_client._internal_.md)._Block - -## Hierarchy - -- **`_Block`** - - ↳ [`Block`](verida_vda_sbt_client._internal_.Block.md) - - ↳ [`BlockWithTransactions`](verida_vda_sbt_client._internal_.BlockWithTransactions.md) - -## Table of contents - -### Properties - -- [\_difficulty](verida_vda_sbt_client._internal_._Block.md#_difficulty) -- [baseFeePerGas](verida_vda_sbt_client._internal_._Block.md#basefeepergas) -- [difficulty](verida_vda_sbt_client._internal_._Block.md#difficulty) -- [extraData](verida_vda_sbt_client._internal_._Block.md#extradata) -- [gasLimit](verida_vda_sbt_client._internal_._Block.md#gaslimit) -- [gasUsed](verida_vda_sbt_client._internal_._Block.md#gasused) -- [hash](verida_vda_sbt_client._internal_._Block.md#hash) -- [miner](verida_vda_sbt_client._internal_._Block.md#miner) -- [nonce](verida_vda_sbt_client._internal_._Block.md#nonce) -- [number](verida_vda_sbt_client._internal_._Block.md#number) -- [parentHash](verida_vda_sbt_client._internal_._Block.md#parenthash) -- [timestamp](verida_vda_sbt_client._internal_._Block.md#timestamp) - -## Properties - -### \_difficulty - -• **\_difficulty**: [`BigNumber`](../classes/verida_vda_sbt_client._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:41 - -___ - -### baseFeePerGas - -• `Optional` **baseFeePerGas**: ``null`` \| [`BigNumber`](../classes/verida_vda_sbt_client._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:46 - -___ - -### difficulty - -• **difficulty**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:40 - -___ - -### extraData - -• **extraData**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:45 - -___ - -### gasLimit - -• **gasLimit**: [`BigNumber`](../classes/verida_vda_sbt_client._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:42 - -___ - -### gasUsed - -• **gasUsed**: [`BigNumber`](../classes/verida_vda_sbt_client._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:43 - -___ - -### hash - -• **hash**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:35 - -___ - -### miner - -• **miner**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:44 - -___ - -### nonce - -• **nonce**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:39 - -___ - -### number - -• **number**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:37 - -___ - -### parentHash - -• **parentHash**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:36 - -___ - -### timestamp - -• **timestamp**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:38 diff --git a/docs/api/verida-js/interfaces/verida_verifiable_credentials.CreateCredentialJWT.md b/docs/api/verida-js/interfaces/verida_verifiable_credentials.CreateCredentialJWT.md deleted file mode 100644 index 8904f76..0000000 --- a/docs/api/verida-js/interfaces/verida_verifiable_credentials.CreateCredentialJWT.md +++ /dev/null @@ -1,76 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / CreateCredentialJWT - -# Interface: CreateCredentialJWT - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).CreateCredentialJWT - -## Table of contents - -### Properties - -- [context](verida_verifiable_credentials.CreateCredentialJWT.md#context) -- [data](verida_verifiable_credentials.CreateCredentialJWT.md#data) -- [options](verida_verifiable_credentials.CreateCredentialJWT.md#options) -- [payload](verida_verifiable_credentials.CreateCredentialJWT.md#payload) -- [schema](verida_verifiable_credentials.CreateCredentialJWT.md#schema) -- [subjectId](verida_verifiable_credentials.CreateCredentialJWT.md#subjectid) - -## Properties - -### context - -• **context**: [`IContext`](verida_verifiable_credentials._internal_.IContext.md) - -#### Defined in - -[packages/verifiable-credentials/src/interfaces.ts:24](https://github.com/verida/verida-js/blob/5040472/packages/verifiable-credentials/src/interfaces.ts#L24) - -___ - -### data - -• **data**: `any` - -#### Defined in - -[packages/verifiable-credentials/src/interfaces.ts:22](https://github.com/verida/verida-js/blob/5040472/packages/verifiable-credentials/src/interfaces.ts#L22) - -___ - -### options - -• `Optional` **options**: [`CreateCredentialOptions`](verida_verifiable_credentials.CreateCredentialOptions.md) - -#### Defined in - -[packages/verifiable-credentials/src/interfaces.ts:20](https://github.com/verida/verida-js/blob/5040472/packages/verifiable-credentials/src/interfaces.ts#L20) - -___ - -### payload - -• `Optional` **payload**: [`Record`](../modules/verida_verifiable_credentials._internal_.md#record)<`string`, `any`\> - -#### Defined in - -[packages/verifiable-credentials/src/interfaces.ts:25](https://github.com/verida/verida-js/blob/5040472/packages/verifiable-credentials/src/interfaces.ts#L25) - -___ - -### schema - -• **schema**: `string` - -#### Defined in - -[packages/verifiable-credentials/src/interfaces.ts:23](https://github.com/verida/verida-js/blob/5040472/packages/verifiable-credentials/src/interfaces.ts#L23) - -___ - -### subjectId - -• **subjectId**: `string` - -#### Defined in - -[packages/verifiable-credentials/src/interfaces.ts:21](https://github.com/verida/verida-js/blob/5040472/packages/verifiable-credentials/src/interfaces.ts#L21) diff --git a/docs/api/verida-js/interfaces/verida_verifiable_credentials.CreateCredentialOptions.md b/docs/api/verida-js/interfaces/verida_verifiable_credentials.CreateCredentialOptions.md deleted file mode 100644 index 4b8dee0..0000000 --- a/docs/api/verida-js/interfaces/verida_verifiable_credentials.CreateCredentialOptions.md +++ /dev/null @@ -1,43 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / CreateCredentialOptions - -# Interface: CreateCredentialOptions - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).CreateCredentialOptions - -## Table of contents - -### Properties - -- [expirationDate](verida_verifiable_credentials.CreateCredentialOptions.md#expirationdate) -- [issuanceDate](verida_verifiable_credentials.CreateCredentialOptions.md#issuancedate) -- [proofStrings](verida_verifiable_credentials.CreateCredentialOptions.md#proofstrings) - -## Properties - -### expirationDate - -• `Optional` **expirationDate**: `string` - -#### Defined in - -[packages/verifiable-credentials/src/interfaces.ts:6](https://github.com/verida/verida-js/blob/5040472/packages/verifiable-credentials/src/interfaces.ts#L6) - -___ - -### issuanceDate - -• `Optional` **issuanceDate**: `string` - -#### Defined in - -[packages/verifiable-credentials/src/interfaces.ts:7](https://github.com/verida/verida-js/blob/5040472/packages/verifiable-credentials/src/interfaces.ts#L7) - -___ - -### proofStrings - -• `Optional` **proofStrings**: [`Record`](../modules/verida_verifiable_credentials._internal_.md#record)<`string`, `string`[]\> - -#### Defined in - -[packages/verifiable-credentials/src/interfaces.ts:8](https://github.com/verida/verida-js/blob/5040472/packages/verifiable-credentials/src/interfaces.ts#L8) diff --git a/docs/api/verida-js/interfaces/verida_verifiable_credentials.VCResult.md b/docs/api/verida-js/interfaces/verida_verifiable_credentials.VCResult.md deleted file mode 100644 index 31129e4..0000000 --- a/docs/api/verida-js/interfaces/verida_verifiable_credentials.VCResult.md +++ /dev/null @@ -1,65 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / VCResult - -# Interface: VCResult - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).VCResult - -## Table of contents - -### Properties - -- [did](verida_verifiable_credentials.VCResult.md#did) -- [item](verida_verifiable_credentials.VCResult.md#item) -- [publicUri](verida_verifiable_credentials.VCResult.md#publicuri) -- [result](verida_verifiable_credentials.VCResult.md#result) -- [veridaUri](verida_verifiable_credentials.VCResult.md#veridauri) - -## Properties - -### did - -• **did**: `string` - -#### Defined in - -[packages/verifiable-credentials/src/interfaces.ts:14](https://github.com/verida/verida-js/blob/5040472/packages/verifiable-credentials/src/interfaces.ts#L14) - -___ - -### item - -• **item**: `any` - -#### Defined in - -[packages/verifiable-credentials/src/interfaces.ts:12](https://github.com/verida/verida-js/blob/5040472/packages/verifiable-credentials/src/interfaces.ts#L12) - -___ - -### publicUri - -• **publicUri**: `string` - -#### Defined in - -[packages/verifiable-credentials/src/interfaces.ts:16](https://github.com/verida/verida-js/blob/5040472/packages/verifiable-credentials/src/interfaces.ts#L16) - -___ - -### result - -• **result**: `any` - -#### Defined in - -[packages/verifiable-credentials/src/interfaces.ts:13](https://github.com/verida/verida-js/blob/5040472/packages/verifiable-credentials/src/interfaces.ts#L13) - -___ - -### veridaUri - -• **veridaUri**: `string` - -#### Defined in - -[packages/verifiable-credentials/src/interfaces.ts:15](https://github.com/verida/verida-js/blob/5040472/packages/verifiable-credentials/src/interfaces.ts#L15) diff --git a/docs/api/verida-js/interfaces/verida_verifiable_credentials.VeridaCredentialRecord.md b/docs/api/verida-js/interfaces/verida_verifiable_credentials.VeridaCredentialRecord.md deleted file mode 100644 index 83bc64f..0000000 --- a/docs/api/verida-js/interfaces/verida_verifiable_credentials.VeridaCredentialRecord.md +++ /dev/null @@ -1,87 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / VeridaCredentialRecord - -# Interface: VeridaCredentialRecord - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).VeridaCredentialRecord - -## Table of contents - -### Properties - -- [credentialData](verida_verifiable_credentials.VeridaCredentialRecord.md#credentialdata) -- [credentialSchema](verida_verifiable_credentials.VeridaCredentialRecord.md#credentialschema) -- [didJwtVc](verida_verifiable_credentials.VeridaCredentialRecord.md#didjwtvc) -- [icon](verida_verifiable_credentials.VeridaCredentialRecord.md#icon) -- [name](verida_verifiable_credentials.VeridaCredentialRecord.md#name) -- [schema](verida_verifiable_credentials.VeridaCredentialRecord.md#schema) -- [summary](verida_verifiable_credentials.VeridaCredentialRecord.md#summary) - -## Properties - -### credentialData - -• **credentialData**: [`Record`](../modules/verida_verifiable_credentials._internal_.md#record)<`string`, `string` \| `object`\> - -#### Defined in - -[packages/verifiable-credentials/src/interfaces.ts:35](https://github.com/verida/verida-js/blob/5040472/packages/verifiable-credentials/src/interfaces.ts#L35) - -___ - -### credentialSchema - -• **credentialSchema**: `string` - -#### Defined in - -[packages/verifiable-credentials/src/interfaces.ts:34](https://github.com/verida/verida-js/blob/5040472/packages/verifiable-credentials/src/interfaces.ts#L34) - -___ - -### didJwtVc - -• **didJwtVc**: `string` - -#### Defined in - -[packages/verifiable-credentials/src/interfaces.ts:33](https://github.com/verida/verida-js/blob/5040472/packages/verifiable-credentials/src/interfaces.ts#L33) - -___ - -### icon - -• `Optional` **icon**: `string` - -#### Defined in - -[packages/verifiable-credentials/src/interfaces.ts:32](https://github.com/verida/verida-js/blob/5040472/packages/verifiable-credentials/src/interfaces.ts#L32) - -___ - -### name - -• **name**: `string` - -#### Defined in - -[packages/verifiable-credentials/src/interfaces.ts:30](https://github.com/verida/verida-js/blob/5040472/packages/verifiable-credentials/src/interfaces.ts#L30) - -___ - -### schema - -• **schema**: `string` - -#### Defined in - -[packages/verifiable-credentials/src/interfaces.ts:29](https://github.com/verida/verida-js/blob/5040472/packages/verifiable-credentials/src/interfaces.ts#L29) - -___ - -### summary - -• `Optional` **summary**: `string` - -#### Defined in - -[packages/verifiable-credentials/src/interfaces.ts:31](https://github.com/verida/verida-js/blob/5040472/packages/verifiable-credentials/src/interfaces.ts#L31) diff --git a/docs/api/verida-js/interfaces/verida_verifiable_credentials.VeridaCredentialSchema.md b/docs/api/verida-js/interfaces/verida_verifiable_credentials.VeridaCredentialSchema.md deleted file mode 100644 index df9ff2c..0000000 --- a/docs/api/verida-js/interfaces/verida_verifiable_credentials.VeridaCredentialSchema.md +++ /dev/null @@ -1,21 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / VeridaCredentialSchema - -# Interface: VeridaCredentialSchema - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).VeridaCredentialSchema - -## Table of contents - -### Properties - -- [veridaProofs](verida_verifiable_credentials.VeridaCredentialSchema.md#veridaproofs) - -## Properties - -### veridaProofs - -• `Optional` **veridaProofs**: [`Record`](../modules/verida_verifiable_credentials._internal_.md#record)<`string`, `string`[]\> - -#### Defined in - -[packages/verifiable-credentials/src/interfaces.ts:39](https://github.com/verida/verida-js/blob/5040472/packages/verifiable-credentials/src/interfaces.ts#L39) diff --git a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.AbortSignal.md b/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.AbortSignal.md deleted file mode 100644 index 94eba7a..0000000 --- a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.AbortSignal.md +++ /dev/null @@ -1,25 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / AbortSignal - -# Interface: AbortSignal - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md).AbortSignal - -A signal object that allows you to communicate with a DOM request (such as a Fetch) and abort it if required via an AbortController object. - -## Table of contents - -### Properties - -- [aborted](verida_verifiable_credentials._internal_.AbortSignal.md#aborted) - -## Properties - -### aborted - -• `Readonly` **aborted**: `boolean` - -Returns true if this AbortSignal's AbortController has signaled to abort, and false otherwise. - -#### Defined in - -node_modules/@types/node/globals.d.ts:64 diff --git a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.AccountConfig.md b/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.AccountConfig.md deleted file mode 100644 index 49d337e..0000000 --- a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.AccountConfig.md +++ /dev/null @@ -1,54 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / AccountConfig - -# Interface: AccountConfig - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md).AccountConfig - -## Table of contents - -### Properties - -- [defaultDatabaseServer](verida_verifiable_credentials._internal_.AccountConfig.md#defaultdatabaseserver) -- [defaultMessageServer](verida_verifiable_credentials._internal_.AccountConfig.md#defaultmessageserver) -- [defaultNotificationServer](verida_verifiable_credentials._internal_.AccountConfig.md#defaultnotificationserver) -- [defaultStorageServer](verida_verifiable_credentials._internal_.AccountConfig.md#defaultstorageserver) - -## Properties - -### defaultDatabaseServer - -• **defaultDatabaseServer**: [`SecureContextEndpoint`](verida_verifiable_credentials._internal_.SecureContextEndpoint.md) - -#### Defined in - -packages/types/dist/AccountInterfaces.d.ts:7 - -___ - -### defaultMessageServer - -• **defaultMessageServer**: [`SecureContextEndpoint`](verida_verifiable_credentials._internal_.SecureContextEndpoint.md) - -#### Defined in - -packages/types/dist/AccountInterfaces.d.ts:8 - -___ - -### defaultNotificationServer - -• `Optional` **defaultNotificationServer**: [`SecureContextEndpoint`](verida_verifiable_credentials._internal_.SecureContextEndpoint.md) - -#### Defined in - -packages/types/dist/AccountInterfaces.d.ts:10 - -___ - -### defaultStorageServer - -• `Optional` **defaultStorageServer**: [`SecureContextEndpoint`](verida_verifiable_credentials._internal_.SecureContextEndpoint.md) - -#### Defined in - -packages/types/dist/AccountInterfaces.d.ts:9 diff --git a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.AsyncFormatDefinition.md b/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.AsyncFormatDefinition.md deleted file mode 100644 index f3cbd17..0000000 --- a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.AsyncFormatDefinition.md +++ /dev/null @@ -1,60 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / AsyncFormatDefinition - -# Interface: AsyncFormatDefinition - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md).AsyncFormatDefinition - -## Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | extends `string` \| `number` | - -## Table of contents - -### Properties - -- [async](verida_verifiable_credentials._internal_.AsyncFormatDefinition.md#async) -- [compare](verida_verifiable_credentials._internal_.AsyncFormatDefinition.md#compare) -- [type](verida_verifiable_credentials._internal_.AsyncFormatDefinition.md#type) -- [validate](verida_verifiable_credentials._internal_.AsyncFormatDefinition.md#validate) - -## Properties - -### async - -• **async**: ``true`` - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:165 - -___ - -### compare - -• `Optional` **compare**: [`FormatCompare`](../modules/verida_verifiable_credentials._internal_.md#formatcompare)<`T`\> - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:166 - -___ - -### type - -• `Optional` **type**: `T` extends `string` ? `undefined` \| ``"string"`` : ``"number"`` - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:163 - -___ - -### validate - -• **validate**: [`AsyncFormatValidator`](../modules/verida_verifiable_credentials._internal_.md#asyncformatvalidator)<`T`\> - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:164 diff --git a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.AsyncIterableIterator.md b/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.AsyncIterableIterator.md deleted file mode 100644 index 8e0296e..0000000 --- a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.AsyncIterableIterator.md +++ /dev/null @@ -1,112 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / AsyncIterableIterator - -# Interface: AsyncIterableIterator - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md).AsyncIterableIterator - -## Type parameters - -| Name | -| :------ | -| `T` | - -## Hierarchy - -- [`AsyncIterator`](verida_verifiable_credentials._internal_.AsyncIterator.md)<`T`\> - - ↳ **`AsyncIterableIterator`** - -## Table of contents - -### Methods - -- [[asyncIterator]](verida_verifiable_credentials._internal_.AsyncIterableIterator.md#[asynciterator]) -- [next](verida_verifiable_credentials._internal_.AsyncIterableIterator.md#next) -- [return](verida_verifiable_credentials._internal_.AsyncIterableIterator.md#return) -- [throw](verida_verifiable_credentials._internal_.AsyncIterableIterator.md#throw) - -## Methods - -### [asyncIterator] - -▸ **[asyncIterator]**(): [`AsyncIterableIterator`](verida_verifiable_credentials._internal_.AsyncIterableIterator.md)<`T`\> - -#### Returns - -[`AsyncIterableIterator`](verida_verifiable_credentials._internal_.AsyncIterableIterator.md)<`T`\> - -#### Defined in - -node_modules/typescript/lib/lib.es2018.asynciterable.d.ts:44 - -___ - -### next - -▸ **next**(...`args`): `Promise`<[`IteratorResult`](../modules/verida_verifiable_credentials._internal_.md#iteratorresult)<`T`, `any`\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `...args` | [] \| [`undefined`] | - -#### Returns - -`Promise`<[`IteratorResult`](../modules/verida_verifiable_credentials._internal_.md#iteratorresult)<`T`, `any`\>\> - -#### Inherited from - -[AsyncIterator](verida_verifiable_credentials._internal_.AsyncIterator.md).[next](verida_verifiable_credentials._internal_.AsyncIterator.md#next) - -#### Defined in - -node_modules/typescript/lib/lib.es2018.asynciterable.d.ts:34 - -___ - -### return - -▸ `Optional` **return**(`value?`): `Promise`<[`IteratorResult`](../modules/verida_verifiable_credentials._internal_.md#iteratorresult)<`T`, `any`\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value?` | `any` | - -#### Returns - -`Promise`<[`IteratorResult`](../modules/verida_verifiable_credentials._internal_.md#iteratorresult)<`T`, `any`\>\> - -#### Inherited from - -[AsyncIterator](verida_verifiable_credentials._internal_.AsyncIterator.md).[return](verida_verifiable_credentials._internal_.AsyncIterator.md#return) - -#### Defined in - -node_modules/typescript/lib/lib.es2018.asynciterable.d.ts:35 - -___ - -### throw - -▸ `Optional` **throw**(`e?`): `Promise`<[`IteratorResult`](../modules/verida_verifiable_credentials._internal_.md#iteratorresult)<`T`, `any`\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `e?` | `any` | - -#### Returns - -`Promise`<[`IteratorResult`](../modules/verida_verifiable_credentials._internal_.md#iteratorresult)<`T`, `any`\>\> - -#### Inherited from - -[AsyncIterator](verida_verifiable_credentials._internal_.AsyncIterator.md).[throw](verida_verifiable_credentials._internal_.AsyncIterator.md#throw) - -#### Defined in - -node_modules/typescript/lib/lib.es2018.asynciterable.d.ts:36 diff --git a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.AsyncIterator.md b/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.AsyncIterator.md deleted file mode 100644 index c108452..0000000 --- a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.AsyncIterator.md +++ /dev/null @@ -1,87 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / AsyncIterator - -# Interface: AsyncIterator - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md).AsyncIterator - -## Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `T` | -| `TReturn` | `any` | -| `TNext` | `undefined` | - -## Hierarchy - -- **`AsyncIterator`** - - ↳ [`AsyncIterableIterator`](verida_verifiable_credentials._internal_.AsyncIterableIterator.md) - -## Table of contents - -### Methods - -- [next](verida_verifiable_credentials._internal_.AsyncIterator.md#next) -- [return](verida_verifiable_credentials._internal_.AsyncIterator.md#return) -- [throw](verida_verifiable_credentials._internal_.AsyncIterator.md#throw) - -## Methods - -### next - -▸ **next**(...`args`): `Promise`<[`IteratorResult`](../modules/verida_verifiable_credentials._internal_.md#iteratorresult)<`T`, `TReturn`\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `...args` | [] \| [`TNext`] | - -#### Returns - -`Promise`<[`IteratorResult`](../modules/verida_verifiable_credentials._internal_.md#iteratorresult)<`T`, `TReturn`\>\> - -#### Defined in - -node_modules/typescript/lib/lib.es2018.asynciterable.d.ts:34 - -___ - -### return - -▸ `Optional` **return**(`value?`): `Promise`<[`IteratorResult`](../modules/verida_verifiable_credentials._internal_.md#iteratorresult)<`T`, `TReturn`\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value?` | `TReturn` \| [`PromiseLike`](verida_verifiable_credentials._internal_.PromiseLike.md)<`TReturn`\> | - -#### Returns - -`Promise`<[`IteratorResult`](../modules/verida_verifiable_credentials._internal_.md#iteratorresult)<`T`, `TReturn`\>\> - -#### Defined in - -node_modules/typescript/lib/lib.es2018.asynciterable.d.ts:35 - -___ - -### throw - -▸ `Optional` **throw**(`e?`): `Promise`<[`IteratorResult`](../modules/verida_verifiable_credentials._internal_.md#iteratorresult)<`T`, `TReturn`\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `e?` | `any` | - -#### Returns - -`Promise`<[`IteratorResult`](../modules/verida_verifiable_credentials._internal_.md#iteratorresult)<`T`, `TReturn`\>\> - -#### Defined in - -node_modules/typescript/lib/lib.es2018.asynciterable.d.ts:36 diff --git a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.AsyncSchema.md b/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.AsyncSchema.md deleted file mode 100644 index e860989..0000000 --- a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.AsyncSchema.md +++ /dev/null @@ -1,72 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / AsyncSchema - -# Interface: AsyncSchema - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md).AsyncSchema - -## Hierarchy - -- [`_SchemaObject`](verida_verifiable_credentials._internal_._SchemaObject.md) - - ↳ **`AsyncSchema`** - -## Table of contents - -### Properties - -- [$async](verida_verifiable_credentials._internal_.AsyncSchema.md#$async) -- [$id](verida_verifiable_credentials._internal_.AsyncSchema.md#$id) -- [$schema](verida_verifiable_credentials._internal_.AsyncSchema.md#$schema) -- [id](verida_verifiable_credentials._internal_.AsyncSchema.md#id) - -## Properties - -### $async - -• **$async**: ``true`` - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:20 - -___ - -### $id - -• `Optional` **$id**: `string` - -#### Inherited from - -[_SchemaObject](verida_verifiable_credentials._internal_._SchemaObject.md).[$id](verida_verifiable_credentials._internal_._SchemaObject.md#$id) - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:8 - -___ - -### $schema - -• `Optional` **$schema**: `string` - -#### Inherited from - -[_SchemaObject](verida_verifiable_credentials._internal_._SchemaObject.md).[$schema](verida_verifiable_credentials._internal_._SchemaObject.md#$schema) - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:9 - -___ - -### id - -• `Optional` **id**: `string` - -#### Inherited from - -[_SchemaObject](verida_verifiable_credentials._internal_._SchemaObject.md).[id](verida_verifiable_credentials._internal_._SchemaObject.md#id) - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:7 diff --git a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.AsyncValidateFunction.md b/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.AsyncValidateFunction.md deleted file mode 100644 index dce5ee8..0000000 --- a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.AsyncValidateFunction.md +++ /dev/null @@ -1,147 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / AsyncValidateFunction - -# Interface: AsyncValidateFunction - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md).AsyncValidateFunction - -## Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `unknown` | - -## Hierarchy - -- [`ValidateFunction`](verida_verifiable_credentials._internal_.ValidateFunction.md)<`T`\> - - ↳ **`AsyncValidateFunction`** - -## Callable - -### AsyncValidateFunction - -▸ **AsyncValidateFunction**(...`args`): `Promise`<`T`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `...args` | [data: any, dataCxt?: DataValidationCxt] | - -#### Returns - -`Promise`<`T`\> - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:69 - -### AsyncValidateFunction - -▸ **AsyncValidateFunction**(`data`, `dataCxt?`): data is T - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `any` | -| `dataCxt?` | [`DataValidationCxt`](verida_verifiable_credentials._internal_.DataValidationCxt.md)<`string` \| `number`\> | - -#### Returns - -data is T - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:46 - -## Table of contents - -### Properties - -- [$async](verida_verifiable_credentials._internal_.AsyncValidateFunction.md#$async) -- [errors](verida_verifiable_credentials._internal_.AsyncValidateFunction.md#errors) -- [evaluated](verida_verifiable_credentials._internal_.AsyncValidateFunction.md#evaluated) -- [schema](verida_verifiable_credentials._internal_.AsyncValidateFunction.md#schema) -- [schemaEnv](verida_verifiable_credentials._internal_.AsyncValidateFunction.md#schemaenv) -- [source](verida_verifiable_credentials._internal_.AsyncValidateFunction.md#source) - -## Properties - -### $async - -• **$async**: ``true`` - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:70 - -___ - -### errors - -• `Optional` **errors**: ``null`` \| [`ErrorObject`](verida_verifiable_credentials._internal_.ErrorObject.md)<`string`, [`Record`](../modules/verida_verifiable_credentials._internal_.md#record)<`string`, `any`\>, `unknown`\>[] - -#### Inherited from - -[ValidateFunction](verida_verifiable_credentials._internal_.ValidateFunction.md).[errors](verida_verifiable_credentials._internal_.ValidateFunction.md#errors) - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:47 - -___ - -### evaluated - -• `Optional` **evaluated**: [`Evaluated`](verida_verifiable_credentials._internal_.Evaluated.md) - -#### Inherited from - -[ValidateFunction](verida_verifiable_credentials._internal_.ValidateFunction.md).[evaluated](verida_verifiable_credentials._internal_.ValidateFunction.md#evaluated) - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:48 - -___ - -### schema - -• **schema**: [`AnySchema`](../modules/verida_verifiable_credentials._internal_.md#anyschema) - -#### Inherited from - -[ValidateFunction](verida_verifiable_credentials._internal_.ValidateFunction.md).[schema](verida_verifiable_credentials._internal_.ValidateFunction.md#schema) - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:49 - -___ - -### schemaEnv - -• **schemaEnv**: [`SchemaEnv`](../classes/verida_verifiable_credentials._internal_.SchemaEnv.md) - -#### Inherited from - -[ValidateFunction](verida_verifiable_credentials._internal_.ValidateFunction.md).[schemaEnv](verida_verifiable_credentials._internal_.ValidateFunction.md#schemaenv) - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:50 - -___ - -### source - -• `Optional` **source**: [`SourceCode`](verida_verifiable_credentials._internal_.SourceCode.md) - -#### Inherited from - -[ValidateFunction](verida_verifiable_credentials._internal_.ValidateFunction.md).[source](verida_verifiable_credentials._internal_.ValidateFunction.md#source) - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:51 diff --git a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.AuthContext.md b/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.AuthContext.md deleted file mode 100644 index f3482e8..0000000 --- a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.AuthContext.md +++ /dev/null @@ -1,21 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / AuthContext - -# Interface: AuthContext - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md).AuthContext - -## Table of contents - -### Properties - -- [publicSigningKey](verida_verifiable_credentials._internal_.AuthContext.md#publicsigningkey) - -## Properties - -### publicSigningKey - -• **publicSigningKey**: [`SecureContextPublicKey`](verida_verifiable_credentials._internal_.SecureContextPublicKey.md) - -#### Defined in - -packages/types/dist/AccountInterfaces.d.ts:13 diff --git a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.AuthTypeConfig.md b/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.AuthTypeConfig.md deleted file mode 100644 index 954b2d8..0000000 --- a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.AuthTypeConfig.md +++ /dev/null @@ -1,21 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / AuthTypeConfig - -# Interface: AuthTypeConfig - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md).AuthTypeConfig - -## Table of contents - -### Properties - -- [force](verida_verifiable_credentials._internal_.AuthTypeConfig.md#force) - -## Properties - -### force - -• `Optional` **force**: `boolean` - -#### Defined in - -packages/types/dist/AccountInterfaces.d.ts:16 diff --git a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.BoxKeyPair.md b/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.BoxKeyPair.md deleted file mode 100644 index 72cf339..0000000 --- a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.BoxKeyPair.md +++ /dev/null @@ -1,32 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / BoxKeyPair - -# Interface: BoxKeyPair - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md).BoxKeyPair - -## Table of contents - -### Properties - -- [publicKey](verida_verifiable_credentials._internal_.BoxKeyPair.md#publickey) -- [secretKey](verida_verifiable_credentials._internal_.BoxKeyPair.md#secretkey) - -## Properties - -### publicKey - -• **publicKey**: `Uint8Array` - -#### Defined in - -node_modules/tweetnacl/nacl.d.ts:10 - -___ - -### secretKey - -• **secretKey**: `Uint8Array` - -#### Defined in - -node_modules/tweetnacl/nacl.d.ts:11 diff --git a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.CallSite.md b/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.CallSite.md deleted file mode 100644 index b215d89..0000000 --- a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.CallSite.md +++ /dev/null @@ -1,238 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / CallSite - -# Interface: CallSite - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md).CallSite - -## Table of contents - -### Methods - -- [getColumnNumber](verida_verifiable_credentials._internal_.CallSite.md#getcolumnnumber) -- [getEvalOrigin](verida_verifiable_credentials._internal_.CallSite.md#getevalorigin) -- [getFileName](verida_verifiable_credentials._internal_.CallSite.md#getfilename) -- [getFunction](verida_verifiable_credentials._internal_.CallSite.md#getfunction) -- [getFunctionName](verida_verifiable_credentials._internal_.CallSite.md#getfunctionname) -- [getLineNumber](verida_verifiable_credentials._internal_.CallSite.md#getlinenumber) -- [getMethodName](verida_verifiable_credentials._internal_.CallSite.md#getmethodname) -- [getThis](verida_verifiable_credentials._internal_.CallSite.md#getthis) -- [getTypeName](verida_verifiable_credentials._internal_.CallSite.md#gettypename) -- [isConstructor](verida_verifiable_credentials._internal_.CallSite.md#isconstructor) -- [isEval](verida_verifiable_credentials._internal_.CallSite.md#iseval) -- [isNative](verida_verifiable_credentials._internal_.CallSite.md#isnative) -- [isToplevel](verida_verifiable_credentials._internal_.CallSite.md#istoplevel) - -## Methods - -### getColumnNumber - -▸ **getColumnNumber**(): ``null`` \| `number` - -Current column number [if this function was defined in a script] - -#### Returns - -``null`` \| `number` - -#### Defined in - -node_modules/@types/node/globals.d.ts:154 - -___ - -### getEvalOrigin - -▸ **getEvalOrigin**(): `undefined` \| `string` - -A call site object representing the location where eval was called -[if this function was created using a call to eval] - -#### Returns - -`undefined` \| `string` - -#### Defined in - -node_modules/@types/node/globals.d.ts:160 - -___ - -### getFileName - -▸ **getFileName**(): ``null`` \| `string` - -Name of the script [if this function was defined in a script] - -#### Returns - -``null`` \| `string` - -#### Defined in - -node_modules/@types/node/globals.d.ts:144 - -___ - -### getFunction - -▸ **getFunction**(): `undefined` \| `Function` - -Current function - -#### Returns - -`undefined` \| `Function` - -#### Defined in - -node_modules/@types/node/globals.d.ts:126 - -___ - -### getFunctionName - -▸ **getFunctionName**(): ``null`` \| `string` - -Name of the current function, typically its name property. -If a name property is not available an attempt will be made to try -to infer a name from the function's context. - -#### Returns - -``null`` \| `string` - -#### Defined in - -node_modules/@types/node/globals.d.ts:133 - -___ - -### getLineNumber - -▸ **getLineNumber**(): ``null`` \| `number` - -Current line number [if this function was defined in a script] - -#### Returns - -``null`` \| `number` - -#### Defined in - -node_modules/@types/node/globals.d.ts:149 - -___ - -### getMethodName - -▸ **getMethodName**(): ``null`` \| `string` - -Name of the property [of "this" or one of its prototypes] that holds -the current function - -#### Returns - -``null`` \| `string` - -#### Defined in - -node_modules/@types/node/globals.d.ts:139 - -___ - -### getThis - -▸ **getThis**(): `unknown` - -Value of "this" - -#### Returns - -`unknown` - -#### Defined in - -node_modules/@types/node/globals.d.ts:113 - -___ - -### getTypeName - -▸ **getTypeName**(): ``null`` \| `string` - -Type of "this" as a string. -This is the name of the function stored in the constructor field of -"this", if available. Otherwise the object's [[Class]] internal -property. - -#### Returns - -``null`` \| `string` - -#### Defined in - -node_modules/@types/node/globals.d.ts:121 - -___ - -### isConstructor - -▸ **isConstructor**(): `boolean` - -Is this a constructor call? - -#### Returns - -`boolean` - -#### Defined in - -node_modules/@types/node/globals.d.ts:180 - -___ - -### isEval - -▸ **isEval**(): `boolean` - -Does this call take place in code defined by a call to eval? - -#### Returns - -`boolean` - -#### Defined in - -node_modules/@types/node/globals.d.ts:170 - -___ - -### isNative - -▸ **isNative**(): `boolean` - -Is this call in native V8 code? - -#### Returns - -`boolean` - -#### Defined in - -node_modules/@types/node/globals.d.ts:175 - -___ - -### isToplevel - -▸ **isToplevel**(): `boolean` - -Is this a toplevel invocation, that is, is "this" the global object? - -#### Returns - -`boolean` - -#### Defined in - -node_modules/@types/node/globals.d.ts:165 diff --git a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.ClientConfig.md b/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.ClientConfig.md deleted file mode 100644 index fe6818e..0000000 --- a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.ClientConfig.md +++ /dev/null @@ -1,66 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / ClientConfig - -# Interface: ClientConfig - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md).ClientConfig - -Interface for ClientConfig - -## Table of contents - -### Properties - -- [didServerUrl](verida_verifiable_credentials._internal_.ClientConfig.md#didserverurl) -- [environment](verida_verifiable_credentials._internal_.ClientConfig.md#environment) -- [schemaPaths](verida_verifiable_credentials._internal_.ClientConfig.md#schemapaths) -- [vaultAppName](verida_verifiable_credentials._internal_.ClientConfig.md#vaultappname) - -## Properties - -### didServerUrl - -• `Optional` **didServerUrl**: `string` - -URL of Verida DID Server node to use. - -#### Defined in - -packages/client-ts/dist/interfaces.d.ts:21 - -___ - -### environment - -• `Optional` **environment**: [`EnvironmentType`](../enums/verida_verifiable_credentials._internal_.EnvironmentType.md) - -Environment to load by default. - -Environment configuration can still be overriden by config items. - -#### Defined in - -packages/client-ts/dist/interfaces.d.ts:17 - -___ - -### schemaPaths - -• `Optional` **schemaPaths**: `object` - -Specify custom schema paths (typicaly for local development). - -#### Defined in - -packages/client-ts/dist/interfaces.d.ts:25 - -___ - -### vaultAppName - -• `Optional` **vaultAppName**: `string` - -Specify client's App name. - -#### Defined in - -packages/client-ts/dist/interfaces.d.ts:11 diff --git a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.CodeGenOptions.md b/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.CodeGenOptions.md deleted file mode 100644 index 76f64ef..0000000 --- a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.CodeGenOptions.md +++ /dev/null @@ -1,43 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / CodeGenOptions - -# Interface: CodeGenOptions - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md).CodeGenOptions - -## Table of contents - -### Properties - -- [es5](verida_verifiable_credentials._internal_.CodeGenOptions.md#es5) -- [lines](verida_verifiable_credentials._internal_.CodeGenOptions.md#lines) -- [ownProperties](verida_verifiable_credentials._internal_.CodeGenOptions.md#ownproperties) - -## Properties - -### es5 - -• `Optional` **es5**: `boolean` - -#### Defined in - -node_modules/ajv/dist/compile/codegen/index.d.ts:21 - -___ - -### lines - -• `Optional` **lines**: `boolean` - -#### Defined in - -node_modules/ajv/dist/compile/codegen/index.d.ts:22 - -___ - -### ownProperties - -• `Optional` **ownProperties**: `boolean` - -#### Defined in - -node_modules/ajv/dist/compile/codegen/index.d.ts:23 diff --git a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.CodeKeywordDefinition.md b/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.CodeKeywordDefinition.md deleted file mode 100644 index ac3f6fc..0000000 --- a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.CodeKeywordDefinition.md +++ /dev/null @@ -1,247 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / CodeKeywordDefinition - -# Interface: CodeKeywordDefinition - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md).CodeKeywordDefinition - -## Hierarchy - -- [`_KeywordDef`](verida_verifiable_credentials._internal_._KeywordDef.md) - - ↳ **`CodeKeywordDefinition`** - -## Table of contents - -### Properties - -- [$data](verida_verifiable_credentials._internal_.CodeKeywordDefinition.md#$data) -- [$dataError](verida_verifiable_credentials._internal_.CodeKeywordDefinition.md#$dataerror) -- [allowUndefined](verida_verifiable_credentials._internal_.CodeKeywordDefinition.md#allowundefined) -- [before](verida_verifiable_credentials._internal_.CodeKeywordDefinition.md#before) -- [dependencies](verida_verifiable_credentials._internal_.CodeKeywordDefinition.md#dependencies) -- [error](verida_verifiable_credentials._internal_.CodeKeywordDefinition.md#error) -- [implements](verida_verifiable_credentials._internal_.CodeKeywordDefinition.md#implements) -- [keyword](verida_verifiable_credentials._internal_.CodeKeywordDefinition.md#keyword) -- [metaSchema](verida_verifiable_credentials._internal_.CodeKeywordDefinition.md#metaschema) -- [post](verida_verifiable_credentials._internal_.CodeKeywordDefinition.md#post) -- [schemaType](verida_verifiable_credentials._internal_.CodeKeywordDefinition.md#schematype) -- [trackErrors](verida_verifiable_credentials._internal_.CodeKeywordDefinition.md#trackerrors) -- [type](verida_verifiable_credentials._internal_.CodeKeywordDefinition.md#type) -- [validateSchema](verida_verifiable_credentials._internal_.CodeKeywordDefinition.md#validateschema) - -### Methods - -- [code](verida_verifiable_credentials._internal_.CodeKeywordDefinition.md#code) - -## Properties - -### $data - -• `Optional` **$data**: `boolean` - -#### Inherited from - -[_KeywordDef](verida_verifiable_credentials._internal_._KeywordDef.md).[$data](verida_verifiable_credentials._internal_._KeywordDef.md#$data) - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:90 - -___ - -### $dataError - -• `Optional` **$dataError**: [`KeywordErrorDefinition`](verida_verifiable_credentials._internal_.KeywordErrorDefinition.md) - -#### Inherited from - -[_KeywordDef](verida_verifiable_credentials._internal_._KeywordDef.md).[$dataError](verida_verifiable_credentials._internal_._KeywordDef.md#$dataerror) - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:98 - -___ - -### allowUndefined - -• `Optional` **allowUndefined**: `boolean` - -#### Inherited from - -[_KeywordDef](verida_verifiable_credentials._internal_._KeywordDef.md).[allowUndefined](verida_verifiable_credentials._internal_._KeywordDef.md#allowundefined) - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:89 - -___ - -### before - -• `Optional` **before**: `string` - -#### Inherited from - -[_KeywordDef](verida_verifiable_credentials._internal_._KeywordDef.md).[before](verida_verifiable_credentials._internal_._KeywordDef.md#before) - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:92 - -___ - -### dependencies - -• `Optional` **dependencies**: `string`[] - -#### Inherited from - -[_KeywordDef](verida_verifiable_credentials._internal_._KeywordDef.md).[dependencies](verida_verifiable_credentials._internal_._KeywordDef.md#dependencies) - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:96 - -___ - -### error - -• `Optional` **error**: [`KeywordErrorDefinition`](verida_verifiable_credentials._internal_.KeywordErrorDefinition.md) - -#### Inherited from - -[_KeywordDef](verida_verifiable_credentials._internal_._KeywordDef.md).[error](verida_verifiable_credentials._internal_._KeywordDef.md#error) - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:97 - -___ - -### implements - -• `Optional` **implements**: `string`[] - -#### Inherited from - -[_KeywordDef](verida_verifiable_credentials._internal_._KeywordDef.md).[implements](verida_verifiable_credentials._internal_._KeywordDef.md#implements) - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:91 - -___ - -### keyword - -• **keyword**: `string` \| `string`[] - -#### Inherited from - -[_KeywordDef](verida_verifiable_credentials._internal_._KeywordDef.md).[keyword](verida_verifiable_credentials._internal_._KeywordDef.md#keyword) - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:86 - -___ - -### metaSchema - -• `Optional` **metaSchema**: [`AnySchemaObject`](../modules/verida_verifiable_credentials._internal_.md#anyschemaobject) - -#### Inherited from - -[_KeywordDef](verida_verifiable_credentials._internal_._KeywordDef.md).[metaSchema](verida_verifiable_credentials._internal_._KeywordDef.md#metaschema) - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:94 - -___ - -### post - -• `Optional` **post**: `boolean` - -#### Inherited from - -[_KeywordDef](verida_verifiable_credentials._internal_._KeywordDef.md).[post](verida_verifiable_credentials._internal_._KeywordDef.md#post) - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:93 - -___ - -### schemaType - -• `Optional` **schemaType**: ``"string"`` \| ``"number"`` \| ``"boolean"`` \| ``"object"`` \| ``"integer"`` \| ``"array"`` \| ``"null"`` \| (``"string"`` \| ``"number"`` \| ``"boolean"`` \| ``"object"`` \| ``"integer"`` \| ``"array"`` \| ``"null"``)[] - -#### Inherited from - -[_KeywordDef](verida_verifiable_credentials._internal_._KeywordDef.md).[schemaType](verida_verifiable_credentials._internal_._KeywordDef.md#schematype) - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:88 - -___ - -### trackErrors - -• `Optional` **trackErrors**: `boolean` - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:102 - -___ - -### type - -• `Optional` **type**: ``"string"`` \| ``"number"`` \| ``"boolean"`` \| ``"object"`` \| ``"integer"`` \| ``"array"`` \| ``"null"`` \| (``"string"`` \| ``"number"`` \| ``"boolean"`` \| ``"object"`` \| ``"integer"`` \| ``"array"`` \| ``"null"``)[] - -#### Inherited from - -[_KeywordDef](verida_verifiable_credentials._internal_._KeywordDef.md).[type](verida_verifiable_credentials._internal_._KeywordDef.md#type) - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:87 - -___ - -### validateSchema - -• `Optional` **validateSchema**: [`AnyValidateFunction`](../modules/verida_verifiable_credentials._internal_.md#anyvalidatefunction)<`any`\> - -#### Inherited from - -[_KeywordDef](verida_verifiable_credentials._internal_._KeywordDef.md).[validateSchema](verida_verifiable_credentials._internal_._KeywordDef.md#validateschema) - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:95 - -## Methods - -### code - -▸ **code**(`cxt`, `ruleType?`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `cxt` | [`KeywordCxt`](../classes/verida_verifiable_credentials._internal_.KeywordCxt.md) | -| `ruleType?` | `string` | - -#### Returns - -`void` - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:101 diff --git a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.CodeOptions.md b/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.CodeOptions.md deleted file mode 100644 index e02b38f..0000000 --- a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.CodeOptions.md +++ /dev/null @@ -1,96 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / CodeOptions - -# Interface: CodeOptions - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md).CodeOptions - -## Hierarchy - -- **`CodeOptions`** - - ↳ [`InstanceCodeOptions`](verida_verifiable_credentials._internal_.InstanceCodeOptions.md) - -## Table of contents - -### Properties - -- [es5](verida_verifiable_credentials._internal_.CodeOptions.md#es5) -- [formats](verida_verifiable_credentials._internal_.CodeOptions.md#formats) -- [lines](verida_verifiable_credentials._internal_.CodeOptions.md#lines) -- [optimize](verida_verifiable_credentials._internal_.CodeOptions.md#optimize) -- [source](verida_verifiable_credentials._internal_.CodeOptions.md#source) - -### Methods - -- [process](verida_verifiable_credentials._internal_.CodeOptions.md#process) - -## Properties - -### es5 - -• `Optional` **es5**: `boolean` - -#### Defined in - -node_modules/ajv/dist/core.d.ts:73 - -___ - -### formats - -• `Optional` **formats**: [`Code`](../modules/verida_verifiable_credentials._internal_.md#code) - -#### Defined in - -node_modules/ajv/dist/core.d.ts:76 - -___ - -### lines - -• `Optional` **lines**: `boolean` - -#### Defined in - -node_modules/ajv/dist/core.d.ts:74 - -___ - -### optimize - -• `Optional` **optimize**: `number` \| `boolean` - -#### Defined in - -node_modules/ajv/dist/core.d.ts:75 - -___ - -### source - -• `Optional` **source**: `boolean` - -#### Defined in - -node_modules/ajv/dist/core.d.ts:77 - -## Methods - -### process - -▸ `Optional` **process**(`code`, `schema?`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `code` | `string` | -| `schema?` | [`SchemaEnv`](../classes/verida_verifiable_credentials._internal_.SchemaEnv.md) | - -#### Returns - -`string` - -#### Defined in - -node_modules/ajv/dist/core.d.ts:78 diff --git a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.ContextCloseOptions.md b/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.ContextCloseOptions.md deleted file mode 100644 index f29d0c5..0000000 --- a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.ContextCloseOptions.md +++ /dev/null @@ -1,27 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / ContextCloseOptions - -# Interface: ContextCloseOptions - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md).ContextCloseOptions - -## Hierarchy - -- **`ContextCloseOptions`** - - ↳ [`DatabaseCloseOptions`](verida_verifiable_credentials._internal_.DatabaseCloseOptions.md) - -## Table of contents - -### Properties - -- [clearLocal](verida_verifiable_credentials._internal_.ContextCloseOptions.md#clearlocal) - -## Properties - -### clearLocal - -• `Optional` **clearLocal**: `boolean` - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:71 diff --git a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.ContextDatabaseInfo.md b/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.ContextDatabaseInfo.md deleted file mode 100644 index 5bacba3..0000000 --- a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.ContextDatabaseInfo.md +++ /dev/null @@ -1,65 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / ContextDatabaseInfo - -# Interface: ContextDatabaseInfo - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md).ContextDatabaseInfo - -## Table of contents - -### Properties - -- [activeEndpoint](verida_verifiable_credentials._internal_.ContextDatabaseInfo.md#activeendpoint) -- [databases](verida_verifiable_credentials._internal_.ContextDatabaseInfo.md#databases) -- [endpoints](verida_verifiable_credentials._internal_.ContextDatabaseInfo.md#endpoints) -- [keys](verida_verifiable_credentials._internal_.ContextDatabaseInfo.md#keys) -- [name](verida_verifiable_credentials._internal_.ContextDatabaseInfo.md#name) - -## Properties - -### activeEndpoint - -• `Optional` **activeEndpoint**: `string` - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:136 - -___ - -### databases - -• **databases**: [`Record`](../modules/verida_verifiable_credentials._internal_.md#record)<`string`, `object`\> - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:138 - -___ - -### endpoints - -• **endpoints**: [`Record`](../modules/verida_verifiable_credentials._internal_.md#record)<`string`, `object`\> - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:137 - -___ - -### keys - -• **keys**: `any` - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:139 - -___ - -### name - -• **name**: `string` - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:135 diff --git a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.ContextInfo.md b/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.ContextInfo.md deleted file mode 100644 index a6e5280..0000000 --- a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.ContextInfo.md +++ /dev/null @@ -1,21 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / ContextInfo - -# Interface: ContextInfo - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md).ContextInfo - -## Table of contents - -### Properties - -- [databases](verida_verifiable_credentials._internal_.ContextInfo.md#databases) - -## Properties - -### databases - -• **databases**: [`ContextDatabaseInfo`](verida_verifiable_credentials._internal_.ContextDatabaseInfo.md) - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:142 diff --git a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.CreateCredentialJWT.md b/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.CreateCredentialJWT.md deleted file mode 100644 index b4c370c..0000000 --- a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.CreateCredentialJWT.md +++ /dev/null @@ -1,54 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / CreateCredentialJWT - -# Interface: CreateCredentialJWT - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md).CreateCredentialJWT - -## Table of contents - -### Properties - -- [context](verida_verifiable_credentials._internal_.CreateCredentialJWT.md#context) -- [data](verida_verifiable_credentials._internal_.CreateCredentialJWT.md#data) -- [options](verida_verifiable_credentials._internal_.CreateCredentialJWT.md#options) -- [subjectId](verida_verifiable_credentials._internal_.CreateCredentialJWT.md#subjectid) - -## Properties - -### context - -• **context**: [`Context`](../classes/verida_verifiable_credentials._internal_.Context.md) - -#### Defined in - -[packages/verifiable-credentials/src/interfaces.ts:20](https://github.com/verida/verida-js/blob/c03b336/packages/verifiable-credentials/src/interfaces.ts#L20) - -___ - -### data - -• **data**: `any` - -#### Defined in - -[packages/verifiable-credentials/src/interfaces.ts:19](https://github.com/verida/verida-js/blob/c03b336/packages/verifiable-credentials/src/interfaces.ts#L19) - -___ - -### options - -• `Optional` **options**: [`credentialDateOptions`](verida_verifiable_credentials._internal_.credentialDateOptions.md) - -#### Defined in - -[packages/verifiable-credentials/src/interfaces.ts:17](https://github.com/verida/verida-js/blob/c03b336/packages/verifiable-credentials/src/interfaces.ts#L17) - -___ - -### subjectId - -• **subjectId**: `string` - -#### Defined in - -[packages/verifiable-credentials/src/interfaces.ts:18](https://github.com/verida/verida-js/blob/c03b336/packages/verifiable-credentials/src/interfaces.ts#L18) diff --git a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.CurrentOptions.md b/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.CurrentOptions.md deleted file mode 100644 index 2004644..0000000 --- a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.CurrentOptions.md +++ /dev/null @@ -1,507 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / CurrentOptions - -# Interface: CurrentOptions - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md).CurrentOptions - -## Table of contents - -### Properties - -- [$comment](verida_verifiable_credentials._internal_.CurrentOptions.md#$comment) -- [$data](verida_verifiable_credentials._internal_.CurrentOptions.md#$data) -- [addUsedSchema](verida_verifiable_credentials._internal_.CurrentOptions.md#addusedschema) -- [allErrors](verida_verifiable_credentials._internal_.CurrentOptions.md#allerrors) -- [allowDate](verida_verifiable_credentials._internal_.CurrentOptions.md#allowdate) -- [allowMatchingProperties](verida_verifiable_credentials._internal_.CurrentOptions.md#allowmatchingproperties) -- [allowUnionTypes](verida_verifiable_credentials._internal_.CurrentOptions.md#allowuniontypes) -- [code](verida_verifiable_credentials._internal_.CurrentOptions.md#code) -- [coerceTypes](verida_verifiable_credentials._internal_.CurrentOptions.md#coercetypes) -- [defaultMeta](verida_verifiable_credentials._internal_.CurrentOptions.md#defaultmeta) -- [discriminator](verida_verifiable_credentials._internal_.CurrentOptions.md#discriminator) -- [dynamicRef](verida_verifiable_credentials._internal_.CurrentOptions.md#dynamicref) -- [formats](verida_verifiable_credentials._internal_.CurrentOptions.md#formats) -- [inlineRefs](verida_verifiable_credentials._internal_.CurrentOptions.md#inlinerefs) -- [int32range](verida_verifiable_credentials._internal_.CurrentOptions.md#int32range) -- [jtd](verida_verifiable_credentials._internal_.CurrentOptions.md#jtd) -- [keywords](verida_verifiable_credentials._internal_.CurrentOptions.md#keywords) -- [logger](verida_verifiable_credentials._internal_.CurrentOptions.md#logger) -- [loopEnum](verida_verifiable_credentials._internal_.CurrentOptions.md#loopenum) -- [loopRequired](verida_verifiable_credentials._internal_.CurrentOptions.md#looprequired) -- [messages](verida_verifiable_credentials._internal_.CurrentOptions.md#messages) -- [meta](verida_verifiable_credentials._internal_.CurrentOptions.md#meta) -- [multipleOfPrecision](verida_verifiable_credentials._internal_.CurrentOptions.md#multipleofprecision) -- [next](verida_verifiable_credentials._internal_.CurrentOptions.md#next) -- [ownProperties](verida_verifiable_credentials._internal_.CurrentOptions.md#ownproperties) -- [parseDate](verida_verifiable_credentials._internal_.CurrentOptions.md#parsedate) -- [passContext](verida_verifiable_credentials._internal_.CurrentOptions.md#passcontext) -- [removeAdditional](verida_verifiable_credentials._internal_.CurrentOptions.md#removeadditional) -- [schemaId](verida_verifiable_credentials._internal_.CurrentOptions.md#schemaid) -- [schemas](verida_verifiable_credentials._internal_.CurrentOptions.md#schemas) -- [strict](verida_verifiable_credentials._internal_.CurrentOptions.md#strict) -- [strictNumbers](verida_verifiable_credentials._internal_.CurrentOptions.md#strictnumbers) -- [strictRequired](verida_verifiable_credentials._internal_.CurrentOptions.md#strictrequired) -- [strictSchema](verida_verifiable_credentials._internal_.CurrentOptions.md#strictschema) -- [strictTuples](verida_verifiable_credentials._internal_.CurrentOptions.md#stricttuples) -- [strictTypes](verida_verifiable_credentials._internal_.CurrentOptions.md#stricttypes) -- [timestamp](verida_verifiable_credentials._internal_.CurrentOptions.md#timestamp) -- [unevaluated](verida_verifiable_credentials._internal_.CurrentOptions.md#unevaluated) -- [unicodeRegExp](verida_verifiable_credentials._internal_.CurrentOptions.md#unicoderegexp) -- [useDefaults](verida_verifiable_credentials._internal_.CurrentOptions.md#usedefaults) -- [validateFormats](verida_verifiable_credentials._internal_.CurrentOptions.md#validateformats) -- [validateSchema](verida_verifiable_credentials._internal_.CurrentOptions.md#validateschema) -- [verbose](verida_verifiable_credentials._internal_.CurrentOptions.md#verbose) - -### Methods - -- [loadSchema](verida_verifiable_credentials._internal_.CurrentOptions.md#loadschema) - -## Properties - -### $comment - -• `Optional` **$comment**: ``true`` \| (`comment`: `string`, `schemaPath?`: `string`, `rootSchema?`: [`AnySchemaObject`](../modules/verida_verifiable_credentials._internal_.md#anyschemaobject)) => `unknown` - -#### Defined in - -node_modules/ajv/dist/core.d.ts:40 - -___ - -### $data - -• `Optional` **$data**: `boolean` - -#### Defined in - -node_modules/ajv/dist/core.d.ts:32 - -___ - -### addUsedSchema - -• `Optional` **addUsedSchema**: `boolean` - -#### Defined in - -node_modules/ajv/dist/core.d.ts:61 - -___ - -### allErrors - -• `Optional` **allErrors**: `boolean` - -#### Defined in - -node_modules/ajv/dist/core.d.ts:33 - -___ - -### allowDate - -• `Optional` **allowDate**: `boolean` - -#### Defined in - -node_modules/ajv/dist/core.d.ts:39 - -___ - -### allowMatchingProperties - -• `Optional` **allowMatchingProperties**: `boolean` - -#### Defined in - -node_modules/ajv/dist/core.d.ts:29 - -___ - -### allowUnionTypes - -• `Optional` **allowUnionTypes**: `boolean` - -#### Defined in - -node_modules/ajv/dist/core.d.ts:30 - -___ - -### code - -• `Optional` **code**: [`CodeOptions`](verida_verifiable_credentials._internal_.CodeOptions.md) - -#### Defined in - -node_modules/ajv/dist/core.d.ts:70 - -___ - -### coerceTypes - -• `Optional` **coerceTypes**: `boolean` \| ``"array"`` - -#### Defined in - -node_modules/ajv/dist/core.d.ts:52 - -___ - -### defaultMeta - -• `Optional` **defaultMeta**: `string` \| [`AnySchemaObject`](../modules/verida_verifiable_credentials._internal_.md#anyschemaobject) - -#### Defined in - -node_modules/ajv/dist/core.d.ts:59 - -___ - -### discriminator - -• `Optional` **discriminator**: `boolean` - -#### Defined in - -node_modules/ajv/dist/core.d.ts:35 - -___ - -### dynamicRef - -• `Optional` **dynamicRef**: `boolean` - -#### Defined in - -node_modules/ajv/dist/core.d.ts:55 - -___ - -### formats - -• `Optional` **formats**: `Object` - -#### Defined in - -node_modules/ajv/dist/core.d.ts:41 - -___ - -### inlineRefs - -• `Optional` **inlineRefs**: `number` \| `boolean` - -#### Defined in - -node_modules/ajv/dist/core.d.ts:62 - -___ - -### int32range - -• `Optional` **int32range**: `boolean` - -#### Defined in - -node_modules/ajv/dist/core.d.ts:68 - -___ - -### jtd - -• `Optional` **jtd**: `boolean` - -#### Defined in - -node_modules/ajv/dist/core.d.ts:57 - -___ - -### keywords - -• `Optional` **keywords**: [`Vocabulary`](../modules/verida_verifiable_credentials._internal_.md#vocabulary) - -#### Defined in - -node_modules/ajv/dist/core.d.ts:44 - -___ - -### logger - -• `Optional` **logger**: ``false`` \| [`Logger`](verida_verifiable_credentials._internal_.Logger.md) - -#### Defined in - -node_modules/ajv/dist/core.d.ts:48 - -___ - -### loopEnum - -• `Optional` **loopEnum**: `number` - -#### Defined in - -node_modules/ajv/dist/core.d.ts:65 - -___ - -### loopRequired - -• `Optional` **loopRequired**: `number` - -#### Defined in - -node_modules/ajv/dist/core.d.ts:64 - -___ - -### messages - -• `Optional` **messages**: `boolean` - -#### Defined in - -node_modules/ajv/dist/core.d.ts:69 - -___ - -### meta - -• `Optional` **meta**: `boolean` \| [`SchemaObject`](verida_verifiable_credentials._internal_.SchemaObject.md) - -#### Defined in - -node_modules/ajv/dist/core.d.ts:58 - -___ - -### multipleOfPrecision - -• `Optional` **multipleOfPrecision**: `number` - -#### Defined in - -node_modules/ajv/dist/core.d.ts:67 - -___ - -### next - -• `Optional` **next**: `boolean` - -#### Defined in - -node_modules/ajv/dist/core.d.ts:53 - -___ - -### ownProperties - -• `Optional` **ownProperties**: `boolean` - -#### Defined in - -node_modules/ajv/dist/core.d.ts:66 - -___ - -### parseDate - -• `Optional` **parseDate**: `boolean` - -#### Defined in - -node_modules/ajv/dist/core.d.ts:38 - -___ - -### passContext - -• `Optional` **passContext**: `boolean` - -#### Defined in - -node_modules/ajv/dist/core.d.ts:63 - -___ - -### removeAdditional - -• `Optional` **removeAdditional**: `boolean` \| ``"all"`` \| ``"failing"`` - -#### Defined in - -node_modules/ajv/dist/core.d.ts:50 - -___ - -### schemaId - -• `Optional` **schemaId**: ``"id"`` \| ``"$id"`` - -#### Defined in - -node_modules/ajv/dist/core.d.ts:56 - -___ - -### schemas - -• `Optional` **schemas**: [`AnySchema`](../modules/verida_verifiable_credentials._internal_.md#anyschema)[] \| {} - -#### Defined in - -node_modules/ajv/dist/core.d.ts:45 - -___ - -### strict - -• `Optional` **strict**: `boolean` \| ``"log"`` - -#### Defined in - -node_modules/ajv/dist/core.d.ts:23 - -___ - -### strictNumbers - -• `Optional` **strictNumbers**: `boolean` \| ``"log"`` - -#### Defined in - -node_modules/ajv/dist/core.d.ts:25 - -___ - -### strictRequired - -• `Optional` **strictRequired**: `boolean` \| ``"log"`` - -#### Defined in - -node_modules/ajv/dist/core.d.ts:28 - -___ - -### strictSchema - -• `Optional` **strictSchema**: `boolean` \| ``"log"`` - -#### Defined in - -node_modules/ajv/dist/core.d.ts:24 - -___ - -### strictTuples - -• `Optional` **strictTuples**: `boolean` \| ``"log"`` - -#### Defined in - -node_modules/ajv/dist/core.d.ts:27 - -___ - -### strictTypes - -• `Optional` **strictTypes**: `boolean` \| ``"log"`` - -#### Defined in - -node_modules/ajv/dist/core.d.ts:26 - -___ - -### timestamp - -• `Optional` **timestamp**: ``"string"`` \| ``"date"`` - -#### Defined in - -node_modules/ajv/dist/core.d.ts:37 - -___ - -### unevaluated - -• `Optional` **unevaluated**: `boolean` - -#### Defined in - -node_modules/ajv/dist/core.d.ts:54 - -___ - -### unicodeRegExp - -• `Optional` **unicodeRegExp**: `boolean` - -#### Defined in - -node_modules/ajv/dist/core.d.ts:36 - -___ - -### useDefaults - -• `Optional` **useDefaults**: `boolean` \| ``"empty"`` - -#### Defined in - -node_modules/ajv/dist/core.d.ts:51 - -___ - -### validateFormats - -• `Optional` **validateFormats**: `boolean` - -#### Defined in - -node_modules/ajv/dist/core.d.ts:31 - -___ - -### validateSchema - -• `Optional` **validateSchema**: `boolean` \| ``"log"`` - -#### Defined in - -node_modules/ajv/dist/core.d.ts:60 - -___ - -### verbose - -• `Optional` **verbose**: `boolean` - -#### Defined in - -node_modules/ajv/dist/core.d.ts:34 - -## Methods - -### loadSchema - -▸ `Optional` **loadSchema**(`uri`): `Promise`<[`AnySchemaObject`](../modules/verida_verifiable_credentials._internal_.md#anyschemaobject)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `uri` | `string` | - -#### Returns - -`Promise`<[`AnySchemaObject`](../modules/verida_verifiable_credentials._internal_.md#anyschemaobject)\> - -#### Defined in - -node_modules/ajv/dist/core.d.ts:49 diff --git a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.DIDDocumentStruct.md b/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.DIDDocumentStruct.md deleted file mode 100644 index 65e4174..0000000 --- a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.DIDDocumentStruct.md +++ /dev/null @@ -1,189 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / DIDDocumentStruct - -# Interface: DIDDocumentStruct - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md).DIDDocumentStruct - -## Hierarchy - -- [`DIDDocument`](../modules/verida_verifiable_credentials._internal_.md#diddocument) - - ↳ **`DIDDocumentStruct`** - -## Table of contents - -### Properties - -- [@context](verida_verifiable_credentials._internal_.DIDDocumentStruct.md#@context) -- [alsoKnownAs](verida_verifiable_credentials._internal_.DIDDocumentStruct.md#alsoknownas) -- [assertionMethod](verida_verifiable_credentials._internal_.DIDDocumentStruct.md#assertionmethod) -- [authentication](verida_verifiable_credentials._internal_.DIDDocumentStruct.md#authentication) -- [capabilityDelegation](verida_verifiable_credentials._internal_.DIDDocumentStruct.md#capabilitydelegation) -- [capabilityInvocation](verida_verifiable_credentials._internal_.DIDDocumentStruct.md#capabilityinvocation) -- [controller](verida_verifiable_credentials._internal_.DIDDocumentStruct.md#controller) -- [id](verida_verifiable_credentials._internal_.DIDDocumentStruct.md#id) -- [keyAgreement](verida_verifiable_credentials._internal_.DIDDocumentStruct.md#keyagreement) -- [proof](verida_verifiable_credentials._internal_.DIDDocumentStruct.md#proof) -- [publicKey](verida_verifiable_credentials._internal_.DIDDocumentStruct.md#publickey) -- [service](verida_verifiable_credentials._internal_.DIDDocumentStruct.md#service) -- [verificationMethod](verida_verifiable_credentials._internal_.DIDDocumentStruct.md#verificationmethod) - -## Properties - -### @context - -• `Optional` **@context**: `string` \| `string`[] - -#### Inherited from - -DD.@context - -#### Defined in - -packages/did-document/node_modules/did-resolver/lib/resolver.d.ts:26 - -___ - -### alsoKnownAs - -• `Optional` **alsoKnownAs**: `string`[] - -#### Inherited from - -DD.alsoKnownAs - -#### Defined in - -packages/did-document/node_modules/did-resolver/lib/resolver.d.ts:28 - -___ - -### assertionMethod - -• **assertionMethod**: `undefined` \| (`string` \| [`VerificationMethod`](verida_verifiable_credentials._internal_.VerificationMethod.md))[] - -#### Inherited from - -DD.assertionMethod - -___ - -### authentication - -• **authentication**: `undefined` \| (`string` \| [`VerificationMethod`](verida_verifiable_credentials._internal_.VerificationMethod.md))[] - -#### Inherited from - -DD.authentication - -___ - -### capabilityDelegation - -• **capabilityDelegation**: `undefined` \| (`string` \| [`VerificationMethod`](verida_verifiable_credentials._internal_.VerificationMethod.md))[] - -#### Inherited from - -DD.capabilityDelegation - -___ - -### capabilityInvocation - -• **capabilityInvocation**: `undefined` \| (`string` \| [`VerificationMethod`](verida_verifiable_credentials._internal_.VerificationMethod.md))[] - -#### Inherited from - -DD.capabilityInvocation - -___ - -### controller - -• `Optional` **controller**: `string` \| `string`[] - -#### Inherited from - -DD.controller - -#### Defined in - -packages/did-document/node_modules/did-resolver/lib/resolver.d.ts:29 - -___ - -### id - -• **id**: `string` - -#### Inherited from - -DD.id - -#### Defined in - -packages/did-document/node_modules/did-resolver/lib/resolver.d.ts:27 - -___ - -### keyAgreement - -• **keyAgreement**: `undefined` \| (`string` \| [`VerificationMethod`](verida_verifiable_credentials._internal_.VerificationMethod.md))[] - -#### Inherited from - -DD.keyAgreement - -___ - -### proof - -• `Optional` **proof**: [`Proof`](verida_verifiable_credentials._internal_.Proof.md) - -#### Defined in - -packages/did-document/dist/interfaces.d.ts:14 - -___ - -### publicKey - -• `Optional` **publicKey**: [`VerificationMethod`](verida_verifiable_credentials._internal_.VerificationMethod.md)[] - -**`deprecated`** - -#### Inherited from - -DD.publicKey - -#### Defined in - -packages/did-document/node_modules/did-resolver/lib/resolver.d.ts:35 - -___ - -### service - -• `Optional` **service**: [`ServiceEndpoint`](verida_verifiable_credentials._internal_.ServiceEndpoint.md)[] - -#### Inherited from - -DD.service - -#### Defined in - -packages/did-document/node_modules/did-resolver/lib/resolver.d.ts:31 - -___ - -### verificationMethod - -• `Optional` **verificationMethod**: [`VerificationMethod`](verida_verifiable_credentials._internal_.VerificationMethod.md)[] - -#### Inherited from - -DD.verificationMethod - -#### Defined in - -packages/did-document/node_modules/did-resolver/lib/resolver.d.ts:30 diff --git a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.DOMEventTarget.md b/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.DOMEventTarget.md deleted file mode 100644 index 6554bd5..0000000 --- a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.DOMEventTarget.md +++ /dev/null @@ -1,34 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / DOMEventTarget - -# Interface: DOMEventTarget - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md).DOMEventTarget - -## Table of contents - -### Methods - -- [addEventListener](verida_verifiable_credentials._internal_.DOMEventTarget.md#addeventlistener) - -## Methods - -### addEventListener - -▸ **addEventListener**(`eventName`, `listener`, `opts?`): `any` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | `string` | -| `listener` | (...`args`: `any`[]) => `void` | -| `opts?` | `Object` | -| `opts.once` | `boolean` | - -#### Returns - -`any` - -#### Defined in - -node_modules/@types/node/events.d.ts:48 diff --git a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.DataValidateFunction.md b/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.DataValidateFunction.md deleted file mode 100644 index 5787914..0000000 --- a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.DataValidateFunction.md +++ /dev/null @@ -1,41 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / DataValidateFunction - -# Interface: DataValidateFunction - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md).DataValidateFunction - -## Callable - -### DataValidateFunction - -▸ **DataValidateFunction**(...`args`): `boolean` \| `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `...args` | [data: any, dataCxt?: DataValidationCxt] | - -#### Returns - -`boolean` \| `Promise`<`any`\> - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:107 - -## Table of contents - -### Properties - -- [errors](verida_verifiable_credentials._internal_.DataValidateFunction.md#errors) - -## Properties - -### errors - -• `Optional` **errors**: [`Partial`](../modules/verida_verifiable_credentials._internal_.md#partial)<[`ErrorObject`](verida_verifiable_credentials._internal_.ErrorObject.md)<`string`, [`Record`](../modules/verida_verifiable_credentials._internal_.md#record)<`string`, `any`\>, `unknown`\>\>[] - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:108 diff --git a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.DataValidationCxt.md b/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.DataValidationCxt.md deleted file mode 100644 index 00f6098..0000000 --- a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.DataValidationCxt.md +++ /dev/null @@ -1,71 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / DataValidationCxt - -# Interface: DataValidationCxt - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md).DataValidationCxt - -## Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | extends `string` \| `number` = `string` \| `number` | - -## Table of contents - -### Properties - -- [dynamicAnchors](verida_verifiable_credentials._internal_.DataValidationCxt.md#dynamicanchors) -- [instancePath](verida_verifiable_credentials._internal_.DataValidationCxt.md#instancepath) -- [parentData](verida_verifiable_credentials._internal_.DataValidationCxt.md#parentdata) -- [parentDataProperty](verida_verifiable_credentials._internal_.DataValidationCxt.md#parentdataproperty) -- [rootData](verida_verifiable_credentials._internal_.DataValidationCxt.md#rootdata) - -## Properties - -### dynamicAnchors - -• **dynamicAnchors**: `Object` - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:41 - -___ - -### instancePath - -• **instancePath**: `string` - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:35 - -___ - -### parentData - -• **parentData**: { [K in string \| number]: any } - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:36 - -___ - -### parentDataProperty - -• **parentDataProperty**: `T` - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:39 - -___ - -### rootData - -• **rootData**: `any`[] \| [`Record`](../modules/verida_verifiable_credentials._internal_.md#record)<`string`, `any`\> - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:40 diff --git a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.DatabaseCloseOptions.md b/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.DatabaseCloseOptions.md deleted file mode 100644 index 96c26c8..0000000 --- a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.DatabaseCloseOptions.md +++ /dev/null @@ -1,31 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / DatabaseCloseOptions - -# Interface: DatabaseCloseOptions - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md).DatabaseCloseOptions - -## Hierarchy - -- [`ContextCloseOptions`](verida_verifiable_credentials._internal_.ContextCloseOptions.md) - - ↳ **`DatabaseCloseOptions`** - -## Table of contents - -### Properties - -- [clearLocal](verida_verifiable_credentials._internal_.DatabaseCloseOptions.md#clearlocal) - -## Properties - -### clearLocal - -• `Optional` **clearLocal**: `boolean` - -#### Inherited from - -[ContextCloseOptions](verida_verifiable_credentials._internal_.ContextCloseOptions.md).[clearLocal](verida_verifiable_credentials._internal_.ContextCloseOptions.md#clearlocal) - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:71 diff --git a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.DatabaseDeleteConfig.md b/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.DatabaseDeleteConfig.md deleted file mode 100644 index 164677f..0000000 --- a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.DatabaseDeleteConfig.md +++ /dev/null @@ -1,21 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / DatabaseDeleteConfig - -# Interface: DatabaseDeleteConfig - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md).DatabaseDeleteConfig - -## Table of contents - -### Properties - -- [localOnly](verida_verifiable_credentials._internal_.DatabaseDeleteConfig.md#localonly) - -## Properties - -### localOnly - -• `Optional` **localOnly**: `boolean` - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:68 diff --git a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.DatabaseOpenConfig.md b/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.DatabaseOpenConfig.md deleted file mode 100644 index 5b00e77..0000000 --- a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.DatabaseOpenConfig.md +++ /dev/null @@ -1,187 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / DatabaseOpenConfig - -# Interface: DatabaseOpenConfig - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md).DatabaseOpenConfig - -Interface for any DatabaseOpenConfig - -## Table of contents - -### Properties - -- [contextName](verida_verifiable_credentials._internal_.DatabaseOpenConfig.md#contextname) -- [createContext](verida_verifiable_credentials._internal_.DatabaseOpenConfig.md#createcontext) -- [did](verida_verifiable_credentials._internal_.DatabaseOpenConfig.md#did) -- [encryptionKey](verida_verifiable_credentials._internal_.DatabaseOpenConfig.md#encryptionkey) -- [endpoints](verida_verifiable_credentials._internal_.DatabaseOpenConfig.md#endpoints) -- [ignoreCache](verida_verifiable_credentials._internal_.DatabaseOpenConfig.md#ignorecache) -- [isOwner](verida_verifiable_credentials._internal_.DatabaseOpenConfig.md#isowner) -- [permissions](verida_verifiable_credentials._internal_.DatabaseOpenConfig.md#permissions) -- [readOnly](verida_verifiable_credentials._internal_.DatabaseOpenConfig.md#readonly) -- [saveDatabase](verida_verifiable_credentials._internal_.DatabaseOpenConfig.md#savedatabase) -- [signingContext](verida_verifiable_credentials._internal_.DatabaseOpenConfig.md#signingcontext) -- [token](verida_verifiable_credentials._internal_.DatabaseOpenConfig.md#token) -- [verifyEncryptionKey](verida_verifiable_credentials._internal_.DatabaseOpenConfig.md#verifyencryptionkey) - -## Properties - -### contextName - -• `Optional` **contextName**: `string` - -Optionally specify an external context to open - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:53 - -___ - -### createContext - -• `Optional` **createContext**: `boolean` - -Create an application context if it doesn't already exist for the connected account. - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:49 - -___ - -### did - -• `Optional` **did**: `string` - -Specify the DID that owns the database. - -This ensures the Verida client connects to the correct database server hosting the data for the specified `did`. - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:17 - -___ - -### encryptionKey - -• `Optional` **encryptionKey**: `Buffer` - -An optional encryption key to use for encrypting / decrypting data. - -This encryption key will not apply if the database is marked as `public`. - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:45 - -___ - -### endpoints - -• `Optional` **endpoints**: `string` \| `string`[] - -Specify an array of possible database connection strings to use when opening the database. - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:21 - -___ - -### ignoreCache - -• `Optional` **ignoreCache**: `boolean` - -Ignore any cached instance already created - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:61 - -___ - -### isOwner - -• `Optional` **isOwner**: `boolean` - -Boolean indicating if it's expected the current connected account is the owner of this database. - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:39 - -___ - -### permissions - -• `Optional` **permissions**: [`DatabasePermissionsConfig`](verida_verifiable_credentials._internal_.DatabasePermissionsConfig.md) - -Specify the permissions to use when opening this database. - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:11 - -___ - -### readOnly - -• `Optional` **readOnly**: `boolean` - -Open the database in read-only mode. - -This is useful when opening a database owned by an external `did` where the current authenticated account has no write access. - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:35 - -___ - -### saveDatabase - -• `Optional` **saveDatabase**: `boolean` - -Save this database into the user's master list of opened databases. - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:29 - -___ - -### signingContext - -• `Optional` **signingContext**: [`IContext`](verida_verifiable_credentials._internal_.IContext.md) - -Optionally specify the context used to sign data - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:57 - -___ - -### token - -• `Optional` **token**: `string` - -Specify a JWT token to use when opening the database. - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:25 - -___ - -### verifyEncryptionKey - -• `Optional` **verifyEncryptionKey**: `boolean` - -Verify the encryption key is correct when opening the database - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:65 diff --git a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.DatabasePermissionsConfig.md b/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.DatabasePermissionsConfig.md deleted file mode 100644 index 613b899..0000000 --- a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.DatabasePermissionsConfig.md +++ /dev/null @@ -1,56 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / DatabasePermissionsConfig - -# Interface: DatabasePermissionsConfig - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md).DatabasePermissionsConfig - -Interface for any PermissionsConfig - -## Table of contents - -### Properties - -- [read](verida_verifiable_credentials._internal_.DatabasePermissionsConfig.md#read) -- [readList](verida_verifiable_credentials._internal_.DatabasePermissionsConfig.md#readlist) -- [write](verida_verifiable_credentials._internal_.DatabasePermissionsConfig.md#write) -- [writeList](verida_verifiable_credentials._internal_.DatabasePermissionsConfig.md#writelist) - -## Properties - -### read - -• **read**: [`DatabasePermissionOptionsEnum`](../enums/verida_verifiable_credentials._internal_.DatabasePermissionOptionsEnum.md) - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:110 - -___ - -### readList - -• `Optional` **readList**: `string`[] - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:112 - -___ - -### write - -• **write**: [`DatabasePermissionOptionsEnum`](../enums/verida_verifiable_credentials._internal_.DatabasePermissionOptionsEnum.md) - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:111 - -___ - -### writeList - -• `Optional` **writeList**: `string`[] - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:113 diff --git a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.DatastoreOpenConfig.md b/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.DatastoreOpenConfig.md deleted file mode 100644 index e9e5992..0000000 --- a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.DatastoreOpenConfig.md +++ /dev/null @@ -1,111 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / DatastoreOpenConfig - -# Interface: DatastoreOpenConfig - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md).DatastoreOpenConfig - -Interface for any DatastoreOpenConfig - -## Table of contents - -### Properties - -- [contextName](verida_verifiable_credentials._internal_.DatastoreOpenConfig.md#contextname) -- [createContext](verida_verifiable_credentials._internal_.DatastoreOpenConfig.md#createcontext) -- [databaseName](verida_verifiable_credentials._internal_.DatastoreOpenConfig.md#databasename) -- [did](verida_verifiable_credentials._internal_.DatastoreOpenConfig.md#did) -- [encryptionKey](verida_verifiable_credentials._internal_.DatastoreOpenConfig.md#encryptionkey) -- [external](verida_verifiable_credentials._internal_.DatastoreOpenConfig.md#external) -- [permissions](verida_verifiable_credentials._internal_.DatastoreOpenConfig.md#permissions) -- [readOnly](verida_verifiable_credentials._internal_.DatastoreOpenConfig.md#readonly) -- [saveDatabase](verida_verifiable_credentials._internal_.DatastoreOpenConfig.md#savedatabase) - -## Properties - -### contextName - -• `Optional` **contextName**: `string` - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:87 - -___ - -### createContext - -• `Optional` **createContext**: `boolean` - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:85 - -___ - -### databaseName - -• `Optional` **databaseName**: `string` - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:84 - -___ - -### did - -• `Optional` **did**: `string` - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:80 - -___ - -### encryptionKey - -• `Optional` **encryptionKey**: `string` - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:83 - -___ - -### external - -• `Optional` **external**: `boolean` - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:86 - -___ - -### permissions - -• `Optional` **permissions**: [`DatabasePermissionsConfig`](verida_verifiable_credentials._internal_.DatabasePermissionsConfig.md) - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:79 - -___ - -### readOnly - -• `Optional` **readOnly**: `boolean` - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:82 - -___ - -### saveDatabase - -• `Optional` **saveDatabase**: `boolean` - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:81 diff --git a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.DbRegistryEntry.md b/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.DbRegistryEntry.md deleted file mode 100644 index 5d4b7a6..0000000 --- a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.DbRegistryEntry.md +++ /dev/null @@ -1,100 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / DbRegistryEntry - -# Interface: DbRegistryEntry - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md).DbRegistryEntry - -Interface for DbRegistryEntry - -## Table of contents - -### Properties - -- [contextName](verida_verifiable_credentials._internal_.DbRegistryEntry.md#contextname) -- [dbHash](verida_verifiable_credentials._internal_.DbRegistryEntry.md#dbhash) -- [dbName](verida_verifiable_credentials._internal_.DbRegistryEntry.md#dbname) -- [did](verida_verifiable_credentials._internal_.DbRegistryEntry.md#did) -- [encryptionKey](verida_verifiable_credentials._internal_.DbRegistryEntry.md#encryptionkey) -- [endpoint](verida_verifiable_credentials._internal_.DbRegistryEntry.md#endpoint) -- [endpointType](verida_verifiable_credentials._internal_.DbRegistryEntry.md#endpointtype) -- [permissions](verida_verifiable_credentials._internal_.DbRegistryEntry.md#permissions) - -## Properties - -### contextName - -• **contextName**: `string` - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:159 - -___ - -### dbHash - -• **dbHash**: `string` - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:155 - -___ - -### dbName - -• **dbName**: `string` - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:156 - -___ - -### did - -• **did**: `string` - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:158 - -___ - -### encryptionKey - -• `Optional` **encryptionKey**: [`DbRegistryEntryEncryptionKey`](verida_verifiable_credentials._internal_.DbRegistryEntryEncryptionKey.md) - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:161 - -___ - -### endpoint - -• **endpoint**: `string` - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:162 - -___ - -### endpointType - -• **endpointType**: `string` - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:157 - -___ - -### permissions - -• **permissions**: [`DatabasePermissionsConfig`](verida_verifiable_credentials._internal_.DatabasePermissionsConfig.md) - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:160 diff --git a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.DbRegistryEntryEncryptionKey.md b/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.DbRegistryEntryEncryptionKey.md deleted file mode 100644 index 15b8c3f..0000000 --- a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.DbRegistryEntryEncryptionKey.md +++ /dev/null @@ -1,34 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / DbRegistryEntryEncryptionKey - -# Interface: DbRegistryEntryEncryptionKey - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md).DbRegistryEntryEncryptionKey - -Interface for DbRegistryEntryEncryptionKey - -## Table of contents - -### Properties - -- [key](verida_verifiable_credentials._internal_.DbRegistryEntryEncryptionKey.md#key) -- [type](verida_verifiable_credentials._internal_.DbRegistryEntryEncryptionKey.md#type) - -## Properties - -### key - -• **key**: `string` - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:148 - -___ - -### type - -• **type**: `string` - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:149 diff --git a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.DefaultClientConfig.md b/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.DefaultClientConfig.md deleted file mode 100644 index 5347a51..0000000 --- a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.DefaultClientConfig.md +++ /dev/null @@ -1,109 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / DefaultClientConfig - -# Interface: DefaultClientConfig - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md).DefaultClientConfig - -## Hierarchy - -- [`DefaultEnvironmentConfig`](verida_verifiable_credentials._internal_.DefaultEnvironmentConfig.md) - - ↳ **`DefaultClientConfig`** - -## Table of contents - -### Properties - -- [defaultDatabaseServerUrl](verida_verifiable_credentials._internal_.DefaultClientConfig.md#defaultdatabaseserverurl) -- [defaultMessageServerUrl](verida_verifiable_credentials._internal_.DefaultClientConfig.md#defaultmessageserverurl) -- [didServerUrl](verida_verifiable_credentials._internal_.DefaultClientConfig.md#didserverurl) -- [environment](verida_verifiable_credentials._internal_.DefaultClientConfig.md#environment) -- [environments](verida_verifiable_credentials._internal_.DefaultClientConfig.md#environments) -- [schemaPaths](verida_verifiable_credentials._internal_.DefaultClientConfig.md#schemapaths) -- [vaultAppName](verida_verifiable_credentials._internal_.DefaultClientConfig.md#vaultappname) - -## Properties - -### defaultDatabaseServerUrl - -• `Optional` **defaultDatabaseServerUrl**: `string` - -#### Inherited from - -[DefaultEnvironmentConfig](verida_verifiable_credentials._internal_.DefaultEnvironmentConfig.md).[defaultDatabaseServerUrl](verida_verifiable_credentials._internal_.DefaultEnvironmentConfig.md#defaultdatabaseserverurl) - -#### Defined in - -packages/client-ts/dist/interfaces.d.ts:69 - -___ - -### defaultMessageServerUrl - -• `Optional` **defaultMessageServerUrl**: `string` - -#### Inherited from - -[DefaultEnvironmentConfig](verida_verifiable_credentials._internal_.DefaultEnvironmentConfig.md).[defaultMessageServerUrl](verida_verifiable_credentials._internal_.DefaultEnvironmentConfig.md#defaultmessageserverurl) - -#### Defined in - -packages/client-ts/dist/interfaces.d.ts:70 - -___ - -### didServerUrl - -• `Optional` **didServerUrl**: `string` - -#### Inherited from - -[DefaultEnvironmentConfig](verida_verifiable_credentials._internal_.DefaultEnvironmentConfig.md).[didServerUrl](verida_verifiable_credentials._internal_.DefaultEnvironmentConfig.md#didserverurl) - -#### Defined in - -packages/client-ts/dist/interfaces.d.ts:68 - -___ - -### environment - -• **environment**: `string` - -#### Defined in - -packages/client-ts/dist/interfaces.d.ts:74 - -___ - -### environments - -• **environments**: [`Record`](../modules/verida_verifiable_credentials._internal_.md#record)<`string`, [`DefaultEnvironmentConfig`](verida_verifiable_credentials._internal_.DefaultEnvironmentConfig.md)\> - -#### Defined in - -packages/client-ts/dist/interfaces.d.ts:75 - -___ - -### schemaPaths - -• `Optional` **schemaPaths**: [`Record`](../modules/verida_verifiable_credentials._internal_.md#record)<`string`, `string`\> - -#### Inherited from - -[DefaultEnvironmentConfig](verida_verifiable_credentials._internal_.DefaultEnvironmentConfig.md).[schemaPaths](verida_verifiable_credentials._internal_.DefaultEnvironmentConfig.md#schemapaths) - -#### Defined in - -packages/client-ts/dist/interfaces.d.ts:71 - -___ - -### vaultAppName - -• **vaultAppName**: `string` - -#### Defined in - -packages/client-ts/dist/interfaces.d.ts:76 diff --git a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.DefaultEnvironmentConfig.md b/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.DefaultEnvironmentConfig.md deleted file mode 100644 index 2ce5ab0..0000000 --- a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.DefaultEnvironmentConfig.md +++ /dev/null @@ -1,60 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / DefaultEnvironmentConfig - -# Interface: DefaultEnvironmentConfig - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md).DefaultEnvironmentConfig - -## Hierarchy - -- **`DefaultEnvironmentConfig`** - - ↳ [`DefaultClientConfig`](verida_verifiable_credentials._internal_.DefaultClientConfig.md) - -## Table of contents - -### Properties - -- [defaultDatabaseServerUrl](verida_verifiable_credentials._internal_.DefaultEnvironmentConfig.md#defaultdatabaseserverurl) -- [defaultMessageServerUrl](verida_verifiable_credentials._internal_.DefaultEnvironmentConfig.md#defaultmessageserverurl) -- [didServerUrl](verida_verifiable_credentials._internal_.DefaultEnvironmentConfig.md#didserverurl) -- [schemaPaths](verida_verifiable_credentials._internal_.DefaultEnvironmentConfig.md#schemapaths) - -## Properties - -### defaultDatabaseServerUrl - -• `Optional` **defaultDatabaseServerUrl**: `string` - -#### Defined in - -packages/client-ts/dist/interfaces.d.ts:69 - -___ - -### defaultMessageServerUrl - -• `Optional` **defaultMessageServerUrl**: `string` - -#### Defined in - -packages/client-ts/dist/interfaces.d.ts:70 - -___ - -### didServerUrl - -• `Optional` **didServerUrl**: `string` - -#### Defined in - -packages/client-ts/dist/interfaces.d.ts:68 - -___ - -### schemaPaths - -• `Optional` **schemaPaths**: [`Record`](../modules/verida_verifiable_credentials._internal_.md#record)<`string`, `string`\> - -#### Defined in - -packages/client-ts/dist/interfaces.d.ts:71 diff --git a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.DeprecatedOptions.md b/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.DeprecatedOptions.md deleted file mode 100644 index 1204798..0000000 --- a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.DeprecatedOptions.md +++ /dev/null @@ -1,49 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / DeprecatedOptions - -# Interface: DeprecatedOptions - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md).DeprecatedOptions - -## Table of contents - -### Properties - -- [ignoreKeywordsWithRef](verida_verifiable_credentials._internal_.DeprecatedOptions.md#ignorekeywordswithref) -- [jsPropertySyntax](verida_verifiable_credentials._internal_.DeprecatedOptions.md#jspropertysyntax) -- [unicode](verida_verifiable_credentials._internal_.DeprecatedOptions.md#unicode) - -## Properties - -### ignoreKeywordsWithRef - -• `Optional` **ignoreKeywordsWithRef**: `boolean` - -**`deprecated`** - -#### Defined in - -node_modules/ajv/dist/core.d.ts:85 - -___ - -### jsPropertySyntax - -• `Optional` **jsPropertySyntax**: `boolean` - -**`deprecated`** - -#### Defined in - -node_modules/ajv/dist/core.d.ts:87 - -___ - -### unicode - -• `Optional` **unicode**: `boolean` - -**`deprecated`** - -#### Defined in - -node_modules/ajv/dist/core.d.ts:89 diff --git a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.EcdsaSignature.md b/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.EcdsaSignature.md deleted file mode 100644 index 0834da0..0000000 --- a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.EcdsaSignature.md +++ /dev/null @@ -1,45 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / EcdsaSignature - -# Interface: EcdsaSignature - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md).EcdsaSignature - -**`deprecated`** Signers will be expected to return base64url `string` signatures. - -## Table of contents - -### Properties - -- [r](verida_verifiable_credentials._internal_.EcdsaSignature.md#r) -- [recoveryParam](verida_verifiable_credentials._internal_.EcdsaSignature.md#recoveryparam) -- [s](verida_verifiable_credentials._internal_.EcdsaSignature.md#s) - -## Properties - -### r - -• **r**: `string` - -#### Defined in - -node_modules/did-jwt/lib/util.d.ts:6 - -___ - -### recoveryParam - -• `Optional` **recoveryParam**: ``null`` \| `number` - -#### Defined in - -node_modules/did-jwt/lib/util.d.ts:8 - -___ - -### s - -• **s**: `string` - -#### Defined in - -node_modules/did-jwt/lib/util.d.ts:7 diff --git a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.EndpointUsage.md b/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.EndpointUsage.md deleted file mode 100644 index 198670c..0000000 --- a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.EndpointUsage.md +++ /dev/null @@ -1,43 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / EndpointUsage - -# Interface: EndpointUsage - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md).EndpointUsage - -## Table of contents - -### Properties - -- [bytes](verida_verifiable_credentials._internal_.EndpointUsage.md#bytes) -- [databases](verida_verifiable_credentials._internal_.EndpointUsage.md#databases) -- [storageLimit](verida_verifiable_credentials._internal_.EndpointUsage.md#storagelimit) - -## Properties - -### bytes - -• **bytes**: `number` - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:131 - -___ - -### databases - -• **databases**: `number` - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:130 - -___ - -### storageLimit - -• **storageLimit**: `number` - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:132 diff --git a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.Endpoints.md b/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.Endpoints.md deleted file mode 100644 index eece62e..0000000 --- a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.Endpoints.md +++ /dev/null @@ -1,54 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / Endpoints - -# Interface: Endpoints - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md).Endpoints - -## Table of contents - -### Properties - -- [database](verida_verifiable_credentials._internal_.Endpoints.md#database) -- [messaging](verida_verifiable_credentials._internal_.Endpoints.md#messaging) -- [notification](verida_verifiable_credentials._internal_.Endpoints.md#notification) -- [storage](verida_verifiable_credentials._internal_.Endpoints.md#storage) - -## Properties - -### database - -• **database**: [`SecureContextEndpoint`](verida_verifiable_credentials._internal_.SecureContextEndpoint-1.md) - -#### Defined in - -packages/did-document/dist/interfaces.d.ts:17 - -___ - -### messaging - -• **messaging**: [`SecureContextEndpoint`](verida_verifiable_credentials._internal_.SecureContextEndpoint-1.md) - -#### Defined in - -packages/did-document/dist/interfaces.d.ts:18 - -___ - -### notification - -• `Optional` **notification**: [`SecureContextEndpoint`](verida_verifiable_credentials._internal_.SecureContextEndpoint-1.md) - -#### Defined in - -packages/did-document/dist/interfaces.d.ts:20 - -___ - -### storage - -• `Optional` **storage**: [`SecureContextEndpoint`](verida_verifiable_credentials._internal_.SecureContextEndpoint-1.md) - -#### Defined in - -packages/did-document/dist/interfaces.d.ts:19 diff --git a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.Error.md b/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.Error.md deleted file mode 100644 index dbe7211..0000000 --- a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.Error.md +++ /dev/null @@ -1,43 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / Error - -# Interface: Error - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md).Error - -## Table of contents - -### Properties - -- [message](verida_verifiable_credentials._internal_.Error.md#message) -- [name](verida_verifiable_credentials._internal_.Error.md#name) -- [stack](verida_verifiable_credentials._internal_.Error.md#stack) - -## Properties - -### message - -• **message**: `string` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:974 - -___ - -### name - -• **name**: `string` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:973 - -___ - -### stack - -• `Optional` **stack**: `string` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:975 diff --git a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.ErrorObject.md b/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.ErrorObject.md deleted file mode 100644 index 1c9bf9d..0000000 --- a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.ErrorObject.md +++ /dev/null @@ -1,117 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / ErrorObject - -# Interface: ErrorObject - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md).ErrorObject - -## Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends `string` = `string` | -| `P` | [`Record`](../modules/verida_verifiable_credentials._internal_.md#record)<`string`, `any`\> | -| `S` | `unknown` | - -## Table of contents - -### Properties - -- [data](verida_verifiable_credentials._internal_.ErrorObject.md#data) -- [instancePath](verida_verifiable_credentials._internal_.ErrorObject.md#instancepath) -- [keyword](verida_verifiable_credentials._internal_.ErrorObject.md#keyword) -- [message](verida_verifiable_credentials._internal_.ErrorObject.md#message) -- [params](verida_verifiable_credentials._internal_.ErrorObject.md#params) -- [parentSchema](verida_verifiable_credentials._internal_.ErrorObject.md#parentschema) -- [propertyName](verida_verifiable_credentials._internal_.ErrorObject.md#propertyname) -- [schema](verida_verifiable_credentials._internal_.ErrorObject.md#schema) -- [schemaPath](verida_verifiable_credentials._internal_.ErrorObject.md#schemapath) - -## Properties - -### data - -• `Optional` **data**: `unknown` - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:82 - -___ - -### instancePath - -• **instancePath**: `string` - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:75 - -___ - -### keyword - -• **keyword**: `K` - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:74 - -___ - -### message - -• `Optional` **message**: `string` - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:79 - -___ - -### params - -• **params**: `P` - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:77 - -___ - -### parentSchema - -• `Optional` **parentSchema**: [`AnySchemaObject`](../modules/verida_verifiable_credentials._internal_.md#anyschemaobject) - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:81 - -___ - -### propertyName - -• `Optional` **propertyName**: `string` - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:78 - -___ - -### schema - -• `Optional` **schema**: `S` - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:80 - -___ - -### schemaPath - -• **schemaPath**: `string` - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:76 diff --git a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.ErrorPaths.md b/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.ErrorPaths.md deleted file mode 100644 index f45575a..0000000 --- a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.ErrorPaths.md +++ /dev/null @@ -1,43 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / ErrorPaths - -# Interface: ErrorPaths - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md).ErrorPaths - -## Table of contents - -### Properties - -- [instancePath](verida_verifiable_credentials._internal_.ErrorPaths.md#instancepath) -- [parentSchema](verida_verifiable_credentials._internal_.ErrorPaths.md#parentschema) -- [schemaPath](verida_verifiable_credentials._internal_.ErrorPaths.md#schemapath) - -## Properties - -### instancePath - -• `Optional` **instancePath**: [`Code`](../modules/verida_verifiable_credentials._internal_.md#code) - -#### Defined in - -node_modules/ajv/dist/compile/errors.d.ts:6 - -___ - -### parentSchema - -• `Optional` **parentSchema**: `boolean` - -#### Defined in - -node_modules/ajv/dist/compile/errors.d.ts:8 - -___ - -### schemaPath - -• `Optional` **schemaPath**: `string` - -#### Defined in - -node_modules/ajv/dist/compile/errors.d.ts:7 diff --git a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.ErrorsTextOptions.md b/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.ErrorsTextOptions.md deleted file mode 100644 index a70542e..0000000 --- a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.ErrorsTextOptions.md +++ /dev/null @@ -1,32 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / ErrorsTextOptions - -# Interface: ErrorsTextOptions - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md).ErrorsTextOptions - -## Table of contents - -### Properties - -- [dataVar](verida_verifiable_credentials._internal_.ErrorsTextOptions.md#datavar) -- [separator](verida_verifiable_credentials._internal_.ErrorsTextOptions.md#separator) - -## Properties - -### dataVar - -• `Optional` **dataVar**: `string` - -#### Defined in - -node_modules/ajv/dist/core.d.ts:168 - -___ - -### separator - -• `Optional` **separator**: `string` - -#### Defined in - -node_modules/ajv/dist/core.d.ts:167 diff --git a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.Evaluated.md b/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.Evaluated.md deleted file mode 100644 index a590fac..0000000 --- a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.Evaluated.md +++ /dev/null @@ -1,54 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / Evaluated - -# Interface: Evaluated - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md).Evaluated - -## Table of contents - -### Properties - -- [dynamicItems](verida_verifiable_credentials._internal_.Evaluated.md#dynamicitems) -- [dynamicProps](verida_verifiable_credentials._internal_.Evaluated.md#dynamicprops) -- [items](verida_verifiable_credentials._internal_.Evaluated.md#items) -- [props](verida_verifiable_credentials._internal_.Evaluated.md#props) - -## Properties - -### dynamicItems - -• **dynamicItems**: `boolean` - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:66 - -___ - -### dynamicProps - -• **dynamicProps**: `boolean` - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:65 - -___ - -### items - -• `Optional` **items**: [`EvaluatedItems`](../modules/verida_verifiable_credentials._internal_.md#evaluateditems) - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:64 - -___ - -### props - -• `Optional` **props**: [`EvaluatedProperties`](../modules/verida_verifiable_credentials._internal_.md#evaluatedproperties) - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:63 diff --git a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.EventEmitter.Abortable.md b/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.EventEmitter.Abortable.md deleted file mode 100644 index 51ee4e3..0000000 --- a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.EventEmitter.Abortable.md +++ /dev/null @@ -1,23 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / [EventEmitter](../modules/verida_verifiable_credentials._internal_.EventEmitter.md) / Abortable - -# Interface: Abortable - -[](../modules/verida_verifiable_credentials._internal_.md).[EventEmitter](../modules/verida_verifiable_credentials._internal_.EventEmitter.md).Abortable - -## Table of contents - -### Properties - -- [signal](verida_verifiable_credentials._internal_.EventEmitter.Abortable.md#signal) - -## Properties - -### signal - -• `Optional` **signal**: [`AbortSignal`](../modules/verida_verifiable_credentials._internal_.md#abortsignal) - -When provided the corresponding `AbortController` can be used to cancel an asynchronous action. - -#### Defined in - -node_modules/@types/node/events.d.ts:289 diff --git a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.EventEmitter.md b/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.EventEmitter.md deleted file mode 100644 index 9f94366..0000000 --- a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.EventEmitter.md +++ /dev/null @@ -1,278 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / EventEmitter - -# Interface: EventEmitter - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md).EventEmitter - -## Table of contents - -### Methods - -- [addListener](verida_verifiable_credentials._internal_.EventEmitter.md#addlistener) -- [emit](verida_verifiable_credentials._internal_.EventEmitter.md#emit) -- [eventNames](verida_verifiable_credentials._internal_.EventEmitter.md#eventnames) -- [getMaxListeners](verida_verifiable_credentials._internal_.EventEmitter.md#getmaxlisteners) -- [listenerCount](verida_verifiable_credentials._internal_.EventEmitter.md#listenercount) -- [listeners](verida_verifiable_credentials._internal_.EventEmitter.md#listeners) -- [on](verida_verifiable_credentials._internal_.EventEmitter.md#on) -- [once](verida_verifiable_credentials._internal_.EventEmitter.md#once) -- [prependListener](verida_verifiable_credentials._internal_.EventEmitter.md#prependlistener) -- [prependOnceListener](verida_verifiable_credentials._internal_.EventEmitter.md#prependoncelistener) -- [removeAllListeners](verida_verifiable_credentials._internal_.EventEmitter.md#removealllisteners) -- [removeListener](verida_verifiable_credentials._internal_.EventEmitter.md#removelistener) -- [setMaxListeners](verida_verifiable_credentials._internal_.EventEmitter.md#setmaxlisteners) - -## Methods - -### addListener - -▸ **addListener**(`event`, `listener`): [`EventEmitter`](verida_verifiable_credentials._internal_.EventEmitter.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | `string` \| `symbol` | -| `listener` | `Function` | - -#### Returns - -[`EventEmitter`](verida_verifiable_credentials._internal_.EventEmitter.md) - -#### Defined in - -node_modules/@types/pouchdb-core/index.d.ts:76 - -___ - -### emit - -▸ **emit**(`event`, ...`args`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | `string` \| `symbol` | -| `...args` | `any`[] | - -#### Returns - -`boolean` - -#### Defined in - -node_modules/@types/pouchdb-core/index.d.ts:84 - -___ - -### eventNames - -▸ **eventNames**(): (`string` \| `symbol`)[] - -#### Returns - -(`string` \| `symbol`)[] - -#### Defined in - -node_modules/@types/pouchdb-core/index.d.ts:88 - -___ - -### getMaxListeners - -▸ **getMaxListeners**(): `number` - -#### Returns - -`number` - -#### Defined in - -node_modules/@types/pouchdb-core/index.d.ts:82 - -___ - -### listenerCount - -▸ **listenerCount**(`type`): `number` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `type` | `string` \| `symbol` | - -#### Returns - -`number` - -#### Defined in - -node_modules/@types/pouchdb-core/index.d.ts:85 - -___ - -### listeners - -▸ **listeners**(`event`): `Function`[] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | `string` \| `symbol` | - -#### Returns - -`Function`[] - -#### Defined in - -node_modules/@types/pouchdb-core/index.d.ts:83 - -___ - -### on - -▸ **on**(`event`, `listener`): [`EventEmitter`](verida_verifiable_credentials._internal_.EventEmitter.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | `string` \| `symbol` | -| `listener` | `Function` | - -#### Returns - -[`EventEmitter`](verida_verifiable_credentials._internal_.EventEmitter.md) - -#### Defined in - -node_modules/@types/pouchdb-core/index.d.ts:77 - -___ - -### once - -▸ **once**(`event`, `listener`): [`EventEmitter`](verida_verifiable_credentials._internal_.EventEmitter.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | `string` \| `symbol` | -| `listener` | `Function` | - -#### Returns - -[`EventEmitter`](verida_verifiable_credentials._internal_.EventEmitter.md) - -#### Defined in - -node_modules/@types/pouchdb-core/index.d.ts:78 - -___ - -### prependListener - -▸ **prependListener**(`event`, `listener`): [`EventEmitter`](verida_verifiable_credentials._internal_.EventEmitter.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | `string` \| `symbol` | -| `listener` | `Function` | - -#### Returns - -[`EventEmitter`](verida_verifiable_credentials._internal_.EventEmitter.md) - -#### Defined in - -node_modules/@types/pouchdb-core/index.d.ts:86 - -___ - -### prependOnceListener - -▸ **prependOnceListener**(`event`, `listener`): [`EventEmitter`](verida_verifiable_credentials._internal_.EventEmitter.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | `string` \| `symbol` | -| `listener` | `Function` | - -#### Returns - -[`EventEmitter`](verida_verifiable_credentials._internal_.EventEmitter.md) - -#### Defined in - -node_modules/@types/pouchdb-core/index.d.ts:87 - -___ - -### removeAllListeners - -▸ **removeAllListeners**(`event?`): [`EventEmitter`](verida_verifiable_credentials._internal_.EventEmitter.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event?` | `string` \| `symbol` | - -#### Returns - -[`EventEmitter`](verida_verifiable_credentials._internal_.EventEmitter.md) - -#### Defined in - -node_modules/@types/pouchdb-core/index.d.ts:80 - -___ - -### removeListener - -▸ **removeListener**(`event`, `listener`): [`EventEmitter`](verida_verifiable_credentials._internal_.EventEmitter.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | `string` \| `symbol` | -| `listener` | `Function` | - -#### Returns - -[`EventEmitter`](verida_verifiable_credentials._internal_.EventEmitter.md) - -#### Defined in - -node_modules/@types/pouchdb-core/index.d.ts:79 - -___ - -### setMaxListeners - -▸ **setMaxListeners**(`n`): [`EventEmitter`](verida_verifiable_credentials._internal_.EventEmitter.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `n` | `number` | - -#### Returns - -[`EventEmitter`](verida_verifiable_credentials._internal_.EventEmitter.md) - -#### Defined in - -node_modules/@types/pouchdb-core/index.d.ts:81 diff --git a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.EventEmitterOptions.md b/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.EventEmitterOptions.md deleted file mode 100644 index 084b568..0000000 --- a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.EventEmitterOptions.md +++ /dev/null @@ -1,23 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / EventEmitterOptions - -# Interface: EventEmitterOptions - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md).EventEmitterOptions - -## Table of contents - -### Properties - -- [captureRejections](verida_verifiable_credentials._internal_.EventEmitterOptions.md#capturerejections) - -## Properties - -### captureRejections - -• `Optional` **captureRejections**: `boolean` - -Enables automatic capturing of promise rejection. - -#### Defined in - -node_modules/@types/node/events.d.ts:42 diff --git a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.FormatDefinition.md b/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.FormatDefinition.md deleted file mode 100644 index a724071..0000000 --- a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.FormatDefinition.md +++ /dev/null @@ -1,60 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / FormatDefinition - -# Interface: FormatDefinition - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md).FormatDefinition - -## Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | extends `string` \| `number` | - -## Table of contents - -### Properties - -- [async](verida_verifiable_credentials._internal_.FormatDefinition.md#async) -- [compare](verida_verifiable_credentials._internal_.FormatDefinition.md#compare) -- [type](verida_verifiable_credentials._internal_.FormatDefinition.md#type) -- [validate](verida_verifiable_credentials._internal_.FormatDefinition.md#validate) - -## Properties - -### async - -• `Optional` **async**: ``false`` - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:159 - -___ - -### compare - -• `Optional` **compare**: [`FormatCompare`](../modules/verida_verifiable_credentials._internal_.md#formatcompare)<`T`\> - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:160 - -___ - -### type - -• `Optional` **type**: `T` extends `string` ? `undefined` \| ``"string"`` : ``"number"`` - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:157 - -___ - -### validate - -• **validate**: [`FormatValidator`](../modules/verida_verifiable_credentials._internal_.md#formatvalidator)<`T`\> \| `T` extends `string` ? `string` \| `RegExp` : `never` - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:158 diff --git a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.FuncKeywordDefinition.md b/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.FuncKeywordDefinition.md deleted file mode 100644 index 700fd6e..0000000 --- a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.FuncKeywordDefinition.md +++ /dev/null @@ -1,290 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / FuncKeywordDefinition - -# Interface: FuncKeywordDefinition - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md).FuncKeywordDefinition - -## Hierarchy - -- [`_KeywordDef`](verida_verifiable_credentials._internal_._KeywordDef.md) - - ↳ **`FuncKeywordDefinition`** - - ↳↳ [`MacroKeywordDefinition`](verida_verifiable_credentials._internal_.MacroKeywordDefinition.md) - -## Table of contents - -### Properties - -- [$data](verida_verifiable_credentials._internal_.FuncKeywordDefinition.md#$data) -- [$dataError](verida_verifiable_credentials._internal_.FuncKeywordDefinition.md#$dataerror) -- [allowUndefined](verida_verifiable_credentials._internal_.FuncKeywordDefinition.md#allowundefined) -- [async](verida_verifiable_credentials._internal_.FuncKeywordDefinition.md#async) -- [before](verida_verifiable_credentials._internal_.FuncKeywordDefinition.md#before) -- [compile](verida_verifiable_credentials._internal_.FuncKeywordDefinition.md#compile) -- [dependencies](verida_verifiable_credentials._internal_.FuncKeywordDefinition.md#dependencies) -- [error](verida_verifiable_credentials._internal_.FuncKeywordDefinition.md#error) -- [errors](verida_verifiable_credentials._internal_.FuncKeywordDefinition.md#errors) -- [implements](verida_verifiable_credentials._internal_.FuncKeywordDefinition.md#implements) -- [keyword](verida_verifiable_credentials._internal_.FuncKeywordDefinition.md#keyword) -- [metaSchema](verida_verifiable_credentials._internal_.FuncKeywordDefinition.md#metaschema) -- [modifying](verida_verifiable_credentials._internal_.FuncKeywordDefinition.md#modifying) -- [post](verida_verifiable_credentials._internal_.FuncKeywordDefinition.md#post) -- [schema](verida_verifiable_credentials._internal_.FuncKeywordDefinition.md#schema) -- [schemaType](verida_verifiable_credentials._internal_.FuncKeywordDefinition.md#schematype) -- [type](verida_verifiable_credentials._internal_.FuncKeywordDefinition.md#type) -- [valid](verida_verifiable_credentials._internal_.FuncKeywordDefinition.md#valid) -- [validate](verida_verifiable_credentials._internal_.FuncKeywordDefinition.md#validate) -- [validateSchema](verida_verifiable_credentials._internal_.FuncKeywordDefinition.md#validateschema) - -## Properties - -### $data - -• `Optional` **$data**: `boolean` - -#### Inherited from - -[_KeywordDef](verida_verifiable_credentials._internal_._KeywordDef.md).[$data](verida_verifiable_credentials._internal_._KeywordDef.md#$data) - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:90 - -___ - -### $dataError - -• `Optional` **$dataError**: [`KeywordErrorDefinition`](verida_verifiable_credentials._internal_.KeywordErrorDefinition.md) - -#### Inherited from - -[_KeywordDef](verida_verifiable_credentials._internal_._KeywordDef.md).[$dataError](verida_verifiable_credentials._internal_._KeywordDef.md#$dataerror) - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:98 - -___ - -### allowUndefined - -• `Optional` **allowUndefined**: `boolean` - -#### Inherited from - -[_KeywordDef](verida_verifiable_credentials._internal_._KeywordDef.md).[allowUndefined](verida_verifiable_credentials._internal_._KeywordDef.md#allowundefined) - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:89 - -___ - -### async - -• `Optional` **async**: `boolean` - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:119 - -___ - -### before - -• `Optional` **before**: `string` - -#### Inherited from - -[_KeywordDef](verida_verifiable_credentials._internal_._KeywordDef.md).[before](verida_verifiable_credentials._internal_._KeywordDef.md#before) - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:92 - -___ - -### compile - -• `Optional` **compile**: [`CompileKeywordFunc`](../modules/verida_verifiable_credentials._internal_.md#compilekeywordfunc) - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:116 - -___ - -### dependencies - -• `Optional` **dependencies**: `string`[] - -#### Inherited from - -[_KeywordDef](verida_verifiable_credentials._internal_._KeywordDef.md).[dependencies](verida_verifiable_credentials._internal_._KeywordDef.md#dependencies) - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:96 - -___ - -### error - -• `Optional` **error**: [`KeywordErrorDefinition`](verida_verifiable_credentials._internal_.KeywordErrorDefinition.md) - -#### Inherited from - -[_KeywordDef](verida_verifiable_credentials._internal_._KeywordDef.md).[error](verida_verifiable_credentials._internal_._KeywordDef.md#error) - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:97 - -___ - -### errors - -• `Optional` **errors**: `boolean` \| ``"full"`` - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:121 - -___ - -### implements - -• `Optional` **implements**: `string`[] - -#### Inherited from - -[_KeywordDef](verida_verifiable_credentials._internal_._KeywordDef.md).[implements](verida_verifiable_credentials._internal_._KeywordDef.md#implements) - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:91 - -___ - -### keyword - -• **keyword**: `string` \| `string`[] - -#### Inherited from - -[_KeywordDef](verida_verifiable_credentials._internal_._KeywordDef.md).[keyword](verida_verifiable_credentials._internal_._KeywordDef.md#keyword) - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:86 - -___ - -### metaSchema - -• `Optional` **metaSchema**: [`AnySchemaObject`](../modules/verida_verifiable_credentials._internal_.md#anyschemaobject) - -#### Inherited from - -[_KeywordDef](verida_verifiable_credentials._internal_._KeywordDef.md).[metaSchema](verida_verifiable_credentials._internal_._KeywordDef.md#metaschema) - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:94 - -___ - -### modifying - -• `Optional` **modifying**: `boolean` - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:118 - -___ - -### post - -• `Optional` **post**: `boolean` - -#### Inherited from - -[_KeywordDef](verida_verifiable_credentials._internal_._KeywordDef.md).[post](verida_verifiable_credentials._internal_._KeywordDef.md#post) - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:93 - -___ - -### schema - -• `Optional` **schema**: `boolean` - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:117 - -___ - -### schemaType - -• `Optional` **schemaType**: ``"string"`` \| ``"number"`` \| ``"boolean"`` \| ``"object"`` \| ``"integer"`` \| ``"array"`` \| ``"null"`` \| (``"string"`` \| ``"number"`` \| ``"boolean"`` \| ``"object"`` \| ``"integer"`` \| ``"array"`` \| ``"null"``)[] - -#### Inherited from - -[_KeywordDef](verida_verifiable_credentials._internal_._KeywordDef.md).[schemaType](verida_verifiable_credentials._internal_._KeywordDef.md#schematype) - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:88 - -___ - -### type - -• `Optional` **type**: ``"string"`` \| ``"number"`` \| ``"boolean"`` \| ``"object"`` \| ``"integer"`` \| ``"array"`` \| ``"null"`` \| (``"string"`` \| ``"number"`` \| ``"boolean"`` \| ``"object"`` \| ``"integer"`` \| ``"array"`` \| ``"null"``)[] - -#### Inherited from - -[_KeywordDef](verida_verifiable_credentials._internal_._KeywordDef.md).[type](verida_verifiable_credentials._internal_._KeywordDef.md#type) - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:87 - -___ - -### valid - -• `Optional` **valid**: `boolean` - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:120 - -___ - -### validate - -• `Optional` **validate**: [`SchemaValidateFunction`](verida_verifiable_credentials._internal_.SchemaValidateFunction.md) \| [`DataValidateFunction`](verida_verifiable_credentials._internal_.DataValidateFunction.md) - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:115 - -___ - -### validateSchema - -• `Optional` **validateSchema**: [`AnyValidateFunction`](../modules/verida_verifiable_credentials._internal_.md#anyvalidatefunction)<`any`\> - -#### Inherited from - -[_KeywordDef](verida_verifiable_credentials._internal_._KeywordDef.md).[validateSchema](verida_verifiable_credentials._internal_._KeywordDef.md#validateschema) - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:95 diff --git a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.IAccount.md b/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.IAccount.md deleted file mode 100644 index 52f8417..0000000 --- a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.IAccount.md +++ /dev/null @@ -1,266 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / IAccount - -# Interface: IAccount - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md).IAccount - -## Table of contents - -### Methods - -- [createDidJwt](verida_verifiable_credentials._internal_.IAccount.md#createdidjwt) -- [did](verida_verifiable_credentials._internal_.IAccount.md#did) -- [disconnect](verida_verifiable_credentials._internal_.IAccount.md#disconnect) -- [disconnectDevice](verida_verifiable_credentials._internal_.IAccount.md#disconnectdevice) -- [getAuthContext](verida_verifiable_credentials._internal_.IAccount.md#getauthcontext) -- [keyring](verida_verifiable_credentials._internal_.IAccount.md#keyring) -- [linkStorage](verida_verifiable_credentials._internal_.IAccount.md#linkstorage) -- [linkStorageContextService](verida_verifiable_credentials._internal_.IAccount.md#linkstoragecontextservice) -- [setAccountConfig](verida_verifiable_credentials._internal_.IAccount.md#setaccountconfig) -- [sign](verida_verifiable_credentials._internal_.IAccount.md#sign) -- [storageConfig](verida_verifiable_credentials._internal_.IAccount.md#storageconfig) -- [unlinkStorage](verida_verifiable_credentials._internal_.IAccount.md#unlinkstorage) - -## Methods - -### createDidJwt - -▸ **createDidJwt**(`contextName`, `data`, `config`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | -| `data` | `object` | -| `config` | `any` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -packages/types/dist/IAccount.d.ts:13 - -___ - -### did - -▸ **did**(): `Promise`<`string`\> - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -packages/types/dist/IAccount.d.ts:7 - -___ - -### disconnect - -▸ **disconnect**(`contextName?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName?` | `string` | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -packages/types/dist/IAccount.d.ts:14 - -___ - -### disconnectDevice - -▸ **disconnectDevice**(`contextName`, `deviceId`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | -| `deviceId` | `string` | - -#### Returns - -`Promise`<`boolean`\> - -#### Defined in - -packages/types/dist/IAccount.d.ts:16 - -___ - -### getAuthContext - -▸ **getAuthContext**(`contextName`, `contextConfig`, `authConfig?`, `authType?`): `Promise`<[`AuthContext`](verida_verifiable_credentials._internal_.AuthContext.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | -| `contextConfig` | [`SecureContextConfig`](verida_verifiable_credentials._internal_.SecureContextConfig.md) | -| `authConfig?` | [`AuthTypeConfig`](verida_verifiable_credentials._internal_.AuthTypeConfig.md) | -| `authType?` | `string` | - -#### Returns - -`Promise`<[`AuthContext`](verida_verifiable_credentials._internal_.AuthContext.md)\> - -#### Defined in - -packages/types/dist/IAccount.d.ts:15 - -___ - -### keyring - -▸ **keyring**(`contextName`): `Promise`<[`IKeyring`](verida_verifiable_credentials._internal_.IKeyring.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | - -#### Returns - -`Promise`<[`IKeyring`](verida_verifiable_credentials._internal_.IKeyring.md)\> - -#### Defined in - -packages/types/dist/IAccount.d.ts:5 - -___ - -### linkStorage - -▸ **linkStorage**(`storageConfig`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `storageConfig` | [`SecureContextConfig`](verida_verifiable_credentials._internal_.SecureContextConfig.md) | - -#### Returns - -`Promise`<`boolean`\> - -#### Defined in - -packages/types/dist/IAccount.d.ts:8 - -___ - -### linkStorageContextService - -▸ **linkStorageContextService**(`contextName`, `endpointType`, `serverType`, `endpointUris`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | -| `endpointType` | `string` | -| `serverType` | `string` | -| `endpointUris` | `string`[] | - -#### Returns - -`Promise`<`boolean`\> - -#### Defined in - -packages/types/dist/IAccount.d.ts:11 - -___ - -### setAccountConfig - -▸ **setAccountConfig**(`accountConfig`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `accountConfig` | [`AccountConfig`](verida_verifiable_credentials._internal_.AccountConfig.md) | - -#### Returns - -`void` - -#### Defined in - -packages/types/dist/IAccount.d.ts:12 - -___ - -### sign - -▸ **sign**(`input`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `input` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -packages/types/dist/IAccount.d.ts:6 - -___ - -### storageConfig - -▸ **storageConfig**(`contextName`, `forceCreate`): `Promise`<`undefined` \| [`SecureContextConfig`](verida_verifiable_credentials._internal_.SecureContextConfig.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | -| `forceCreate` | `boolean` | - -#### Returns - -`Promise`<`undefined` \| [`SecureContextConfig`](verida_verifiable_credentials._internal_.SecureContextConfig.md)\> - -#### Defined in - -packages/types/dist/IAccount.d.ts:10 - -___ - -### unlinkStorage - -▸ **unlinkStorage**(`contextName`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | - -#### Returns - -`Promise`<`boolean`\> - -#### Defined in - -packages/types/dist/IAccount.d.ts:9 diff --git a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.IClient.md b/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.IClient.md deleted file mode 100644 index 6f34c65..0000000 --- a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.IClient.md +++ /dev/null @@ -1,179 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / IClient - -# Interface: IClient - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md).IClient - -## Table of contents - -### Methods - -- [connect](verida_verifiable_credentials._internal_.IClient.md#connect) -- [getContextConfig](verida_verifiable_credentials._internal_.IClient.md#getcontextconfig) -- [getSchema](verida_verifiable_credentials._internal_.IClient.md#getschema) -- [getValidDataSignatures](verida_verifiable_credentials._internal_.IClient.md#getvaliddatasignatures) -- [isConnected](verida_verifiable_credentials._internal_.IClient.md#isconnected) -- [openContext](verida_verifiable_credentials._internal_.IClient.md#opencontext) -- [openExternalContext](verida_verifiable_credentials._internal_.IClient.md#openexternalcontext) -- [openPublicProfile](verida_verifiable_credentials._internal_.IClient.md#openpublicprofile) - -## Methods - -### connect - -▸ **connect**(`account`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `account` | [`IAccount`](verida_verifiable_credentials._internal_.IAccount.md) | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -packages/types/dist/IClient.d.ts:7 - -___ - -### getContextConfig - -▸ **getContextConfig**(`did`, `contextName`): `Promise`<`undefined` \| [`SecureContextConfig`](verida_verifiable_credentials._internal_.SecureContextConfig.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did` | `string` | -| `contextName` | `string` | - -#### Returns - -`Promise`<`undefined` \| [`SecureContextConfig`](verida_verifiable_credentials._internal_.SecureContextConfig.md)\> - -#### Defined in - -packages/types/dist/IClient.d.ts:11 - -___ - -### getSchema - -▸ **getSchema**(`schemaUri`): `Promise`<[`ISchema`](verida_verifiable_credentials._internal_.ISchema.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schemaUri` | `string` | - -#### Returns - -`Promise`<[`ISchema`](verida_verifiable_credentials._internal_.ISchema.md)\> - -#### Defined in - -packages/types/dist/IClient.d.ts:14 - -___ - -### getValidDataSignatures - -▸ **getValidDataSignatures**(`data`, `did?`): `Promise`<`string`[]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `any` | -| `did?` | `string` | - -#### Returns - -`Promise`<`string`[]\> - -#### Defined in - -packages/types/dist/IClient.d.ts:13 - -___ - -### isConnected - -▸ **isConnected**(): `void` - -#### Returns - -`void` - -#### Defined in - -packages/types/dist/IClient.d.ts:8 - -___ - -### openContext - -▸ **openContext**(`contextName`, `forceCreate`): `Promise`<`undefined` \| [`IContext`](verida_verifiable_credentials._internal_.IContext.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | -| `forceCreate` | `boolean` | - -#### Returns - -`Promise`<`undefined` \| [`IContext`](verida_verifiable_credentials._internal_.IContext.md)\> - -#### Defined in - -packages/types/dist/IClient.d.ts:9 - -___ - -### openExternalContext - -▸ **openExternalContext**(`contextName`, `did`): `Promise`<[`IContext`](verida_verifiable_credentials._internal_.IContext.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | -| `did` | `string` | - -#### Returns - -`Promise`<[`IContext`](verida_verifiable_credentials._internal_.IContext.md)\> - -#### Defined in - -packages/types/dist/IClient.d.ts:10 - -___ - -### openPublicProfile - -▸ **openPublicProfile**(`did`, `contextName`, `profileName`, `fallbackContext`): `Promise`<`undefined` \| [`IProfile`](verida_verifiable_credentials._internal_.IProfile.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did` | `string` | -| `contextName` | `string` | -| `profileName` | `string` | -| `fallbackContext` | ``null`` \| `string` | - -#### Returns - -`Promise`<`undefined` \| [`IProfile`](verida_verifiable_credentials._internal_.IProfile.md)\> - -#### Defined in - -packages/types/dist/IClient.d.ts:12 diff --git a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.IContext.md b/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.IContext.md deleted file mode 100644 index 4622d5b..0000000 --- a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.IContext.md +++ /dev/null @@ -1,402 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / IContext - -# Interface: IContext - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md).IContext - -## Table of contents - -### Methods - -- [addEndpoint](verida_verifiable_credentials._internal_.IContext.md#addendpoint) -- [clearDatabaseCache](verida_verifiable_credentials._internal_.IContext.md#cleardatabasecache) -- [close](verida_verifiable_credentials._internal_.IContext.md#close) -- [disconnect](verida_verifiable_credentials._internal_.IContext.md#disconnect) -- [getAccount](verida_verifiable_credentials._internal_.IContext.md#getaccount) -- [getAuthContext](verida_verifiable_credentials._internal_.IContext.md#getauthcontext) -- [getClient](verida_verifiable_credentials._internal_.IContext.md#getclient) -- [getContextConfig](verida_verifiable_credentials._internal_.IContext.md#getcontextconfig) -- [getContextName](verida_verifiable_credentials._internal_.IContext.md#getcontextname) -- [getDatabaseEngine](verida_verifiable_credentials._internal_.IContext.md#getdatabaseengine) -- [getDbRegistry](verida_verifiable_credentials._internal_.IContext.md#getdbregistry) -- [getDidContextManager](verida_verifiable_credentials._internal_.IContext.md#getdidcontextmanager) -- [getMessaging](verida_verifiable_credentials._internal_.IContext.md#getmessaging) -- [getNotification](verida_verifiable_credentials._internal_.IContext.md#getnotification) -- [info](verida_verifiable_credentials._internal_.IContext.md#info) -- [openDatabase](verida_verifiable_credentials._internal_.IContext.md#opendatabase) -- [openDatastore](verida_verifiable_credentials._internal_.IContext.md#opendatastore) -- [openExternalDatabase](verida_verifiable_credentials._internal_.IContext.md#openexternaldatabase) -- [openExternalDatastore](verida_verifiable_credentials._internal_.IContext.md#openexternaldatastore) -- [openProfile](verida_verifiable_credentials._internal_.IContext.md#openprofile) - -## Methods - -### addEndpoint - -▸ **addEndpoint**(`engineType`, `endpointUri`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `engineType` | [`ContextEngineType`](../enums/verida_verifiable_credentials._internal_.ContextEngineType.md) | -| `endpointUri` | `string` | - -#### Returns - -`void` - -#### Defined in - -packages/types/dist/IContext.d.ts:32 - -___ - -### clearDatabaseCache - -▸ **clearDatabaseCache**(`did`, `databaseName`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did` | `string` | -| `databaseName` | `string` | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -packages/types/dist/IContext.d.ts:34 - -___ - -### close - -▸ **close**(`options?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options?` | [`ContextCloseOptions`](verida_verifiable_credentials._internal_.ContextCloseOptions.md) | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -packages/types/dist/IContext.d.ts:33 - -___ - -### disconnect - -▸ **disconnect**(): `Promise`<`boolean`\> - -#### Returns - -`Promise`<`boolean`\> - -#### Defined in - -packages/types/dist/IContext.d.ts:20 - -___ - -### getAccount - -▸ **getAccount**(): [`IAccount`](verida_verifiable_credentials._internal_.IAccount.md) - -#### Returns - -[`IAccount`](verida_verifiable_credentials._internal_.IAccount.md) - -#### Defined in - -packages/types/dist/IContext.d.ts:17 - -___ - -### getAuthContext - -▸ **getAuthContext**(`authConfig?`, `authType?`): `Promise`<[`AuthContext`](verida_verifiable_credentials._internal_.AuthContext.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `authConfig?` | [`AuthTypeConfig`](verida_verifiable_credentials._internal_.AuthTypeConfig.md) | -| `authType?` | `string` | - -#### Returns - -`Promise`<[`AuthContext`](verida_verifiable_credentials._internal_.AuthContext.md)\> - -#### Defined in - -packages/types/dist/IContext.d.ts:31 - -___ - -### getClient - -▸ **getClient**(): [`IClient`](verida_verifiable_credentials._internal_.IClient.md) - -#### Returns - -[`IClient`](verida_verifiable_credentials._internal_.IClient.md) - -#### Defined in - -packages/types/dist/IContext.d.ts:19 - -___ - -### getContextConfig - -▸ **getContextConfig**(`did?`, `forceCreate?`, `customContextName?`): `Promise`<[`SecureContextConfig`](verida_verifiable_credentials._internal_.SecureContextConfig.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did?` | `string` | -| `forceCreate?` | `boolean` | -| `customContextName?` | `string` | - -#### Returns - -`Promise`<[`SecureContextConfig`](verida_verifiable_credentials._internal_.SecureContextConfig.md)\> - -#### Defined in - -packages/types/dist/IContext.d.ts:15 - -___ - -### getContextName - -▸ **getContextName**(): `string` - -#### Returns - -`string` - -#### Defined in - -packages/types/dist/IContext.d.ts:16 - -___ - -### getDatabaseEngine - -▸ **getDatabaseEngine**(`did`, `createContext?`): `Promise`<[`IStorageEngine`](verida_verifiable_credentials._internal_.IStorageEngine.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did` | `string` | -| `createContext?` | `boolean` | - -#### Returns - -`Promise`<[`IStorageEngine`](verida_verifiable_credentials._internal_.IStorageEngine.md)\> - -#### Defined in - -packages/types/dist/IContext.d.ts:21 - -___ - -### getDbRegistry - -▸ **getDbRegistry**(): [`IDbRegistry`](verida_verifiable_credentials._internal_.IDbRegistry.md) - -#### Returns - -[`IDbRegistry`](verida_verifiable_credentials._internal_.IDbRegistry.md) - -#### Defined in - -packages/types/dist/IContext.d.ts:29 - -___ - -### getDidContextManager - -▸ **getDidContextManager**(): [`IDIDContextManager`](verida_verifiable_credentials._internal_.IDIDContextManager.md) - -#### Returns - -[`IDIDContextManager`](verida_verifiable_credentials._internal_.IDIDContextManager.md) - -#### Defined in - -packages/types/dist/IContext.d.ts:18 - -___ - -### getMessaging - -▸ **getMessaging**(`messageConfig`): `Promise`<[`IMessaging`](verida_verifiable_credentials._internal_.IMessaging.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `messageConfig` | [`MessagesConfig`](verida_verifiable_credentials._internal_.MessagesConfig.md) | - -#### Returns - -`Promise`<[`IMessaging`](verida_verifiable_credentials._internal_.IMessaging.md)\> - -#### Defined in - -packages/types/dist/IContext.d.ts:22 - -___ - -### getNotification - -▸ **getNotification**(`did`, `contextName`): `Promise`<`undefined` \| [`INotification`](verida_verifiable_credentials._internal_.INotification.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did` | `string` | -| `contextName` | `string` | - -#### Returns - -`Promise`<`undefined` \| [`INotification`](verida_verifiable_credentials._internal_.INotification.md)\> - -#### Defined in - -packages/types/dist/IContext.d.ts:23 - -___ - -### info - -▸ **info**(): `Promise`<[`ContextInfo`](verida_verifiable_credentials._internal_.ContextInfo.md)\> - -#### Returns - -`Promise`<[`ContextInfo`](verida_verifiable_credentials._internal_.ContextInfo.md)\> - -#### Defined in - -packages/types/dist/IContext.d.ts:30 - -___ - -### openDatabase - -▸ **openDatabase**(`databaseName`, `config?`): `Promise`<[`IDatabase`](verida_verifiable_credentials._internal_.IDatabase.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `databaseName` | `string` | -| `config?` | [`DatabaseOpenConfig`](verida_verifiable_credentials._internal_.DatabaseOpenConfig.md) | - -#### Returns - -`Promise`<[`IDatabase`](verida_verifiable_credentials._internal_.IDatabase.md)\> - -#### Defined in - -packages/types/dist/IContext.d.ts:25 - -___ - -### openDatastore - -▸ **openDatastore**(`schemaUri`, `config?`): `Promise`<[`IDatastore`](verida_verifiable_credentials._internal_.IDatastore.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schemaUri` | `string` | -| `config?` | [`DatastoreOpenConfig`](verida_verifiable_credentials._internal_.DatastoreOpenConfig.md) | - -#### Returns - -`Promise`<[`IDatastore`](verida_verifiable_credentials._internal_.IDatastore.md)\> - -#### Defined in - -packages/types/dist/IContext.d.ts:27 - -___ - -### openExternalDatabase - -▸ **openExternalDatabase**(`databaseName`, `did`, `config?`): `Promise`<[`IDatabase`](verida_verifiable_credentials._internal_.IDatabase.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `databaseName` | `string` | -| `did` | `string` | -| `config?` | [`DatabaseOpenConfig`](verida_verifiable_credentials._internal_.DatabaseOpenConfig.md) | - -#### Returns - -`Promise`<[`IDatabase`](verida_verifiable_credentials._internal_.IDatabase.md)\> - -#### Defined in - -packages/types/dist/IContext.d.ts:26 - -___ - -### openExternalDatastore - -▸ **openExternalDatastore**(`schemaUri`, `did`, `options?`): `Promise`<[`IDatastore`](verida_verifiable_credentials._internal_.IDatastore.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schemaUri` | `string` | -| `did` | `string` | -| `options?` | [`DatastoreOpenConfig`](verida_verifiable_credentials._internal_.DatastoreOpenConfig.md) | - -#### Returns - -`Promise`<[`IDatastore`](verida_verifiable_credentials._internal_.IDatastore.md)\> - -#### Defined in - -packages/types/dist/IContext.d.ts:28 - -___ - -### openProfile - -▸ **openProfile**(`profileName?`, `did?`): `Promise`<`undefined` \| [`IProfile`](verida_verifiable_credentials._internal_.IProfile.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `profileName?` | `string` | -| `did?` | `string` | - -#### Returns - -`Promise`<`undefined` \| [`IProfile`](verida_verifiable_credentials._internal_.IProfile.md)\> - -#### Defined in - -packages/types/dist/IContext.d.ts:24 diff --git a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.IDIDContextManager.md b/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.IDIDContextManager.md deleted file mode 100644 index 03db8ae..0000000 --- a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.IDIDContextManager.md +++ /dev/null @@ -1,145 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / IDIDContextManager - -# Interface: IDIDContextManager - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md).IDIDContextManager - -## Table of contents - -### Methods - -- [getContextDatabaseServer](verida_verifiable_credentials._internal_.IDIDContextManager.md#getcontextdatabaseserver) -- [getContextMessageServer](verida_verifiable_credentials._internal_.IDIDContextManager.md#getcontextmessageserver) -- [getContextStorageServer](verida_verifiable_credentials._internal_.IDIDContextManager.md#getcontextstorageserver) -- [getDIDContextConfig](verida_verifiable_credentials._internal_.IDIDContextManager.md#getdidcontextconfig) -- [getDIDContextHashConfig](verida_verifiable_credentials._internal_.IDIDContextManager.md#getdidcontexthashconfig) -- [setAccount](verida_verifiable_credentials._internal_.IDIDContextManager.md#setaccount) - -## Methods - -### getContextDatabaseServer - -▸ **getContextDatabaseServer**(`did`, `contextName`, `forceCreate`): `Promise`<[`SecureContextEndpoint`](verida_verifiable_credentials._internal_.SecureContextEndpoint.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did` | `string` | -| `contextName` | `string` | -| `forceCreate` | `boolean` | - -#### Returns - -`Promise`<[`SecureContextEndpoint`](verida_verifiable_credentials._internal_.SecureContextEndpoint.md)\> - -#### Defined in - -packages/types/dist/IDIDContextManager.d.ts:6 - -___ - -### getContextMessageServer - -▸ **getContextMessageServer**(`did`, `contextName`, `forceCreate`): `Promise`<[`SecureContextEndpoint`](verida_verifiable_credentials._internal_.SecureContextEndpoint.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did` | `string` | -| `contextName` | `string` | -| `forceCreate` | `boolean` | - -#### Returns - -`Promise`<[`SecureContextEndpoint`](verida_verifiable_credentials._internal_.SecureContextEndpoint.md)\> - -#### Defined in - -packages/types/dist/IDIDContextManager.d.ts:8 - -___ - -### getContextStorageServer - -▸ **getContextStorageServer**(`did`, `contextName`, `forceCreate`): `Promise`<[`SecureContextEndpoint`](verida_verifiable_credentials._internal_.SecureContextEndpoint.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did` | `string` | -| `contextName` | `string` | -| `forceCreate` | `boolean` | - -#### Returns - -`Promise`<[`SecureContextEndpoint`](verida_verifiable_credentials._internal_.SecureContextEndpoint.md)\> - -#### Defined in - -packages/types/dist/IDIDContextManager.d.ts:7 - -___ - -### getDIDContextConfig - -▸ **getDIDContextConfig**(`did`, `contextName`, `forceCreate?`): `Promise`<[`SecureContextConfig`](verida_verifiable_credentials._internal_.SecureContextConfig.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did` | `string` | -| `contextName` | `string` | -| `forceCreate?` | `boolean` | - -#### Returns - -`Promise`<[`SecureContextConfig`](verida_verifiable_credentials._internal_.SecureContextConfig.md)\> - -#### Defined in - -packages/types/dist/IDIDContextManager.d.ts:10 - -___ - -### getDIDContextHashConfig - -▸ **getDIDContextHashConfig**(`did`, `contextHash`): `Promise`<[`SecureContextConfig`](verida_verifiable_credentials._internal_.SecureContextConfig.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did` | `string` | -| `contextHash` | `string` | - -#### Returns - -`Promise`<[`SecureContextConfig`](verida_verifiable_credentials._internal_.SecureContextConfig.md)\> - -#### Defined in - -packages/types/dist/IDIDContextManager.d.ts:9 - -___ - -### setAccount - -▸ **setAccount**(`account`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `account` | [`IAccount`](verida_verifiable_credentials._internal_.IAccount.md) | - -#### Returns - -`void` - -#### Defined in - -packages/types/dist/IDIDContextManager.d.ts:5 diff --git a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.IDatabase.md b/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.IDatabase.md deleted file mode 100644 index 1149bfd..0000000 --- a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.IDatabase.md +++ /dev/null @@ -1,261 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / IDatabase - -# Interface: IDatabase - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md).IDatabase - -Interface for any database returned from a storage engine - -## Table of contents - -### Methods - -- [changes](verida_verifiable_credentials._internal_.IDatabase.md#changes) -- [close](verida_verifiable_credentials._internal_.IDatabase.md#close) -- [delete](verida_verifiable_credentials._internal_.IDatabase.md#delete) -- [deleteAll](verida_verifiable_credentials._internal_.IDatabase.md#deleteall) -- [destroy](verida_verifiable_credentials._internal_.IDatabase.md#destroy) -- [get](verida_verifiable_credentials._internal_.IDatabase.md#get) -- [getDb](verida_verifiable_credentials._internal_.IDatabase.md#getdb) -- [getMany](verida_verifiable_credentials._internal_.IDatabase.md#getmany) -- [info](verida_verifiable_credentials._internal_.IDatabase.md#info) -- [registryEntry](verida_verifiable_credentials._internal_.IDatabase.md#registryentry) -- [save](verida_verifiable_credentials._internal_.IDatabase.md#save) -- [updateUsers](verida_verifiable_credentials._internal_.IDatabase.md#updateusers) -- [usage](verida_verifiable_credentials._internal_.IDatabase.md#usage) - -## Methods - -### changes - -▸ **changes**(`cb`, `options?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `cb` | `Function` | -| `options?` | `any` | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -packages/types/dist/IDatabase.d.ts:11 - -___ - -### close - -▸ **close**(`options?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options?` | [`DatabaseCloseOptions`](verida_verifiable_credentials._internal_.DatabaseCloseOptions.md) | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -packages/types/dist/IDatabase.d.ts:16 - -___ - -### delete - -▸ **delete**(`doc`, `options?`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `doc` | `any` | -| `options?` | `any` | - -#### Returns - -`Promise`<`boolean`\> - -#### Defined in - -packages/types/dist/IDatabase.d.ts:9 - -___ - -### deleteAll - -▸ **deleteAll**(): `Promise`<`void`\> - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -packages/types/dist/IDatabase.d.ts:10 - -___ - -### destroy - -▸ **destroy**(`options?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options?` | [`DatabaseDeleteConfig`](verida_verifiable_credentials._internal_.DatabaseDeleteConfig.md) | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -packages/types/dist/IDatabase.d.ts:17 - -___ - -### get - -▸ **get**(`docId`, `options?`): `Promise`<`undefined` \| `object`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `docId` | `any` | -| `options?` | `any` | - -#### Returns - -`Promise`<`undefined` \| `object`\> - -#### Defined in - -packages/types/dist/IDatabase.d.ts:8 - -___ - -### getDb - -▸ **getDb**(): `Promise`<`any`\> - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -packages/types/dist/IDatabase.d.ts:13 - -___ - -### getMany - -▸ **getMany**(`filter?`, `options?`): `Promise`<`object`[]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `filter?` | `any` | -| `options?` | `any` | - -#### Returns - -`Promise`<`object`[]\> - -#### Defined in - -packages/types/dist/IDatabase.d.ts:7 - -___ - -### info - -▸ **info**(): `Promise`<`any`\> - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -packages/types/dist/IDatabase.d.ts:14 - -___ - -### registryEntry - -▸ **registryEntry**(): `Promise`<[`DbRegistryEntry`](verida_verifiable_credentials._internal_.DbRegistryEntry.md)\> - -#### Returns - -`Promise`<[`DbRegistryEntry`](verida_verifiable_credentials._internal_.DbRegistryEntry.md)\> - -#### Defined in - -packages/types/dist/IDatabase.d.ts:15 - -___ - -### save - -▸ **save**(`data`, `options?`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `any` | -| `options?` | `any` | - -#### Returns - -`Promise`<`boolean`\> - -#### Defined in - -packages/types/dist/IDatabase.d.ts:6 - -___ - -### updateUsers - -▸ **updateUsers**(`readList`, `writeList`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `readList` | `string`[] | -| `writeList` | `string`[] | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -packages/types/dist/IDatabase.d.ts:12 - -___ - -### usage - -▸ **usage**(): `Promise`<[`EndpointUsage`](verida_verifiable_credentials._internal_.EndpointUsage.md)\> - -#### Returns - -`Promise`<[`EndpointUsage`](verida_verifiable_credentials._internal_.EndpointUsage.md)\> - -#### Defined in - -packages/types/dist/IDatabase.d.ts:18 diff --git a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.IDatastore.md b/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.IDatastore.md deleted file mode 100644 index 0eac9ca..0000000 --- a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.IDatastore.md +++ /dev/null @@ -1,249 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / IDatastore - -# Interface: IDatastore - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md).IDatastore - -## Table of contents - -### Properties - -- [errors](verida_verifiable_credentials._internal_.IDatastore.md#errors) - -### Methods - -- [changes](verida_verifiable_credentials._internal_.IDatastore.md#changes) -- [close](verida_verifiable_credentials._internal_.IDatastore.md#close) -- [delete](verida_verifiable_credentials._internal_.IDatastore.md#delete) -- [deleteAll](verida_verifiable_credentials._internal_.IDatastore.md#deleteall) -- [ensureIndexes](verida_verifiable_credentials._internal_.IDatastore.md#ensureindexes) -- [get](verida_verifiable_credentials._internal_.IDatastore.md#get) -- [getDb](verida_verifiable_credentials._internal_.IDatastore.md#getdb) -- [getMany](verida_verifiable_credentials._internal_.IDatastore.md#getmany) -- [getOne](verida_verifiable_credentials._internal_.IDatastore.md#getone) -- [save](verida_verifiable_credentials._internal_.IDatastore.md#save) -- [updateUsers](verida_verifiable_credentials._internal_.IDatastore.md#updateusers) - -## Properties - -### errors - -• **errors**: `any` - -#### Defined in - -packages/types/dist/IDatastore.d.ts:4 - -## Methods - -### changes - -▸ **changes**(`cb`, `options`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `cb` | `any` | -| `options` | `any` | - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -packages/types/dist/IDatastore.d.ts:12 - -___ - -### close - -▸ **close**(`options?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options?` | [`DatabaseCloseOptions`](verida_verifiable_credentials._internal_.DatabaseCloseOptions.md) | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -packages/types/dist/IDatastore.d.ts:15 - -___ - -### delete - -▸ **delete**(`docId`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `docId` | `string` | - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -packages/types/dist/IDatastore.d.ts:9 - -___ - -### deleteAll - -▸ **deleteAll**(): `Promise`<`void`\> - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -packages/types/dist/IDatastore.d.ts:10 - -___ - -### ensureIndexes - -▸ **ensureIndexes**(`indexes`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `indexes` | `any` | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -packages/types/dist/IDatastore.d.ts:13 - -___ - -### get - -▸ **get**(`key`, `options`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `key` | `string` | -| `options` | `any` | - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -packages/types/dist/IDatastore.d.ts:8 - -___ - -### getDb - -▸ **getDb**(): `Promise`<[`IDatabase`](verida_verifiable_credentials._internal_.IDatabase.md)\> - -#### Returns - -`Promise`<[`IDatabase`](verida_verifiable_credentials._internal_.IDatabase.md)\> - -#### Defined in - -packages/types/dist/IDatastore.d.ts:11 - -___ - -### getMany - -▸ **getMany**(`customFilter?`, `options?`): `Promise`<`object`[]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `customFilter?` | `any` | -| `options?` | `any` | - -#### Returns - -`Promise`<`object`[]\> - -#### Defined in - -packages/types/dist/IDatastore.d.ts:6 - -___ - -### getOne - -▸ **getOne**(`customFilter?`, `options?`): `Promise`<`undefined` \| `object`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `customFilter?` | `any` | -| `options?` | `any` | - -#### Returns - -`Promise`<`undefined` \| `object`\> - -#### Defined in - -packages/types/dist/IDatastore.d.ts:7 - -___ - -### save - -▸ **save**(`data`, `options`): `Promise`<`boolean` \| `object`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `any` | -| `options` | `any` | - -#### Returns - -`Promise`<`boolean` \| `object`\> - -#### Defined in - -packages/types/dist/IDatastore.d.ts:5 - -___ - -### updateUsers - -▸ **updateUsers**(`readList`, `writeList`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `readList` | `string`[] | -| `writeList` | `string`[] | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -packages/types/dist/IDatastore.d.ts:14 diff --git a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.IDbRegistry.md b/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.IDbRegistry.md deleted file mode 100644 index 40d5065..0000000 --- a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.IDbRegistry.md +++ /dev/null @@ -1,115 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / IDbRegistry - -# Interface: IDbRegistry - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md).IDbRegistry - -## Table of contents - -### Methods - -- [get](verida_verifiable_credentials._internal_.IDbRegistry.md#get) -- [getMany](verida_verifiable_credentials._internal_.IDbRegistry.md#getmany) -- [init](verida_verifiable_credentials._internal_.IDbRegistry.md#init) -- [removeDb](verida_verifiable_credentials._internal_.IDbRegistry.md#removedb) -- [saveDb](verida_verifiable_credentials._internal_.IDbRegistry.md#savedb) - -## Methods - -### get - -▸ **get**(`dbName`, `did`, `contextName`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `dbName` | `string` | -| `did` | `string` | -| `contextName` | `string` | - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -packages/types/dist/IDbRegistry.d.ts:6 - -___ - -### getMany - -▸ **getMany**(`filter`, `options`): `Promise`<`any`[]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `filter` | `any` | -| `options` | `any` | - -#### Returns - -`Promise`<`any`[]\> - -#### Defined in - -packages/types/dist/IDbRegistry.d.ts:5 - -___ - -### init - -▸ **init**(): `Promise`<`void`\> - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -packages/types/dist/IDbRegistry.d.ts:7 - -___ - -### removeDb - -▸ **removeDb**(`databaseName`, `did`, `contextName`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `databaseName` | `string` | -| `did` | `string` | -| `contextName` | `string` | - -#### Returns - -`Promise`<`boolean`\> - -#### Defined in - -packages/types/dist/IDbRegistry.d.ts:4 - -___ - -### saveDb - -▸ **saveDb**(`database`, `checkPermissions`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `database` | [`IDatabase`](verida_verifiable_credentials._internal_.IDatabase.md) | -| `checkPermissions` | `boolean` | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -packages/types/dist/IDbRegistry.d.ts:3 diff --git a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.IKeyring.md b/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.IKeyring.md deleted file mode 100644 index a46acb8..0000000 --- a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.IKeyring.md +++ /dev/null @@ -1,262 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / IKeyring - -# Interface: IKeyring - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md).IKeyring - -## Table of contents - -### Methods - -- [\_init](verida_verifiable_credentials._internal_.IKeyring.md#_init) -- [asymDecrypt](verida_verifiable_credentials._internal_.IKeyring.md#asymdecrypt) -- [asymEncrypt](verida_verifiable_credentials._internal_.IKeyring.md#asymencrypt) -- [buildSharedKeyEnd](verida_verifiable_credentials._internal_.IKeyring.md#buildsharedkeyend) -- [buildSharedKeyStart](verida_verifiable_credentials._internal_.IKeyring.md#buildsharedkeystart) -- [getKeys](verida_verifiable_credentials._internal_.IKeyring.md#getkeys) -- [getSeed](verida_verifiable_credentials._internal_.IKeyring.md#getseed) -- [getStorageContextKey](verida_verifiable_credentials._internal_.IKeyring.md#getstoragecontextkey) -- [publicKeys](verida_verifiable_credentials._internal_.IKeyring.md#publickeys) -- [sign](verida_verifiable_credentials._internal_.IKeyring.md#sign) -- [symDecrypt](verida_verifiable_credentials._internal_.IKeyring.md#symdecrypt) -- [symEncrypt](verida_verifiable_credentials._internal_.IKeyring.md#symencrypt) -- [verifySig](verida_verifiable_credentials._internal_.IKeyring.md#verifysig) - -## Methods - -### \_init - -▸ **_init**(): `Promise`<`void`\> - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:3 - -___ - -### asymDecrypt - -▸ **asymDecrypt**(`messageWithNonce`, `secretOrSharedKey`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `messageWithNonce` | `string` | -| `secretOrSharedKey` | `Uint8Array` | - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:10 - -___ - -### asymEncrypt - -▸ **asymEncrypt**(`data`, `secretOrSharedKey`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `string` | -| `secretOrSharedKey` | `Uint8Array` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:9 - -___ - -### buildSharedKeyEnd - -▸ **buildSharedKeyEnd**(`publicKey`): `Promise`<`Uint8Array`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `publicKey` | `Uint8Array` | - -#### Returns - -`Promise`<`Uint8Array`\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:12 - -___ - -### buildSharedKeyStart - -▸ **buildSharedKeyStart**(`privateKey`): `Promise`<`Uint8Array`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `privateKey` | `Uint8Array` | - -#### Returns - -`Promise`<`Uint8Array`\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:11 - -___ - -### getKeys - -▸ **getKeys**(): `Promise`<`any`\> - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:2 - -___ - -### getSeed - -▸ **getSeed**(): `string` - -#### Returns - -`string` - -#### Defined in - -packages/types/dist/IKeyring.d.ts:13 - -___ - -### getStorageContextKey - -▸ **getStorageContextKey**(`databaseName`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `databaseName` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:14 - -___ - -### publicKeys - -▸ **publicKeys**(): `Promise`<[`KeyringPublicKeys`](verida_verifiable_credentials._internal_.KeyringPublicKeys.md)\> - -#### Returns - -`Promise`<[`KeyringPublicKeys`](verida_verifiable_credentials._internal_.KeyringPublicKeys.md)\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:4 - -___ - -### sign - -▸ **sign**(`data`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `any` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:5 - -___ - -### symDecrypt - -▸ **symDecrypt**(`data`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `string` | - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:8 - -___ - -### symEncrypt - -▸ **symEncrypt**(`data`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:7 - -___ - -### verifySig - -▸ **verifySig**(`data`, `sig`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `string` | -| `sig` | `string` | - -#### Returns - -`Promise`<`boolean`\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:6 diff --git a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.IMessaging.md b/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.IMessaging.md deleted file mode 100644 index d9bdcd5..0000000 --- a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.IMessaging.md +++ /dev/null @@ -1,180 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / IMessaging - -# Interface: IMessaging - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md).IMessaging - -Interface Messaging - -## Table of contents - -### Methods - -- [connectAccount](verida_verifiable_credentials._internal_.IMessaging.md#connectaccount) -- [getInbox](verida_verifiable_credentials._internal_.IMessaging.md#getinbox) -- [getMessages](verida_verifiable_credentials._internal_.IMessaging.md#getmessages) -- [init](verida_verifiable_credentials._internal_.IMessaging.md#init) -- [offMessage](verida_verifiable_credentials._internal_.IMessaging.md#offmessage) -- [onMessage](verida_verifiable_credentials._internal_.IMessaging.md#onmessage) -- [send](verida_verifiable_credentials._internal_.IMessaging.md#send) - -## Methods - -### connectAccount - -▸ **connectAccount**(`account`): `Promise`<`void`\> - -Connect an account to this messaging instance. - -Used internally. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `account` | [`IAccount`](verida_verifiable_credentials._internal_.IAccount.md) | Account | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -packages/types/dist/IMessaging.d.ts:62 - -___ - -### getInbox - -▸ **getInbox**(): `Promise`<`any`\> - -Get the underlying inbox instance specific for the message storage type. - -#### Returns - -`Promise`<`any`\> - -any Currently returns a `Datastore` instance. - -#### Defined in - -packages/types/dist/IMessaging.d.ts:54 - -___ - -### getMessages - -▸ **getMessages**(`filter?`, `options?`): `Promise`<`any`\> - -Get messages from this inbox. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `filter?` | `object` | object An optional datastore filter | -| `options?` | `any` | object An optional list of datastore options | - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -packages/types/dist/IMessaging.d.ts:48 - -___ - -### init - -▸ **init**(): `Promise`<`void`\> - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -packages/types/dist/IMessaging.d.ts:9 - -___ - -### offMessage - -▸ **offMessage**(`callback`): `Promise`<`void`\> - -Unregister a callback to fire when a new message is received - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `callback` | `any` | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -packages/types/dist/IMessaging.d.ts:41 - -___ - -### onMessage - -▸ **onMessage**(`callback`): `Promise`<[`EventEmitter`](../classes/verida_verifiable_credentials._internal_.EventEmitter-1.md)\> - -Register a callback to fire when a new message is received from another DID or application. - -Usage: - -``` -// configure the listener -const callback = (msg) => { console.log(msg) } -const emitter = messaging.onMessage(callback) -``` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `callback` | `any` | - -#### Returns - -`Promise`<[`EventEmitter`](../classes/verida_verifiable_credentials._internal_.EventEmitter-1.md)\> - -Returns an event emitter - -#### Defined in - -packages/types/dist/IMessaging.d.ts:35 - -___ - -### send - -▸ **send**(`did`, `type`, `data`, `message`, `config`): `Promise`<``null`` \| `object`\> - -Send a message to another DID on the network. - -**`todo:`** Link to documentation - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `did` | `string` | string DID to receive the message | -| `type` | `string` | string Type of inbox message (See https://github.com/verida/schemas/tree/master/schemas/inbox/type). ie: `dataSend` | -| `data` | `object` | object Data to send. Structure of data will depend on the inbox message type. | -| `message` | `string` | string A human readable message that will be displayed to the user upon receipt of the message. Similar to an email subject. | -| `config` | [`MessageSendConfig`](verida_verifiable_credentials._internal_.MessageSendConfig.md) | object Optional configuration. | - -#### Returns - -`Promise`<``null`` \| `object`\> - -#### Defined in - -packages/types/dist/IMessaging.d.ts:21 diff --git a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.INotification.md b/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.INotification.md deleted file mode 100644 index 3aa963d..0000000 --- a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.INotification.md +++ /dev/null @@ -1,71 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / INotification - -# Interface: INotification - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md).INotification - -Interface for notifications - -## Table of contents - -### Methods - -- [getErrors](verida_verifiable_credentials._internal_.INotification.md#geterrors) -- [init](verida_verifiable_credentials._internal_.INotification.md#init) -- [ping](verida_verifiable_credentials._internal_.INotification.md#ping) - -## Methods - -### getErrors - -▸ **getErrors**(): `string`[] - -#### Returns - -`string`[] - -#### Defined in - -packages/types/dist/INotification.d.ts:16 - -___ - -### init - -▸ **init**(): `Promise`<`void`\> - -Initialize notifications for the connected user - -(ie; connect to a notification server) - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -packages/types/dist/INotification.d.ts:10 - -___ - -### ping - -▸ **ping**(`recipientContextName`, `didToNotify`): `Promise`<`boolean`\> - -Ping a notification server to fetch new messages -TODO: Change this - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `recipientContextName` | `string` | -| `didToNotify` | `any` | - -#### Returns - -`Promise`<`boolean`\> - -#### Defined in - -packages/types/dist/INotification.d.ts:15 diff --git a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.IProfile.md b/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.IProfile.md deleted file mode 100644 index 668d0a7..0000000 --- a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.IProfile.md +++ /dev/null @@ -1,140 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / IProfile - -# Interface: IProfile - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md).IProfile - -## Table of contents - -### Methods - -- [delete](verida_verifiable_credentials._internal_.IProfile.md#delete) -- [get](verida_verifiable_credentials._internal_.IProfile.md#get) -- [getMany](verida_verifiable_credentials._internal_.IProfile.md#getmany) -- [listen](verida_verifiable_credentials._internal_.IProfile.md#listen) -- [set](verida_verifiable_credentials._internal_.IProfile.md#set) -- [setMany](verida_verifiable_credentials._internal_.IProfile.md#setmany) - -## Methods - -### delete - -▸ **delete**(`key`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `key` | `string` | - -#### Returns - -`Promise`<`boolean`\> - -#### Defined in - -packages/types/dist/IProfile.d.ts:7 - -___ - -### get - -▸ **get**(`key`, `options?`, `extended?`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `key` | `string` | -| `options?` | `any` | -| `extended?` | `boolean` | - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -packages/types/dist/IProfile.d.ts:6 - -___ - -### getMany - -▸ **getMany**(`filter`, `options`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `filter` | `any` | -| `options` | `any` | - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -packages/types/dist/IProfile.d.ts:8 - -___ - -### listen - -▸ **listen**(`callback`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `callback` | `any` | - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -packages/types/dist/IProfile.d.ts:11 - -___ - -### set - -▸ **set**(`key`, `value`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `key` | `string` | -| `value` | `any` | - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -packages/types/dist/IProfile.d.ts:9 - -___ - -### setMany - -▸ **setMany**(`data`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `any` | - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -packages/types/dist/IProfile.d.ts:10 diff --git a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.ISchema.md b/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.ISchema.md deleted file mode 100644 index bfe9004..0000000 --- a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.ISchema.md +++ /dev/null @@ -1,90 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / ISchema - -# Interface: ISchema - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md).ISchema - -## Table of contents - -### Properties - -- [errors](verida_verifiable_credentials._internal_.ISchema.md#errors) - -### Methods - -- [getAppearance](verida_verifiable_credentials._internal_.ISchema.md#getappearance) -- [getSchemaJson](verida_verifiable_credentials._internal_.ISchema.md#getschemajson) -- [getSpecification](verida_verifiable_credentials._internal_.ISchema.md#getspecification) -- [validate](verida_verifiable_credentials._internal_.ISchema.md#validate) - -## Properties - -### errors - -• **errors**: `string`[] - -#### Defined in - -packages/types/dist/ISchema.d.ts:2 - -## Methods - -### getAppearance - -▸ **getAppearance**(): `Promise`<`any`\> - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -packages/types/dist/ISchema.d.ts:6 - -___ - -### getSchemaJson - -▸ **getSchemaJson**(): `Promise`<`object`\> - -#### Returns - -`Promise`<`object`\> - -#### Defined in - -packages/types/dist/ISchema.d.ts:5 - -___ - -### getSpecification - -▸ **getSpecification**(): `Promise`<`any`\> - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -packages/types/dist/ISchema.d.ts:3 - -___ - -### validate - -▸ **validate**(`data`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `any` | - -#### Returns - -`Promise`<`boolean`\> - -#### Defined in - -packages/types/dist/ISchema.d.ts:4 diff --git a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.IStorageEngine.md b/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.IStorageEngine.md deleted file mode 100644 index b7c920e..0000000 --- a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.IStorageEngine.md +++ /dev/null @@ -1,211 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / IStorageEngine - -# Interface: IStorageEngine - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md).IStorageEngine - -**`emits`** EndpointUnavailable - -## Table of contents - -### Methods - -- [addEndpoint](verida_verifiable_credentials._internal_.IStorageEngine.md#addendpoint) -- [connectAccount](verida_verifiable_credentials._internal_.IStorageEngine.md#connectaccount) -- [deleteDatabase](verida_verifiable_credentials._internal_.IStorageEngine.md#deletedatabase) -- [getAccount](verida_verifiable_credentials._internal_.IStorageEngine.md#getaccount) -- [getContextConfig](verida_verifiable_credentials._internal_.IStorageEngine.md#getcontextconfig) -- [getDbRegistry](verida_verifiable_credentials._internal_.IStorageEngine.md#getdbregistry) -- [getKeyring](verida_verifiable_credentials._internal_.IStorageEngine.md#getkeyring) -- [info](verida_verifiable_credentials._internal_.IStorageEngine.md#info) -- [logout](verida_verifiable_credentials._internal_.IStorageEngine.md#logout) -- [openDatabase](verida_verifiable_credentials._internal_.IStorageEngine.md#opendatabase) -- [openDatastore](verida_verifiable_credentials._internal_.IStorageEngine.md#opendatastore) - -## Methods - -### addEndpoint - -▸ **addEndpoint**(`context`, `uri`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `context` | [`IContext`](verida_verifiable_credentials._internal_.IContext.md) | -| `uri` | `string` | - -#### Returns - -`Promise`<`boolean`\> - -#### Defined in - -packages/types/dist/IStorageEngine.d.ts:22 - -___ - -### connectAccount - -▸ **connectAccount**(`account`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `account` | [`IAccount`](verida_verifiable_credentials._internal_.IAccount.md) | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -packages/types/dist/IStorageEngine.d.ts:16 - -___ - -### deleteDatabase - -▸ **deleteDatabase**(`databaseName`, `config?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `databaseName` | `string` | -| `config?` | [`DatabaseDeleteConfig`](verida_verifiable_credentials._internal_.DatabaseDeleteConfig.md) | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -packages/types/dist/IStorageEngine.d.ts:20 - -___ - -### getAccount - -▸ **getAccount**(): [`IAccount`](verida_verifiable_credentials._internal_.IAccount.md) - -#### Returns - -[`IAccount`](verida_verifiable_credentials._internal_.IAccount.md) - -#### Defined in - -packages/types/dist/IStorageEngine.d.ts:15 - -___ - -### getContextConfig - -▸ **getContextConfig**(): [`SecureContextConfig`](verida_verifiable_credentials._internal_.SecureContextConfig.md) - -#### Returns - -[`SecureContextConfig`](verida_verifiable_credentials._internal_.SecureContextConfig.md) - -#### Defined in - -packages/types/dist/IStorageEngine.d.ts:14 - -___ - -### getDbRegistry - -▸ **getDbRegistry**(): [`IDbRegistry`](verida_verifiable_credentials._internal_.IDbRegistry.md) - -#### Returns - -[`IDbRegistry`](verida_verifiable_credentials._internal_.IDbRegistry.md) - -#### Defined in - -packages/types/dist/IStorageEngine.d.ts:17 - -___ - -### getKeyring - -▸ **getKeyring**(): [`IKeyring`](verida_verifiable_credentials._internal_.IKeyring.md) - -#### Returns - -[`IKeyring`](verida_verifiable_credentials._internal_.IKeyring.md) - -#### Defined in - -packages/types/dist/IStorageEngine.d.ts:13 - -___ - -### info - -▸ **info**(): `Promise`<[`ContextDatabaseInfo`](verida_verifiable_credentials._internal_.ContextDatabaseInfo.md)\> - -#### Returns - -`Promise`<[`ContextDatabaseInfo`](verida_verifiable_credentials._internal_.ContextDatabaseInfo.md)\> - -#### Defined in - -packages/types/dist/IStorageEngine.d.ts:23 - -___ - -### logout - -▸ **logout**(): `void` - -#### Returns - -`void` - -#### Defined in - -packages/types/dist/IStorageEngine.d.ts:21 - -___ - -### openDatabase - -▸ **openDatabase**(`databaseName`, `config`): `Promise`<[`IDatabase`](verida_verifiable_credentials._internal_.IDatabase.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `databaseName` | `string` | -| `config` | [`DatabaseOpenConfig`](verida_verifiable_credentials._internal_.DatabaseOpenConfig.md) | - -#### Returns - -`Promise`<[`IDatabase`](verida_verifiable_credentials._internal_.IDatabase.md)\> - -#### Defined in - -packages/types/dist/IStorageEngine.d.ts:18 - -___ - -### openDatastore - -▸ **openDatastore**(`schemaName`, `config`): `Promise`<[`IDatastore`](verida_verifiable_credentials._internal_.IDatastore.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schemaName` | `string` | -| `config` | [`DatastoreOpenConfig`](verida_verifiable_credentials._internal_.DatastoreOpenConfig.md) | - -#### Returns - -`Promise`<[`IDatastore`](verida_verifiable_credentials._internal_.IDatastore.md)\> - -#### Defined in - -packages/types/dist/IStorageEngine.d.ts:19 diff --git a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.InstanceCodeOptions.md b/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.InstanceCodeOptions.md deleted file mode 100644 index 8d9ae19..0000000 --- a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.InstanceCodeOptions.md +++ /dev/null @@ -1,120 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / InstanceCodeOptions - -# Interface: InstanceCodeOptions - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md).InstanceCodeOptions - -## Hierarchy - -- [`CodeOptions`](verida_verifiable_credentials._internal_.CodeOptions.md) - - ↳ **`InstanceCodeOptions`** - -## Table of contents - -### Properties - -- [es5](verida_verifiable_credentials._internal_.InstanceCodeOptions.md#es5) -- [formats](verida_verifiable_credentials._internal_.InstanceCodeOptions.md#formats) -- [lines](verida_verifiable_credentials._internal_.InstanceCodeOptions.md#lines) -- [optimize](verida_verifiable_credentials._internal_.InstanceCodeOptions.md#optimize) -- [source](verida_verifiable_credentials._internal_.InstanceCodeOptions.md#source) - -### Methods - -- [process](verida_verifiable_credentials._internal_.InstanceCodeOptions.md#process) - -## Properties - -### es5 - -• `Optional` **es5**: `boolean` - -#### Inherited from - -[CodeOptions](verida_verifiable_credentials._internal_.CodeOptions.md).[es5](verida_verifiable_credentials._internal_.CodeOptions.md#es5) - -#### Defined in - -node_modules/ajv/dist/core.d.ts:73 - -___ - -### formats - -• `Optional` **formats**: [`Code`](../modules/verida_verifiable_credentials._internal_.md#code) - -#### Inherited from - -[CodeOptions](verida_verifiable_credentials._internal_.CodeOptions.md).[formats](verida_verifiable_credentials._internal_.CodeOptions.md#formats) - -#### Defined in - -node_modules/ajv/dist/core.d.ts:76 - -___ - -### lines - -• `Optional` **lines**: `boolean` - -#### Inherited from - -[CodeOptions](verida_verifiable_credentials._internal_.CodeOptions.md).[lines](verida_verifiable_credentials._internal_.CodeOptions.md#lines) - -#### Defined in - -node_modules/ajv/dist/core.d.ts:74 - -___ - -### optimize - -• **optimize**: `number` - -#### Overrides - -[CodeOptions](verida_verifiable_credentials._internal_.CodeOptions.md).[optimize](verida_verifiable_credentials._internal_.CodeOptions.md#optimize) - -#### Defined in - -node_modules/ajv/dist/core.d.ts:81 - -___ - -### source - -• `Optional` **source**: `boolean` - -#### Inherited from - -[CodeOptions](verida_verifiable_credentials._internal_.CodeOptions.md).[source](verida_verifiable_credentials._internal_.CodeOptions.md#source) - -#### Defined in - -node_modules/ajv/dist/core.d.ts:77 - -## Methods - -### process - -▸ `Optional` **process**(`code`, `schema?`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `code` | `string` | -| `schema?` | [`SchemaEnv`](../classes/verida_verifiable_credentials._internal_.SchemaEnv.md) | - -#### Returns - -`string` - -#### Inherited from - -[CodeOptions](verida_verifiable_credentials._internal_.CodeOptions.md).[process](verida_verifiable_credentials._internal_.CodeOptions.md#process) - -#### Defined in - -node_modules/ajv/dist/core.d.ts:78 diff --git a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.Issuer.md b/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.Issuer.md deleted file mode 100644 index 4a77ec7..0000000 --- a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.Issuer.md +++ /dev/null @@ -1,45 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / Issuer - -# Interface: Issuer - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md).Issuer - -Represents a tuple of a DID-URL with a `Signer` and associated algorithm. - -## Table of contents - -### Properties - -- [alg](verida_verifiable_credentials._internal_.Issuer.md#alg) -- [did](verida_verifiable_credentials._internal_.Issuer.md#did) -- [signer](verida_verifiable_credentials._internal_.Issuer.md#signer) - -## Properties - -### alg - -• `Optional` **alg**: `string` - -#### Defined in - -node_modules/did-jwt-vc/lib/types.d.ts:194 - -___ - -### did - -• **did**: `string` - -#### Defined in - -node_modules/did-jwt-vc/lib/types.d.ts:192 - -___ - -### signer - -• **signer**: [`Signer`](../modules/verida_verifiable_credentials._internal_.md#signer) - -#### Defined in - -node_modules/did-jwt-vc/lib/types.d.ts:193 diff --git a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.IteratorReturnResult.md b/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.IteratorReturnResult.md deleted file mode 100644 index 9423b4e..0000000 --- a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.IteratorReturnResult.md +++ /dev/null @@ -1,38 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / IteratorReturnResult - -# Interface: IteratorReturnResult - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md).IteratorReturnResult - -## Type parameters - -| Name | -| :------ | -| `TReturn` | - -## Table of contents - -### Properties - -- [done](verida_verifiable_credentials._internal_.IteratorReturnResult.md#done) -- [value](verida_verifiable_credentials._internal_.IteratorReturnResult.md#value) - -## Properties - -### done - -• **done**: ``true`` - -#### Defined in - -node_modules/typescript/lib/lib.es2015.iterable.d.ts:37 - -___ - -### value - -• **value**: `TReturn` - -#### Defined in - -node_modules/typescript/lib/lib.es2015.iterable.d.ts:38 diff --git a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.IteratorYieldResult.md b/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.IteratorYieldResult.md deleted file mode 100644 index 93bffde..0000000 --- a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.IteratorYieldResult.md +++ /dev/null @@ -1,38 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / IteratorYieldResult - -# Interface: IteratorYieldResult - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md).IteratorYieldResult - -## Type parameters - -| Name | -| :------ | -| `TYield` | - -## Table of contents - -### Properties - -- [done](verida_verifiable_credentials._internal_.IteratorYieldResult.md#done) -- [value](verida_verifiable_credentials._internal_.IteratorYieldResult.md#value) - -## Properties - -### done - -• `Optional` **done**: ``false`` - -#### Defined in - -node_modules/typescript/lib/lib.es2015.iterable.d.ts:32 - -___ - -### value - -• **value**: `TYield` - -#### Defined in - -node_modules/typescript/lib/lib.es2015.iterable.d.ts:33 diff --git a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.JsonWebKey.md b/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.JsonWebKey.md deleted file mode 100644 index f69087c..0000000 --- a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.JsonWebKey.md +++ /dev/null @@ -1,137 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / JsonWebKey - -# Interface: JsonWebKey - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md).JsonWebKey - -## Hierarchy - -- [`Extensible`](../modules/verida_verifiable_credentials._internal_.md#extensible) - - ↳ **`JsonWebKey`** - -## Table of contents - -### Properties - -- [alg](verida_verifiable_credentials._internal_.JsonWebKey.md#alg) -- [crv](verida_verifiable_credentials._internal_.JsonWebKey.md#crv) -- [e](verida_verifiable_credentials._internal_.JsonWebKey.md#e) -- [ext](verida_verifiable_credentials._internal_.JsonWebKey.md#ext) -- [key\_ops](verida_verifiable_credentials._internal_.JsonWebKey.md#key_ops) -- [kid](verida_verifiable_credentials._internal_.JsonWebKey.md#kid) -- [kty](verida_verifiable_credentials._internal_.JsonWebKey.md#kty) -- [n](verida_verifiable_credentials._internal_.JsonWebKey.md#n) -- [use](verida_verifiable_credentials._internal_.JsonWebKey.md#use) -- [x](verida_verifiable_credentials._internal_.JsonWebKey.md#x) -- [y](verida_verifiable_credentials._internal_.JsonWebKey.md#y) - -## Properties - -### alg - -• `Optional` **alg**: `string` - -#### Defined in - -packages/did-document/node_modules/did-resolver/lib/resolver.d.ts:46 - -___ - -### crv - -• `Optional` **crv**: `string` - -#### Defined in - -packages/did-document/node_modules/did-resolver/lib/resolver.d.ts:47 - -___ - -### e - -• `Optional` **e**: `string` - -#### Defined in - -packages/did-document/node_modules/did-resolver/lib/resolver.d.ts:48 - -___ - -### ext - -• `Optional` **ext**: `boolean` - -#### Defined in - -packages/did-document/node_modules/did-resolver/lib/resolver.d.ts:49 - -___ - -### key\_ops - -• `Optional` **key\_ops**: `string`[] - -#### Defined in - -packages/did-document/node_modules/did-resolver/lib/resolver.d.ts:50 - -___ - -### kid - -• `Optional` **kid**: `string` - -#### Defined in - -packages/did-document/node_modules/did-resolver/lib/resolver.d.ts:51 - -___ - -### kty - -• **kty**: `string` - -#### Defined in - -packages/did-document/node_modules/did-resolver/lib/resolver.d.ts:52 - -___ - -### n - -• `Optional` **n**: `string` - -#### Defined in - -packages/did-document/node_modules/did-resolver/lib/resolver.d.ts:53 - -___ - -### use - -• `Optional` **use**: `string` - -#### Defined in - -packages/did-document/node_modules/did-resolver/lib/resolver.d.ts:54 - -___ - -### x - -• `Optional` **x**: `string` - -#### Defined in - -packages/did-document/node_modules/did-resolver/lib/resolver.d.ts:55 - -___ - -### y - -• `Optional` **y**: `string` - -#### Defined in - -packages/did-document/node_modules/did-resolver/lib/resolver.d.ts:56 diff --git a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.KeyringPublicKeys.md b/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.KeyringPublicKeys.md deleted file mode 100644 index 7a33289..0000000 --- a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.KeyringPublicKeys.md +++ /dev/null @@ -1,76 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / KeyringPublicKeys - -# Interface: KeyringPublicKeys - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md).KeyringPublicKeys - -## Table of contents - -### Properties - -- [asymPublicKey](verida_verifiable_credentials._internal_.KeyringPublicKeys.md#asympublickey) -- [asymPublicKeyBase58](verida_verifiable_credentials._internal_.KeyringPublicKeys.md#asympublickeybase58) -- [asymPublicKeyHex](verida_verifiable_credentials._internal_.KeyringPublicKeys.md#asympublickeyhex) -- [signPublicKey](verida_verifiable_credentials._internal_.KeyringPublicKeys.md#signpublickey) -- [signPublicKeyBase58](verida_verifiable_credentials._internal_.KeyringPublicKeys.md#signpublickeybase58) -- [signPublicKeyHex](verida_verifiable_credentials._internal_.KeyringPublicKeys.md#signpublickeyhex) - -## Properties - -### asymPublicKey - -• **asymPublicKey**: `Uint8Array` - -#### Defined in - -packages/types/dist/IKeyring.d.ts:17 - -___ - -### asymPublicKeyBase58 - -• **asymPublicKeyBase58**: `string` - -#### Defined in - -packages/types/dist/IKeyring.d.ts:19 - -___ - -### asymPublicKeyHex - -• **asymPublicKeyHex**: `string` - -#### Defined in - -packages/types/dist/IKeyring.d.ts:18 - -___ - -### signPublicKey - -• **signPublicKey**: `Uint8Array` - -#### Defined in - -packages/types/dist/IKeyring.d.ts:20 - -___ - -### signPublicKeyBase58 - -• **signPublicKeyBase58**: `string` - -#### Defined in - -packages/types/dist/IKeyring.d.ts:22 - -___ - -### signPublicKeyHex - -• **signPublicKeyHex**: `string` - -#### Defined in - -packages/types/dist/IKeyring.d.ts:21 diff --git a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.KeywordErrorCxt.md b/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.KeywordErrorCxt.md deleted file mode 100644 index 2cfa099..0000000 --- a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.KeywordErrorCxt.md +++ /dev/null @@ -1,146 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / KeywordErrorCxt - -# Interface: KeywordErrorCxt - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md).KeywordErrorCxt - -## Implemented by - -- [`KeywordCxt`](../classes/verida_verifiable_credentials._internal_.KeywordCxt.md) - -## Table of contents - -### Properties - -- [$data](verida_verifiable_credentials._internal_.KeywordErrorCxt.md#$data) -- [data](verida_verifiable_credentials._internal_.KeywordErrorCxt.md#data) -- [errsCount](verida_verifiable_credentials._internal_.KeywordErrorCxt.md#errscount) -- [gen](verida_verifiable_credentials._internal_.KeywordErrorCxt.md#gen) -- [it](verida_verifiable_credentials._internal_.KeywordErrorCxt.md#it) -- [keyword](verida_verifiable_credentials._internal_.KeywordErrorCxt.md#keyword) -- [params](verida_verifiable_credentials._internal_.KeywordErrorCxt.md#params) -- [parentSchema](verida_verifiable_credentials._internal_.KeywordErrorCxt.md#parentschema) -- [schema](verida_verifiable_credentials._internal_.KeywordErrorCxt.md#schema) -- [schemaCode](verida_verifiable_credentials._internal_.KeywordErrorCxt.md#schemacode) -- [schemaType](verida_verifiable_credentials._internal_.KeywordErrorCxt.md#schematype) -- [schemaValue](verida_verifiable_credentials._internal_.KeywordErrorCxt.md#schemavalue) - -## Properties - -### $data - -• `Optional` **$data**: `string` \| ``false`` - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:140 - -___ - -### data - -• **data**: [`Name`](../classes/verida_verifiable_credentials._internal_.Name.md) - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:139 - -___ - -### errsCount - -• `Optional` **errsCount**: [`Name`](../classes/verida_verifiable_credentials._internal_.Name.md) - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:146 - -___ - -### gen - -• **gen**: [`CodeGen`](../classes/verida_verifiable_credentials._internal_.CodeGen.md) - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:137 - -___ - -### it - -• **it**: [`SchemaCxt`](verida_verifiable_credentials._internal_.SchemaCxt.md) - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:148 - -___ - -### keyword - -• **keyword**: `string` - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:138 - -___ - -### params - -• **params**: [`KeywordCxtParams`](../modules/verida_verifiable_credentials._internal_.md#keywordcxtparams) - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:147 - -___ - -### parentSchema - -• `Optional` **parentSchema**: [`AnySchemaObject`](../modules/verida_verifiable_credentials._internal_.md#anyschemaobject) - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:142 - -___ - -### schema - -• **schema**: `any` - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:141 - -___ - -### schemaCode - -• **schemaCode**: `number` \| `boolean` \| [`Code`](../modules/verida_verifiable_credentials._internal_.md#code) - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:143 - -___ - -### schemaType - -• `Optional` **schemaType**: (``"string"`` \| ``"number"`` \| ``"boolean"`` \| ``"object"`` \| ``"integer"`` \| ``"array"`` \| ``"null"``)[] - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:145 - -___ - -### schemaValue - -• **schemaValue**: `number` \| `boolean` \| [`Code`](../modules/verida_verifiable_credentials._internal_.md#code) - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:144 diff --git a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.KeywordErrorDefinition.md b/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.KeywordErrorDefinition.md deleted file mode 100644 index 7312842..0000000 --- a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.KeywordErrorDefinition.md +++ /dev/null @@ -1,32 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / KeywordErrorDefinition - -# Interface: KeywordErrorDefinition - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md).KeywordErrorDefinition - -## Table of contents - -### Properties - -- [message](verida_verifiable_credentials._internal_.KeywordErrorDefinition.md#message) -- [params](verida_verifiable_credentials._internal_.KeywordErrorDefinition.md#params) - -## Properties - -### message - -• **message**: `string` \| [`Code`](../modules/verida_verifiable_credentials._internal_.md#code) \| (`cxt`: [`KeywordErrorCxt`](verida_verifiable_credentials._internal_.KeywordErrorCxt.md)) => `string` \| [`Code`](../modules/verida_verifiable_credentials._internal_.md#code) - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:132 - -___ - -### params - -• `Optional` **params**: [`Code`](../modules/verida_verifiable_credentials._internal_.md#code) \| (`cxt`: [`KeywordErrorCxt`](verida_verifiable_credentials._internal_.KeywordErrorCxt.md)) => [`Code`](../modules/verida_verifiable_credentials._internal_.md#code) - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:133 diff --git a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.Logger.md b/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.Logger.md deleted file mode 100644 index 87e93f9..0000000 --- a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.Logger.md +++ /dev/null @@ -1,73 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / Logger - -# Interface: Logger - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md).Logger - -## Table of contents - -### Methods - -- [error](verida_verifiable_credentials._internal_.Logger.md#error) -- [log](verida_verifiable_credentials._internal_.Logger.md#log) -- [warn](verida_verifiable_credentials._internal_.Logger.md#warn) - -## Methods - -### error - -▸ **error**(...`args`): `unknown` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `...args` | `unknown`[] | - -#### Returns - -`unknown` - -#### Defined in - -node_modules/ajv/dist/core.d.ts:100 - -___ - -### log - -▸ **log**(...`args`): `unknown` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `...args` | `unknown`[] | - -#### Returns - -`unknown` - -#### Defined in - -node_modules/ajv/dist/core.d.ts:98 - -___ - -### warn - -▸ **warn**(...`args`): `unknown` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `...args` | `unknown`[] | - -#### Returns - -`unknown` - -#### Defined in - -node_modules/ajv/dist/core.d.ts:99 diff --git a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.MacroKeywordDefinition.md b/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.MacroKeywordDefinition.md deleted file mode 100644 index d72a27c..0000000 --- a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.MacroKeywordDefinition.md +++ /dev/null @@ -1,327 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / MacroKeywordDefinition - -# Interface: MacroKeywordDefinition - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md).MacroKeywordDefinition - -## Hierarchy - -- [`FuncKeywordDefinition`](verida_verifiable_credentials._internal_.FuncKeywordDefinition.md) - - ↳ **`MacroKeywordDefinition`** - -## Table of contents - -### Properties - -- [$data](verida_verifiable_credentials._internal_.MacroKeywordDefinition.md#$data) -- [$dataError](verida_verifiable_credentials._internal_.MacroKeywordDefinition.md#$dataerror) -- [allowUndefined](verida_verifiable_credentials._internal_.MacroKeywordDefinition.md#allowundefined) -- [async](verida_verifiable_credentials._internal_.MacroKeywordDefinition.md#async) -- [before](verida_verifiable_credentials._internal_.MacroKeywordDefinition.md#before) -- [compile](verida_verifiable_credentials._internal_.MacroKeywordDefinition.md#compile) -- [dependencies](verida_verifiable_credentials._internal_.MacroKeywordDefinition.md#dependencies) -- [error](verida_verifiable_credentials._internal_.MacroKeywordDefinition.md#error) -- [errors](verida_verifiable_credentials._internal_.MacroKeywordDefinition.md#errors) -- [implements](verida_verifiable_credentials._internal_.MacroKeywordDefinition.md#implements) -- [keyword](verida_verifiable_credentials._internal_.MacroKeywordDefinition.md#keyword) -- [macro](verida_verifiable_credentials._internal_.MacroKeywordDefinition.md#macro) -- [metaSchema](verida_verifiable_credentials._internal_.MacroKeywordDefinition.md#metaschema) -- [modifying](verida_verifiable_credentials._internal_.MacroKeywordDefinition.md#modifying) -- [post](verida_verifiable_credentials._internal_.MacroKeywordDefinition.md#post) -- [schema](verida_verifiable_credentials._internal_.MacroKeywordDefinition.md#schema) -- [schemaType](verida_verifiable_credentials._internal_.MacroKeywordDefinition.md#schematype) -- [type](verida_verifiable_credentials._internal_.MacroKeywordDefinition.md#type) -- [valid](verida_verifiable_credentials._internal_.MacroKeywordDefinition.md#valid) -- [validate](verida_verifiable_credentials._internal_.MacroKeywordDefinition.md#validate) -- [validateSchema](verida_verifiable_credentials._internal_.MacroKeywordDefinition.md#validateschema) - -## Properties - -### $data - -• `Optional` **$data**: `boolean` - -#### Inherited from - -[FuncKeywordDefinition](verida_verifiable_credentials._internal_.FuncKeywordDefinition.md).[$data](verida_verifiable_credentials._internal_.FuncKeywordDefinition.md#$data) - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:90 - -___ - -### $dataError - -• `Optional` **$dataError**: [`KeywordErrorDefinition`](verida_verifiable_credentials._internal_.KeywordErrorDefinition.md) - -#### Inherited from - -[FuncKeywordDefinition](verida_verifiable_credentials._internal_.FuncKeywordDefinition.md).[$dataError](verida_verifiable_credentials._internal_.FuncKeywordDefinition.md#$dataerror) - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:98 - -___ - -### allowUndefined - -• `Optional` **allowUndefined**: `boolean` - -#### Inherited from - -[FuncKeywordDefinition](verida_verifiable_credentials._internal_.FuncKeywordDefinition.md).[allowUndefined](verida_verifiable_credentials._internal_.FuncKeywordDefinition.md#allowundefined) - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:89 - -___ - -### async - -• `Optional` **async**: `boolean` - -#### Inherited from - -[FuncKeywordDefinition](verida_verifiable_credentials._internal_.FuncKeywordDefinition.md).[async](verida_verifiable_credentials._internal_.FuncKeywordDefinition.md#async) - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:119 - -___ - -### before - -• `Optional` **before**: `string` - -#### Inherited from - -[FuncKeywordDefinition](verida_verifiable_credentials._internal_.FuncKeywordDefinition.md).[before](verida_verifiable_credentials._internal_.FuncKeywordDefinition.md#before) - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:92 - -___ - -### compile - -• `Optional` **compile**: [`CompileKeywordFunc`](../modules/verida_verifiable_credentials._internal_.md#compilekeywordfunc) - -#### Inherited from - -[FuncKeywordDefinition](verida_verifiable_credentials._internal_.FuncKeywordDefinition.md).[compile](verida_verifiable_credentials._internal_.FuncKeywordDefinition.md#compile) - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:116 - -___ - -### dependencies - -• `Optional` **dependencies**: `string`[] - -#### Inherited from - -[FuncKeywordDefinition](verida_verifiable_credentials._internal_.FuncKeywordDefinition.md).[dependencies](verida_verifiable_credentials._internal_.FuncKeywordDefinition.md#dependencies) - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:96 - -___ - -### error - -• `Optional` **error**: [`KeywordErrorDefinition`](verida_verifiable_credentials._internal_.KeywordErrorDefinition.md) - -#### Inherited from - -[FuncKeywordDefinition](verida_verifiable_credentials._internal_.FuncKeywordDefinition.md).[error](verida_verifiable_credentials._internal_.FuncKeywordDefinition.md#error) - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:97 - -___ - -### errors - -• `Optional` **errors**: `boolean` \| ``"full"`` - -#### Inherited from - -[FuncKeywordDefinition](verida_verifiable_credentials._internal_.FuncKeywordDefinition.md).[errors](verida_verifiable_credentials._internal_.FuncKeywordDefinition.md#errors) - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:121 - -___ - -### implements - -• `Optional` **implements**: `string`[] - -#### Inherited from - -[FuncKeywordDefinition](verida_verifiable_credentials._internal_.FuncKeywordDefinition.md).[implements](verida_verifiable_credentials._internal_.FuncKeywordDefinition.md#implements) - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:91 - -___ - -### keyword - -• **keyword**: `string` \| `string`[] - -#### Inherited from - -[FuncKeywordDefinition](verida_verifiable_credentials._internal_.FuncKeywordDefinition.md).[keyword](verida_verifiable_credentials._internal_.FuncKeywordDefinition.md#keyword) - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:86 - -___ - -### macro - -• **macro**: [`MacroKeywordFunc`](../modules/verida_verifiable_credentials._internal_.md#macrokeywordfunc) - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:124 - -___ - -### metaSchema - -• `Optional` **metaSchema**: [`AnySchemaObject`](../modules/verida_verifiable_credentials._internal_.md#anyschemaobject) - -#### Inherited from - -[FuncKeywordDefinition](verida_verifiable_credentials._internal_.FuncKeywordDefinition.md).[metaSchema](verida_verifiable_credentials._internal_.FuncKeywordDefinition.md#metaschema) - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:94 - -___ - -### modifying - -• `Optional` **modifying**: `boolean` - -#### Inherited from - -[FuncKeywordDefinition](verida_verifiable_credentials._internal_.FuncKeywordDefinition.md).[modifying](verida_verifiable_credentials._internal_.FuncKeywordDefinition.md#modifying) - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:118 - -___ - -### post - -• `Optional` **post**: `boolean` - -#### Inherited from - -[FuncKeywordDefinition](verida_verifiable_credentials._internal_.FuncKeywordDefinition.md).[post](verida_verifiable_credentials._internal_.FuncKeywordDefinition.md#post) - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:93 - -___ - -### schema - -• `Optional` **schema**: `boolean` - -#### Inherited from - -[FuncKeywordDefinition](verida_verifiable_credentials._internal_.FuncKeywordDefinition.md).[schema](verida_verifiable_credentials._internal_.FuncKeywordDefinition.md#schema) - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:117 - -___ - -### schemaType - -• `Optional` **schemaType**: ``"string"`` \| ``"number"`` \| ``"boolean"`` \| ``"object"`` \| ``"integer"`` \| ``"array"`` \| ``"null"`` \| (``"string"`` \| ``"number"`` \| ``"boolean"`` \| ``"object"`` \| ``"integer"`` \| ``"array"`` \| ``"null"``)[] - -#### Inherited from - -[FuncKeywordDefinition](verida_verifiable_credentials._internal_.FuncKeywordDefinition.md).[schemaType](verida_verifiable_credentials._internal_.FuncKeywordDefinition.md#schematype) - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:88 - -___ - -### type - -• `Optional` **type**: ``"string"`` \| ``"number"`` \| ``"boolean"`` \| ``"object"`` \| ``"integer"`` \| ``"array"`` \| ``"null"`` \| (``"string"`` \| ``"number"`` \| ``"boolean"`` \| ``"object"`` \| ``"integer"`` \| ``"array"`` \| ``"null"``)[] - -#### Inherited from - -[FuncKeywordDefinition](verida_verifiable_credentials._internal_.FuncKeywordDefinition.md).[type](verida_verifiable_credentials._internal_.FuncKeywordDefinition.md#type) - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:87 - -___ - -### valid - -• `Optional` **valid**: `boolean` - -#### Inherited from - -[FuncKeywordDefinition](verida_verifiable_credentials._internal_.FuncKeywordDefinition.md).[valid](verida_verifiable_credentials._internal_.FuncKeywordDefinition.md#valid) - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:120 - -___ - -### validate - -• `Optional` **validate**: [`SchemaValidateFunction`](verida_verifiable_credentials._internal_.SchemaValidateFunction.md) \| [`DataValidateFunction`](verida_verifiable_credentials._internal_.DataValidateFunction.md) - -#### Inherited from - -[FuncKeywordDefinition](verida_verifiable_credentials._internal_.FuncKeywordDefinition.md).[validate](verida_verifiable_credentials._internal_.FuncKeywordDefinition.md#validate) - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:115 - -___ - -### validateSchema - -• `Optional` **validateSchema**: [`AnyValidateFunction`](../modules/verida_verifiable_credentials._internal_.md#anyvalidatefunction)<`any`\> - -#### Inherited from - -[FuncKeywordDefinition](verida_verifiable_credentials._internal_.FuncKeywordDefinition.md).[validateSchema](verida_verifiable_credentials._internal_.FuncKeywordDefinition.md#validateschema) - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:95 diff --git a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.MessageSendConfig.md b/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.MessageSendConfig.md deleted file mode 100644 index c9380f8..0000000 --- a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.MessageSendConfig.md +++ /dev/null @@ -1,56 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / MessageSendConfig - -# Interface: MessageSendConfig - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md).MessageSendConfig - -Interface for any MessageSendConfig - -## Table of contents - -### Properties - -- [did](verida_verifiable_credentials._internal_.MessageSendConfig.md#did) -- [expiry](verida_verifiable_credentials._internal_.MessageSendConfig.md#expiry) -- [openUrl](verida_verifiable_credentials._internal_.MessageSendConfig.md#openurl) -- [recipientContextName](verida_verifiable_credentials._internal_.MessageSendConfig.md#recipientcontextname) - -## Properties - -### did - -• **did**: `string` - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:124 - -___ - -### expiry - -• `Optional` **expiry**: [`Number`](../modules/verida_verifiable_credentials._internal_.md#number) - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:125 - -___ - -### openUrl - -• `Optional` **openUrl**: `string` - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:127 - -___ - -### recipientContextName - -• `Optional` **recipientContextName**: `string` - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:126 diff --git a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.MessagesConfig.md b/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.MessagesConfig.md deleted file mode 100644 index fba7342..0000000 --- a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.MessagesConfig.md +++ /dev/null @@ -1,23 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / MessagesConfig - -# Interface: MessagesConfig - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md).MessagesConfig - -Interface for any MessagesConfig - -## Table of contents - -### Properties - -- [maxItems](verida_verifiable_credentials._internal_.MessagesConfig.md#maxitems) - -## Properties - -### maxItems - -• `Optional` **maxItems**: [`Number`](../modules/verida_verifiable_credentials._internal_.md#number) - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:93 diff --git a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.NameValue.md b/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.NameValue.md deleted file mode 100644 index 96137ce..0000000 --- a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.NameValue.md +++ /dev/null @@ -1,43 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / NameValue - -# Interface: NameValue - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md).NameValue - -## Table of contents - -### Properties - -- [code](verida_verifiable_credentials._internal_.NameValue.md#code) -- [key](verida_verifiable_credentials._internal_.NameValue.md#key) -- [ref](verida_verifiable_credentials._internal_.NameValue.md#ref) - -## Properties - -### code - -• `Optional` **code**: [`Code`](../modules/verida_verifiable_credentials._internal_.md#code) - -#### Defined in - -node_modules/ajv/dist/compile/codegen/scope.d.ts:9 - -___ - -### key - -• `Optional` **key**: `unknown` - -#### Defined in - -node_modules/ajv/dist/compile/codegen/scope.d.ts:8 - -___ - -### ref - -• **ref**: `unknown` - -#### Defined in - -node_modules/ajv/dist/compile/codegen/scope.d.ts:7 diff --git a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.NodeEventTarget.md b/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.NodeEventTarget.md deleted file mode 100644 index 851f93b..0000000 --- a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.NodeEventTarget.md +++ /dev/null @@ -1,32 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / NodeEventTarget - -# Interface: NodeEventTarget - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md).NodeEventTarget - -## Table of contents - -### Methods - -- [once](verida_verifiable_credentials._internal_.NodeEventTarget.md#once) - -## Methods - -### once - -▸ **once**(`eventName`, `listener`): [`NodeEventTarget`](verida_verifiable_credentials._internal_.NodeEventTarget.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | `string` \| `symbol` | -| `listener` | (...`args`: `any`[]) => `void` | - -#### Returns - -[`NodeEventTarget`](verida_verifiable_credentials._internal_.NodeEventTarget.md) - -#### Defined in - -node_modules/@types/node/events.d.ts:45 diff --git a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.Number.md b/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.Number.md deleted file mode 100644 index b3fbb87..0000000 --- a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.Number.md +++ /dev/null @@ -1,143 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / Number - -# Interface: Number - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md).Number - -## Table of contents - -### Methods - -- [toExponential](verida_verifiable_credentials._internal_.Number.md#toexponential) -- [toFixed](verida_verifiable_credentials._internal_.Number.md#tofixed) -- [toLocaleString](verida_verifiable_credentials._internal_.Number.md#tolocalestring) -- [toPrecision](verida_verifiable_credentials._internal_.Number.md#toprecision) -- [toString](verida_verifiable_credentials._internal_.Number.md#tostring) -- [valueOf](verida_verifiable_credentials._internal_.Number.md#valueof) - -## Methods - -### toExponential - -▸ **toExponential**(`fractionDigits?`): `string` - -Returns a string containing a number represented in exponential notation. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `fractionDigits?` | `number` | Number of digits after the decimal point. Must be in the range 0 - 20, inclusive. | - -#### Returns - -`string` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:559 - -___ - -### toFixed - -▸ **toFixed**(`fractionDigits?`): `string` - -Returns a string representing a number in fixed-point notation. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `fractionDigits?` | `number` | Number of digits after the decimal point. Must be in the range 0 - 20, inclusive. | - -#### Returns - -`string` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:553 - -___ - -### toLocaleString - -▸ **toLocaleString**(`locales?`, `options?`): `string` - -Converts a number to a string by using the current or specified locale. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `locales?` | `string` \| `string`[] | A locale string or array of locale strings that contain one or more language or locale tags. If you include more than one locale string, list them in descending order of priority so that the first entry is the preferred locale. If you omit this parameter, the default locale of the JavaScript runtime is used. | -| `options?` | `NumberFormatOptions` | An object that contains one or more properties that specify comparison options. | - -#### Returns - -`string` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:4412 - -___ - -### toPrecision - -▸ **toPrecision**(`precision?`): `string` - -Returns a string containing a number represented either in exponential or fixed-point notation with a specified number of digits. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `precision?` | `number` | Number of significant digits. Must be in the range 1 - 21, inclusive. | - -#### Returns - -`string` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:565 - -___ - -### toString - -▸ **toString**(`radix?`): `string` - -Returns a string representation of an object. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `radix?` | `number` | Specifies a radix for converting numeric values to strings. This value is only used for numbers. | - -#### Returns - -`string` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:547 - -___ - -### valueOf - -▸ **valueOf**(): `number` - -Returns the primitive value of the specified object. - -#### Returns - -`number` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:568 diff --git a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.NumberKeywords.md b/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.NumberKeywords.md deleted file mode 100644 index 61a02dc..0000000 --- a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.NumberKeywords.md +++ /dev/null @@ -1,76 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / NumberKeywords - -# Interface: NumberKeywords - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md).NumberKeywords - -## Table of contents - -### Properties - -- [exclusiveMaximum](verida_verifiable_credentials._internal_.NumberKeywords.md#exclusivemaximum) -- [exclusiveMinimum](verida_verifiable_credentials._internal_.NumberKeywords.md#exclusiveminimum) -- [format](verida_verifiable_credentials._internal_.NumberKeywords.md#format) -- [maximum](verida_verifiable_credentials._internal_.NumberKeywords.md#maximum) -- [minimum](verida_verifiable_credentials._internal_.NumberKeywords.md#minimum) -- [multipleOf](verida_verifiable_credentials._internal_.NumberKeywords.md#multipleof) - -## Properties - -### exclusiveMaximum - -• `Optional` **exclusiveMaximum**: `number` - -#### Defined in - -node_modules/ajv/dist/types/json-schema.d.ts:11 - -___ - -### exclusiveMinimum - -• `Optional` **exclusiveMinimum**: `number` - -#### Defined in - -node_modules/ajv/dist/types/json-schema.d.ts:10 - -___ - -### format - -• `Optional` **format**: `string` - -#### Defined in - -node_modules/ajv/dist/types/json-schema.d.ts:13 - -___ - -### maximum - -• `Optional` **maximum**: `number` - -#### Defined in - -node_modules/ajv/dist/types/json-schema.d.ts:9 - -___ - -### minimum - -• `Optional` **minimum**: `number` - -#### Defined in - -node_modules/ajv/dist/types/json-schema.d.ts:8 - -___ - -### multipleOf - -• `Optional` **multipleOf**: `number` - -#### Defined in - -node_modules/ajv/dist/types/json-schema.d.ts:12 diff --git a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.PermissionsConfig.md b/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.PermissionsConfig.md deleted file mode 100644 index d9c7351..0000000 --- a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.PermissionsConfig.md +++ /dev/null @@ -1,56 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / PermissionsConfig - -# Interface: PermissionsConfig - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md).PermissionsConfig - -Interface for any PermissionsConfig - -## Table of contents - -### Properties - -- [read](verida_verifiable_credentials._internal_.PermissionsConfig.md#read) -- [readList](verida_verifiable_credentials._internal_.PermissionsConfig.md#readlist) -- [write](verida_verifiable_credentials._internal_.PermissionsConfig.md#write) -- [writeList](verida_verifiable_credentials._internal_.PermissionsConfig.md#writelist) - -## Properties - -### read - -• **read**: [`PermissionOptionsEnum`](../enums/verida_verifiable_credentials._internal_.PermissionOptionsEnum.md) - -#### Defined in - -packages/client-ts/dist/context/interfaces.d.ts:83 - -___ - -### readList - -• `Optional` **readList**: `string`[] - -#### Defined in - -packages/client-ts/dist/context/interfaces.d.ts:85 - -___ - -### write - -• **write**: [`PermissionOptionsEnum`](../enums/verida_verifiable_credentials._internal_.PermissionOptionsEnum.md) - -#### Defined in - -packages/client-ts/dist/context/interfaces.d.ts:84 - -___ - -### writeList - -• `Optional` **writeList**: `string`[] - -#### Defined in - -packages/client-ts/dist/context/interfaces.d.ts:86 diff --git a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.PromiseLike.md b/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.PromiseLike.md deleted file mode 100644 index ff6aa8c..0000000 --- a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.PromiseLike.md +++ /dev/null @@ -1,49 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / PromiseLike - -# Interface: PromiseLike - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md).PromiseLike - -## Type parameters - -| Name | -| :------ | -| `T` | - -## Table of contents - -### Methods - -- [then](verida_verifiable_credentials._internal_.PromiseLike.md#then) - -## Methods - -### then - -▸ **then**<`TResult1`, `TResult2`\>(`onfulfilled?`, `onrejected?`): [`PromiseLike`](verida_verifiable_credentials._internal_.PromiseLike.md)<`TResult1` \| `TResult2`\> - -Attaches callbacks for the resolution and/or rejection of the Promise. - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `TResult1` | `T` | -| `TResult2` | `never` | - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `onfulfilled?` | ``null`` \| (`value`: `T`) => `TResult1` \| [`PromiseLike`](verida_verifiable_credentials._internal_.PromiseLike.md)<`TResult1`\> | The callback to execute when the Promise is resolved. | -| `onrejected?` | ``null`` \| (`reason`: `any`) => `TResult2` \| [`PromiseLike`](verida_verifiable_credentials._internal_.PromiseLike.md)<`TResult2`\> | The callback to execute when the Promise is rejected. | - -#### Returns - -[`PromiseLike`](verida_verifiable_credentials._internal_.PromiseLike.md)<`TResult1` \| `TResult2`\> - -A Promise for the completion of which ever callback is executed. - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1440 diff --git a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.Proof.md b/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.Proof.md deleted file mode 100644 index 6f70820..0000000 --- a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.Proof.md +++ /dev/null @@ -1,54 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / Proof - -# Interface: Proof - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md).Proof - -## Table of contents - -### Properties - -- [proofPurpose](verida_verifiable_credentials._internal_.Proof.md#proofpurpose) -- [proofValue](verida_verifiable_credentials._internal_.Proof.md#proofvalue) -- [type](verida_verifiable_credentials._internal_.Proof.md#type) -- [verificationMethod](verida_verifiable_credentials._internal_.Proof.md#verificationmethod) - -## Properties - -### proofPurpose - -• **proofPurpose**: ``"assertionMethod"`` - -#### Defined in - -packages/did-document/dist/interfaces.d.ts:10 - -___ - -### proofValue - -• **proofValue**: `string` - -#### Defined in - -packages/did-document/dist/interfaces.d.ts:11 - -___ - -### type - -• **type**: ``"EcdsaSecp256k1VerificationKey2019"`` - -#### Defined in - -packages/did-document/dist/interfaces.d.ts:8 - -___ - -### verificationMethod - -• **verificationMethod**: `string` - -#### Defined in - -packages/did-document/dist/interfaces.d.ts:9 diff --git a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.Rule.md b/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.Rule.md deleted file mode 100644 index 83e64c8..0000000 --- a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.Rule.md +++ /dev/null @@ -1,32 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / Rule - -# Interface: Rule - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md).Rule - -## Table of contents - -### Properties - -- [definition](verida_verifiable_credentials._internal_.Rule.md#definition) -- [keyword](verida_verifiable_credentials._internal_.Rule.md#keyword) - -## Properties - -### definition - -• **definition**: [`AddedKeywordDefinition`](../modules/verida_verifiable_credentials._internal_.md#addedkeyworddefinition) - -#### Defined in - -node_modules/ajv/dist/compile/rules.d.ts:25 - -___ - -### keyword - -• **keyword**: `string` - -#### Defined in - -node_modules/ajv/dist/compile/rules.d.ts:24 diff --git a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.RuleGroup.md b/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.RuleGroup.md deleted file mode 100644 index 844cf69..0000000 --- a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.RuleGroup.md +++ /dev/null @@ -1,32 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / RuleGroup - -# Interface: RuleGroup - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md).RuleGroup - -## Table of contents - -### Properties - -- [rules](verida_verifiable_credentials._internal_.RuleGroup.md#rules) -- [type](verida_verifiable_credentials._internal_.RuleGroup.md#type) - -## Properties - -### rules - -• **rules**: [`Rule`](verida_verifiable_credentials._internal_.Rule.md)[] - -#### Defined in - -node_modules/ajv/dist/compile/rules.d.ts:21 - -___ - -### type - -• `Optional` **type**: ``"string"`` \| ``"number"`` \| ``"boolean"`` \| ``"object"`` \| ``"integer"`` \| ``"array"`` \| ``"null"`` - -#### Defined in - -node_modules/ajv/dist/compile/rules.d.ts:20 diff --git a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.SchemaCxt.md b/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.SchemaCxt.md deleted file mode 100644 index ee3d33b..0000000 --- a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.SchemaCxt.md +++ /dev/null @@ -1,346 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / SchemaCxt - -# Interface: SchemaCxt - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md).SchemaCxt - -## Hierarchy - -- **`SchemaCxt`** - - ↳ [`SchemaObjCxt`](verida_verifiable_credentials._internal_.SchemaObjCxt.md) - -## Table of contents - -### Properties - -- [ValidationError](verida_verifiable_credentials._internal_.SchemaCxt.md#validationerror) -- [allErrors](verida_verifiable_credentials._internal_.SchemaCxt.md#allerrors) -- [baseId](verida_verifiable_credentials._internal_.SchemaCxt.md#baseid) -- [compositeRule](verida_verifiable_credentials._internal_.SchemaCxt.md#compositerule) -- [createErrors](verida_verifiable_credentials._internal_.SchemaCxt.md#createerrors) -- [data](verida_verifiable_credentials._internal_.SchemaCxt.md#data) -- [dataLevel](verida_verifiable_credentials._internal_.SchemaCxt.md#datalevel) -- [dataNames](verida_verifiable_credentials._internal_.SchemaCxt.md#datanames) -- [dataPathArr](verida_verifiable_credentials._internal_.SchemaCxt.md#datapatharr) -- [dataTypes](verida_verifiable_credentials._internal_.SchemaCxt.md#datatypes) -- [definedProperties](verida_verifiable_credentials._internal_.SchemaCxt.md#definedproperties) -- [errSchemaPath](verida_verifiable_credentials._internal_.SchemaCxt.md#errschemapath) -- [errorPath](verida_verifiable_credentials._internal_.SchemaCxt.md#errorpath) -- [evaluated](verida_verifiable_credentials._internal_.SchemaCxt.md#evaluated) -- [gen](verida_verifiable_credentials._internal_.SchemaCxt.md#gen) -- [items](verida_verifiable_credentials._internal_.SchemaCxt.md#items) -- [jtdDiscriminator](verida_verifiable_credentials._internal_.SchemaCxt.md#jtddiscriminator) -- [jtdMetadata](verida_verifiable_credentials._internal_.SchemaCxt.md#jtdmetadata) -- [opts](verida_verifiable_credentials._internal_.SchemaCxt.md#opts) -- [parentData](verida_verifiable_credentials._internal_.SchemaCxt.md#parentdata) -- [parentDataProperty](verida_verifiable_credentials._internal_.SchemaCxt.md#parentdataproperty) -- [propertyName](verida_verifiable_credentials._internal_.SchemaCxt.md#propertyname) -- [props](verida_verifiable_credentials._internal_.SchemaCxt.md#props) -- [rootId](verida_verifiable_credentials._internal_.SchemaCxt.md#rootid) -- [schema](verida_verifiable_credentials._internal_.SchemaCxt.md#schema) -- [schemaEnv](verida_verifiable_credentials._internal_.SchemaCxt.md#schemaenv) -- [schemaPath](verida_verifiable_credentials._internal_.SchemaCxt.md#schemapath) -- [self](verida_verifiable_credentials._internal_.SchemaCxt.md#self) -- [topSchemaRef](verida_verifiable_credentials._internal_.SchemaCxt.md#topschemaref) -- [validateName](verida_verifiable_credentials._internal_.SchemaCxt.md#validatename) - -## Properties - -### ValidationError - -• `Optional` `Readonly` **ValidationError**: [`Name`](../classes/verida_verifiable_credentials._internal_.Name.md) - -#### Defined in - -node_modules/ajv/dist/compile/index.d.ts:24 - -___ - -### allErrors - -• `Optional` `Readonly` **allErrors**: `boolean` - -#### Defined in - -node_modules/ajv/dist/compile/index.d.ts:12 - -___ - -### baseId - -• **baseId**: `string` - -#### Defined in - -node_modules/ajv/dist/compile/index.d.ts:28 - -___ - -### compositeRule - -• `Optional` `Readonly` **compositeRule**: `boolean` - -#### Defined in - -node_modules/ajv/dist/compile/index.d.ts:33 - -___ - -### createErrors - -• `Optional` `Readonly` **createErrors**: `boolean` - -#### Defined in - -node_modules/ajv/dist/compile/index.d.ts:38 - -___ - -### data - -• `Readonly` **data**: [`Name`](../classes/verida_verifiable_credentials._internal_.Name.md) - -#### Defined in - -node_modules/ajv/dist/compile/index.d.ts:13 - -___ - -### dataLevel - -• `Readonly` **dataLevel**: `number` - -#### Defined in - -node_modules/ajv/dist/compile/index.d.ts:18 - -___ - -### dataNames - -• `Readonly` **dataNames**: [`Name`](../classes/verida_verifiable_credentials._internal_.Name.md)[] - -#### Defined in - -node_modules/ajv/dist/compile/index.d.ts:16 - -___ - -### dataPathArr - -• `Readonly` **dataPathArr**: (`number` \| [`Code`](../modules/verida_verifiable_credentials._internal_.md#code))[] - -#### Defined in - -node_modules/ajv/dist/compile/index.d.ts:17 - -___ - -### dataTypes - -• **dataTypes**: (``"string"`` \| ``"number"`` \| ``"boolean"`` \| ``"object"`` \| ``"integer"`` \| ``"array"`` \| ``"null"``)[] - -#### Defined in - -node_modules/ajv/dist/compile/index.d.ts:19 - -___ - -### definedProperties - -• **definedProperties**: `Set`<`string`\> - -#### Defined in - -node_modules/ajv/dist/compile/index.d.ts:20 - -___ - -### errSchemaPath - -• `Readonly` **errSchemaPath**: `string` - -#### Defined in - -node_modules/ajv/dist/compile/index.d.ts:30 - -___ - -### errorPath - -• `Readonly` **errorPath**: [`Code`](../modules/verida_verifiable_credentials._internal_.md#code) - -#### Defined in - -node_modules/ajv/dist/compile/index.d.ts:31 - -___ - -### evaluated - -• `Optional` **evaluated**: [`Name`](../classes/verida_verifiable_credentials._internal_.Name.md) - -#### Defined in - -node_modules/ajv/dist/compile/index.d.ts:23 - -___ - -### gen - -• `Readonly` **gen**: [`CodeGen`](../classes/verida_verifiable_credentials._internal_.CodeGen.md) - -#### Defined in - -node_modules/ajv/dist/compile/index.d.ts:11 - -___ - -### items - -• `Optional` **items**: [`Name`](../classes/verida_verifiable_credentials._internal_.Name.md) \| [`EvaluatedItems`](../modules/verida_verifiable_credentials._internal_.md#evaluateditems) - -#### Defined in - -node_modules/ajv/dist/compile/index.d.ts:35 - -___ - -### jtdDiscriminator - -• `Optional` **jtdDiscriminator**: `string` - -#### Defined in - -node_modules/ajv/dist/compile/index.d.ts:36 - -___ - -### jtdMetadata - -• `Optional` **jtdMetadata**: `boolean` - -#### Defined in - -node_modules/ajv/dist/compile/index.d.ts:37 - -___ - -### opts - -• `Readonly` **opts**: [`InstanceOptions`](../modules/verida_verifiable_credentials._internal_.md#instanceoptions) - -#### Defined in - -node_modules/ajv/dist/compile/index.d.ts:39 - -___ - -### parentData - -• `Readonly` **parentData**: [`Name`](../classes/verida_verifiable_credentials._internal_.Name.md) - -#### Defined in - -node_modules/ajv/dist/compile/index.d.ts:14 - -___ - -### parentDataProperty - -• `Readonly` **parentDataProperty**: `number` \| [`Code`](../modules/verida_verifiable_credentials._internal_.md#code) - -#### Defined in - -node_modules/ajv/dist/compile/index.d.ts:15 - -___ - -### propertyName - -• `Optional` `Readonly` **propertyName**: [`Name`](../classes/verida_verifiable_credentials._internal_.Name.md) - -#### Defined in - -node_modules/ajv/dist/compile/index.d.ts:32 - -___ - -### props - -• `Optional` **props**: [`Name`](../classes/verida_verifiable_credentials._internal_.Name.md) \| [`EvaluatedProperties`](../modules/verida_verifiable_credentials._internal_.md#evaluatedproperties) - -#### Defined in - -node_modules/ajv/dist/compile/index.d.ts:34 - -___ - -### rootId - -• `Readonly` **rootId**: `string` - -#### Defined in - -node_modules/ajv/dist/compile/index.d.ts:27 - -___ - -### schema - -• `Readonly` **schema**: [`AnySchema`](../modules/verida_verifiable_credentials._internal_.md#anyschema) - -#### Defined in - -node_modules/ajv/dist/compile/index.d.ts:25 - -___ - -### schemaEnv - -• `Readonly` **schemaEnv**: [`SchemaEnv`](../classes/verida_verifiable_credentials._internal_.SchemaEnv.md) - -#### Defined in - -node_modules/ajv/dist/compile/index.d.ts:26 - -___ - -### schemaPath - -• `Readonly` **schemaPath**: [`Code`](../modules/verida_verifiable_credentials._internal_.md#code) - -#### Defined in - -node_modules/ajv/dist/compile/index.d.ts:29 - -___ - -### self - -• `Readonly` **self**: [`default`](../classes/verida_verifiable_credentials._internal_.default-4.md) - -#### Defined in - -node_modules/ajv/dist/compile/index.d.ts:40 - -___ - -### topSchemaRef - -• `Readonly` **topSchemaRef**: [`Code`](../modules/verida_verifiable_credentials._internal_.md#code) - -#### Defined in - -node_modules/ajv/dist/compile/index.d.ts:21 - -___ - -### validateName - -• `Readonly` **validateName**: [`Name`](../classes/verida_verifiable_credentials._internal_.Name.md) - -#### Defined in - -node_modules/ajv/dist/compile/index.d.ts:22 diff --git a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.SchemaEnvArgs.md b/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.SchemaEnvArgs.md deleted file mode 100644 index ec4bfbf..0000000 --- a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.SchemaEnvArgs.md +++ /dev/null @@ -1,91 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / SchemaEnvArgs - -# Interface: SchemaEnvArgs - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md).SchemaEnvArgs - -## Implemented by - -- [`SchemaEnv`](../classes/verida_verifiable_credentials._internal_.SchemaEnv.md) - -## Table of contents - -### Properties - -- [baseId](verida_verifiable_credentials._internal_.SchemaEnvArgs.md#baseid) -- [localRefs](verida_verifiable_credentials._internal_.SchemaEnvArgs.md#localrefs) -- [meta](verida_verifiable_credentials._internal_.SchemaEnvArgs.md#meta) -- [root](verida_verifiable_credentials._internal_.SchemaEnvArgs.md#root) -- [schema](verida_verifiable_credentials._internal_.SchemaEnvArgs.md#schema) -- [schemaId](verida_verifiable_credentials._internal_.SchemaEnvArgs.md#schemaid) -- [schemaPath](verida_verifiable_credentials._internal_.SchemaEnvArgs.md#schemapath) - -## Properties - -### baseId - -• `Optional` `Readonly` **baseId**: `string` - -#### Defined in - -node_modules/ajv/dist/compile/index.d.ts:49 - -___ - -### localRefs - -• `Optional` `Readonly` **localRefs**: [`LocalRefs`](../modules/verida_verifiable_credentials._internal_.md#localrefs) - -#### Defined in - -node_modules/ajv/dist/compile/index.d.ts:51 - -___ - -### meta - -• `Optional` `Readonly` **meta**: `boolean` - -#### Defined in - -node_modules/ajv/dist/compile/index.d.ts:52 - -___ - -### root - -• `Optional` `Readonly` **root**: [`SchemaEnv`](../classes/verida_verifiable_credentials._internal_.SchemaEnv.md) - -#### Defined in - -node_modules/ajv/dist/compile/index.d.ts:48 - -___ - -### schema - -• `Readonly` **schema**: [`AnySchema`](../modules/verida_verifiable_credentials._internal_.md#anyschema) - -#### Defined in - -node_modules/ajv/dist/compile/index.d.ts:46 - -___ - -### schemaId - -• `Optional` `Readonly` **schemaId**: ``"id"`` \| ``"$id"`` - -#### Defined in - -node_modules/ajv/dist/compile/index.d.ts:47 - -___ - -### schemaPath - -• `Optional` `Readonly` **schemaPath**: `string` - -#### Defined in - -node_modules/ajv/dist/compile/index.d.ts:50 diff --git a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.SchemaObjCxt.md b/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.SchemaObjCxt.md deleted file mode 100644 index 838f81e..0000000 --- a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.SchemaObjCxt.md +++ /dev/null @@ -1,466 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / SchemaObjCxt - -# Interface: SchemaObjCxt - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md).SchemaObjCxt - -## Hierarchy - -- [`SchemaCxt`](verida_verifiable_credentials._internal_.SchemaCxt.md) - - ↳ **`SchemaObjCxt`** - -## Table of contents - -### Properties - -- [ValidationError](verida_verifiable_credentials._internal_.SchemaObjCxt.md#validationerror) -- [allErrors](verida_verifiable_credentials._internal_.SchemaObjCxt.md#allerrors) -- [baseId](verida_verifiable_credentials._internal_.SchemaObjCxt.md#baseid) -- [compositeRule](verida_verifiable_credentials._internal_.SchemaObjCxt.md#compositerule) -- [createErrors](verida_verifiable_credentials._internal_.SchemaObjCxt.md#createerrors) -- [data](verida_verifiable_credentials._internal_.SchemaObjCxt.md#data) -- [dataLevel](verida_verifiable_credentials._internal_.SchemaObjCxt.md#datalevel) -- [dataNames](verida_verifiable_credentials._internal_.SchemaObjCxt.md#datanames) -- [dataPathArr](verida_verifiable_credentials._internal_.SchemaObjCxt.md#datapatharr) -- [dataTypes](verida_verifiable_credentials._internal_.SchemaObjCxt.md#datatypes) -- [definedProperties](verida_verifiable_credentials._internal_.SchemaObjCxt.md#definedproperties) -- [errSchemaPath](verida_verifiable_credentials._internal_.SchemaObjCxt.md#errschemapath) -- [errorPath](verida_verifiable_credentials._internal_.SchemaObjCxt.md#errorpath) -- [evaluated](verida_verifiable_credentials._internal_.SchemaObjCxt.md#evaluated) -- [gen](verida_verifiable_credentials._internal_.SchemaObjCxt.md#gen) -- [items](verida_verifiable_credentials._internal_.SchemaObjCxt.md#items) -- [jtdDiscriminator](verida_verifiable_credentials._internal_.SchemaObjCxt.md#jtddiscriminator) -- [jtdMetadata](verida_verifiable_credentials._internal_.SchemaObjCxt.md#jtdmetadata) -- [opts](verida_verifiable_credentials._internal_.SchemaObjCxt.md#opts) -- [parentData](verida_verifiable_credentials._internal_.SchemaObjCxt.md#parentdata) -- [parentDataProperty](verida_verifiable_credentials._internal_.SchemaObjCxt.md#parentdataproperty) -- [propertyName](verida_verifiable_credentials._internal_.SchemaObjCxt.md#propertyname) -- [props](verida_verifiable_credentials._internal_.SchemaObjCxt.md#props) -- [rootId](verida_verifiable_credentials._internal_.SchemaObjCxt.md#rootid) -- [schema](verida_verifiable_credentials._internal_.SchemaObjCxt.md#schema) -- [schemaEnv](verida_verifiable_credentials._internal_.SchemaObjCxt.md#schemaenv) -- [schemaPath](verida_verifiable_credentials._internal_.SchemaObjCxt.md#schemapath) -- [self](verida_verifiable_credentials._internal_.SchemaObjCxt.md#self) -- [topSchemaRef](verida_verifiable_credentials._internal_.SchemaObjCxt.md#topschemaref) -- [validateName](verida_verifiable_credentials._internal_.SchemaObjCxt.md#validatename) - -## Properties - -### ValidationError - -• `Optional` `Readonly` **ValidationError**: [`Name`](../classes/verida_verifiable_credentials._internal_.Name.md) - -#### Inherited from - -[SchemaCxt](verida_verifiable_credentials._internal_.SchemaCxt.md).[ValidationError](verida_verifiable_credentials._internal_.SchemaCxt.md#validationerror) - -#### Defined in - -node_modules/ajv/dist/compile/index.d.ts:24 - -___ - -### allErrors - -• `Optional` `Readonly` **allErrors**: `boolean` - -#### Inherited from - -[SchemaCxt](verida_verifiable_credentials._internal_.SchemaCxt.md).[allErrors](verida_verifiable_credentials._internal_.SchemaCxt.md#allerrors) - -#### Defined in - -node_modules/ajv/dist/compile/index.d.ts:12 - -___ - -### baseId - -• **baseId**: `string` - -#### Inherited from - -[SchemaCxt](verida_verifiable_credentials._internal_.SchemaCxt.md).[baseId](verida_verifiable_credentials._internal_.SchemaCxt.md#baseid) - -#### Defined in - -node_modules/ajv/dist/compile/index.d.ts:28 - -___ - -### compositeRule - -• `Optional` `Readonly` **compositeRule**: `boolean` - -#### Inherited from - -[SchemaCxt](verida_verifiable_credentials._internal_.SchemaCxt.md).[compositeRule](verida_verifiable_credentials._internal_.SchemaCxt.md#compositerule) - -#### Defined in - -node_modules/ajv/dist/compile/index.d.ts:33 - -___ - -### createErrors - -• `Optional` `Readonly` **createErrors**: `boolean` - -#### Inherited from - -[SchemaCxt](verida_verifiable_credentials._internal_.SchemaCxt.md).[createErrors](verida_verifiable_credentials._internal_.SchemaCxt.md#createerrors) - -#### Defined in - -node_modules/ajv/dist/compile/index.d.ts:38 - -___ - -### data - -• `Readonly` **data**: [`Name`](../classes/verida_verifiable_credentials._internal_.Name.md) - -#### Inherited from - -[SchemaCxt](verida_verifiable_credentials._internal_.SchemaCxt.md).[data](verida_verifiable_credentials._internal_.SchemaCxt.md#data) - -#### Defined in - -node_modules/ajv/dist/compile/index.d.ts:13 - -___ - -### dataLevel - -• `Readonly` **dataLevel**: `number` - -#### Inherited from - -[SchemaCxt](verida_verifiable_credentials._internal_.SchemaCxt.md).[dataLevel](verida_verifiable_credentials._internal_.SchemaCxt.md#datalevel) - -#### Defined in - -node_modules/ajv/dist/compile/index.d.ts:18 - -___ - -### dataNames - -• `Readonly` **dataNames**: [`Name`](../classes/verida_verifiable_credentials._internal_.Name.md)[] - -#### Inherited from - -[SchemaCxt](verida_verifiable_credentials._internal_.SchemaCxt.md).[dataNames](verida_verifiable_credentials._internal_.SchemaCxt.md#datanames) - -#### Defined in - -node_modules/ajv/dist/compile/index.d.ts:16 - -___ - -### dataPathArr - -• `Readonly` **dataPathArr**: (`number` \| [`Code`](../modules/verida_verifiable_credentials._internal_.md#code))[] - -#### Inherited from - -[SchemaCxt](verida_verifiable_credentials._internal_.SchemaCxt.md).[dataPathArr](verida_verifiable_credentials._internal_.SchemaCxt.md#datapatharr) - -#### Defined in - -node_modules/ajv/dist/compile/index.d.ts:17 - -___ - -### dataTypes - -• **dataTypes**: (``"string"`` \| ``"number"`` \| ``"boolean"`` \| ``"object"`` \| ``"integer"`` \| ``"array"`` \| ``"null"``)[] - -#### Inherited from - -[SchemaCxt](verida_verifiable_credentials._internal_.SchemaCxt.md).[dataTypes](verida_verifiable_credentials._internal_.SchemaCxt.md#datatypes) - -#### Defined in - -node_modules/ajv/dist/compile/index.d.ts:19 - -___ - -### definedProperties - -• **definedProperties**: `Set`<`string`\> - -#### Inherited from - -[SchemaCxt](verida_verifiable_credentials._internal_.SchemaCxt.md).[definedProperties](verida_verifiable_credentials._internal_.SchemaCxt.md#definedproperties) - -#### Defined in - -node_modules/ajv/dist/compile/index.d.ts:20 - -___ - -### errSchemaPath - -• `Readonly` **errSchemaPath**: `string` - -#### Inherited from - -[SchemaCxt](verida_verifiable_credentials._internal_.SchemaCxt.md).[errSchemaPath](verida_verifiable_credentials._internal_.SchemaCxt.md#errschemapath) - -#### Defined in - -node_modules/ajv/dist/compile/index.d.ts:30 - -___ - -### errorPath - -• `Readonly` **errorPath**: [`Code`](../modules/verida_verifiable_credentials._internal_.md#code) - -#### Inherited from - -[SchemaCxt](verida_verifiable_credentials._internal_.SchemaCxt.md).[errorPath](verida_verifiable_credentials._internal_.SchemaCxt.md#errorpath) - -#### Defined in - -node_modules/ajv/dist/compile/index.d.ts:31 - -___ - -### evaluated - -• `Optional` **evaluated**: [`Name`](../classes/verida_verifiable_credentials._internal_.Name.md) - -#### Inherited from - -[SchemaCxt](verida_verifiable_credentials._internal_.SchemaCxt.md).[evaluated](verida_verifiable_credentials._internal_.SchemaCxt.md#evaluated) - -#### Defined in - -node_modules/ajv/dist/compile/index.d.ts:23 - -___ - -### gen - -• `Readonly` **gen**: [`CodeGen`](../classes/verida_verifiable_credentials._internal_.CodeGen.md) - -#### Inherited from - -[SchemaCxt](verida_verifiable_credentials._internal_.SchemaCxt.md).[gen](verida_verifiable_credentials._internal_.SchemaCxt.md#gen) - -#### Defined in - -node_modules/ajv/dist/compile/index.d.ts:11 - -___ - -### items - -• `Optional` **items**: [`Name`](../classes/verida_verifiable_credentials._internal_.Name.md) \| [`EvaluatedItems`](../modules/verida_verifiable_credentials._internal_.md#evaluateditems) - -#### Inherited from - -[SchemaCxt](verida_verifiable_credentials._internal_.SchemaCxt.md).[items](verida_verifiable_credentials._internal_.SchemaCxt.md#items) - -#### Defined in - -node_modules/ajv/dist/compile/index.d.ts:35 - -___ - -### jtdDiscriminator - -• `Optional` **jtdDiscriminator**: `string` - -#### Inherited from - -[SchemaCxt](verida_verifiable_credentials._internal_.SchemaCxt.md).[jtdDiscriminator](verida_verifiable_credentials._internal_.SchemaCxt.md#jtddiscriminator) - -#### Defined in - -node_modules/ajv/dist/compile/index.d.ts:36 - -___ - -### jtdMetadata - -• `Optional` **jtdMetadata**: `boolean` - -#### Inherited from - -[SchemaCxt](verida_verifiable_credentials._internal_.SchemaCxt.md).[jtdMetadata](verida_verifiable_credentials._internal_.SchemaCxt.md#jtdmetadata) - -#### Defined in - -node_modules/ajv/dist/compile/index.d.ts:37 - -___ - -### opts - -• `Readonly` **opts**: [`InstanceOptions`](../modules/verida_verifiable_credentials._internal_.md#instanceoptions) - -#### Inherited from - -[SchemaCxt](verida_verifiable_credentials._internal_.SchemaCxt.md).[opts](verida_verifiable_credentials._internal_.SchemaCxt.md#opts) - -#### Defined in - -node_modules/ajv/dist/compile/index.d.ts:39 - -___ - -### parentData - -• `Readonly` **parentData**: [`Name`](../classes/verida_verifiable_credentials._internal_.Name.md) - -#### Inherited from - -[SchemaCxt](verida_verifiable_credentials._internal_.SchemaCxt.md).[parentData](verida_verifiable_credentials._internal_.SchemaCxt.md#parentdata) - -#### Defined in - -node_modules/ajv/dist/compile/index.d.ts:14 - -___ - -### parentDataProperty - -• `Readonly` **parentDataProperty**: `number` \| [`Code`](../modules/verida_verifiable_credentials._internal_.md#code) - -#### Inherited from - -[SchemaCxt](verida_verifiable_credentials._internal_.SchemaCxt.md).[parentDataProperty](verida_verifiable_credentials._internal_.SchemaCxt.md#parentdataproperty) - -#### Defined in - -node_modules/ajv/dist/compile/index.d.ts:15 - -___ - -### propertyName - -• `Optional` `Readonly` **propertyName**: [`Name`](../classes/verida_verifiable_credentials._internal_.Name.md) - -#### Inherited from - -[SchemaCxt](verida_verifiable_credentials._internal_.SchemaCxt.md).[propertyName](verida_verifiable_credentials._internal_.SchemaCxt.md#propertyname) - -#### Defined in - -node_modules/ajv/dist/compile/index.d.ts:32 - -___ - -### props - -• `Optional` **props**: [`Name`](../classes/verida_verifiable_credentials._internal_.Name.md) \| [`EvaluatedProperties`](../modules/verida_verifiable_credentials._internal_.md#evaluatedproperties) - -#### Inherited from - -[SchemaCxt](verida_verifiable_credentials._internal_.SchemaCxt.md).[props](verida_verifiable_credentials._internal_.SchemaCxt.md#props) - -#### Defined in - -node_modules/ajv/dist/compile/index.d.ts:34 - -___ - -### rootId - -• `Readonly` **rootId**: `string` - -#### Inherited from - -[SchemaCxt](verida_verifiable_credentials._internal_.SchemaCxt.md).[rootId](verida_verifiable_credentials._internal_.SchemaCxt.md#rootid) - -#### Defined in - -node_modules/ajv/dist/compile/index.d.ts:27 - -___ - -### schema - -• `Readonly` **schema**: [`AnySchemaObject`](../modules/verida_verifiable_credentials._internal_.md#anyschemaobject) - -#### Overrides - -[SchemaCxt](verida_verifiable_credentials._internal_.SchemaCxt.md).[schema](verida_verifiable_credentials._internal_.SchemaCxt.md#schema) - -#### Defined in - -node_modules/ajv/dist/compile/index.d.ts:43 - -___ - -### schemaEnv - -• `Readonly` **schemaEnv**: [`SchemaEnv`](../classes/verida_verifiable_credentials._internal_.SchemaEnv.md) - -#### Inherited from - -[SchemaCxt](verida_verifiable_credentials._internal_.SchemaCxt.md).[schemaEnv](verida_verifiable_credentials._internal_.SchemaCxt.md#schemaenv) - -#### Defined in - -node_modules/ajv/dist/compile/index.d.ts:26 - -___ - -### schemaPath - -• `Readonly` **schemaPath**: [`Code`](../modules/verida_verifiable_credentials._internal_.md#code) - -#### Inherited from - -[SchemaCxt](verida_verifiable_credentials._internal_.SchemaCxt.md).[schemaPath](verida_verifiable_credentials._internal_.SchemaCxt.md#schemapath) - -#### Defined in - -node_modules/ajv/dist/compile/index.d.ts:29 - -___ - -### self - -• `Readonly` **self**: [`default`](../classes/verida_verifiable_credentials._internal_.default-4.md) - -#### Inherited from - -[SchemaCxt](verida_verifiable_credentials._internal_.SchemaCxt.md).[self](verida_verifiable_credentials._internal_.SchemaCxt.md#self) - -#### Defined in - -node_modules/ajv/dist/compile/index.d.ts:40 - -___ - -### topSchemaRef - -• `Readonly` **topSchemaRef**: [`Code`](../modules/verida_verifiable_credentials._internal_.md#code) - -#### Inherited from - -[SchemaCxt](verida_verifiable_credentials._internal_.SchemaCxt.md).[topSchemaRef](verida_verifiable_credentials._internal_.SchemaCxt.md#topschemaref) - -#### Defined in - -node_modules/ajv/dist/compile/index.d.ts:21 - -___ - -### validateName - -• `Readonly` **validateName**: [`Name`](../classes/verida_verifiable_credentials._internal_.Name.md) - -#### Inherited from - -[SchemaCxt](verida_verifiable_credentials._internal_.SchemaCxt.md).[validateName](verida_verifiable_credentials._internal_.SchemaCxt.md#validatename) - -#### Defined in - -node_modules/ajv/dist/compile/index.d.ts:22 diff --git a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.SchemaObject.md b/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.SchemaObject.md deleted file mode 100644 index 3a26246..0000000 --- a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.SchemaObject.md +++ /dev/null @@ -1,76 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / SchemaObject - -# Interface: SchemaObject - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md).SchemaObject - -## Hierarchy - -- [`_SchemaObject`](verida_verifiable_credentials._internal_._SchemaObject.md) - - ↳ **`SchemaObject`** - -## Indexable - -▪ [x: `string`]: `any` - -## Table of contents - -### Properties - -- [$async](verida_verifiable_credentials._internal_.SchemaObject.md#$async) -- [$id](verida_verifiable_credentials._internal_.SchemaObject.md#$id) -- [$schema](verida_verifiable_credentials._internal_.SchemaObject.md#$schema) -- [id](verida_verifiable_credentials._internal_.SchemaObject.md#id) - -## Properties - -### $async - -• `Optional` **$async**: ``false`` - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:16 - -___ - -### $id - -• `Optional` **$id**: `string` - -#### Overrides - -[_SchemaObject](verida_verifiable_credentials._internal_._SchemaObject.md).[$id](verida_verifiable_credentials._internal_._SchemaObject.md#$id) - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:14 - -___ - -### $schema - -• `Optional` **$schema**: `string` - -#### Overrides - -[_SchemaObject](verida_verifiable_credentials._internal_._SchemaObject.md).[$schema](verida_verifiable_credentials._internal_._SchemaObject.md#$schema) - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:15 - -___ - -### id - -• `Optional` **id**: `string` - -#### Overrides - -[_SchemaObject](verida_verifiable_credentials._internal_._SchemaObject.md).[id](verida_verifiable_credentials._internal_._SchemaObject.md#id) - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:13 diff --git a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.SchemaValidateFunction.md b/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.SchemaValidateFunction.md deleted file mode 100644 index a5ac8fc..0000000 --- a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.SchemaValidateFunction.md +++ /dev/null @@ -1,44 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / SchemaValidateFunction - -# Interface: SchemaValidateFunction - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md).SchemaValidateFunction - -## Callable - -### SchemaValidateFunction - -▸ **SchemaValidateFunction**(`schema`, `data`, `parentSchema?`, `dataCxt?`): `boolean` \| `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schema` | `any` | -| `data` | `any` | -| `parentSchema?` | [`AnySchemaObject`](../modules/verida_verifiable_credentials._internal_.md#anyschemaobject) | -| `dataCxt?` | [`DataValidationCxt`](verida_verifiable_credentials._internal_.DataValidationCxt.md)<`string` \| `number`\> | - -#### Returns - -`boolean` \| `Promise`<`any`\> - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:111 - -## Table of contents - -### Properties - -- [errors](verida_verifiable_credentials._internal_.SchemaValidateFunction.md#errors) - -## Properties - -### errors - -• `Optional` **errors**: [`Partial`](../modules/verida_verifiable_credentials._internal_.md#partial)<[`ErrorObject`](verida_verifiable_credentials._internal_.ErrorObject.md)<`string`, [`Record`](../modules/verida_verifiable_credentials._internal_.md#record)<`string`, `any`\>, `unknown`\>\>[] - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:112 diff --git a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.ScopeOptions.md b/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.ScopeOptions.md deleted file mode 100644 index d33b8f0..0000000 --- a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.ScopeOptions.md +++ /dev/null @@ -1,38 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / ScopeOptions - -# Interface: ScopeOptions - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md).ScopeOptions - -## Hierarchy - -- **`ScopeOptions`** - - ↳ [`ValueScopeOptions`](verida_verifiable_credentials._internal_.ValueScopeOptions.md) - -## Table of contents - -### Properties - -- [parent](verida_verifiable_credentials._internal_.ScopeOptions.md#parent) -- [prefixes](verida_verifiable_credentials._internal_.ScopeOptions.md#prefixes) - -## Properties - -### parent - -• `Optional` **parent**: [`Scope`](../classes/verida_verifiable_credentials._internal_.Scope.md) - -#### Defined in - -node_modules/ajv/dist/compile/codegen/scope.d.ts:14 - -___ - -### prefixes - -• `Optional` **prefixes**: `Set`<`string`\> - -#### Defined in - -node_modules/ajv/dist/compile/codegen/scope.d.ts:13 diff --git a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.ScopePath.md b/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.ScopePath.md deleted file mode 100644 index 9380fb2..0000000 --- a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.ScopePath.md +++ /dev/null @@ -1,32 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / ScopePath - -# Interface: ScopePath - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md).ScopePath - -## Table of contents - -### Properties - -- [itemIndex](verida_verifiable_credentials._internal_.ScopePath.md#itemindex) -- [property](verida_verifiable_credentials._internal_.ScopePath.md#property) - -## Properties - -### itemIndex - -• **itemIndex**: `number` - -#### Defined in - -node_modules/ajv/dist/compile/codegen/scope.d.ts:54 - -___ - -### property - -• **property**: `string` - -#### Defined in - -node_modules/ajv/dist/compile/codegen/scope.d.ts:53 diff --git a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.SecureContextConfig.md b/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.SecureContextConfig.md deleted file mode 100644 index cc073ef..0000000 --- a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.SecureContextConfig.md +++ /dev/null @@ -1,43 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / SecureContextConfig - -# Interface: SecureContextConfig - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md).SecureContextConfig - -## Table of contents - -### Properties - -- [id](verida_verifiable_credentials._internal_.SecureContextConfig.md#id) -- [publicKeys](verida_verifiable_credentials._internal_.SecureContextConfig.md#publickeys) -- [services](verida_verifiable_credentials._internal_.SecureContextConfig.md#services) - -## Properties - -### id - -• **id**: `string` - -#### Defined in - -packages/types/dist/StorageLinkInterfaces.d.ts:17 - -___ - -### publicKeys - -• **publicKeys**: [`SecureStorageContextPublicKeys`](verida_verifiable_credentials._internal_.SecureStorageContextPublicKeys.md) - -#### Defined in - -packages/types/dist/StorageLinkInterfaces.d.ts:18 - -___ - -### services - -• **services**: [`SecureContextServices`](verida_verifiable_credentials._internal_.SecureContextServices.md) - -#### Defined in - -packages/types/dist/StorageLinkInterfaces.d.ts:19 diff --git a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.SecureContextEndpoint-1.md b/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.SecureContextEndpoint-1.md deleted file mode 100644 index 1bb4c05..0000000 --- a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.SecureContextEndpoint-1.md +++ /dev/null @@ -1,43 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / SecureContextEndpoint - -# Interface: SecureContextEndpoint - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md).SecureContextEndpoint - -## Table of contents - -### Properties - -- [config](verida_verifiable_credentials._internal_.SecureContextEndpoint-1.md#config) -- [endpointUri](verida_verifiable_credentials._internal_.SecureContextEndpoint-1.md#endpointuri) -- [type](verida_verifiable_credentials._internal_.SecureContextEndpoint-1.md#type) - -## Properties - -### config - -• `Optional` **config**: `object` - -#### Defined in - -packages/did-document/dist/interfaces.d.ts:5 - -___ - -### endpointUri - -• **endpointUri**: `string` - -#### Defined in - -packages/did-document/dist/interfaces.d.ts:4 - -___ - -### type - -• **type**: `string` - -#### Defined in - -packages/did-document/dist/interfaces.d.ts:3 diff --git a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.SecureContextEndpoint.md b/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.SecureContextEndpoint.md deleted file mode 100644 index 639a1a3..0000000 --- a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.SecureContextEndpoint.md +++ /dev/null @@ -1,43 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / SecureContextEndpoint - -# Interface: SecureContextEndpoint - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md).SecureContextEndpoint - -## Table of contents - -### Properties - -- [config](verida_verifiable_credentials._internal_.SecureContextEndpoint.md#config) -- [endpointUri](verida_verifiable_credentials._internal_.SecureContextEndpoint.md#endpointuri) -- [type](verida_verifiable_credentials._internal_.SecureContextEndpoint.md#type) - -## Properties - -### config - -• `Optional` **config**: `object` - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:5 - -___ - -### endpointUri - -• **endpointUri**: [`ServiceEndpoint`](../modules/verida_verifiable_credentials._internal_.md#serviceendpoint)[] - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:4 - -___ - -### type - -• **type**: `string` - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:3 diff --git a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.SecureContextPublicKey.md b/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.SecureContextPublicKey.md deleted file mode 100644 index abb4122..0000000 --- a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.SecureContextPublicKey.md +++ /dev/null @@ -1,32 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / SecureContextPublicKey - -# Interface: SecureContextPublicKey - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md).SecureContextPublicKey - -## Table of contents - -### Properties - -- [publicKeyHex](verida_verifiable_credentials._internal_.SecureContextPublicKey.md#publickeyhex) -- [type](verida_verifiable_credentials._internal_.SecureContextPublicKey.md#type) - -## Properties - -### publicKeyHex - -• **publicKeyHex**: `string` - -#### Defined in - -packages/types/dist/StorageLinkInterfaces.d.ts:4 - -___ - -### type - -• **type**: `string` - -#### Defined in - -packages/types/dist/StorageLinkInterfaces.d.ts:3 diff --git a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.SecureContextServices.md b/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.SecureContextServices.md deleted file mode 100644 index 1735f92..0000000 --- a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.SecureContextServices.md +++ /dev/null @@ -1,54 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / SecureContextServices - -# Interface: SecureContextServices - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md).SecureContextServices - -## Table of contents - -### Properties - -- [databaseServer](verida_verifiable_credentials._internal_.SecureContextServices.md#databaseserver) -- [messageServer](verida_verifiable_credentials._internal_.SecureContextServices.md#messageserver) -- [notificationServer](verida_verifiable_credentials._internal_.SecureContextServices.md#notificationserver) -- [storageServer](verida_verifiable_credentials._internal_.SecureContextServices.md#storageserver) - -## Properties - -### databaseServer - -• **databaseServer**: [`SecureContextEndpoint`](verida_verifiable_credentials._internal_.SecureContextEndpoint.md) - -#### Defined in - -packages/types/dist/StorageLinkInterfaces.d.ts:11 - -___ - -### messageServer - -• **messageServer**: [`SecureContextEndpoint`](verida_verifiable_credentials._internal_.SecureContextEndpoint.md) - -#### Defined in - -packages/types/dist/StorageLinkInterfaces.d.ts:12 - -___ - -### notificationServer - -• `Optional` **notificationServer**: [`SecureContextEndpoint`](verida_verifiable_credentials._internal_.SecureContextEndpoint.md) - -#### Defined in - -packages/types/dist/StorageLinkInterfaces.d.ts:14 - -___ - -### storageServer - -• `Optional` **storageServer**: [`SecureContextEndpoint`](verida_verifiable_credentials._internal_.SecureContextEndpoint.md) - -#### Defined in - -packages/types/dist/StorageLinkInterfaces.d.ts:13 diff --git a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.SecureStorageContextPublicKeys.md b/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.SecureStorageContextPublicKeys.md deleted file mode 100644 index 35f885e..0000000 --- a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.SecureStorageContextPublicKeys.md +++ /dev/null @@ -1,32 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / SecureStorageContextPublicKeys - -# Interface: SecureStorageContextPublicKeys - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md).SecureStorageContextPublicKeys - -## Table of contents - -### Properties - -- [asymKey](verida_verifiable_credentials._internal_.SecureStorageContextPublicKeys.md#asymkey) -- [signKey](verida_verifiable_credentials._internal_.SecureStorageContextPublicKeys.md#signkey) - -## Properties - -### asymKey - -• **asymKey**: [`SecureContextPublicKey`](verida_verifiable_credentials._internal_.SecureContextPublicKey.md) - -#### Defined in - -packages/types/dist/StorageLinkInterfaces.d.ts:7 - -___ - -### signKey - -• **signKey**: [`SecureContextPublicKey`](verida_verifiable_credentials._internal_.SecureContextPublicKey.md) - -#### Defined in - -packages/types/dist/StorageLinkInterfaces.d.ts:8 diff --git a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.ServiceEndpoint.md b/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.ServiceEndpoint.md deleted file mode 100644 index 647b52a..0000000 --- a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.ServiceEndpoint.md +++ /dev/null @@ -1,54 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / ServiceEndpoint - -# Interface: ServiceEndpoint - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md).ServiceEndpoint - -## Table of contents - -### Properties - -- [description](verida_verifiable_credentials._internal_.ServiceEndpoint.md#description) -- [id](verida_verifiable_credentials._internal_.ServiceEndpoint.md#id) -- [serviceEndpoint](verida_verifiable_credentials._internal_.ServiceEndpoint.md#serviceendpoint) -- [type](verida_verifiable_credentials._internal_.ServiceEndpoint.md#type) - -## Properties - -### description - -• `Optional` **description**: `string` - -#### Defined in - -packages/did-document/node_modules/did-resolver/lib/resolver.d.ts:43 - -___ - -### id - -• **id**: `string` - -#### Defined in - -packages/did-document/node_modules/did-resolver/lib/resolver.d.ts:40 - -___ - -### serviceEndpoint - -• **serviceEndpoint**: `string` - -#### Defined in - -packages/did-document/node_modules/did-resolver/lib/resolver.d.ts:42 - -___ - -### type - -• **type**: `string` - -#### Defined in - -packages/did-document/node_modules/did-resolver/lib/resolver.d.ts:41 diff --git a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.SignKeyPair.md b/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.SignKeyPair.md deleted file mode 100644 index d8ff709..0000000 --- a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.SignKeyPair.md +++ /dev/null @@ -1,32 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / SignKeyPair - -# Interface: SignKeyPair - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md).SignKeyPair - -## Table of contents - -### Properties - -- [publicKey](verida_verifiable_credentials._internal_.SignKeyPair.md#publickey) -- [secretKey](verida_verifiable_credentials._internal_.SignKeyPair.md#secretkey) - -## Properties - -### publicKey - -• **publicKey**: `Uint8Array` - -#### Defined in - -node_modules/tweetnacl/nacl.d.ts:15 - -___ - -### secretKey - -• **secretKey**: `Uint8Array` - -#### Defined in - -node_modules/tweetnacl/nacl.d.ts:16 diff --git a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.SourceCode.md b/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.SourceCode.md deleted file mode 100644 index c5bc1b3..0000000 --- a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.SourceCode.md +++ /dev/null @@ -1,54 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / SourceCode - -# Interface: SourceCode - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md).SourceCode - -## Table of contents - -### Properties - -- [evaluated](verida_verifiable_credentials._internal_.SourceCode.md#evaluated) -- [scopeValues](verida_verifiable_credentials._internal_.SourceCode.md#scopevalues) -- [validateCode](verida_verifiable_credentials._internal_.SourceCode.md#validatecode) -- [validateName](verida_verifiable_credentials._internal_.SourceCode.md#validatename) - -## Properties - -### evaluated - -• `Optional` **evaluated**: [`Code`](../modules/verida_verifiable_credentials._internal_.md#code) - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:32 - -___ - -### scopeValues - -• **scopeValues**: [`ScopeValueSets`](../modules/verida_verifiable_credentials._internal_.md#scopevaluesets) - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:31 - -___ - -### validateCode - -• **validateCode**: `string` - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:30 - -___ - -### validateName - -• **validateName**: [`ValueScopeName`](../classes/verida_verifiable_credentials._internal_.ValueScopeName.md) - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:29 diff --git a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.StaticEventEmitterOptions.md b/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.StaticEventEmitterOptions.md deleted file mode 100644 index 399d447..0000000 --- a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.StaticEventEmitterOptions.md +++ /dev/null @@ -1,21 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / StaticEventEmitterOptions - -# Interface: StaticEventEmitterOptions - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md).StaticEventEmitterOptions - -## Table of contents - -### Properties - -- [signal](verida_verifiable_credentials._internal_.StaticEventEmitterOptions.md#signal) - -## Properties - -### signal - -• `Optional` **signal**: [`AbortSignal`](../modules/verida_verifiable_credentials._internal_.md#abortsignal) - -#### Defined in - -node_modules/@types/node/events.d.ts:57 diff --git a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.StringKeywords.md b/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.StringKeywords.md deleted file mode 100644 index 02c3ad4..0000000 --- a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.StringKeywords.md +++ /dev/null @@ -1,54 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / StringKeywords - -# Interface: StringKeywords - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md).StringKeywords - -## Table of contents - -### Properties - -- [format](verida_verifiable_credentials._internal_.StringKeywords.md#format) -- [maxLength](verida_verifiable_credentials._internal_.StringKeywords.md#maxlength) -- [minLength](verida_verifiable_credentials._internal_.StringKeywords.md#minlength) -- [pattern](verida_verifiable_credentials._internal_.StringKeywords.md#pattern) - -## Properties - -### format - -• `Optional` **format**: `string` - -#### Defined in - -node_modules/ajv/dist/types/json-schema.d.ts:19 - -___ - -### maxLength - -• `Optional` **maxLength**: `number` - -#### Defined in - -node_modules/ajv/dist/types/json-schema.d.ts:17 - -___ - -### minLength - -• `Optional` **minLength**: `number` - -#### Defined in - -node_modules/ajv/dist/types/json-schema.d.ts:16 - -___ - -### pattern - -• `Optional` **pattern**: `string` - -#### Defined in - -node_modules/ajv/dist/types/json-schema.d.ts:18 diff --git a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.VSOptions.md b/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.VSOptions.md deleted file mode 100644 index de669da..0000000 --- a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.VSOptions.md +++ /dev/null @@ -1,102 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / VSOptions - -# Interface: VSOptions - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md).VSOptions - -## Hierarchy - -- [`ValueScopeOptions`](verida_verifiable_credentials._internal_.ValueScopeOptions.md) - - ↳ **`VSOptions`** - -## Table of contents - -### Properties - -- [\_n](verida_verifiable_credentials._internal_.VSOptions.md#_n) -- [es5](verida_verifiable_credentials._internal_.VSOptions.md#es5) -- [lines](verida_verifiable_credentials._internal_.VSOptions.md#lines) -- [parent](verida_verifiable_credentials._internal_.VSOptions.md#parent) -- [prefixes](verida_verifiable_credentials._internal_.VSOptions.md#prefixes) -- [scope](verida_verifiable_credentials._internal_.VSOptions.md#scope) - -## Properties - -### \_n - -• **\_n**: [`Code`](../modules/verida_verifiable_credentials._internal_.md#code) - -#### Defined in - -node_modules/ajv/dist/compile/codegen/scope.d.ts:64 - -___ - -### es5 - -• `Optional` **es5**: `boolean` - -#### Inherited from - -[ValueScopeOptions](verida_verifiable_credentials._internal_.ValueScopeOptions.md).[es5](verida_verifiable_credentials._internal_.ValueScopeOptions.md#es5) - -#### Defined in - -node_modules/ajv/dist/compile/codegen/scope.d.ts:18 - -___ - -### lines - -• `Optional` **lines**: `boolean` - -#### Inherited from - -[ValueScopeOptions](verida_verifiable_credentials._internal_.ValueScopeOptions.md).[lines](verida_verifiable_credentials._internal_.ValueScopeOptions.md#lines) - -#### Defined in - -node_modules/ajv/dist/compile/codegen/scope.d.ts:19 - -___ - -### parent - -• `Optional` **parent**: [`Scope`](../classes/verida_verifiable_credentials._internal_.Scope.md) - -#### Inherited from - -[ValueScopeOptions](verida_verifiable_credentials._internal_.ValueScopeOptions.md).[parent](verida_verifiable_credentials._internal_.ValueScopeOptions.md#parent) - -#### Defined in - -node_modules/ajv/dist/compile/codegen/scope.d.ts:14 - -___ - -### prefixes - -• `Optional` **prefixes**: `Set`<`string`\> - -#### Inherited from - -[ValueScopeOptions](verida_verifiable_credentials._internal_.ValueScopeOptions.md).[prefixes](verida_verifiable_credentials._internal_.ValueScopeOptions.md#prefixes) - -#### Defined in - -node_modules/ajv/dist/compile/codegen/scope.d.ts:13 - -___ - -### scope - -• **scope**: [`ScopeStore`](../modules/verida_verifiable_credentials._internal_.md#scopestore) - -#### Inherited from - -[ValueScopeOptions](verida_verifiable_credentials._internal_.ValueScopeOptions.md).[scope](verida_verifiable_credentials._internal_.ValueScopeOptions.md#scope) - -#### Defined in - -node_modules/ajv/dist/compile/codegen/scope.d.ts:17 diff --git a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.ValidateFunction.md b/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.ValidateFunction.md deleted file mode 100644 index c9829de..0000000 --- a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.ValidateFunction.md +++ /dev/null @@ -1,98 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / ValidateFunction - -# Interface: ValidateFunction - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md).ValidateFunction - -## Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `unknown` | - -## Hierarchy - -- **`ValidateFunction`** - - ↳ [`AsyncValidateFunction`](verida_verifiable_credentials._internal_.AsyncValidateFunction.md) - -## Callable - -### ValidateFunction - -▸ **ValidateFunction**(`data`, `dataCxt?`): data is T - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `any` | -| `dataCxt?` | [`DataValidationCxt`](verida_verifiable_credentials._internal_.DataValidationCxt.md)<`string` \| `number`\> | - -#### Returns - -data is T - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:46 - -## Table of contents - -### Properties - -- [errors](verida_verifiable_credentials._internal_.ValidateFunction.md#errors) -- [evaluated](verida_verifiable_credentials._internal_.ValidateFunction.md#evaluated) -- [schema](verida_verifiable_credentials._internal_.ValidateFunction.md#schema) -- [schemaEnv](verida_verifiable_credentials._internal_.ValidateFunction.md#schemaenv) -- [source](verida_verifiable_credentials._internal_.ValidateFunction.md#source) - -## Properties - -### errors - -• `Optional` **errors**: ``null`` \| [`ErrorObject`](verida_verifiable_credentials._internal_.ErrorObject.md)<`string`, [`Record`](../modules/verida_verifiable_credentials._internal_.md#record)<`string`, `any`\>, `unknown`\>[] - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:47 - -___ - -### evaluated - -• `Optional` **evaluated**: [`Evaluated`](verida_verifiable_credentials._internal_.Evaluated.md) - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:48 - -___ - -### schema - -• **schema**: [`AnySchema`](../modules/verida_verifiable_credentials._internal_.md#anyschema) - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:49 - -___ - -### schemaEnv - -• **schemaEnv**: [`SchemaEnv`](../classes/verida_verifiable_credentials._internal_.SchemaEnv.md) - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:50 - -___ - -### source - -• `Optional` **source**: [`SourceCode`](verida_verifiable_credentials._internal_.SourceCode.md) - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:51 diff --git a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.ValidationRules.md b/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.ValidationRules.md deleted file mode 100644 index e5a55d0..0000000 --- a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.ValidationRules.md +++ /dev/null @@ -1,65 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / ValidationRules - -# Interface: ValidationRules - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md).ValidationRules - -## Table of contents - -### Properties - -- [all](verida_verifiable_credentials._internal_.ValidationRules.md#all) -- [keywords](verida_verifiable_credentials._internal_.ValidationRules.md#keywords) -- [post](verida_verifiable_credentials._internal_.ValidationRules.md#post) -- [rules](verida_verifiable_credentials._internal_.ValidationRules.md#rules) -- [types](verida_verifiable_credentials._internal_.ValidationRules.md#types) - -## Properties - -### all - -• **all**: `Object` - -#### Defined in - -node_modules/ajv/dist/compile/rules.d.ts:11 - -___ - -### keywords - -• **keywords**: `Object` - -#### Defined in - -node_modules/ajv/dist/compile/rules.d.ts:14 - -___ - -### post - -• **post**: [`RuleGroup`](verida_verifiable_credentials._internal_.RuleGroup.md) - -#### Defined in - -node_modules/ajv/dist/compile/rules.d.ts:10 - -___ - -### rules - -• **rules**: [`RuleGroup`](verida_verifiable_credentials._internal_.RuleGroup.md)[] - -#### Defined in - -node_modules/ajv/dist/compile/rules.d.ts:9 - -___ - -### types - -• **types**: [`ValidationTypes`](../modules/verida_verifiable_credentials._internal_.md#validationtypes) - -#### Defined in - -node_modules/ajv/dist/compile/rules.d.ts:17 diff --git a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.ValueScopeOptions.md b/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.ValueScopeOptions.md deleted file mode 100644 index 92e2bca..0000000 --- a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.ValueScopeOptions.md +++ /dev/null @@ -1,81 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / ValueScopeOptions - -# Interface: ValueScopeOptions - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md).ValueScopeOptions - -## Hierarchy - -- [`ScopeOptions`](verida_verifiable_credentials._internal_.ScopeOptions.md) - - ↳ **`ValueScopeOptions`** - - ↳↳ [`VSOptions`](verida_verifiable_credentials._internal_.VSOptions.md) - -## Table of contents - -### Properties - -- [es5](verida_verifiable_credentials._internal_.ValueScopeOptions.md#es5) -- [lines](verida_verifiable_credentials._internal_.ValueScopeOptions.md#lines) -- [parent](verida_verifiable_credentials._internal_.ValueScopeOptions.md#parent) -- [prefixes](verida_verifiable_credentials._internal_.ValueScopeOptions.md#prefixes) -- [scope](verida_verifiable_credentials._internal_.ValueScopeOptions.md#scope) - -## Properties - -### es5 - -• `Optional` **es5**: `boolean` - -#### Defined in - -node_modules/ajv/dist/compile/codegen/scope.d.ts:18 - -___ - -### lines - -• `Optional` **lines**: `boolean` - -#### Defined in - -node_modules/ajv/dist/compile/codegen/scope.d.ts:19 - -___ - -### parent - -• `Optional` **parent**: [`Scope`](../classes/verida_verifiable_credentials._internal_.Scope.md) - -#### Inherited from - -[ScopeOptions](verida_verifiable_credentials._internal_.ScopeOptions.md).[parent](verida_verifiable_credentials._internal_.ScopeOptions.md#parent) - -#### Defined in - -node_modules/ajv/dist/compile/codegen/scope.d.ts:14 - -___ - -### prefixes - -• `Optional` **prefixes**: `Set`<`string`\> - -#### Inherited from - -[ScopeOptions](verida_verifiable_credentials._internal_.ScopeOptions.md).[prefixes](verida_verifiable_credentials._internal_.ScopeOptions.md#prefixes) - -#### Defined in - -node_modules/ajv/dist/compile/codegen/scope.d.ts:13 - -___ - -### scope - -• **scope**: [`ScopeStore`](../modules/verida_verifiable_credentials._internal_.md#scopestore) - -#### Defined in - -node_modules/ajv/dist/compile/codegen/scope.d.ts:17 diff --git a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.VerificationMethod.md b/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.VerificationMethod.md deleted file mode 100644 index 9f9825b..0000000 --- a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.VerificationMethod.md +++ /dev/null @@ -1,120 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / VerificationMethod - -# Interface: VerificationMethod - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md).VerificationMethod - -## Table of contents - -### Properties - -- [blockchainAccountId](verida_verifiable_credentials._internal_.VerificationMethod.md#blockchainaccountid) -- [controller](verida_verifiable_credentials._internal_.VerificationMethod.md#controller) -- [ethereumAddress](verida_verifiable_credentials._internal_.VerificationMethod.md#ethereumaddress) -- [id](verida_verifiable_credentials._internal_.VerificationMethod.md#id) -- [publicKeyBase58](verida_verifiable_credentials._internal_.VerificationMethod.md#publickeybase58) -- [publicKeyBase64](verida_verifiable_credentials._internal_.VerificationMethod.md#publickeybase64) -- [publicKeyHex](verida_verifiable_credentials._internal_.VerificationMethod.md#publickeyhex) -- [publicKeyJwk](verida_verifiable_credentials._internal_.VerificationMethod.md#publickeyjwk) -- [publicKeyMultibase](verida_verifiable_credentials._internal_.VerificationMethod.md#publickeymultibase) -- [type](verida_verifiable_credentials._internal_.VerificationMethod.md#type) - -## Properties - -### blockchainAccountId - -• `Optional` **blockchainAccountId**: `string` - -#### Defined in - -packages/did-document/node_modules/did-resolver/lib/resolver.d.ts:67 - -___ - -### controller - -• **controller**: `string` - -#### Defined in - -packages/did-document/node_modules/did-resolver/lib/resolver.d.ts:61 - -___ - -### ethereumAddress - -• `Optional` **ethereumAddress**: `string` - -#### Defined in - -packages/did-document/node_modules/did-resolver/lib/resolver.d.ts:68 - -___ - -### id - -• **id**: `string` - -#### Defined in - -packages/did-document/node_modules/did-resolver/lib/resolver.d.ts:59 - -___ - -### publicKeyBase58 - -• `Optional` **publicKeyBase58**: `string` - -#### Defined in - -packages/did-document/node_modules/did-resolver/lib/resolver.d.ts:62 - -___ - -### publicKeyBase64 - -• `Optional` **publicKeyBase64**: `string` - -#### Defined in - -packages/did-document/node_modules/did-resolver/lib/resolver.d.ts:63 - -___ - -### publicKeyHex - -• `Optional` **publicKeyHex**: `string` - -#### Defined in - -packages/did-document/node_modules/did-resolver/lib/resolver.d.ts:65 - -___ - -### publicKeyJwk - -• `Optional` **publicKeyJwk**: [`JsonWebKey`](verida_verifiable_credentials._internal_.JsonWebKey.md) - -#### Defined in - -packages/did-document/node_modules/did-resolver/lib/resolver.d.ts:64 - -___ - -### publicKeyMultibase - -• `Optional` **publicKeyMultibase**: `string` - -#### Defined in - -packages/did-document/node_modules/did-resolver/lib/resolver.d.ts:66 - -___ - -### type - -• **type**: `string` - -#### Defined in - -packages/did-document/node_modules/did-resolver/lib/resolver.d.ts:60 diff --git a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.Web3ResolverConfigurationOptions.md b/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.Web3ResolverConfigurationOptions.md deleted file mode 100644 index b94a85d..0000000 --- a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.Web3ResolverConfigurationOptions.md +++ /dev/null @@ -1,32 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / Web3ResolverConfigurationOptions - -# Interface: Web3ResolverConfigurationOptions - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md).Web3ResolverConfigurationOptions - -## Table of contents - -### Properties - -- [rpcUrl](verida_verifiable_credentials._internal_.Web3ResolverConfigurationOptions.md#rpcurl) -- [timeout](verida_verifiable_credentials._internal_.Web3ResolverConfigurationOptions.md#timeout) - -## Properties - -### rpcUrl - -• `Optional` **rpcUrl**: `string` - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:119 - -___ - -### timeout - -• `Optional` **timeout**: `number` - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:120 diff --git a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_._KeywordDef.md b/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_._KeywordDef.md deleted file mode 100644 index 9e9f1fa..0000000 --- a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_._KeywordDef.md +++ /dev/null @@ -1,161 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / \_KeywordDef - -# Interface: \_KeywordDef - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md)._KeywordDef - -## Hierarchy - -- **`_KeywordDef`** - - ↳ [`CodeKeywordDefinition`](verida_verifiable_credentials._internal_.CodeKeywordDefinition.md) - - ↳ [`FuncKeywordDefinition`](verida_verifiable_credentials._internal_.FuncKeywordDefinition.md) - -## Table of contents - -### Properties - -- [$data](verida_verifiable_credentials._internal_._KeywordDef.md#$data) -- [$dataError](verida_verifiable_credentials._internal_._KeywordDef.md#$dataerror) -- [allowUndefined](verida_verifiable_credentials._internal_._KeywordDef.md#allowundefined) -- [before](verida_verifiable_credentials._internal_._KeywordDef.md#before) -- [dependencies](verida_verifiable_credentials._internal_._KeywordDef.md#dependencies) -- [error](verida_verifiable_credentials._internal_._KeywordDef.md#error) -- [implements](verida_verifiable_credentials._internal_._KeywordDef.md#implements) -- [keyword](verida_verifiable_credentials._internal_._KeywordDef.md#keyword) -- [metaSchema](verida_verifiable_credentials._internal_._KeywordDef.md#metaschema) -- [post](verida_verifiable_credentials._internal_._KeywordDef.md#post) -- [schemaType](verida_verifiable_credentials._internal_._KeywordDef.md#schematype) -- [type](verida_verifiable_credentials._internal_._KeywordDef.md#type) -- [validateSchema](verida_verifiable_credentials._internal_._KeywordDef.md#validateschema) - -## Properties - -### $data - -• `Optional` **$data**: `boolean` - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:90 - -___ - -### $dataError - -• `Optional` **$dataError**: [`KeywordErrorDefinition`](verida_verifiable_credentials._internal_.KeywordErrorDefinition.md) - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:98 - -___ - -### allowUndefined - -• `Optional` **allowUndefined**: `boolean` - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:89 - -___ - -### before - -• `Optional` **before**: `string` - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:92 - -___ - -### dependencies - -• `Optional` **dependencies**: `string`[] - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:96 - -___ - -### error - -• `Optional` **error**: [`KeywordErrorDefinition`](verida_verifiable_credentials._internal_.KeywordErrorDefinition.md) - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:97 - -___ - -### implements - -• `Optional` **implements**: `string`[] - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:91 - -___ - -### keyword - -• **keyword**: `string` \| `string`[] - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:86 - -___ - -### metaSchema - -• `Optional` **metaSchema**: [`AnySchemaObject`](../modules/verida_verifiable_credentials._internal_.md#anyschemaobject) - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:94 - -___ - -### post - -• `Optional` **post**: `boolean` - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:93 - -___ - -### schemaType - -• `Optional` **schemaType**: ``"string"`` \| ``"number"`` \| ``"boolean"`` \| ``"object"`` \| ``"integer"`` \| ``"array"`` \| ``"null"`` \| (``"string"`` \| ``"number"`` \| ``"boolean"`` \| ``"object"`` \| ``"integer"`` \| ``"array"`` \| ``"null"``)[] - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:88 - -___ - -### type - -• `Optional` **type**: ``"string"`` \| ``"number"`` \| ``"boolean"`` \| ``"object"`` \| ``"integer"`` \| ``"array"`` \| ``"null"`` \| (``"string"`` \| ``"number"`` \| ``"boolean"`` \| ``"object"`` \| ``"integer"`` \| ``"array"`` \| ``"null"``)[] - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:87 - -___ - -### validateSchema - -• `Optional` **validateSchema**: [`AnyValidateFunction`](../modules/verida_verifiable_credentials._internal_.md#anyvalidatefunction)<`any`\> - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:95 diff --git a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_._SchemaObject.md b/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_._SchemaObject.md deleted file mode 100644 index 87ad81f..0000000 --- a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_._SchemaObject.md +++ /dev/null @@ -1,55 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / \_SchemaObject - -# Interface: \_SchemaObject - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md)._SchemaObject - -## Hierarchy - -- **`_SchemaObject`** - - ↳ [`AsyncSchema`](verida_verifiable_credentials._internal_.AsyncSchema.md) - - ↳ [`SchemaObject`](verida_verifiable_credentials._internal_.SchemaObject.md) - -## Indexable - -▪ [x: `string`]: `any` - -## Table of contents - -### Properties - -- [$id](verida_verifiable_credentials._internal_._SchemaObject.md#$id) -- [$schema](verida_verifiable_credentials._internal_._SchemaObject.md#$schema) -- [id](verida_verifiable_credentials._internal_._SchemaObject.md#id) - -## Properties - -### $id - -• `Optional` **$id**: `string` - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:8 - -___ - -### $schema - -• `Optional` **$schema**: `string` - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:9 - -___ - -### id - -• `Optional` **id**: `string` - -#### Defined in - -node_modules/ajv/dist/types/index.d.ts:7 diff --git a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.credentialDateOptions.md b/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.credentialDateOptions.md deleted file mode 100644 index 34e6223..0000000 --- a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.credentialDateOptions.md +++ /dev/null @@ -1,32 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / credentialDateOptions - -# Interface: credentialDateOptions - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md).credentialDateOptions - -## Table of contents - -### Properties - -- [expirationDate](verida_verifiable_credentials._internal_.credentialDateOptions.md#expirationdate) -- [issuanceDate](verida_verifiable_credentials._internal_.credentialDateOptions.md#issuancedate) - -## Properties - -### expirationDate - -• `Optional` **expirationDate**: `string` - -#### Defined in - -[packages/verifiable-credentials/src/interfaces.ts:4](https://github.com/verida/verida-js/blob/c03b336/packages/verifiable-credentials/src/interfaces.ts#L4) - -___ - -### issuanceDate - -• `Optional` **issuanceDate**: `string` - -#### Defined in - -[packages/verifiable-credentials/src/interfaces.ts:5](https://github.com/verida/verida-js/blob/c03b336/packages/verifiable-credentials/src/interfaces.ts#L5) diff --git a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.default-7.md b/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.default-7.md deleted file mode 100644 index 49de745..0000000 --- a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.default-7.md +++ /dev/null @@ -1,184 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / default - -# Interface: default - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md).default - -Interface Messaging - -## Table of contents - -### Methods - -- [connectAccount](verida_verifiable_credentials._internal_.default-7.md#connectaccount) -- [getInbox](verida_verifiable_credentials._internal_.default-7.md#getinbox) -- [getMessages](verida_verifiable_credentials._internal_.default-7.md#getmessages) -- [init](verida_verifiable_credentials._internal_.default-7.md#init) -- [offMessage](verida_verifiable_credentials._internal_.default-7.md#offmessage) -- [onMessage](verida_verifiable_credentials._internal_.default-7.md#onmessage) -- [send](verida_verifiable_credentials._internal_.default-7.md#send) - -## Methods - -### connectAccount - -▸ **connectAccount**(`account`): `Promise`<`void`\> - -Connect an account to this messaging instance. - -Used internally. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `account` | [`default`](../classes/verida_verifiable_credentials._internal_.default.md) | Account | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -packages/client-ts/dist/context/messaging.d.ts:66 - -___ - -### getInbox - -▸ **getInbox**(): `Promise`<`any`\> - -Get the underlying inbox instance specific for the message storage type. - -#### Returns - -`Promise`<`any`\> - -any Currently returns a `Datastore` instance. - -#### Defined in - -packages/client-ts/dist/context/messaging.d.ts:58 - -___ - -### getMessages - -▸ **getMessages**(`filter?`, `options?`): `Promise`<`any`\> - -Get messages from this inbox. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `filter?` | `object` | object An optional datastore filter | -| `options?` | `any` | object An optional list of datastore options | - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -packages/client-ts/dist/context/messaging.d.ts:52 - -___ - -### init - -▸ **init**(): `Promise`<`void`\> - -Initialize messaging for the connected user - -(ie; create an empty database or anything else required to start receiving messages) - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -packages/client-ts/dist/context/messaging.d.ts:13 - -___ - -### offMessage - -▸ **offMessage**(`callback`): `Promise`<`void`\> - -Unregister a callback to fire when a new message is received - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `callback` | `any` | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -packages/client-ts/dist/context/messaging.d.ts:45 - -___ - -### onMessage - -▸ **onMessage**(`callback`): `Promise`<[`EventEmitter`](verida_verifiable_credentials._internal_.EventEmitter.md)\> - -Register a callback to fire when a new message is received from another DID or application. - -Usage: - -``` -// configure the listener -const callback = (msg) => { console.log(msg) } -const emitter = messaging.onMessage(callback) -``` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `callback` | `any` | - -#### Returns - -`Promise`<[`EventEmitter`](verida_verifiable_credentials._internal_.EventEmitter.md)\> - -Returns an event emitter - -#### Defined in - -packages/client-ts/dist/context/messaging.d.ts:39 - -___ - -### send - -▸ **send**(`did`, `type`, `data`, `message`, `config`): `Promise`<``null`` \| `object`\> - -Send a message to another DID on the network. - -**`todo:`** Link to documentation - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `did` | `string` | string DID to receive the message | -| `type` | `string` | string Type of inbox message (See https://github.com/verida/schemas/tree/master/schemas/inbox/type). ie: `dataSend` | -| `data` | `object` | object Data to send. Structure of data will depend on the inbox message type. | -| `message` | `string` | string A human readable message that will be displayed to the user upon receipt of the message. Similar to an email subject. | -| `config` | [`MessageSendConfig`](verida_verifiable_credentials._internal_.MessageSendConfig.md) | object Optional configuration. | - -#### Returns - -`Promise`<``null`` \| `object`\> - -#### Defined in - -packages/client-ts/dist/context/messaging.d.ts:25 diff --git a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.default-8.md b/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.default-8.md deleted file mode 100644 index 725419d..0000000 --- a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.default-8.md +++ /dev/null @@ -1,71 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / default - -# Interface: default - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md).default - -Interface for notifications - -## Table of contents - -### Methods - -- [getErrors](verida_verifiable_credentials._internal_.default-8.md#geterrors) -- [init](verida_verifiable_credentials._internal_.default-8.md#init) -- [ping](verida_verifiable_credentials._internal_.default-8.md#ping) - -## Methods - -### getErrors - -▸ **getErrors**(): `string`[] - -#### Returns - -`string`[] - -#### Defined in - -packages/client-ts/dist/context/notification.d.ts:16 - -___ - -### init - -▸ **init**(): `Promise`<`void`\> - -Initialize notifications for the connected user - -(ie; connect to a notification server) - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -packages/client-ts/dist/context/notification.d.ts:10 - -___ - -### ping - -▸ **ping**(`recipientContextName`, `didToNotify`): `Promise`<`boolean`\> - -Ping a notification server to fetch new messages -TODO: Change this - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `recipientContextName` | `string` | -| `didToNotify` | `any` | - -#### Returns - -`Promise`<`boolean`\> - -#### Defined in - -packages/client-ts/dist/context/notification.d.ts:15 diff --git a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.default-9.md b/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.default-9.md deleted file mode 100644 index 051c893..0000000 --- a/docs/api/verida-js/interfaces/verida_verifiable_credentials._internal_.default-9.md +++ /dev/null @@ -1,219 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md) / [](../modules/verida_verifiable_credentials._internal_.md) / default - -# Interface: default - -[@verida/verifiable-credentials](../modules/verida_verifiable_credentials.md).[](../modules/verida_verifiable_credentials._internal_.md).default - -Interface for any database returned from a storage engine - -## Table of contents - -### Methods - -- [changes](verida_verifiable_credentials._internal_.default-9.md#changes) -- [delete](verida_verifiable_credentials._internal_.default-9.md#delete) -- [deleteAll](verida_verifiable_credentials._internal_.default-9.md#deleteall) -- [get](verida_verifiable_credentials._internal_.default-9.md#get) -- [getDb](verida_verifiable_credentials._internal_.default-9.md#getdb) -- [getMany](verida_verifiable_credentials._internal_.default-9.md#getmany) -- [info](verida_verifiable_credentials._internal_.default-9.md#info) -- [init](verida_verifiable_credentials._internal_.default-9.md#init) -- [registryEntry](verida_verifiable_credentials._internal_.default-9.md#registryentry) -- [save](verida_verifiable_credentials._internal_.default-9.md#save) -- [updateUsers](verida_verifiable_credentials._internal_.default-9.md#updateusers) - -## Methods - -### changes - -▸ **changes**(`cb`, `options`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `cb` | `Function` | -| `options` | `any` | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -packages/client-ts/dist/context/database.d.ts:11 - -___ - -### delete - -▸ **delete**(`doc`, `options`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `doc` | `any` | -| `options` | `any` | - -#### Returns - -`Promise`<`boolean`\> - -#### Defined in - -packages/client-ts/dist/context/database.d.ts:9 - -___ - -### deleteAll - -▸ **deleteAll**(): `Promise`<`void`\> - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -packages/client-ts/dist/context/database.d.ts:10 - -___ - -### get - -▸ **get**(`docId`, `options`): `Promise`<`undefined` \| `object`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `docId` | `any` | -| `options` | `any` | - -#### Returns - -`Promise`<`undefined` \| `object`\> - -#### Defined in - -packages/client-ts/dist/context/database.d.ts:8 - -___ - -### getDb - -▸ **getDb**(): `Promise`<`any`\> - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -packages/client-ts/dist/context/database.d.ts:13 - -___ - -### getMany - -▸ **getMany**(`filter`, `options`): `Promise`<`undefined` \| `object`[]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `filter` | `any` | -| `options` | `any` | - -#### Returns - -`Promise`<`undefined` \| `object`[]\> - -#### Defined in - -packages/client-ts/dist/context/database.d.ts:7 - -___ - -### info - -▸ **info**(): `Promise`<`any`\> - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -packages/client-ts/dist/context/database.d.ts:15 - -___ - -### init - -▸ **init**(): `Promise`<`void`\> - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -packages/client-ts/dist/context/database.d.ts:14 - -___ - -### registryEntry - -▸ **registryEntry**(): `Promise`<[`DbRegistryEntry`](verida_verifiable_credentials._internal_.DbRegistryEntry.md)\> - -#### Returns - -`Promise`<[`DbRegistryEntry`](verida_verifiable_credentials._internal_.DbRegistryEntry.md)\> - -#### Defined in - -packages/client-ts/dist/context/database.d.ts:16 - -___ - -### save - -▸ **save**(`data`, `options`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `any` | -| `options` | `any` | - -#### Returns - -`Promise`<`boolean`\> - -#### Defined in - -packages/client-ts/dist/context/database.d.ts:6 - -___ - -### updateUsers - -▸ **updateUsers**(`readList`, `writeList`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `readList` | `string`[] | -| `writeList` | `string`[] | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -packages/client-ts/dist/context/database.d.ts:12 diff --git a/docs/api/verida-js/interfaces/verida_web3._internal_.ArrayLike.md b/docs/api/verida-js/interfaces/verida_web3._internal_.ArrayLike.md deleted file mode 100644 index fadfca4..0000000 --- a/docs/api/verida-js/interfaces/verida_web3._internal_.ArrayLike.md +++ /dev/null @@ -1,31 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web3](../modules/verida_web3.md) / [](../modules/verida_web3._internal_.md) / ArrayLike - -# Interface: ArrayLike - -[@verida/web3](../modules/verida_web3.md).[](../modules/verida_web3._internal_.md).ArrayLike - -## Type parameters - -| Name | -| :------ | -| `T` | - -## Indexable - -▪ [n: `number`]: `T` - -## Table of contents - -### Properties - -- [length](verida_web3._internal_.ArrayLike.md#length) - -## Properties - -### length - -• `Readonly` **length**: `number` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1464 diff --git a/docs/api/verida-js/interfaces/verida_web3._internal_.Block.md b/docs/api/verida-js/interfaces/verida_web3._internal_.Block.md deleted file mode 100644 index a2687e3..0000000 --- a/docs/api/verida-js/interfaces/verida_web3._internal_.Block.md +++ /dev/null @@ -1,207 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web3](../modules/verida_web3.md) / [](../modules/verida_web3._internal_.md) / Block - -# Interface: Block - -[@verida/web3](../modules/verida_web3.md).[](../modules/verida_web3._internal_.md).Block - -## Hierarchy - -- [`_Block`](verida_web3._internal_._Block.md) - - ↳ **`Block`** - -## Table of contents - -### Properties - -- [\_difficulty](verida_web3._internal_.Block.md#_difficulty) -- [baseFeePerGas](verida_web3._internal_.Block.md#basefeepergas) -- [difficulty](verida_web3._internal_.Block.md#difficulty) -- [extraData](verida_web3._internal_.Block.md#extradata) -- [gasLimit](verida_web3._internal_.Block.md#gaslimit) -- [gasUsed](verida_web3._internal_.Block.md#gasused) -- [hash](verida_web3._internal_.Block.md#hash) -- [miner](verida_web3._internal_.Block.md#miner) -- [nonce](verida_web3._internal_.Block.md#nonce) -- [number](verida_web3._internal_.Block.md#number) -- [parentHash](verida_web3._internal_.Block.md#parenthash) -- [timestamp](verida_web3._internal_.Block.md#timestamp) -- [transactions](verida_web3._internal_.Block.md#transactions) - -## Properties - -### \_difficulty - -• **\_difficulty**: [`BigNumber`](../classes/verida_web3._internal_.BigNumber.md) - -#### Inherited from - -[_Block](verida_web3._internal_._Block.md).[_difficulty](verida_web3._internal_._Block.md#_difficulty) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:41 - -___ - -### baseFeePerGas - -• `Optional` **baseFeePerGas**: ``null`` \| [`BigNumber`](../classes/verida_web3._internal_.BigNumber.md) - -#### Inherited from - -[_Block](verida_web3._internal_._Block.md).[baseFeePerGas](verida_web3._internal_._Block.md#basefeepergas) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:46 - -___ - -### difficulty - -• **difficulty**: `number` - -#### Inherited from - -[_Block](verida_web3._internal_._Block.md).[difficulty](verida_web3._internal_._Block.md#difficulty) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:40 - -___ - -### extraData - -• **extraData**: `string` - -#### Inherited from - -[_Block](verida_web3._internal_._Block.md).[extraData](verida_web3._internal_._Block.md#extradata) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:45 - -___ - -### gasLimit - -• **gasLimit**: [`BigNumber`](../classes/verida_web3._internal_.BigNumber.md) - -#### Inherited from - -[_Block](verida_web3._internal_._Block.md).[gasLimit](verida_web3._internal_._Block.md#gaslimit) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:42 - -___ - -### gasUsed - -• **gasUsed**: [`BigNumber`](../classes/verida_web3._internal_.BigNumber.md) - -#### Inherited from - -[_Block](verida_web3._internal_._Block.md).[gasUsed](verida_web3._internal_._Block.md#gasused) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:43 - -___ - -### hash - -• **hash**: `string` - -#### Inherited from - -[_Block](verida_web3._internal_._Block.md).[hash](verida_web3._internal_._Block.md#hash) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:35 - -___ - -### miner - -• **miner**: `string` - -#### Inherited from - -[_Block](verida_web3._internal_._Block.md).[miner](verida_web3._internal_._Block.md#miner) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:44 - -___ - -### nonce - -• **nonce**: `string` - -#### Inherited from - -[_Block](verida_web3._internal_._Block.md).[nonce](verida_web3._internal_._Block.md#nonce) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:39 - -___ - -### number - -• **number**: `number` - -#### Inherited from - -[_Block](verida_web3._internal_._Block.md).[number](verida_web3._internal_._Block.md#number) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:37 - -___ - -### parentHash - -• **parentHash**: `string` - -#### Inherited from - -[_Block](verida_web3._internal_._Block.md).[parentHash](verida_web3._internal_._Block.md#parenthash) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:36 - -___ - -### timestamp - -• **timestamp**: `number` - -#### Inherited from - -[_Block](verida_web3._internal_._Block.md).[timestamp](verida_web3._internal_._Block.md#timestamp) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:38 - -___ - -### transactions - -• **transactions**: `string`[] - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:49 diff --git a/docs/api/verida-js/interfaces/verida_web3._internal_.BlockWithTransactions.md b/docs/api/verida-js/interfaces/verida_web3._internal_.BlockWithTransactions.md deleted file mode 100644 index 102a3ff..0000000 --- a/docs/api/verida-js/interfaces/verida_web3._internal_.BlockWithTransactions.md +++ /dev/null @@ -1,207 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web3](../modules/verida_web3.md) / [](../modules/verida_web3._internal_.md) / BlockWithTransactions - -# Interface: BlockWithTransactions - -[@verida/web3](../modules/verida_web3.md).[](../modules/verida_web3._internal_.md).BlockWithTransactions - -## Hierarchy - -- [`_Block`](verida_web3._internal_._Block.md) - - ↳ **`BlockWithTransactions`** - -## Table of contents - -### Properties - -- [\_difficulty](verida_web3._internal_.BlockWithTransactions.md#_difficulty) -- [baseFeePerGas](verida_web3._internal_.BlockWithTransactions.md#basefeepergas) -- [difficulty](verida_web3._internal_.BlockWithTransactions.md#difficulty) -- [extraData](verida_web3._internal_.BlockWithTransactions.md#extradata) -- [gasLimit](verida_web3._internal_.BlockWithTransactions.md#gaslimit) -- [gasUsed](verida_web3._internal_.BlockWithTransactions.md#gasused) -- [hash](verida_web3._internal_.BlockWithTransactions.md#hash) -- [miner](verida_web3._internal_.BlockWithTransactions.md#miner) -- [nonce](verida_web3._internal_.BlockWithTransactions.md#nonce) -- [number](verida_web3._internal_.BlockWithTransactions.md#number) -- [parentHash](verida_web3._internal_.BlockWithTransactions.md#parenthash) -- [timestamp](verida_web3._internal_.BlockWithTransactions.md#timestamp) -- [transactions](verida_web3._internal_.BlockWithTransactions.md#transactions) - -## Properties - -### \_difficulty - -• **\_difficulty**: [`BigNumber`](../classes/verida_web3._internal_.BigNumber.md) - -#### Inherited from - -[_Block](verida_web3._internal_._Block.md).[_difficulty](verida_web3._internal_._Block.md#_difficulty) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:41 - -___ - -### baseFeePerGas - -• `Optional` **baseFeePerGas**: ``null`` \| [`BigNumber`](../classes/verida_web3._internal_.BigNumber.md) - -#### Inherited from - -[_Block](verida_web3._internal_._Block.md).[baseFeePerGas](verida_web3._internal_._Block.md#basefeepergas) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:46 - -___ - -### difficulty - -• **difficulty**: `number` - -#### Inherited from - -[_Block](verida_web3._internal_._Block.md).[difficulty](verida_web3._internal_._Block.md#difficulty) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:40 - -___ - -### extraData - -• **extraData**: `string` - -#### Inherited from - -[_Block](verida_web3._internal_._Block.md).[extraData](verida_web3._internal_._Block.md#extradata) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:45 - -___ - -### gasLimit - -• **gasLimit**: [`BigNumber`](../classes/verida_web3._internal_.BigNumber.md) - -#### Inherited from - -[_Block](verida_web3._internal_._Block.md).[gasLimit](verida_web3._internal_._Block.md#gaslimit) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:42 - -___ - -### gasUsed - -• **gasUsed**: [`BigNumber`](../classes/verida_web3._internal_.BigNumber.md) - -#### Inherited from - -[_Block](verida_web3._internal_._Block.md).[gasUsed](verida_web3._internal_._Block.md#gasused) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:43 - -___ - -### hash - -• **hash**: `string` - -#### Inherited from - -[_Block](verida_web3._internal_._Block.md).[hash](verida_web3._internal_._Block.md#hash) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:35 - -___ - -### miner - -• **miner**: `string` - -#### Inherited from - -[_Block](verida_web3._internal_._Block.md).[miner](verida_web3._internal_._Block.md#miner) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:44 - -___ - -### nonce - -• **nonce**: `string` - -#### Inherited from - -[_Block](verida_web3._internal_._Block.md).[nonce](verida_web3._internal_._Block.md#nonce) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:39 - -___ - -### number - -• **number**: `number` - -#### Inherited from - -[_Block](verida_web3._internal_._Block.md).[number](verida_web3._internal_._Block.md#number) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:37 - -___ - -### parentHash - -• **parentHash**: `string` - -#### Inherited from - -[_Block](verida_web3._internal_._Block.md).[parentHash](verida_web3._internal_._Block.md#parenthash) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:36 - -___ - -### timestamp - -• **timestamp**: `number` - -#### Inherited from - -[_Block](verida_web3._internal_._Block.md).[timestamp](verida_web3._internal_._Block.md#timestamp) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:38 - -___ - -### transactions - -• **transactions**: [`TransactionResponse`](verida_web3._internal_.TransactionResponse.md)[] - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:52 diff --git a/docs/api/verida-js/interfaces/verida_web3._internal_.ConcatArray.md b/docs/api/verida-js/interfaces/verida_web3._internal_.ConcatArray.md deleted file mode 100644 index f66a17b..0000000 --- a/docs/api/verida-js/interfaces/verida_web3._internal_.ConcatArray.md +++ /dev/null @@ -1,77 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web3](../modules/verida_web3.md) / [](../modules/verida_web3._internal_.md) / ConcatArray - -# Interface: ConcatArray - -[@verida/web3](../modules/verida_web3.md).[](../modules/verida_web3._internal_.md).ConcatArray - -## Type parameters - -| Name | -| :------ | -| `T` | - -## Indexable - -▪ [n: `number`]: `T` - -## Table of contents - -### Properties - -- [length](verida_web3._internal_.ConcatArray.md#length) - -### Methods - -- [join](verida_web3._internal_.ConcatArray.md#join) -- [slice](verida_web3._internal_.ConcatArray.md#slice) - -## Properties - -### length - -• `Readonly` **length**: `number` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1214 - -## Methods - -### join - -▸ **join**(`separator?`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `separator?` | `string` | - -#### Returns - -`string` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1216 - -___ - -### slice - -▸ **slice**(`start?`, `end?`): `T`[] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `start?` | `number` | -| `end?` | `number` | - -#### Returns - -`T`[] - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1217 diff --git a/docs/api/verida-js/interfaces/verida_web3._internal_.Error.md b/docs/api/verida-js/interfaces/verida_web3._internal_.Error.md deleted file mode 100644 index 3f6b2a4..0000000 --- a/docs/api/verida-js/interfaces/verida_web3._internal_.Error.md +++ /dev/null @@ -1,43 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web3](../modules/verida_web3.md) / [](../modules/verida_web3._internal_.md) / Error - -# Interface: Error - -[@verida/web3](../modules/verida_web3.md).[](../modules/verida_web3._internal_.md).Error - -## Table of contents - -### Properties - -- [message](verida_web3._internal_.Error.md#message) -- [name](verida_web3._internal_.Error.md#name) -- [stack](verida_web3._internal_.Error.md#stack) - -## Properties - -### message - -• **message**: `string` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:974 - -___ - -### name - -• **name**: `string` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:973 - -___ - -### stack - -• `Optional` **stack**: `string` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:975 diff --git a/docs/api/verida-js/interfaces/verida_web3._internal_.Event.md b/docs/api/verida-js/interfaces/verida_web3._internal_.Event.md deleted file mode 100644 index 0fd6685..0000000 --- a/docs/api/verida-js/interfaces/verida_web3._internal_.Event.md +++ /dev/null @@ -1,280 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web3](../modules/verida_web3.md) / [](../modules/verida_web3._internal_.md) / Event - -# Interface: Event - -[@verida/web3](../modules/verida_web3.md).[](../modules/verida_web3._internal_.md).Event - -## Hierarchy - -- [`Log`](verida_web3._internal_.Log.md) - - ↳ **`Event`** - -## Table of contents - -### Properties - -- [address](verida_web3._internal_.Event.md#address) -- [args](verida_web3._internal_.Event.md#args) -- [blockHash](verida_web3._internal_.Event.md#blockhash) -- [blockNumber](verida_web3._internal_.Event.md#blocknumber) -- [data](verida_web3._internal_.Event.md#data) -- [decodeError](verida_web3._internal_.Event.md#decodeerror) -- [event](verida_web3._internal_.Event.md#event) -- [eventSignature](verida_web3._internal_.Event.md#eventsignature) -- [logIndex](verida_web3._internal_.Event.md#logindex) -- [removed](verida_web3._internal_.Event.md#removed) -- [topics](verida_web3._internal_.Event.md#topics) -- [transactionHash](verida_web3._internal_.Event.md#transactionhash) -- [transactionIndex](verida_web3._internal_.Event.md#transactionindex) - -### Methods - -- [decode](verida_web3._internal_.Event.md#decode) -- [getBlock](verida_web3._internal_.Event.md#getblock) -- [getTransaction](verida_web3._internal_.Event.md#gettransaction) -- [getTransactionReceipt](verida_web3._internal_.Event.md#gettransactionreceipt) -- [removeListener](verida_web3._internal_.Event.md#removelistener) - -## Properties - -### address - -• **address**: `string` - -#### Inherited from - -[Log](verida_web3._internal_.Log.md).[address](verida_web3._internal_.Log.md#address) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:59 - -___ - -### args - -• `Optional` **args**: [`Result`](verida_web3._internal_.Result.md) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:49 - -___ - -### blockHash - -• **blockHash**: `string` - -#### Inherited from - -[Log](verida_web3._internal_.Log.md).[blockHash](verida_web3._internal_.Log.md#blockhash) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:56 - -___ - -### blockNumber - -• **blockNumber**: `number` - -#### Inherited from - -[Log](verida_web3._internal_.Log.md).[blockNumber](verida_web3._internal_.Log.md#blocknumber) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:55 - -___ - -### data - -• **data**: `string` - -#### Inherited from - -[Log](verida_web3._internal_.Log.md).[data](verida_web3._internal_.Log.md#data) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:60 - -___ - -### decodeError - -• `Optional` **decodeError**: [`Error`](../modules/verida_web3._internal_.md#error) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:50 - -___ - -### event - -• `Optional` **event**: `string` - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:47 - -___ - -### eventSignature - -• `Optional` **eventSignature**: `string` - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:48 - -___ - -### logIndex - -• **logIndex**: `number` - -#### Inherited from - -[Log](verida_web3._internal_.Log.md).[logIndex](verida_web3._internal_.Log.md#logindex) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:63 - -___ - -### removed - -• **removed**: `boolean` - -#### Inherited from - -[Log](verida_web3._internal_.Log.md).[removed](verida_web3._internal_.Log.md#removed) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:58 - -___ - -### topics - -• **topics**: `string`[] - -#### Inherited from - -[Log](verida_web3._internal_.Log.md).[topics](verida_web3._internal_.Log.md#topics) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:61 - -___ - -### transactionHash - -• **transactionHash**: `string` - -#### Inherited from - -[Log](verida_web3._internal_.Log.md).[transactionHash](verida_web3._internal_.Log.md#transactionhash) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:62 - -___ - -### transactionIndex - -• **transactionIndex**: `number` - -#### Inherited from - -[Log](verida_web3._internal_.Log.md).[transactionIndex](verida_web3._internal_.Log.md#transactionindex) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:57 - -## Methods - -### decode - -▸ `Optional` **decode**(`data`, `topics?`): `any` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `string` | -| `topics?` | `string`[] | - -#### Returns - -`any` - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:51 - -___ - -### getBlock - -▸ **getBlock**(): `Promise`<[`Block`](verida_web3._internal_.Block.md)\> - -#### Returns - -`Promise`<[`Block`](verida_web3._internal_.Block.md)\> - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:53 - -___ - -### getTransaction - -▸ **getTransaction**(): `Promise`<[`TransactionResponse`](verida_web3._internal_.TransactionResponse.md)\> - -#### Returns - -`Promise`<[`TransactionResponse`](verida_web3._internal_.TransactionResponse.md)\> - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:54 - -___ - -### getTransactionReceipt - -▸ **getTransactionReceipt**(): `Promise`<[`TransactionReceipt`](verida_web3._internal_.TransactionReceipt.md)\> - -#### Returns - -`Promise`<[`TransactionReceipt`](verida_web3._internal_.TransactionReceipt.md)\> - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:55 - -___ - -### removeListener - -▸ **removeListener**(): `void` - -#### Returns - -`void` - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:52 diff --git a/docs/api/verida-js/interfaces/verida_web3._internal_.EventFilter.md b/docs/api/verida-js/interfaces/verida_web3._internal_.EventFilter.md deleted file mode 100644 index 5e1f1ee..0000000 --- a/docs/api/verida-js/interfaces/verida_web3._internal_.EventFilter.md +++ /dev/null @@ -1,38 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web3](../modules/verida_web3.md) / [](../modules/verida_web3._internal_.md) / EventFilter - -# Interface: EventFilter - -[@verida/web3](../modules/verida_web3.md).[](../modules/verida_web3._internal_.md).EventFilter - -## Hierarchy - -- **`EventFilter`** - - ↳ [`Filter`](verida_web3._internal_.Filter.md) - -## Table of contents - -### Properties - -- [address](verida_web3._internal_.EventFilter.md#address) -- [topics](verida_web3._internal_.EventFilter.md#topics) - -## Properties - -### address - -• `Optional` **address**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:91 - -___ - -### topics - -• `Optional` **topics**: (``null`` \| `string` \| `string`[])[] - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:92 diff --git a/docs/api/verida-js/interfaces/verida_web3._internal_.FeeData.md b/docs/api/verida-js/interfaces/verida_web3._internal_.FeeData.md deleted file mode 100644 index e689f87..0000000 --- a/docs/api/verida-js/interfaces/verida_web3._internal_.FeeData.md +++ /dev/null @@ -1,54 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web3](../modules/verida_web3.md) / [](../modules/verida_web3._internal_.md) / FeeData - -# Interface: FeeData - -[@verida/web3](../modules/verida_web3.md).[](../modules/verida_web3._internal_.md).FeeData - -## Table of contents - -### Properties - -- [gasPrice](verida_web3._internal_.FeeData.md#gasprice) -- [lastBaseFeePerGas](verida_web3._internal_.FeeData.md#lastbasefeepergas) -- [maxFeePerGas](verida_web3._internal_.FeeData.md#maxfeepergas) -- [maxPriorityFeePerGas](verida_web3._internal_.FeeData.md#maxpriorityfeepergas) - -## Properties - -### gasPrice - -• **gasPrice**: ``null`` \| [`BigNumber`](../classes/verida_web3._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:88 - -___ - -### lastBaseFeePerGas - -• **lastBaseFeePerGas**: ``null`` \| [`BigNumber`](../classes/verida_web3._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:85 - -___ - -### maxFeePerGas - -• **maxFeePerGas**: ``null`` \| [`BigNumber`](../classes/verida_web3._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:86 - -___ - -### maxPriorityFeePerGas - -• **maxPriorityFeePerGas**: ``null`` \| [`BigNumber`](../classes/verida_web3._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:87 diff --git a/docs/api/verida-js/interfaces/verida_web3._internal_.Filter.md b/docs/api/verida-js/interfaces/verida_web3._internal_.Filter.md deleted file mode 100644 index e2a9a1e..0000000 --- a/docs/api/verida-js/interfaces/verida_web3._internal_.Filter.md +++ /dev/null @@ -1,68 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web3](../modules/verida_web3.md) / [](../modules/verida_web3._internal_.md) / Filter - -# Interface: Filter - -[@verida/web3](../modules/verida_web3.md).[](../modules/verida_web3._internal_.md).Filter - -## Hierarchy - -- [`EventFilter`](verida_web3._internal_.EventFilter.md) - - ↳ **`Filter`** - -## Table of contents - -### Properties - -- [address](verida_web3._internal_.Filter.md#address) -- [fromBlock](verida_web3._internal_.Filter.md#fromblock) -- [toBlock](verida_web3._internal_.Filter.md#toblock) -- [topics](verida_web3._internal_.Filter.md#topics) - -## Properties - -### address - -• `Optional` **address**: `string` - -#### Inherited from - -[EventFilter](verida_web3._internal_.EventFilter.md).[address](verida_web3._internal_.EventFilter.md#address) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:91 - -___ - -### fromBlock - -• `Optional` **fromBlock**: [`BlockTag`](../modules/verida_web3._internal_.md#blocktag) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:95 - -___ - -### toBlock - -• `Optional` **toBlock**: [`BlockTag`](../modules/verida_web3._internal_.md#blocktag) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:96 - -___ - -### topics - -• `Optional` **topics**: (``null`` \| `string` \| `string`[])[] - -#### Inherited from - -[EventFilter](verida_web3._internal_.EventFilter.md).[topics](verida_web3._internal_.EventFilter.md#topics) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:92 diff --git a/docs/api/verida-js/interfaces/verida_web3._internal_.Hexable.md b/docs/api/verida-js/interfaces/verida_web3._internal_.Hexable.md deleted file mode 100644 index bf774c8..0000000 --- a/docs/api/verida-js/interfaces/verida_web3._internal_.Hexable.md +++ /dev/null @@ -1,29 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web3](../modules/verida_web3.md) / [](../modules/verida_web3._internal_.md) / Hexable - -# Interface: Hexable - -[@verida/web3](../modules/verida_web3.md).[](../modules/verida_web3._internal_.md).Hexable - -## Implemented by - -- [`BigNumber`](../classes/verida_web3._internal_.BigNumber.md) - -## Table of contents - -### Methods - -- [toHexString](verida_web3._internal_.Hexable.md#tohexstring) - -## Methods - -### toHexString - -▸ **toHexString**(): `string` - -#### Returns - -`string` - -#### Defined in - -node_modules/@ethersproject/bytes/lib/index.d.ts:8 diff --git a/docs/api/verida-js/interfaces/verida_web3._internal_.IterableIterator.md b/docs/api/verida-js/interfaces/verida_web3._internal_.IterableIterator.md deleted file mode 100644 index eb7ff02..0000000 --- a/docs/api/verida-js/interfaces/verida_web3._internal_.IterableIterator.md +++ /dev/null @@ -1,112 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web3](../modules/verida_web3.md) / [](../modules/verida_web3._internal_.md) / IterableIterator - -# Interface: IterableIterator - -[@verida/web3](../modules/verida_web3.md).[](../modules/verida_web3._internal_.md).IterableIterator - -## Type parameters - -| Name | -| :------ | -| `T` | - -## Hierarchy - -- [`Iterator`](verida_web3._internal_.Iterator.md)<`T`\> - - ↳ **`IterableIterator`** - -## Table of contents - -### Methods - -- [[iterator]](verida_web3._internal_.IterableIterator.md#[iterator]) -- [next](verida_web3._internal_.IterableIterator.md#next) -- [return](verida_web3._internal_.IterableIterator.md#return) -- [throw](verida_web3._internal_.IterableIterator.md#throw) - -## Methods - -### [iterator] - -▸ **[iterator]**(): [`IterableIterator`](verida_web3._internal_.IterableIterator.md)<`T`\> - -#### Returns - -[`IterableIterator`](verida_web3._internal_.IterableIterator.md)<`T`\> - -#### Defined in - -node_modules/typescript/lib/lib.es2015.iterable.d.ts:55 - -___ - -### next - -▸ **next**(...`args`): [`IteratorResult`](../modules/verida_web3._internal_.md#iteratorresult)<`T`, `any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `...args` | [] \| [`undefined`] | - -#### Returns - -[`IteratorResult`](../modules/verida_web3._internal_.md#iteratorresult)<`T`, `any`\> - -#### Inherited from - -[Iterator](verida_web3._internal_.Iterator.md).[next](verida_web3._internal_.Iterator.md#next) - -#### Defined in - -node_modules/typescript/lib/lib.es2015.iterable.d.ts:45 - -___ - -### return - -▸ `Optional` **return**(`value?`): [`IteratorResult`](../modules/verida_web3._internal_.md#iteratorresult)<`T`, `any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value?` | `any` | - -#### Returns - -[`IteratorResult`](../modules/verida_web3._internal_.md#iteratorresult)<`T`, `any`\> - -#### Inherited from - -[Iterator](verida_web3._internal_.Iterator.md).[return](verida_web3._internal_.Iterator.md#return) - -#### Defined in - -node_modules/typescript/lib/lib.es2015.iterable.d.ts:46 - -___ - -### throw - -▸ `Optional` **throw**(`e?`): [`IteratorResult`](../modules/verida_web3._internal_.md#iteratorresult)<`T`, `any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `e?` | `any` | - -#### Returns - -[`IteratorResult`](../modules/verida_web3._internal_.md#iteratorresult)<`T`, `any`\> - -#### Inherited from - -[Iterator](verida_web3._internal_.Iterator.md).[throw](verida_web3._internal_.Iterator.md#throw) - -#### Defined in - -node_modules/typescript/lib/lib.es2015.iterable.d.ts:47 diff --git a/docs/api/verida-js/interfaces/verida_web3._internal_.Iterator.md b/docs/api/verida-js/interfaces/verida_web3._internal_.Iterator.md deleted file mode 100644 index 50d2e62..0000000 --- a/docs/api/verida-js/interfaces/verida_web3._internal_.Iterator.md +++ /dev/null @@ -1,87 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web3](../modules/verida_web3.md) / [](../modules/verida_web3._internal_.md) / Iterator - -# Interface: Iterator - -[@verida/web3](../modules/verida_web3.md).[](../modules/verida_web3._internal_.md).Iterator - -## Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `T` | -| `TReturn` | `any` | -| `TNext` | `undefined` | - -## Hierarchy - -- **`Iterator`** - - ↳ [`IterableIterator`](verida_web3._internal_.IterableIterator.md) - -## Table of contents - -### Methods - -- [next](verida_web3._internal_.Iterator.md#next) -- [return](verida_web3._internal_.Iterator.md#return) -- [throw](verida_web3._internal_.Iterator.md#throw) - -## Methods - -### next - -▸ **next**(...`args`): [`IteratorResult`](../modules/verida_web3._internal_.md#iteratorresult)<`T`, `TReturn`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `...args` | [] \| [`TNext`] | - -#### Returns - -[`IteratorResult`](../modules/verida_web3._internal_.md#iteratorresult)<`T`, `TReturn`\> - -#### Defined in - -node_modules/typescript/lib/lib.es2015.iterable.d.ts:45 - -___ - -### return - -▸ `Optional` **return**(`value?`): [`IteratorResult`](../modules/verida_web3._internal_.md#iteratorresult)<`T`, `TReturn`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value?` | `TReturn` | - -#### Returns - -[`IteratorResult`](../modules/verida_web3._internal_.md#iteratorresult)<`T`, `TReturn`\> - -#### Defined in - -node_modules/typescript/lib/lib.es2015.iterable.d.ts:46 - -___ - -### throw - -▸ `Optional` **throw**(`e?`): [`IteratorResult`](../modules/verida_web3._internal_.md#iteratorresult)<`T`, `TReturn`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `e?` | `any` | - -#### Returns - -[`IteratorResult`](../modules/verida_web3._internal_.md#iteratorresult)<`T`, `TReturn`\> - -#### Defined in - -node_modules/typescript/lib/lib.es2015.iterable.d.ts:47 diff --git a/docs/api/verida-js/interfaces/verida_web3._internal_.IteratorReturnResult.md b/docs/api/verida-js/interfaces/verida_web3._internal_.IteratorReturnResult.md deleted file mode 100644 index 251e61a..0000000 --- a/docs/api/verida-js/interfaces/verida_web3._internal_.IteratorReturnResult.md +++ /dev/null @@ -1,38 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web3](../modules/verida_web3.md) / [](../modules/verida_web3._internal_.md) / IteratorReturnResult - -# Interface: IteratorReturnResult - -[@verida/web3](../modules/verida_web3.md).[](../modules/verida_web3._internal_.md).IteratorReturnResult - -## Type parameters - -| Name | -| :------ | -| `TReturn` | - -## Table of contents - -### Properties - -- [done](verida_web3._internal_.IteratorReturnResult.md#done) -- [value](verida_web3._internal_.IteratorReturnResult.md#value) - -## Properties - -### done - -• **done**: ``true`` - -#### Defined in - -node_modules/typescript/lib/lib.es2015.iterable.d.ts:37 - -___ - -### value - -• **value**: `TReturn` - -#### Defined in - -node_modules/typescript/lib/lib.es2015.iterable.d.ts:38 diff --git a/docs/api/verida-js/interfaces/verida_web3._internal_.IteratorYieldResult.md b/docs/api/verida-js/interfaces/verida_web3._internal_.IteratorYieldResult.md deleted file mode 100644 index d5951d8..0000000 --- a/docs/api/verida-js/interfaces/verida_web3._internal_.IteratorYieldResult.md +++ /dev/null @@ -1,38 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web3](../modules/verida_web3.md) / [](../modules/verida_web3._internal_.md) / IteratorYieldResult - -# Interface: IteratorYieldResult - -[@verida/web3](../modules/verida_web3.md).[](../modules/verida_web3._internal_.md).IteratorYieldResult - -## Type parameters - -| Name | -| :------ | -| `TYield` | - -## Table of contents - -### Properties - -- [done](verida_web3._internal_.IteratorYieldResult.md#done) -- [value](verida_web3._internal_.IteratorYieldResult.md#value) - -## Properties - -### done - -• `Optional` **done**: ``false`` - -#### Defined in - -node_modules/typescript/lib/lib.es2015.iterable.d.ts:32 - -___ - -### value - -• **value**: `TYield` - -#### Defined in - -node_modules/typescript/lib/lib.es2015.iterable.d.ts:33 diff --git a/docs/api/verida-js/interfaces/verida_web3._internal_.JsonFragment.md b/docs/api/verida-js/interfaces/verida_web3._internal_.JsonFragment.md deleted file mode 100644 index 9916542..0000000 --- a/docs/api/verida-js/interfaces/verida_web3._internal_.JsonFragment.md +++ /dev/null @@ -1,109 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web3](../modules/verida_web3.md) / [](../modules/verida_web3._internal_.md) / JsonFragment - -# Interface: JsonFragment - -[@verida/web3](../modules/verida_web3.md).[](../modules/verida_web3._internal_.md).JsonFragment - -## Table of contents - -### Properties - -- [anonymous](verida_web3._internal_.JsonFragment.md#anonymous) -- [constant](verida_web3._internal_.JsonFragment.md#constant) -- [gas](verida_web3._internal_.JsonFragment.md#gas) -- [inputs](verida_web3._internal_.JsonFragment.md#inputs) -- [name](verida_web3._internal_.JsonFragment.md#name) -- [outputs](verida_web3._internal_.JsonFragment.md#outputs) -- [payable](verida_web3._internal_.JsonFragment.md#payable) -- [stateMutability](verida_web3._internal_.JsonFragment.md#statemutability) -- [type](verida_web3._internal_.JsonFragment.md#type) - -## Properties - -### anonymous - -• `Optional` `Readonly` **anonymous**: `boolean` - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:12 - -___ - -### constant - -• `Optional` `Readonly` **constant**: `boolean` - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:14 - -___ - -### gas - -• `Optional` `Readonly` **gas**: `string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:18 - -___ - -### inputs - -• `Optional` `Readonly` **inputs**: readonly [`JsonFragmentType`](verida_web3._internal_.JsonFragmentType.md)[] - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:16 - -___ - -### name - -• `Optional` `Readonly` **name**: `string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:10 - -___ - -### outputs - -• `Optional` `Readonly` **outputs**: readonly [`JsonFragmentType`](verida_web3._internal_.JsonFragmentType.md)[] - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:17 - -___ - -### payable - -• `Optional` `Readonly` **payable**: `boolean` - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:13 - -___ - -### stateMutability - -• `Optional` `Readonly` **stateMutability**: `string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:15 - -___ - -### type - -• `Optional` `Readonly` **type**: `string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:11 diff --git a/docs/api/verida-js/interfaces/verida_web3._internal_.JsonFragmentType.md b/docs/api/verida-js/interfaces/verida_web3._internal_.JsonFragmentType.md deleted file mode 100644 index 5109af0..0000000 --- a/docs/api/verida-js/interfaces/verida_web3._internal_.JsonFragmentType.md +++ /dev/null @@ -1,65 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web3](../modules/verida_web3.md) / [](../modules/verida_web3._internal_.md) / JsonFragmentType - -# Interface: JsonFragmentType - -[@verida/web3](../modules/verida_web3.md).[](../modules/verida_web3._internal_.md).JsonFragmentType - -## Table of contents - -### Properties - -- [components](verida_web3._internal_.JsonFragmentType.md#components) -- [indexed](verida_web3._internal_.JsonFragmentType.md#indexed) -- [internalType](verida_web3._internal_.JsonFragmentType.md#internaltype) -- [name](verida_web3._internal_.JsonFragmentType.md#name) -- [type](verida_web3._internal_.JsonFragmentType.md#type) - -## Properties - -### components - -• `Optional` `Readonly` **components**: readonly [`JsonFragmentType`](verida_web3._internal_.JsonFragmentType.md)[] - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:7 - -___ - -### indexed - -• `Optional` `Readonly` **indexed**: `boolean` - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:4 - -___ - -### internalType - -• `Optional` `Readonly` **internalType**: `any` - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:6 - -___ - -### name - -• `Optional` `Readonly` **name**: `string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:3 - -___ - -### type - -• `Optional` `Readonly` **type**: `string` - -#### Defined in - -node_modules/@ethersproject/abi/lib/fragments.d.ts:5 diff --git a/docs/api/verida-js/interfaces/verida_web3._internal_.Log.md b/docs/api/verida-js/interfaces/verida_web3._internal_.Log.md deleted file mode 100644 index 7c2d9a7..0000000 --- a/docs/api/verida-js/interfaces/verida_web3._internal_.Log.md +++ /dev/null @@ -1,115 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web3](../modules/verida_web3.md) / [](../modules/verida_web3._internal_.md) / Log - -# Interface: Log - -[@verida/web3](../modules/verida_web3.md).[](../modules/verida_web3._internal_.md).Log - -## Hierarchy - -- **`Log`** - - ↳ [`Event`](verida_web3._internal_.Event.md) - -## Table of contents - -### Properties - -- [address](verida_web3._internal_.Log.md#address) -- [blockHash](verida_web3._internal_.Log.md#blockhash) -- [blockNumber](verida_web3._internal_.Log.md#blocknumber) -- [data](verida_web3._internal_.Log.md#data) -- [logIndex](verida_web3._internal_.Log.md#logindex) -- [removed](verida_web3._internal_.Log.md#removed) -- [topics](verida_web3._internal_.Log.md#topics) -- [transactionHash](verida_web3._internal_.Log.md#transactionhash) -- [transactionIndex](verida_web3._internal_.Log.md#transactionindex) - -## Properties - -### address - -• **address**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:59 - -___ - -### blockHash - -• **blockHash**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:56 - -___ - -### blockNumber - -• **blockNumber**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:55 - -___ - -### data - -• **data**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:60 - -___ - -### logIndex - -• **logIndex**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:63 - -___ - -### removed - -• **removed**: `boolean` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:58 - -___ - -### topics - -• **topics**: `string`[] - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:61 - -___ - -### transactionHash - -• **transactionHash**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:62 - -___ - -### transactionIndex - -• **transactionIndex**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:57 diff --git a/docs/api/verida-js/interfaces/verida_web3._internal_.OnceBlockable.md b/docs/api/verida-js/interfaces/verida_web3._internal_.OnceBlockable.md deleted file mode 100644 index f4fac65..0000000 --- a/docs/api/verida-js/interfaces/verida_web3._internal_.OnceBlockable.md +++ /dev/null @@ -1,36 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web3](../modules/verida_web3.md) / [](../modules/verida_web3._internal_.md) / OnceBlockable - -# Interface: OnceBlockable - -[@verida/web3](../modules/verida_web3.md).[](../modules/verida_web3._internal_.md).OnceBlockable - -## Implemented by - -- [`Provider`](../classes/verida_web3._internal_.Provider.md) - -## Table of contents - -### Methods - -- [once](verida_web3._internal_.OnceBlockable.md#once) - -## Methods - -### once - -▸ **once**(`eventName`, `handler`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | ``"block"`` | -| `handler` | () => `void` | - -#### Returns - -`void` - -#### Defined in - -node_modules/@ethersproject/web/lib/index.d.ts:19 diff --git a/docs/api/verida-js/interfaces/verida_web3._internal_.PopulatedTransaction.md b/docs/api/verida-js/interfaces/verida_web3._internal_.PopulatedTransaction.md deleted file mode 100644 index a5bd3f2..0000000 --- a/docs/api/verida-js/interfaces/verida_web3._internal_.PopulatedTransaction.md +++ /dev/null @@ -1,164 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web3](../modules/verida_web3.md) / [](../modules/verida_web3._internal_.md) / PopulatedTransaction - -# Interface: PopulatedTransaction - -[@verida/web3](../modules/verida_web3.md).[](../modules/verida_web3._internal_.md).PopulatedTransaction - -## Table of contents - -### Properties - -- [accessList](verida_web3._internal_.PopulatedTransaction.md#accesslist) -- [ccipReadEnabled](verida_web3._internal_.PopulatedTransaction.md#ccipreadenabled) -- [chainId](verida_web3._internal_.PopulatedTransaction.md#chainid) -- [customData](verida_web3._internal_.PopulatedTransaction.md#customdata) -- [data](verida_web3._internal_.PopulatedTransaction.md#data) -- [from](verida_web3._internal_.PopulatedTransaction.md#from) -- [gasLimit](verida_web3._internal_.PopulatedTransaction.md#gaslimit) -- [gasPrice](verida_web3._internal_.PopulatedTransaction.md#gasprice) -- [maxFeePerGas](verida_web3._internal_.PopulatedTransaction.md#maxfeepergas) -- [maxPriorityFeePerGas](verida_web3._internal_.PopulatedTransaction.md#maxpriorityfeepergas) -- [nonce](verida_web3._internal_.PopulatedTransaction.md#nonce) -- [to](verida_web3._internal_.PopulatedTransaction.md#to) -- [type](verida_web3._internal_.PopulatedTransaction.md#type) -- [value](verida_web3._internal_.PopulatedTransaction.md#value) - -## Properties - -### accessList - -• `Optional` **accessList**: [`AccessList`](../modules/verida_web3._internal_.md#accesslist) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:35 - -___ - -### ccipReadEnabled - -• `Optional` **ccipReadEnabled**: `boolean` - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:39 - -___ - -### chainId - -• `Optional` **chainId**: `number` - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:33 - -___ - -### customData - -• `Optional` **customData**: [`Record`](../modules/verida_web3._internal_.md#record)<`string`, `any`\> - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:38 - -___ - -### data - -• `Optional` **data**: `string` - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:31 - -___ - -### from - -• `Optional` **from**: `string` - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:27 - -___ - -### gasLimit - -• `Optional` **gasLimit**: [`BigNumber`](../classes/verida_web3._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:29 - -___ - -### gasPrice - -• `Optional` **gasPrice**: [`BigNumber`](../classes/verida_web3._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:30 - -___ - -### maxFeePerGas - -• `Optional` **maxFeePerGas**: [`BigNumber`](../classes/verida_web3._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:36 - -___ - -### maxPriorityFeePerGas - -• `Optional` **maxPriorityFeePerGas**: [`BigNumber`](../classes/verida_web3._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:37 - -___ - -### nonce - -• `Optional` **nonce**: `number` - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:28 - -___ - -### to - -• `Optional` **to**: `string` - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:26 - -___ - -### type - -• `Optional` **type**: `number` - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:34 - -___ - -### value - -• `Optional` **value**: [`BigNumber`](../classes/verida_web3._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:32 diff --git a/docs/api/verida-js/interfaces/verida_web3._internal_.Result.md b/docs/api/verida-js/interfaces/verida_web3._internal_.Result.md deleted file mode 100644 index c5d9a75..0000000 --- a/docs/api/verida-js/interfaces/verida_web3._internal_.Result.md +++ /dev/null @@ -1,869 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web3](../modules/verida_web3.md) / [](../modules/verida_web3._internal_.md) / Result - -# Interface: Result - -[@verida/web3](../modules/verida_web3.md).[](../modules/verida_web3._internal_.md).Result - -## Hierarchy - -- `ReadonlyArray`<`any`\> - - ↳ **`Result`** - -## Indexable - -▪ [key: `string`]: `any` - -## Table of contents - -### Properties - -- [length](verida_web3._internal_.Result.md#length) - -### Methods - -- [[iterator]](verida_web3._internal_.Result.md#[iterator]) -- [concat](verida_web3._internal_.Result.md#concat) -- [entries](verida_web3._internal_.Result.md#entries) -- [every](verida_web3._internal_.Result.md#every) -- [filter](verida_web3._internal_.Result.md#filter) -- [find](verida_web3._internal_.Result.md#find) -- [findIndex](verida_web3._internal_.Result.md#findindex) -- [flat](verida_web3._internal_.Result.md#flat) -- [flatMap](verida_web3._internal_.Result.md#flatmap) -- [forEach](verida_web3._internal_.Result.md#foreach) -- [includes](verida_web3._internal_.Result.md#includes) -- [indexOf](verida_web3._internal_.Result.md#indexof) -- [join](verida_web3._internal_.Result.md#join) -- [keys](verida_web3._internal_.Result.md#keys) -- [lastIndexOf](verida_web3._internal_.Result.md#lastindexof) -- [map](verida_web3._internal_.Result.md#map) -- [reduce](verida_web3._internal_.Result.md#reduce) -- [reduceRight](verida_web3._internal_.Result.md#reduceright) -- [slice](verida_web3._internal_.Result.md#slice) -- [some](verida_web3._internal_.Result.md#some) -- [toLocaleString](verida_web3._internal_.Result.md#tolocalestring) -- [toString](verida_web3._internal_.Result.md#tostring) -- [values](verida_web3._internal_.Result.md#values) - -## Properties - -### length - -• `Readonly` **length**: `number` - -Gets the length of the array. This is a number one higher than the highest element defined in an array. - -#### Inherited from - -ReadonlyArray.length - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1090 - -## Methods - -### [iterator] - -▸ **[iterator]**(): [`IterableIterator`](verida_web3._internal_.IterableIterator.md)<`any`\> - -Iterator of values in the array. - -#### Returns - -[`IterableIterator`](verida_web3._internal_.IterableIterator.md)<`any`\> - -#### Inherited from - -ReadonlyArray.\_\_@iterator@17192 - -#### Defined in - -node_modules/typescript/lib/lib.es2015.iterable.d.ts:96 - -___ - -### concat - -▸ **concat**(...`items`): `any`[] - -Combines two or more arrays. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `...items` | [`ConcatArray`](verida_web3._internal_.ConcatArray.md)<`any`\>[] | Additional items to add to the end of array1. | - -#### Returns - -`any`[] - -#### Inherited from - -ReadonlyArray.concat - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1103 - -▸ **concat**(...`items`): `any`[] - -Combines two or more arrays. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `...items` | `any`[] | Additional items to add to the end of array1. | - -#### Returns - -`any`[] - -#### Inherited from - -ReadonlyArray.concat - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1108 - -___ - -### entries - -▸ **entries**(): [`IterableIterator`](verida_web3._internal_.IterableIterator.md)<[`number`, `any`]\> - -Returns an iterable of key, value pairs for every entry in the array - -#### Returns - -[`IterableIterator`](verida_web3._internal_.IterableIterator.md)<[`number`, `any`]\> - -#### Inherited from - -ReadonlyArray.entries - -#### Defined in - -node_modules/typescript/lib/lib.es2015.iterable.d.ts:101 - -___ - -### every - -▸ **every**<`S`\>(`predicate`, `thisArg?`): this is readonly S[] - -Determines whether all the members of an array satisfy the specified test. - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `S` | extends `any` | - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `predicate` | (`value`: `any`, `index`: `number`, `array`: readonly `any`[]) => value is S | A function that accepts up to three arguments. The every method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value false, or until the end of the array. | -| `thisArg?` | `any` | An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value. | - -#### Returns - -this is readonly S[] - -#### Inherited from - -ReadonlyArray.every - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1140 - -▸ **every**(`predicate`, `thisArg?`): `boolean` - -Determines whether all the members of an array satisfy the specified test. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `predicate` | (`value`: `any`, `index`: `number`, `array`: readonly `any`[]) => `unknown` | A function that accepts up to three arguments. The every method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value false, or until the end of the array. | -| `thisArg?` | `any` | An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value. | - -#### Returns - -`boolean` - -#### Inherited from - -ReadonlyArray.every - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1149 - -___ - -### filter - -▸ **filter**<`S`\>(`predicate`, `thisArg?`): `S`[] - -Returns the elements of an array that meet the condition specified in a callback function. - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `S` | extends `any` | - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `predicate` | (`value`: `any`, `index`: `number`, `array`: readonly `any`[]) => value is S | A function that accepts up to three arguments. The filter method calls the predicate function one time for each element in the array. | -| `thisArg?` | `any` | An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value. | - -#### Returns - -`S`[] - -#### Inherited from - -ReadonlyArray.filter - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1176 - -▸ **filter**(`predicate`, `thisArg?`): `any`[] - -Returns the elements of an array that meet the condition specified in a callback function. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `predicate` | (`value`: `any`, `index`: `number`, `array`: readonly `any`[]) => `unknown` | A function that accepts up to three arguments. The filter method calls the predicate function one time for each element in the array. | -| `thisArg?` | `any` | An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value. | - -#### Returns - -`any`[] - -#### Inherited from - -ReadonlyArray.filter - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1182 - -___ - -### find - -▸ **find**<`S`\>(`predicate`, `thisArg?`): `undefined` \| `S` - -Returns the value of the first element in the array where predicate is true, and undefined -otherwise. - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `S` | extends `any` | - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `predicate` | (`value`: `any`, `index`: `number`, `obj`: readonly `any`[]) => value is S | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined. | -| `thisArg?` | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. | - -#### Returns - -`undefined` \| `S` - -#### Inherited from - -ReadonlyArray.find - -#### Defined in - -node_modules/typescript/lib/lib.es2015.core.d.ts:352 - -▸ **find**(`predicate`, `thisArg?`): `any` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `predicate` | (`value`: `any`, `index`: `number`, `obj`: readonly `any`[]) => `unknown` | -| `thisArg?` | `any` | - -#### Returns - -`any` - -#### Inherited from - -ReadonlyArray.find - -#### Defined in - -node_modules/typescript/lib/lib.es2015.core.d.ts:353 - -___ - -### findIndex - -▸ **findIndex**(`predicate`, `thisArg?`): `number` - -Returns the index of the first element in the array where predicate is true, and -1 -otherwise. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `predicate` | (`value`: `any`, `index`: `number`, `obj`: readonly `any`[]) => `unknown` | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1. | -| `thisArg?` | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. | - -#### Returns - -`number` - -#### Inherited from - -ReadonlyArray.findIndex - -#### Defined in - -node_modules/typescript/lib/lib.es2015.core.d.ts:364 - -___ - -### flat - -▸ **flat**<`A`, `D`\>(`depth?`): [`FlatArray`](../modules/verida_web3._internal_.md#flatarray)<`A`, `D`\>[] - -Returns a new array with all sub-array elements concatenated into it recursively up to the -specified depth. - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `A` | `A` | -| `D` | extends `number` = ``1`` | - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `depth?` | `D` | The maximum recursion depth | - -#### Returns - -[`FlatArray`](../modules/verida_web3._internal_.md#flatarray)<`A`, `D`\>[] - -#### Inherited from - -ReadonlyArray.flat - -#### Defined in - -node_modules/typescript/lib/lib.es2019.array.d.ts:52 - -___ - -### flatMap - -▸ **flatMap**<`U`, `This`\>(`callback`, `thisArg?`): `U`[] - -Calls a defined callback function on each element of an array. Then, flattens the result into -a new array. -This is identical to a map followed by flat with depth 1. - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `U` | `U` | -| `This` | `undefined` | - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `callback` | (`value`: `any`, `index`: `number`, `array`: `any`[]) => `U` \| readonly `U`[] | A function that accepts up to three arguments. The flatMap method calls the callback function one time for each element in the array. | -| `thisArg?` | `This` | An object to which the this keyword can refer in the callback function. If thisArg is omitted, undefined is used as the this value. | - -#### Returns - -`U`[] - -#### Inherited from - -ReadonlyArray.flatMap - -#### Defined in - -node_modules/typescript/lib/lib.es2019.array.d.ts:40 - -___ - -### forEach - -▸ **forEach**(`callbackfn`, `thisArg?`): `void` - -Performs the specified action for each element in an array. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `callbackfn` | (`value`: `any`, `index`: `number`, `array`: readonly `any`[]) => `void` | A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array. | -| `thisArg?` | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -#### Returns - -`void` - -#### Inherited from - -ReadonlyArray.forEach - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1164 - -___ - -### includes - -▸ **includes**(`searchElement`, `fromIndex?`): `boolean` - -Determines whether an array includes a certain element, returning true or false as appropriate. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `searchElement` | `any` | The element to search for. | -| `fromIndex?` | `number` | The position in this array at which to begin searching for searchElement. | - -#### Returns - -`boolean` - -#### Inherited from - -ReadonlyArray.includes - -#### Defined in - -node_modules/typescript/lib/lib.es2016.array.include.d.ts:36 - -___ - -### indexOf - -▸ **indexOf**(`searchElement`, `fromIndex?`): `number` - -Returns the index of the first occurrence of a value in an array. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `searchElement` | `any` | The value to locate in the array. | -| `fromIndex?` | `number` | The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0. | - -#### Returns - -`number` - -#### Inherited from - -ReadonlyArray.indexOf - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1125 - -___ - -### join - -▸ **join**(`separator?`): `string` - -Adds all the elements of an array separated by the specified separator string. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `separator?` | `string` | A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma. | - -#### Returns - -`string` - -#### Inherited from - -ReadonlyArray.join - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1113 - -___ - -### keys - -▸ **keys**(): [`IterableIterator`](verida_web3._internal_.IterableIterator.md)<`number`\> - -Returns an iterable of keys in the array - -#### Returns - -[`IterableIterator`](verida_web3._internal_.IterableIterator.md)<`number`\> - -#### Inherited from - -ReadonlyArray.keys - -#### Defined in - -node_modules/typescript/lib/lib.es2015.iterable.d.ts:106 - -___ - -### lastIndexOf - -▸ **lastIndexOf**(`searchElement`, `fromIndex?`): `number` - -Returns the index of the last occurrence of a specified value in an array. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `searchElement` | `any` | The value to locate in the array. | -| `fromIndex?` | `number` | The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array. | - -#### Returns - -`number` - -#### Inherited from - -ReadonlyArray.lastIndexOf - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1131 - -___ - -### map - -▸ **map**<`U`\>(`callbackfn`, `thisArg?`): `U`[] - -Calls a defined callback function on each element of an array, and returns an array that contains the results. - -#### Type parameters - -| Name | -| :------ | -| `U` | - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `callbackfn` | (`value`: `any`, `index`: `number`, `array`: readonly `any`[]) => `U` | A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array. | -| `thisArg?` | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -#### Returns - -`U`[] - -#### Inherited from - -ReadonlyArray.map - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1170 - -___ - -### reduce - -▸ **reduce**(`callbackfn`): `any` - -Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `callbackfn` | (`previousValue`: `any`, `currentValue`: `any`, `currentIndex`: `number`, `array`: readonly `any`[]) => `any` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. | - -#### Returns - -`any` - -#### Inherited from - -ReadonlyArray.reduce - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1188 - -▸ **reduce**(`callbackfn`, `initialValue`): `any` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `callbackfn` | (`previousValue`: `any`, `currentValue`: `any`, `currentIndex`: `number`, `array`: readonly `any`[]) => `any` | -| `initialValue` | `any` | - -#### Returns - -`any` - -#### Inherited from - -ReadonlyArray.reduce - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1189 - -▸ **reduce**<`U`\>(`callbackfn`, `initialValue`): `U` - -Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -#### Type parameters - -| Name | -| :------ | -| `U` | - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `callbackfn` | (`previousValue`: `U`, `currentValue`: `any`, `currentIndex`: `number`, `array`: readonly `any`[]) => `U` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. | -| `initialValue` | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. | - -#### Returns - -`U` - -#### Inherited from - -ReadonlyArray.reduce - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1195 - -___ - -### reduceRight - -▸ **reduceRight**(`callbackfn`): `any` - -Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `callbackfn` | (`previousValue`: `any`, `currentValue`: `any`, `currentIndex`: `number`, `array`: readonly `any`[]) => `any` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. | - -#### Returns - -`any` - -#### Inherited from - -ReadonlyArray.reduceRight - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1201 - -▸ **reduceRight**(`callbackfn`, `initialValue`): `any` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `callbackfn` | (`previousValue`: `any`, `currentValue`: `any`, `currentIndex`: `number`, `array`: readonly `any`[]) => `any` | -| `initialValue` | `any` | - -#### Returns - -`any` - -#### Inherited from - -ReadonlyArray.reduceRight - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1202 - -▸ **reduceRight**<`U`\>(`callbackfn`, `initialValue`): `U` - -Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -#### Type parameters - -| Name | -| :------ | -| `U` | - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `callbackfn` | (`previousValue`: `U`, `currentValue`: `any`, `currentIndex`: `number`, `array`: readonly `any`[]) => `U` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. | -| `initialValue` | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. | - -#### Returns - -`U` - -#### Inherited from - -ReadonlyArray.reduceRight - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1208 - -___ - -### slice - -▸ **slice**(`start?`, `end?`): `any`[] - -Returns a section of an array. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `start?` | `number` | The beginning of the specified portion of the array. | -| `end?` | `number` | The end of the specified portion of the array. This is exclusive of the element at the index 'end'. | - -#### Returns - -`any`[] - -#### Inherited from - -ReadonlyArray.slice - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1119 - -___ - -### some - -▸ **some**(`predicate`, `thisArg?`): `boolean` - -Determines whether the specified callback function returns true for any element of an array. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `predicate` | (`value`: `any`, `index`: `number`, `array`: readonly `any`[]) => `unknown` | A function that accepts up to three arguments. The some method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value true, or until the end of the array. | -| `thisArg?` | `any` | An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value. | - -#### Returns - -`boolean` - -#### Inherited from - -ReadonlyArray.some - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1158 - -___ - -### toLocaleString - -▸ **toLocaleString**(): `string` - -Returns a string representation of an array. The elements are converted to string using their toLocaleString methods. - -#### Returns - -`string` - -#### Inherited from - -ReadonlyArray.toLocaleString - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1098 - -___ - -### toString - -▸ **toString**(): `string` - -Returns a string representation of an array. - -#### Returns - -`string` - -#### Inherited from - -ReadonlyArray.toString - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1094 - -___ - -### values - -▸ **values**(): [`IterableIterator`](verida_web3._internal_.IterableIterator.md)<`any`\> - -Returns an iterable of values in the array - -#### Returns - -[`IterableIterator`](verida_web3._internal_.IterableIterator.md)<`any`\> - -#### Inherited from - -ReadonlyArray.values - -#### Defined in - -node_modules/typescript/lib/lib.es2015.iterable.d.ts:111 diff --git a/docs/api/verida-js/interfaces/verida_web3._internal_.Transaction.md b/docs/api/verida-js/interfaces/verida_web3._internal_.Transaction.md deleted file mode 100644 index 2d9fe7b..0000000 --- a/docs/api/verida-js/interfaces/verida_web3._internal_.Transaction.md +++ /dev/null @@ -1,192 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web3](../modules/verida_web3.md) / [](../modules/verida_web3._internal_.md) / Transaction - -# Interface: Transaction - -[@verida/web3](../modules/verida_web3.md).[](../modules/verida_web3._internal_.md).Transaction - -## Hierarchy - -- **`Transaction`** - - ↳ [`TransactionResponse`](verida_web3._internal_.TransactionResponse.md) - -## Table of contents - -### Properties - -- [accessList](verida_web3._internal_.Transaction.md#accesslist) -- [chainId](verida_web3._internal_.Transaction.md#chainid) -- [data](verida_web3._internal_.Transaction.md#data) -- [from](verida_web3._internal_.Transaction.md#from) -- [gasLimit](verida_web3._internal_.Transaction.md#gaslimit) -- [gasPrice](verida_web3._internal_.Transaction.md#gasprice) -- [hash](verida_web3._internal_.Transaction.md#hash) -- [maxFeePerGas](verida_web3._internal_.Transaction.md#maxfeepergas) -- [maxPriorityFeePerGas](verida_web3._internal_.Transaction.md#maxpriorityfeepergas) -- [nonce](verida_web3._internal_.Transaction.md#nonce) -- [r](verida_web3._internal_.Transaction.md#r) -- [s](verida_web3._internal_.Transaction.md#s) -- [to](verida_web3._internal_.Transaction.md#to) -- [type](verida_web3._internal_.Transaction.md#type) -- [v](verida_web3._internal_.Transaction.md#v) -- [value](verida_web3._internal_.Transaction.md#value) - -## Properties - -### accessList - -• `Optional` **accessList**: [`AccessList`](../modules/verida_web3._internal_.md#accesslist) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:40 - -___ - -### chainId - -• **chainId**: `number` - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:35 - -___ - -### data - -• **data**: `string` - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:33 - -___ - -### from - -• `Optional` **from**: `string` - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:29 - -___ - -### gasLimit - -• **gasLimit**: [`BigNumber`](../classes/verida_web3._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:31 - -___ - -### gasPrice - -• `Optional` **gasPrice**: [`BigNumber`](../classes/verida_web3._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:32 - -___ - -### hash - -• `Optional` **hash**: `string` - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:27 - -___ - -### maxFeePerGas - -• `Optional` **maxFeePerGas**: [`BigNumber`](../classes/verida_web3._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:42 - -___ - -### maxPriorityFeePerGas - -• `Optional` **maxPriorityFeePerGas**: [`BigNumber`](../classes/verida_web3._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:41 - -___ - -### nonce - -• **nonce**: `number` - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:30 - -___ - -### r - -• `Optional` **r**: `string` - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:36 - -___ - -### s - -• `Optional` **s**: `string` - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:37 - -___ - -### to - -• `Optional` **to**: `string` - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:28 - -___ - -### type - -• `Optional` **type**: ``null`` \| `number` - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:39 - -___ - -### v - -• `Optional` **v**: `number` - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:38 - -___ - -### value - -• **value**: [`BigNumber`](../classes/verida_web3._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:34 diff --git a/docs/api/verida-js/interfaces/verida_web3._internal_.TransactionReceipt.md b/docs/api/verida-js/interfaces/verida_web3._internal_.TransactionReceipt.md deleted file mode 100644 index 5ba3446..0000000 --- a/docs/api/verida-js/interfaces/verida_web3._internal_.TransactionReceipt.md +++ /dev/null @@ -1,197 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web3](../modules/verida_web3.md) / [](../modules/verida_web3._internal_.md) / TransactionReceipt - -# Interface: TransactionReceipt - -[@verida/web3](../modules/verida_web3.md).[](../modules/verida_web3._internal_.md).TransactionReceipt - -## Table of contents - -### Properties - -- [blockHash](verida_web3._internal_.TransactionReceipt.md#blockhash) -- [blockNumber](verida_web3._internal_.TransactionReceipt.md#blocknumber) -- [byzantium](verida_web3._internal_.TransactionReceipt.md#byzantium) -- [confirmations](verida_web3._internal_.TransactionReceipt.md#confirmations) -- [contractAddress](verida_web3._internal_.TransactionReceipt.md#contractaddress) -- [cumulativeGasUsed](verida_web3._internal_.TransactionReceipt.md#cumulativegasused) -- [effectiveGasPrice](verida_web3._internal_.TransactionReceipt.md#effectivegasprice) -- [from](verida_web3._internal_.TransactionReceipt.md#from) -- [gasUsed](verida_web3._internal_.TransactionReceipt.md#gasused) -- [logs](verida_web3._internal_.TransactionReceipt.md#logs) -- [logsBloom](verida_web3._internal_.TransactionReceipt.md#logsbloom) -- [root](verida_web3._internal_.TransactionReceipt.md#root) -- [status](verida_web3._internal_.TransactionReceipt.md#status) -- [to](verida_web3._internal_.TransactionReceipt.md#to) -- [transactionHash](verida_web3._internal_.TransactionReceipt.md#transactionhash) -- [transactionIndex](verida_web3._internal_.TransactionReceipt.md#transactionindex) -- [type](verida_web3._internal_.TransactionReceipt.md#type) - -## Properties - -### blockHash - -• **blockHash**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:73 - -___ - -### blockNumber - -• **blockNumber**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:76 - -___ - -### byzantium - -• **byzantium**: `boolean` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:80 - -___ - -### confirmations - -• **confirmations**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:77 - -___ - -### contractAddress - -• **contractAddress**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:68 - -___ - -### cumulativeGasUsed - -• **cumulativeGasUsed**: [`BigNumber`](../classes/verida_web3._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:78 - -___ - -### effectiveGasPrice - -• **effectiveGasPrice**: [`BigNumber`](../classes/verida_web3._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:79 - -___ - -### from - -• **from**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:67 - -___ - -### gasUsed - -• **gasUsed**: [`BigNumber`](../classes/verida_web3._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:71 - -___ - -### logs - -• **logs**: [`Log`](verida_web3._internal_.Log.md)[] - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:75 - -___ - -### logsBloom - -• **logsBloom**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:72 - -___ - -### root - -• `Optional` **root**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:70 - -___ - -### status - -• `Optional` **status**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:82 - -___ - -### to - -• **to**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:66 - -___ - -### transactionHash - -• **transactionHash**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:74 - -___ - -### transactionIndex - -• **transactionIndex**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:69 - -___ - -### type - -• **type**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:81 diff --git a/docs/api/verida-js/interfaces/verida_web3._internal_.TransactionResponse.md b/docs/api/verida-js/interfaces/verida_web3._internal_.TransactionResponse.md deleted file mode 100644 index cc3bc08..0000000 --- a/docs/api/verida-js/interfaces/verida_web3._internal_.TransactionResponse.md +++ /dev/null @@ -1,335 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web3](../modules/verida_web3.md) / [](../modules/verida_web3._internal_.md) / TransactionResponse - -# Interface: TransactionResponse - -[@verida/web3](../modules/verida_web3.md).[](../modules/verida_web3._internal_.md).TransactionResponse - -## Hierarchy - -- [`Transaction`](verida_web3._internal_.Transaction.md) - - ↳ **`TransactionResponse`** - -## Table of contents - -### Properties - -- [accessList](verida_web3._internal_.TransactionResponse.md#accesslist) -- [blockHash](verida_web3._internal_.TransactionResponse.md#blockhash) -- [blockNumber](verida_web3._internal_.TransactionResponse.md#blocknumber) -- [chainId](verida_web3._internal_.TransactionResponse.md#chainid) -- [confirmations](verida_web3._internal_.TransactionResponse.md#confirmations) -- [data](verida_web3._internal_.TransactionResponse.md#data) -- [from](verida_web3._internal_.TransactionResponse.md#from) -- [gasLimit](verida_web3._internal_.TransactionResponse.md#gaslimit) -- [gasPrice](verida_web3._internal_.TransactionResponse.md#gasprice) -- [hash](verida_web3._internal_.TransactionResponse.md#hash) -- [maxFeePerGas](verida_web3._internal_.TransactionResponse.md#maxfeepergas) -- [maxPriorityFeePerGas](verida_web3._internal_.TransactionResponse.md#maxpriorityfeepergas) -- [nonce](verida_web3._internal_.TransactionResponse.md#nonce) -- [r](verida_web3._internal_.TransactionResponse.md#r) -- [raw](verida_web3._internal_.TransactionResponse.md#raw) -- [s](verida_web3._internal_.TransactionResponse.md#s) -- [timestamp](verida_web3._internal_.TransactionResponse.md#timestamp) -- [to](verida_web3._internal_.TransactionResponse.md#to) -- [type](verida_web3._internal_.TransactionResponse.md#type) -- [v](verida_web3._internal_.TransactionResponse.md#v) -- [value](verida_web3._internal_.TransactionResponse.md#value) - -### Methods - -- [wait](verida_web3._internal_.TransactionResponse.md#wait) - -## Properties - -### accessList - -• `Optional` **accessList**: [`AccessList`](../modules/verida_web3._internal_.md#accesslist) - -#### Inherited from - -[Transaction](verida_web3._internal_.Transaction.md).[accessList](verida_web3._internal_.Transaction.md#accesslist) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:40 - -___ - -### blockHash - -• `Optional` **blockHash**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:26 - -___ - -### blockNumber - -• `Optional` **blockNumber**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:25 - -___ - -### chainId - -• **chainId**: `number` - -#### Inherited from - -[Transaction](verida_web3._internal_.Transaction.md).[chainId](verida_web3._internal_.Transaction.md#chainid) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:35 - -___ - -### confirmations - -• **confirmations**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:28 - -___ - -### data - -• **data**: `string` - -#### Inherited from - -[Transaction](verida_web3._internal_.Transaction.md).[data](verida_web3._internal_.Transaction.md#data) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:33 - -___ - -### from - -• **from**: `string` - -#### Overrides - -[Transaction](verida_web3._internal_.Transaction.md).[from](verida_web3._internal_.Transaction.md#from) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:29 - -___ - -### gasLimit - -• **gasLimit**: [`BigNumber`](../classes/verida_web3._internal_.BigNumber.md) - -#### Inherited from - -[Transaction](verida_web3._internal_.Transaction.md).[gasLimit](verida_web3._internal_.Transaction.md#gaslimit) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:31 - -___ - -### gasPrice - -• `Optional` **gasPrice**: [`BigNumber`](../classes/verida_web3._internal_.BigNumber.md) - -#### Inherited from - -[Transaction](verida_web3._internal_.Transaction.md).[gasPrice](verida_web3._internal_.Transaction.md#gasprice) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:32 - -___ - -### hash - -• **hash**: `string` - -#### Overrides - -[Transaction](verida_web3._internal_.Transaction.md).[hash](verida_web3._internal_.Transaction.md#hash) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:24 - -___ - -### maxFeePerGas - -• `Optional` **maxFeePerGas**: [`BigNumber`](../classes/verida_web3._internal_.BigNumber.md) - -#### Inherited from - -[Transaction](verida_web3._internal_.Transaction.md).[maxFeePerGas](verida_web3._internal_.Transaction.md#maxfeepergas) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:42 - -___ - -### maxPriorityFeePerGas - -• `Optional` **maxPriorityFeePerGas**: [`BigNumber`](../classes/verida_web3._internal_.BigNumber.md) - -#### Inherited from - -[Transaction](verida_web3._internal_.Transaction.md).[maxPriorityFeePerGas](verida_web3._internal_.Transaction.md#maxpriorityfeepergas) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:41 - -___ - -### nonce - -• **nonce**: `number` - -#### Inherited from - -[Transaction](verida_web3._internal_.Transaction.md).[nonce](verida_web3._internal_.Transaction.md#nonce) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:30 - -___ - -### r - -• `Optional` **r**: `string` - -#### Inherited from - -[Transaction](verida_web3._internal_.Transaction.md).[r](verida_web3._internal_.Transaction.md#r) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:36 - -___ - -### raw - -• `Optional` **raw**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:30 - -___ - -### s - -• `Optional` **s**: `string` - -#### Inherited from - -[Transaction](verida_web3._internal_.Transaction.md).[s](verida_web3._internal_.Transaction.md#s) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:37 - -___ - -### timestamp - -• `Optional` **timestamp**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:27 - -___ - -### to - -• `Optional` **to**: `string` - -#### Inherited from - -[Transaction](verida_web3._internal_.Transaction.md).[to](verida_web3._internal_.Transaction.md#to) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:28 - -___ - -### type - -• `Optional` **type**: ``null`` \| `number` - -#### Inherited from - -[Transaction](verida_web3._internal_.Transaction.md).[type](verida_web3._internal_.Transaction.md#type) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:39 - -___ - -### v - -• `Optional` **v**: `number` - -#### Inherited from - -[Transaction](verida_web3._internal_.Transaction.md).[v](verida_web3._internal_.Transaction.md#v) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:38 - -___ - -### value - -• **value**: [`BigNumber`](../classes/verida_web3._internal_.BigNumber.md) - -#### Inherited from - -[Transaction](verida_web3._internal_.Transaction.md).[value](verida_web3._internal_.Transaction.md#value) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:34 - -## Methods - -### wait - -▸ **wait**(`confirmations?`): `Promise`<[`TransactionReceipt`](verida_web3._internal_.TransactionReceipt.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `confirmations?` | `number` | - -#### Returns - -`Promise`<[`TransactionReceipt`](verida_web3._internal_.TransactionReceipt.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:31 diff --git a/docs/api/verida-js/interfaces/verida_web3._internal_.VdaTransactionResult.md b/docs/api/verida-js/interfaces/verida_web3._internal_.VdaTransactionResult.md deleted file mode 100644 index 1b6009a..0000000 --- a/docs/api/verida-js/interfaces/verida_web3._internal_.VdaTransactionResult.md +++ /dev/null @@ -1,43 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web3](../modules/verida_web3.md) / [](../modules/verida_web3._internal_.md) / VdaTransactionResult - -# Interface: VdaTransactionResult - -[@verida/web3](../modules/verida_web3.md).[](../modules/verida_web3._internal_.md).VdaTransactionResult - -## Table of contents - -### Properties - -- [data](verida_web3._internal_.VdaTransactionResult.md#data) -- [error](verida_web3._internal_.VdaTransactionResult.md#error) -- [success](verida_web3._internal_.VdaTransactionResult.md#success) - -## Properties - -### data - -• `Optional` **data**: `any` - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:124 - -___ - -### error - -• `Optional` **error**: `string` - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:125 - -___ - -### success - -• **success**: `boolean` - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:123 diff --git a/docs/api/verida-js/interfaces/verida_web3._internal_.Web3ContractInfo.md b/docs/api/verida-js/interfaces/verida_web3._internal_.Web3ContractInfo.md deleted file mode 100644 index dfd1391..0000000 --- a/docs/api/verida-js/interfaces/verida_web3._internal_.Web3ContractInfo.md +++ /dev/null @@ -1,45 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web3](../modules/verida_web3.md) / [](../modules/verida_web3._internal_.md) / Web3ContractInfo - -# Interface: Web3ContractInfo - -[@verida/web3](../modules/verida_web3.md).[](../modules/verida_web3._internal_.md).Web3ContractInfo - -Contract Info. Used for 'web3' mode - -## Table of contents - -### Properties - -- [abi](verida_web3._internal_.Web3ContractInfo.md#abi) -- [address](verida_web3._internal_.Web3ContractInfo.md#address) -- [logPerformance](verida_web3._internal_.Web3ContractInfo.md#logperformance) - -## Properties - -### abi - -• **abi**: `any` - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:8 - -___ - -### address - -• **address**: `string` - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:9 - -___ - -### logPerformance - -• `Optional` **logPerformance**: `boolean` - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:10 diff --git a/docs/api/verida-js/interfaces/verida_web3._internal_.Web3GasConfiguration.md b/docs/api/verida-js/interfaces/verida_web3._internal_.Web3GasConfiguration.md deleted file mode 100644 index 3b43d56..0000000 --- a/docs/api/verida-js/interfaces/verida_web3._internal_.Web3GasConfiguration.md +++ /dev/null @@ -1,91 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web3](../modules/verida_web3.md) / [](../modules/verida_web3._internal_.md) / Web3GasConfiguration - -# Interface: Web3GasConfiguration - -[@verida/web3](../modules/verida_web3.md).[](../modules/verida_web3._internal_.md).Web3GasConfiguration - -Gas configuration - -eip1559Mode - optional - Once this parameter is set, all other parameters are not used. Gas information is pulled from network. - -maxFeePerGas - optional - Used for EIP1559 chains -maxPriorityFeePerGas - optional - Used for EIP1559 chains -gasLimit - optional - Used for non EIP1559 chains -gasPrice - optional - Used for non EIP1559 chains - -## Hierarchy - -- **`Web3GasConfiguration`** - - ↳ [`Web3SelfTransactionConfig`](verida_web3._internal_.Web3SelfTransactionConfig.md) - -## Table of contents - -### Properties - -- [eip1559Mode](verida_web3._internal_.Web3GasConfiguration.md#eip1559mode) -- [eip1559gasStationUrl](verida_web3._internal_.Web3GasConfiguration.md#eip1559gasstationurl) -- [gasLimit](verida_web3._internal_.Web3GasConfiguration.md#gaslimit) -- [gasPrice](verida_web3._internal_.Web3GasConfiguration.md#gasprice) -- [maxFeePerGas](verida_web3._internal_.Web3GasConfiguration.md#maxfeepergas) -- [maxPriorityFeePerGas](verida_web3._internal_.Web3GasConfiguration.md#maxpriorityfeepergas) - -## Properties - -### eip1559Mode - -• `Optional` **eip1559Mode**: [`EIP1559GasMode`](../modules/verida_web3._internal_.md#eip1559gasmode) - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:24 - -___ - -### eip1559gasStationUrl - -• `Optional` **eip1559gasStationUrl**: `string` - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:25 - -___ - -### gasLimit - -• `Optional` **gasLimit**: [`BigNumber`](../classes/verida_web3._internal_.BigNumber.md) - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:28 - -___ - -### gasPrice - -• `Optional` **gasPrice**: [`BigNumber`](../classes/verida_web3._internal_.BigNumber.md) - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:29 - -___ - -### maxFeePerGas - -• `Optional` **maxFeePerGas**: [`BigNumber`](../classes/verida_web3._internal_.BigNumber.md) - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:26 - -___ - -### maxPriorityFeePerGas - -• `Optional` **maxPriorityFeePerGas**: [`BigNumber`](../classes/verida_web3._internal_.BigNumber.md) - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:27 diff --git a/docs/api/verida-js/interfaces/verida_web3._internal_.Web3GaslessPostConfig.md b/docs/api/verida-js/interfaces/verida_web3._internal_.Web3GaslessPostConfig.md deleted file mode 100644 index 08d9f85..0000000 --- a/docs/api/verida-js/interfaces/verida_web3._internal_.Web3GaslessPostConfig.md +++ /dev/null @@ -1,37 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web3](../modules/verida_web3.md) / [](../modules/verida_web3._internal_.md) / Web3GaslessPostConfig - -# Interface: Web3GaslessPostConfig - -[@verida/web3](../modules/verida_web3.md).[](../modules/verida_web3._internal_.md).Web3GaslessPostConfig - -Configuration type for gasless post - -## Indexable - -▪ [key: `string`]: `any` - -## Table of contents - -### Properties - -- [headers](verida_web3._internal_.Web3GaslessPostConfig.md#headers) - -## Properties - -### headers - -• **headers**: `Object` - -#### Index signature - -▪ [key: `string`]: `any` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `user-agent` | `string` | - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:64 diff --git a/docs/api/verida-js/interfaces/verida_web3._internal_.Web3GaslessRequestConfig.md b/docs/api/verida-js/interfaces/verida_web3._internal_.Web3GaslessRequestConfig.md deleted file mode 100644 index cd3da9b..0000000 --- a/docs/api/verida-js/interfaces/verida_web3._internal_.Web3GaslessRequestConfig.md +++ /dev/null @@ -1,37 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web3](../modules/verida_web3.md) / [](../modules/verida_web3._internal_.md) / Web3GaslessRequestConfig - -# Interface: Web3GaslessRequestConfig - -[@verida/web3](../modules/verida_web3.md).[](../modules/verida_web3._internal_.md).Web3GaslessRequestConfig - -Configuration type for gasless request - -## Indexable - -▪ [key: `string`]: `any` - -## Table of contents - -### Properties - -- [headers](verida_web3._internal_.Web3GaslessRequestConfig.md#headers) - -## Properties - -### headers - -• **headers**: `Object` - -#### Index signature - -▪ [key: `string`]: `any` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `context-name` | `string` | - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:56 diff --git a/docs/api/verida-js/interfaces/verida_web3._internal_.Web3MetaTransactionConfig.md b/docs/api/verida-js/interfaces/verida_web3._internal_.Web3MetaTransactionConfig.md deleted file mode 100644 index d954f21..0000000 --- a/docs/api/verida-js/interfaces/verida_web3._internal_.Web3MetaTransactionConfig.md +++ /dev/null @@ -1,45 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web3](../modules/verida_web3.md) / [](../modules/verida_web3._internal_.md) / Web3MetaTransactionConfig - -# Interface: Web3MetaTransactionConfig - -[@verida/web3](../modules/verida_web3.md).[](../modules/verida_web3._internal_.md).Web3MetaTransactionConfig - -Configuration type for gasless mode - -## Table of contents - -### Properties - -- [endpointUrl](verida_web3._internal_.Web3MetaTransactionConfig.md#endpointurl) -- [postConfig](verida_web3._internal_.Web3MetaTransactionConfig.md#postconfig) -- [serverConfig](verida_web3._internal_.Web3MetaTransactionConfig.md#serverconfig) - -## Properties - -### endpointUrl - -• **endpointUrl**: `string` - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:51 - -___ - -### postConfig - -• **postConfig**: [`Web3GaslessPostConfig`](verida_web3._internal_.Web3GaslessPostConfig.md) - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:50 - -___ - -### serverConfig - -• **serverConfig**: [`Web3GaslessRequestConfig`](verida_web3._internal_.Web3GaslessRequestConfig.md) - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:49 diff --git a/docs/api/verida-js/interfaces/verida_web3._internal_.Web3SelfTransactionConfig.md b/docs/api/verida-js/interfaces/verida_web3._internal_.Web3SelfTransactionConfig.md deleted file mode 100644 index 20df426..0000000 --- a/docs/api/verida-js/interfaces/verida_web3._internal_.Web3SelfTransactionConfig.md +++ /dev/null @@ -1,179 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web3](../modules/verida_web3.md) / [](../modules/verida_web3._internal_.md) / Web3SelfTransactionConfig - -# Interface: Web3SelfTransactionConfig - -[@verida/web3](../modules/verida_web3.md).[](../modules/verida_web3._internal_.md).Web3SelfTransactionConfig - -Configuration type for Web3 mode - -signer - optional - a Signer that sign the blockchain transactions. If a 'signer' is not provided, then 'contract' with an attached signer need to be used to make transactions -provider - optional - a web3 provider. At least one of `signer`,`provider`, or `rpcUrl` is required -rpcUrl - optinal - a JSON-RPC URL that can be used to connect to an ethereum network. At least one of `signer`, `provider`, or `rpcUrl` is required -web3 - optional - Can use provider or web.currentProvider as a provider. - -## Hierarchy - -- [`Web3GasConfiguration`](verida_web3._internal_.Web3GasConfiguration.md) - - ↳ **`Web3SelfTransactionConfig`** - -## Table of contents - -### Properties - -- [eip1559Mode](verida_web3._internal_.Web3SelfTransactionConfig.md#eip1559mode) -- [eip1559gasStationUrl](verida_web3._internal_.Web3SelfTransactionConfig.md#eip1559gasstationurl) -- [gasLimit](verida_web3._internal_.Web3SelfTransactionConfig.md#gaslimit) -- [gasPrice](verida_web3._internal_.Web3SelfTransactionConfig.md#gasprice) -- [maxFeePerGas](verida_web3._internal_.Web3SelfTransactionConfig.md#maxfeepergas) -- [maxPriorityFeePerGas](verida_web3._internal_.Web3SelfTransactionConfig.md#maxpriorityfeepergas) -- [methodDefaults](verida_web3._internal_.Web3SelfTransactionConfig.md#methoddefaults) -- [privateKey](verida_web3._internal_.Web3SelfTransactionConfig.md#privatekey) -- [provider](verida_web3._internal_.Web3SelfTransactionConfig.md#provider) -- [rpcUrl](verida_web3._internal_.Web3SelfTransactionConfig.md#rpcurl) -- [signer](verida_web3._internal_.Web3SelfTransactionConfig.md#signer) -- [web3](verida_web3._internal_.Web3SelfTransactionConfig.md#web3) - -## Properties - -### eip1559Mode - -• `Optional` **eip1559Mode**: [`EIP1559GasMode`](../modules/verida_web3._internal_.md#eip1559gasmode) - -#### Inherited from - -[Web3GasConfiguration](verida_web3._internal_.Web3GasConfiguration.md).[eip1559Mode](verida_web3._internal_.Web3GasConfiguration.md#eip1559mode) - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:24 - -___ - -### eip1559gasStationUrl - -• `Optional` **eip1559gasStationUrl**: `string` - -#### Inherited from - -[Web3GasConfiguration](verida_web3._internal_.Web3GasConfiguration.md).[eip1559gasStationUrl](verida_web3._internal_.Web3GasConfiguration.md#eip1559gasstationurl) - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:25 - -___ - -### gasLimit - -• `Optional` **gasLimit**: [`BigNumber`](../classes/verida_web3._internal_.BigNumber.md) - -#### Inherited from - -[Web3GasConfiguration](verida_web3._internal_.Web3GasConfiguration.md).[gasLimit](verida_web3._internal_.Web3GasConfiguration.md#gaslimit) - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:28 - -___ - -### gasPrice - -• `Optional` **gasPrice**: [`BigNumber`](../classes/verida_web3._internal_.BigNumber.md) - -#### Inherited from - -[Web3GasConfiguration](verida_web3._internal_.Web3GasConfiguration.md).[gasPrice](verida_web3._internal_.Web3GasConfiguration.md#gasprice) - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:29 - -___ - -### maxFeePerGas - -• `Optional` **maxFeePerGas**: [`BigNumber`](../classes/verida_web3._internal_.BigNumber.md) - -#### Inherited from - -[Web3GasConfiguration](verida_web3._internal_.Web3GasConfiguration.md).[maxFeePerGas](verida_web3._internal_.Web3GasConfiguration.md#maxfeepergas) - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:26 - -___ - -### maxPriorityFeePerGas - -• `Optional` **maxPriorityFeePerGas**: [`BigNumber`](../classes/verida_web3._internal_.BigNumber.md) - -#### Inherited from - -[Web3GasConfiguration](verida_web3._internal_.Web3GasConfiguration.md).[maxPriorityFeePerGas](verida_web3._internal_.Web3GasConfiguration.md#maxpriorityfeepergas) - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:27 - -___ - -### methodDefaults - -• `Optional` **methodDefaults**: [`Record`](../modules/verida_web3._internal_.md#record)<`string`, [`Web3GasConfiguration`](verida_web3._internal_.Web3GasConfiguration.md)\> - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:45 - -___ - -### privateKey - -• `Optional` **privateKey**: `string` - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:41 - -___ - -### provider - -• `Optional` **provider**: [`Provider`](../classes/verida_web3._internal_.Provider.md) - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:42 - -___ - -### rpcUrl - -• `Optional` **rpcUrl**: `string` - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:43 - -___ - -### signer - -• `Optional` **signer**: [`Signer`](../classes/verida_web3._internal_.Signer.md) - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:40 - -___ - -### web3 - -• `Optional` **web3**: `any` - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:44 diff --git a/docs/api/verida-js/interfaces/verida_web3._internal_._Block.md b/docs/api/verida-js/interfaces/verida_web3._internal_._Block.md deleted file mode 100644 index 24f66be..0000000 --- a/docs/api/verida-js/interfaces/verida_web3._internal_._Block.md +++ /dev/null @@ -1,150 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web3](../modules/verida_web3.md) / [](../modules/verida_web3._internal_.md) / \_Block - -# Interface: \_Block - -[@verida/web3](../modules/verida_web3.md).[](../modules/verida_web3._internal_.md)._Block - -## Hierarchy - -- **`_Block`** - - ↳ [`Block`](verida_web3._internal_.Block.md) - - ↳ [`BlockWithTransactions`](verida_web3._internal_.BlockWithTransactions.md) - -## Table of contents - -### Properties - -- [\_difficulty](verida_web3._internal_._Block.md#_difficulty) -- [baseFeePerGas](verida_web3._internal_._Block.md#basefeepergas) -- [difficulty](verida_web3._internal_._Block.md#difficulty) -- [extraData](verida_web3._internal_._Block.md#extradata) -- [gasLimit](verida_web3._internal_._Block.md#gaslimit) -- [gasUsed](verida_web3._internal_._Block.md#gasused) -- [hash](verida_web3._internal_._Block.md#hash) -- [miner](verida_web3._internal_._Block.md#miner) -- [nonce](verida_web3._internal_._Block.md#nonce) -- [number](verida_web3._internal_._Block.md#number) -- [parentHash](verida_web3._internal_._Block.md#parenthash) -- [timestamp](verida_web3._internal_._Block.md#timestamp) - -## Properties - -### \_difficulty - -• **\_difficulty**: [`BigNumber`](../classes/verida_web3._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:41 - -___ - -### baseFeePerGas - -• `Optional` **baseFeePerGas**: ``null`` \| [`BigNumber`](../classes/verida_web3._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:46 - -___ - -### difficulty - -• **difficulty**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:40 - -___ - -### extraData - -• **extraData**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:45 - -___ - -### gasLimit - -• **gasLimit**: [`BigNumber`](../classes/verida_web3._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:42 - -___ - -### gasUsed - -• **gasUsed**: [`BigNumber`](../classes/verida_web3._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:43 - -___ - -### hash - -• **hash**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:35 - -___ - -### miner - -• **miner**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:44 - -___ - -### nonce - -• **nonce**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:39 - -___ - -### number - -• **number**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:37 - -___ - -### parentHash - -• **parentHash**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:36 - -___ - -### timestamp - -• **timestamp**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:38 diff --git a/docs/api/verida-js/interfaces/verida_web_helpers.WebUserConfig.md b/docs/api/verida-js/interfaces/verida_web_helpers.WebUserConfig.md deleted file mode 100644 index 1f280cd..0000000 --- a/docs/api/verida-js/interfaces/verida_web_helpers.WebUserConfig.md +++ /dev/null @@ -1,54 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / WebUserConfig - -# Interface: WebUserConfig - -[@verida/web-helpers](../modules/verida_web_helpers.md).WebUserConfig - -## Table of contents - -### Properties - -- [accountConfig](verida_web_helpers.WebUserConfig.md#accountconfig) -- [clientConfig](verida_web_helpers.WebUserConfig.md#clientconfig) -- [contextConfig](verida_web_helpers.WebUserConfig.md#contextconfig) -- [debug](verida_web_helpers.WebUserConfig.md#debug) - -## Properties - -### accountConfig - -• **accountConfig**: [`AccountVaultConfig`](verida_web_helpers._internal_.AccountVaultConfig.md) - -#### Defined in - -[packages/web-helpers/src/WebUser.ts:15](https://github.com/verida/verida-js/blob/5040472/packages/web-helpers/src/WebUser.ts#L15) - -___ - -### clientConfig - -• **clientConfig**: [`ClientConfig`](verida_web_helpers._internal_.ClientConfig.md) - -#### Defined in - -[packages/web-helpers/src/WebUser.ts:14](https://github.com/verida/verida-js/blob/5040472/packages/web-helpers/src/WebUser.ts#L14) - -___ - -### contextConfig - -• **contextConfig**: [`ContextConfig`](verida_web_helpers._internal_.ContextConfig.md) - -#### Defined in - -[packages/web-helpers/src/WebUser.ts:16](https://github.com/verida/verida-js/blob/5040472/packages/web-helpers/src/WebUser.ts#L16) - -___ - -### debug - -• `Optional` **debug**: `boolean` - -#### Defined in - -[packages/web-helpers/src/WebUser.ts:17](https://github.com/verida/verida-js/blob/5040472/packages/web-helpers/src/WebUser.ts#L17) diff --git a/docs/api/verida-js/interfaces/verida_web_helpers.WebUserMessage.md b/docs/api/verida-js/interfaces/verida_web_helpers.WebUserMessage.md deleted file mode 100644 index 5c8f2d3..0000000 --- a/docs/api/verida-js/interfaces/verida_web_helpers.WebUserMessage.md +++ /dev/null @@ -1,43 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / WebUserMessage - -# Interface: WebUserMessage - -[@verida/web-helpers](../modules/verida_web_helpers.md).WebUserMessage - -## Table of contents - -### Properties - -- [link](verida_web_helpers.WebUserMessage.md#link) -- [subject](verida_web_helpers.WebUserMessage.md#subject) -- [text](verida_web_helpers.WebUserMessage.md#text) - -## Properties - -### link - -• `Optional` **link**: [`WebUserMessageLink`](verida_web_helpers.WebUserMessageLink.md) - -#### Defined in - -[packages/web-helpers/src/WebUser.ts:23](https://github.com/verida/verida-js/blob/5040472/packages/web-helpers/src/WebUser.ts#L23) - -___ - -### subject - -• **subject**: `string` - -#### Defined in - -[packages/web-helpers/src/WebUser.ts:21](https://github.com/verida/verida-js/blob/5040472/packages/web-helpers/src/WebUser.ts#L21) - -___ - -### text - -• **text**: `string` - -#### Defined in - -[packages/web-helpers/src/WebUser.ts:22](https://github.com/verida/verida-js/blob/5040472/packages/web-helpers/src/WebUser.ts#L22) diff --git a/docs/api/verida-js/interfaces/verida_web_helpers.WebUserMessageLink.md b/docs/api/verida-js/interfaces/verida_web_helpers.WebUserMessageLink.md deleted file mode 100644 index 1aa8dce..0000000 --- a/docs/api/verida-js/interfaces/verida_web_helpers.WebUserMessageLink.md +++ /dev/null @@ -1,32 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / WebUserMessageLink - -# Interface: WebUserMessageLink - -[@verida/web-helpers](../modules/verida_web_helpers.md).WebUserMessageLink - -## Table of contents - -### Properties - -- [text](verida_web_helpers.WebUserMessageLink.md#text) -- [url](verida_web_helpers.WebUserMessageLink.md#url) - -## Properties - -### text - -• **text**: `string` - -#### Defined in - -[packages/web-helpers/src/WebUser.ts:28](https://github.com/verida/verida-js/blob/5040472/packages/web-helpers/src/WebUser.ts#L28) - -___ - -### url - -• **url**: `string` - -#### Defined in - -[packages/web-helpers/src/WebUser.ts:27](https://github.com/verida/verida-js/blob/5040472/packages/web-helpers/src/WebUser.ts#L27) diff --git a/docs/api/verida-js/interfaces/verida_web_helpers.WebUserProfile.md b/docs/api/verida-js/interfaces/verida_web_helpers.WebUserProfile.md deleted file mode 100644 index 2335283..0000000 --- a/docs/api/verida-js/interfaces/verida_web_helpers.WebUserProfile.md +++ /dev/null @@ -1,54 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / WebUserProfile - -# Interface: WebUserProfile - -[@verida/web-helpers](../modules/verida_web_helpers.md).WebUserProfile - -## Table of contents - -### Properties - -- [avatarUri](verida_web_helpers.WebUserProfile.md#avataruri) -- [country](verida_web_helpers.WebUserProfile.md#country) -- [description](verida_web_helpers.WebUserProfile.md#description) -- [name](verida_web_helpers.WebUserProfile.md#name) - -## Properties - -### avatarUri - -• `Optional` **avatarUri**: `string` - -#### Defined in - -[packages/web-helpers/src/WebUser.ts:8](https://github.com/verida/verida-js/blob/5040472/packages/web-helpers/src/WebUser.ts#L8) - -___ - -### country - -• `Optional` **country**: `string` - -#### Defined in - -[packages/web-helpers/src/WebUser.ts:9](https://github.com/verida/verida-js/blob/5040472/packages/web-helpers/src/WebUser.ts#L9) - -___ - -### description - -• `Optional` **description**: `string` - -#### Defined in - -[packages/web-helpers/src/WebUser.ts:10](https://github.com/verida/verida-js/blob/5040472/packages/web-helpers/src/WebUser.ts#L10) - -___ - -### name - -• `Optional` **name**: `string` - -#### Defined in - -[packages/web-helpers/src/WebUser.ts:7](https://github.com/verida/verida-js/blob/5040472/packages/web-helpers/src/WebUser.ts#L7) diff --git a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.AccountConfig.md b/docs/api/verida-js/interfaces/verida_web_helpers._internal_.AccountConfig.md deleted file mode 100644 index 9722877..0000000 --- a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.AccountConfig.md +++ /dev/null @@ -1,54 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / AccountConfig - -# Interface: AccountConfig - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).AccountConfig - -## Table of contents - -### Properties - -- [defaultDatabaseServer](verida_web_helpers._internal_.AccountConfig.md#defaultdatabaseserver) -- [defaultMessageServer](verida_web_helpers._internal_.AccountConfig.md#defaultmessageserver) -- [defaultNotificationServer](verida_web_helpers._internal_.AccountConfig.md#defaultnotificationserver) -- [defaultStorageServer](verida_web_helpers._internal_.AccountConfig.md#defaultstorageserver) - -## Properties - -### defaultDatabaseServer - -• **defaultDatabaseServer**: [`SecureContextEndpoint`](verida_web_helpers._internal_.SecureContextEndpoint.md) - -#### Defined in - -packages/types/dist/AccountInterfaces.d.ts:7 - -___ - -### defaultMessageServer - -• **defaultMessageServer**: [`SecureContextEndpoint`](verida_web_helpers._internal_.SecureContextEndpoint.md) - -#### Defined in - -packages/types/dist/AccountInterfaces.d.ts:8 - -___ - -### defaultNotificationServer - -• `Optional` **defaultNotificationServer**: [`SecureContextEndpoint`](verida_web_helpers._internal_.SecureContextEndpoint.md) - -#### Defined in - -packages/types/dist/AccountInterfaces.d.ts:10 - -___ - -### defaultStorageServer - -• `Optional` **defaultStorageServer**: [`SecureContextEndpoint`](verida_web_helpers._internal_.SecureContextEndpoint.md) - -#### Defined in - -packages/types/dist/AccountInterfaces.d.ts:9 diff --git a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.AccountVaultConfig.md b/docs/api/verida-js/interfaces/verida_web_helpers._internal_.AccountVaultConfig.md deleted file mode 100644 index 53be8d2..0000000 --- a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.AccountVaultConfig.md +++ /dev/null @@ -1,126 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / AccountVaultConfig - -# Interface: AccountVaultConfig - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).AccountVaultConfig - -## Table of contents - -### Properties - -- [canvasId](verida_web_helpers._internal_.AccountVaultConfig.md#canvasid) -- [deeplinkId](verida_web_helpers._internal_.AccountVaultConfig.md#deeplinkid) -- [environment](verida_web_helpers._internal_.AccountVaultConfig.md#environment) -- [loginUri](verida_web_helpers._internal_.AccountVaultConfig.md#loginuri) -- [request](verida_web_helpers._internal_.AccountVaultConfig.md#request) -- [schemeUri](verida_web_helpers._internal_.AccountVaultConfig.md#schemeuri) -- [serverUri](verida_web_helpers._internal_.AccountVaultConfig.md#serveruri) - -### Methods - -- [callback](verida_web_helpers._internal_.AccountVaultConfig.md#callback) -- [callbackRejected](verida_web_helpers._internal_.AccountVaultConfig.md#callbackrejected) - -## Properties - -### canvasId - -• `Optional` **canvasId**: `string` - -#### Defined in - -packages/types/dist/AccountInterfaces.d.ts:66 - -___ - -### deeplinkId - -• `Optional` **deeplinkId**: `string` - -#### Defined in - -packages/types/dist/AccountInterfaces.d.ts:68 - -___ - -### environment - -• `Optional` **environment**: [`EnvironmentType`](../enums/verida_web_helpers._internal_.EnvironmentType.md) - -#### Defined in - -packages/types/dist/AccountInterfaces.d.ts:70 - -___ - -### loginUri - -• `Optional` **loginUri**: `string` - -#### Defined in - -packages/types/dist/AccountInterfaces.d.ts:65 - -___ - -### request - -• `Optional` **request**: [`AccountVaultRequest`](verida_web_helpers._internal_.AccountVaultRequest.md) - -#### Defined in - -packages/types/dist/AccountInterfaces.d.ts:69 - -___ - -### schemeUri - -• `Optional` **schemeUri**: `string` - -#### Defined in - -packages/types/dist/AccountInterfaces.d.ts:67 - -___ - -### serverUri - -• `Optional` **serverUri**: `string` - -#### Defined in - -packages/types/dist/AccountInterfaces.d.ts:64 - -## Methods - -### callback - -▸ `Optional` **callback**(`response`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `response` | [`AuthResponse`](verida_web_helpers._internal_.AuthResponse.md) | - -#### Returns - -`void` - -#### Defined in - -packages/types/dist/AccountInterfaces.d.ts:71 - -___ - -### callbackRejected - -▸ `Optional` **callbackRejected**(): `void` - -#### Returns - -`void` - -#### Defined in - -packages/types/dist/AccountInterfaces.d.ts:72 diff --git a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.AccountVaultRequest.md b/docs/api/verida-js/interfaces/verida_web_helpers._internal_.AccountVaultRequest.md deleted file mode 100644 index 32b3b09..0000000 --- a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.AccountVaultRequest.md +++ /dev/null @@ -1,62 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / AccountVaultRequest - -# Interface: AccountVaultRequest - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).AccountVaultRequest - -## Table of contents - -### Properties - -- [logoUrl](verida_web_helpers._internal_.AccountVaultRequest.md#logourl) -- [openUrl](verida_web_helpers._internal_.AccountVaultRequest.md#openurl) -- [userAgent](verida_web_helpers._internal_.AccountVaultRequest.md#useragent) -- [walletConnect](verida_web_helpers._internal_.AccountVaultRequest.md#walletconnect) - -## Properties - -### logoUrl - -• `Optional` **logoUrl**: `string` - -#### Defined in - -packages/types/dist/AccountInterfaces.d.ts:54 - -___ - -### openUrl - -• `Optional` **openUrl**: `string` - -#### Defined in - -packages/types/dist/AccountInterfaces.d.ts:55 - -___ - -### userAgent - -• `Optional` **userAgent**: `string` - -#### Defined in - -packages/types/dist/AccountInterfaces.d.ts:61 - -___ - -### walletConnect - -• `Optional` **walletConnect**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `chainId` | `string` | -| `uri` | `string` | -| `version` | `number` | - -#### Defined in - -packages/types/dist/AccountInterfaces.d.ts:56 diff --git a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.ArrayLike.md b/docs/api/verida-js/interfaces/verida_web_helpers._internal_.ArrayLike.md deleted file mode 100644 index de52476..0000000 --- a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.ArrayLike.md +++ /dev/null @@ -1,31 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / ArrayLike - -# Interface: ArrayLike - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).ArrayLike - -## Type parameters - -| Name | -| :------ | -| `T` | - -## Indexable - -▪ [n: `number`]: `T` - -## Table of contents - -### Properties - -- [length](verida_web_helpers._internal_.ArrayLike.md#length) - -## Properties - -### length - -• `Readonly` **length**: `number` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1464 diff --git a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.AsyncFormatDefinition.md b/docs/api/verida-js/interfaces/verida_web_helpers._internal_.AsyncFormatDefinition.md deleted file mode 100644 index 67eb310..0000000 --- a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.AsyncFormatDefinition.md +++ /dev/null @@ -1,60 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / AsyncFormatDefinition - -# Interface: AsyncFormatDefinition - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).AsyncFormatDefinition - -## Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | extends `string` \| `number` | - -## Table of contents - -### Properties - -- [async](verida_web_helpers._internal_.AsyncFormatDefinition.md#async) -- [compare](verida_web_helpers._internal_.AsyncFormatDefinition.md#compare) -- [type](verida_web_helpers._internal_.AsyncFormatDefinition.md#type) -- [validate](verida_web_helpers._internal_.AsyncFormatDefinition.md#validate) - -## Properties - -### async - -• **async**: ``true`` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:166 - -___ - -### compare - -• `Optional` **compare**: [`FormatCompare`](../modules/verida_web_helpers._internal_.md#formatcompare)<`T`\> - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:167 - -___ - -### type - -• `Optional` **type**: `T` extends `string` ? `undefined` \| ``"string"`` : ``"number"`` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:164 - -___ - -### validate - -• **validate**: [`AsyncFormatValidator`](../modules/verida_web_helpers._internal_.md#asyncformatvalidator)<`T`\> - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:165 diff --git a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.AsyncIterableIterator.md b/docs/api/verida-js/interfaces/verida_web_helpers._internal_.AsyncIterableIterator.md deleted file mode 100644 index 659919f..0000000 --- a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.AsyncIterableIterator.md +++ /dev/null @@ -1,112 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / AsyncIterableIterator - -# Interface: AsyncIterableIterator - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).AsyncIterableIterator - -## Type parameters - -| Name | -| :------ | -| `T` | - -## Hierarchy - -- [`AsyncIterator`](verida_web_helpers._internal_.AsyncIterator.md)<`T`\> - - ↳ **`AsyncIterableIterator`** - -## Table of contents - -### Methods - -- [[asyncIterator]](verida_web_helpers._internal_.AsyncIterableIterator.md#[asynciterator]) -- [next](verida_web_helpers._internal_.AsyncIterableIterator.md#next) -- [return](verida_web_helpers._internal_.AsyncIterableIterator.md#return) -- [throw](verida_web_helpers._internal_.AsyncIterableIterator.md#throw) - -## Methods - -### [asyncIterator] - -▸ **[asyncIterator]**(): [`AsyncIterableIterator`](verida_web_helpers._internal_.AsyncIterableIterator.md)<`T`\> - -#### Returns - -[`AsyncIterableIterator`](verida_web_helpers._internal_.AsyncIterableIterator.md)<`T`\> - -#### Defined in - -node_modules/typescript/lib/lib.es2018.asynciterable.d.ts:44 - -___ - -### next - -▸ **next**(...`args`): `Promise`<[`IteratorResult`](../modules/verida_web_helpers._internal_.md#iteratorresult)<`T`, `any`\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `...args` | [] \| [`undefined`] | - -#### Returns - -`Promise`<[`IteratorResult`](../modules/verida_web_helpers._internal_.md#iteratorresult)<`T`, `any`\>\> - -#### Inherited from - -[AsyncIterator](verida_web_helpers._internal_.AsyncIterator.md).[next](verida_web_helpers._internal_.AsyncIterator.md#next) - -#### Defined in - -node_modules/typescript/lib/lib.es2018.asynciterable.d.ts:34 - -___ - -### return - -▸ `Optional` **return**(`value?`): `Promise`<[`IteratorResult`](../modules/verida_web_helpers._internal_.md#iteratorresult)<`T`, `any`\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value?` | `any` | - -#### Returns - -`Promise`<[`IteratorResult`](../modules/verida_web_helpers._internal_.md#iteratorresult)<`T`, `any`\>\> - -#### Inherited from - -[AsyncIterator](verida_web_helpers._internal_.AsyncIterator.md).[return](verida_web_helpers._internal_.AsyncIterator.md#return) - -#### Defined in - -node_modules/typescript/lib/lib.es2018.asynciterable.d.ts:35 - -___ - -### throw - -▸ `Optional` **throw**(`e?`): `Promise`<[`IteratorResult`](../modules/verida_web_helpers._internal_.md#iteratorresult)<`T`, `any`\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `e?` | `any` | - -#### Returns - -`Promise`<[`IteratorResult`](../modules/verida_web_helpers._internal_.md#iteratorresult)<`T`, `any`\>\> - -#### Inherited from - -[AsyncIterator](verida_web_helpers._internal_.AsyncIterator.md).[throw](verida_web_helpers._internal_.AsyncIterator.md#throw) - -#### Defined in - -node_modules/typescript/lib/lib.es2018.asynciterable.d.ts:36 diff --git a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.AsyncIterator.md b/docs/api/verida-js/interfaces/verida_web_helpers._internal_.AsyncIterator.md deleted file mode 100644 index 6a94eea..0000000 --- a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.AsyncIterator.md +++ /dev/null @@ -1,87 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / AsyncIterator - -# Interface: AsyncIterator - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).AsyncIterator - -## Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `T` | -| `TReturn` | `any` | -| `TNext` | `undefined` | - -## Hierarchy - -- **`AsyncIterator`** - - ↳ [`AsyncIterableIterator`](verida_web_helpers._internal_.AsyncIterableIterator.md) - -## Table of contents - -### Methods - -- [next](verida_web_helpers._internal_.AsyncIterator.md#next) -- [return](verida_web_helpers._internal_.AsyncIterator.md#return) -- [throw](verida_web_helpers._internal_.AsyncIterator.md#throw) - -## Methods - -### next - -▸ **next**(...`args`): `Promise`<[`IteratorResult`](../modules/verida_web_helpers._internal_.md#iteratorresult)<`T`, `TReturn`\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `...args` | [] \| [`TNext`] | - -#### Returns - -`Promise`<[`IteratorResult`](../modules/verida_web_helpers._internal_.md#iteratorresult)<`T`, `TReturn`\>\> - -#### Defined in - -node_modules/typescript/lib/lib.es2018.asynciterable.d.ts:34 - -___ - -### return - -▸ `Optional` **return**(`value?`): `Promise`<[`IteratorResult`](../modules/verida_web_helpers._internal_.md#iteratorresult)<`T`, `TReturn`\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value?` | `TReturn` \| [`PromiseLike`](verida_web_helpers._internal_.PromiseLike.md)<`TReturn`\> | - -#### Returns - -`Promise`<[`IteratorResult`](../modules/verida_web_helpers._internal_.md#iteratorresult)<`T`, `TReturn`\>\> - -#### Defined in - -node_modules/typescript/lib/lib.es2018.asynciterable.d.ts:35 - -___ - -### throw - -▸ `Optional` **throw**(`e?`): `Promise`<[`IteratorResult`](../modules/verida_web_helpers._internal_.md#iteratorresult)<`T`, `TReturn`\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `e?` | `any` | - -#### Returns - -`Promise`<[`IteratorResult`](../modules/verida_web_helpers._internal_.md#iteratorresult)<`T`, `TReturn`\>\> - -#### Defined in - -node_modules/typescript/lib/lib.es2018.asynciterable.d.ts:36 diff --git a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.AsyncSchema.md b/docs/api/verida-js/interfaces/verida_web_helpers._internal_.AsyncSchema.md deleted file mode 100644 index 220deb8..0000000 --- a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.AsyncSchema.md +++ /dev/null @@ -1,72 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / AsyncSchema - -# Interface: AsyncSchema - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).AsyncSchema - -## Hierarchy - -- [`_SchemaObject`](verida_web_helpers._internal_._SchemaObject.md) - - ↳ **`AsyncSchema`** - -## Table of contents - -### Properties - -- [$async](verida_web_helpers._internal_.AsyncSchema.md#$async) -- [$id](verida_web_helpers._internal_.AsyncSchema.md#$id) -- [$schema](verida_web_helpers._internal_.AsyncSchema.md#$schema) -- [id](verida_web_helpers._internal_.AsyncSchema.md#id) - -## Properties - -### $async - -• **$async**: ``true`` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:21 - -___ - -### $id - -• `Optional` **$id**: `string` - -#### Inherited from - -[_SchemaObject](verida_web_helpers._internal_._SchemaObject.md).[$id](verida_web_helpers._internal_._SchemaObject.md#$id) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:9 - -___ - -### $schema - -• `Optional` **$schema**: `string` - -#### Inherited from - -[_SchemaObject](verida_web_helpers._internal_._SchemaObject.md).[$schema](verida_web_helpers._internal_._SchemaObject.md#$schema) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:10 - -___ - -### id - -• `Optional` **id**: `string` - -#### Inherited from - -[_SchemaObject](verida_web_helpers._internal_._SchemaObject.md).[id](verida_web_helpers._internal_._SchemaObject.md#id) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:8 diff --git a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.AsyncValidateFunction.md b/docs/api/verida-js/interfaces/verida_web_helpers._internal_.AsyncValidateFunction.md deleted file mode 100644 index 2947d50..0000000 --- a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.AsyncValidateFunction.md +++ /dev/null @@ -1,147 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / AsyncValidateFunction - -# Interface: AsyncValidateFunction - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).AsyncValidateFunction - -## Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `unknown` | - -## Hierarchy - -- [`ValidateFunction`](verida_web_helpers._internal_.ValidateFunction.md)<`T`\> - - ↳ **`AsyncValidateFunction`** - -## Callable - -### AsyncValidateFunction - -▸ **AsyncValidateFunction**(...`args`): `Promise`<`T`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `...args` | [data: any, dataCxt?: DataValidationCxt] | - -#### Returns - -`Promise`<`T`\> - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:70 - -### AsyncValidateFunction - -▸ **AsyncValidateFunction**(`data`, `dataCxt?`): data is T - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `any` | -| `dataCxt?` | [`DataValidationCxt`](verida_web_helpers._internal_.DataValidationCxt.md)<`string` \| `number`\> | - -#### Returns - -data is T - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:47 - -## Table of contents - -### Properties - -- [$async](verida_web_helpers._internal_.AsyncValidateFunction.md#$async) -- [errors](verida_web_helpers._internal_.AsyncValidateFunction.md#errors) -- [evaluated](verida_web_helpers._internal_.AsyncValidateFunction.md#evaluated) -- [schema](verida_web_helpers._internal_.AsyncValidateFunction.md#schema) -- [schemaEnv](verida_web_helpers._internal_.AsyncValidateFunction.md#schemaenv) -- [source](verida_web_helpers._internal_.AsyncValidateFunction.md#source) - -## Properties - -### $async - -• **$async**: ``true`` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:71 - -___ - -### errors - -• `Optional` **errors**: ``null`` \| [`ErrorObject`](verida_web_helpers._internal_.ErrorObject.md)<`string`, [`Record`](../modules/verida_web_helpers._internal_.md#record)<`string`, `any`\>, `unknown`\>[] - -#### Inherited from - -[ValidateFunction](verida_web_helpers._internal_.ValidateFunction.md).[errors](verida_web_helpers._internal_.ValidateFunction.md#errors) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:48 - -___ - -### evaluated - -• `Optional` **evaluated**: [`Evaluated`](verida_web_helpers._internal_.Evaluated.md) - -#### Inherited from - -[ValidateFunction](verida_web_helpers._internal_.ValidateFunction.md).[evaluated](verida_web_helpers._internal_.ValidateFunction.md#evaluated) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:49 - -___ - -### schema - -• **schema**: [`AnySchema`](../modules/verida_web_helpers._internal_.md#anyschema) - -#### Inherited from - -[ValidateFunction](verida_web_helpers._internal_.ValidateFunction.md).[schema](verida_web_helpers._internal_.ValidateFunction.md#schema) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:50 - -___ - -### schemaEnv - -• **schemaEnv**: [`SchemaEnv`](../classes/verida_web_helpers._internal_.SchemaEnv.md) - -#### Inherited from - -[ValidateFunction](verida_web_helpers._internal_.ValidateFunction.md).[schemaEnv](verida_web_helpers._internal_.ValidateFunction.md#schemaenv) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:51 - -___ - -### source - -• `Optional` **source**: [`SourceCode`](verida_web_helpers._internal_.SourceCode.md) - -#### Inherited from - -[ValidateFunction](verida_web_helpers._internal_.ValidateFunction.md).[source](verida_web_helpers._internal_.ValidateFunction.md#source) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:52 diff --git a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.AuthContext.md b/docs/api/verida-js/interfaces/verida_web_helpers._internal_.AuthContext.md deleted file mode 100644 index 1e0d206..0000000 --- a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.AuthContext.md +++ /dev/null @@ -1,27 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / AuthContext - -# Interface: AuthContext - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).AuthContext - -## Hierarchy - -- **`AuthContext`** - - ↳ [`VeridaDatabaseAuthContext`](verida_web_helpers._internal_.VeridaDatabaseAuthContext.md) - -## Table of contents - -### Properties - -- [publicSigningKey](verida_web_helpers._internal_.AuthContext.md#publicsigningkey) - -## Properties - -### publicSigningKey - -• **publicSigningKey**: [`SecureContextPublicKey`](verida_web_helpers._internal_.SecureContextPublicKey.md) - -#### Defined in - -packages/types/dist/AccountInterfaces.d.ts:13 diff --git a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.AuthResponse.md b/docs/api/verida-js/interfaces/verida_web_helpers._internal_.AuthResponse.md deleted file mode 100644 index 03909d4..0000000 --- a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.AuthResponse.md +++ /dev/null @@ -1,43 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / AuthResponse - -# Interface: AuthResponse - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).AuthResponse - -## Table of contents - -### Properties - -- [message](verida_web_helpers._internal_.AuthResponse.md#message) -- [success](verida_web_helpers._internal_.AuthResponse.md#success) -- [type](verida_web_helpers._internal_.AuthResponse.md#type) - -## Properties - -### message - -• **message**: `string` - -#### Defined in - -packages/types/dist/AccountInterfaces.d.ts:88 - -___ - -### success - -• **success**: `boolean` - -#### Defined in - -packages/types/dist/AccountInterfaces.d.ts:87 - -___ - -### type - -• **type**: `string` - -#### Defined in - -packages/types/dist/AccountInterfaces.d.ts:86 diff --git a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.AuthTypeConfig.md b/docs/api/verida-js/interfaces/verida_web_helpers._internal_.AuthTypeConfig.md deleted file mode 100644 index 6d42287..0000000 --- a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.AuthTypeConfig.md +++ /dev/null @@ -1,21 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / AuthTypeConfig - -# Interface: AuthTypeConfig - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).AuthTypeConfig - -## Table of contents - -### Properties - -- [force](verida_web_helpers._internal_.AuthTypeConfig.md#force) - -## Properties - -### force - -• `Optional` **force**: `boolean` - -#### Defined in - -packages/types/dist/AccountInterfaces.d.ts:16 diff --git a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.Block.md b/docs/api/verida-js/interfaces/verida_web_helpers._internal_.Block.md deleted file mode 100644 index 0533cc7..0000000 --- a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.Block.md +++ /dev/null @@ -1,207 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / Block - -# Interface: Block - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).Block - -## Hierarchy - -- [`_Block`](verida_web_helpers._internal_._Block.md) - - ↳ **`Block`** - -## Table of contents - -### Properties - -- [\_difficulty](verida_web_helpers._internal_.Block.md#_difficulty) -- [baseFeePerGas](verida_web_helpers._internal_.Block.md#basefeepergas) -- [difficulty](verida_web_helpers._internal_.Block.md#difficulty) -- [extraData](verida_web_helpers._internal_.Block.md#extradata) -- [gasLimit](verida_web_helpers._internal_.Block.md#gaslimit) -- [gasUsed](verida_web_helpers._internal_.Block.md#gasused) -- [hash](verida_web_helpers._internal_.Block.md#hash) -- [miner](verida_web_helpers._internal_.Block.md#miner) -- [nonce](verida_web_helpers._internal_.Block.md#nonce) -- [number](verida_web_helpers._internal_.Block.md#number) -- [parentHash](verida_web_helpers._internal_.Block.md#parenthash) -- [timestamp](verida_web_helpers._internal_.Block.md#timestamp) -- [transactions](verida_web_helpers._internal_.Block.md#transactions) - -## Properties - -### \_difficulty - -• **\_difficulty**: [`BigNumber`](../classes/verida_web_helpers._internal_.BigNumber.md) - -#### Inherited from - -[_Block](verida_web_helpers._internal_._Block.md).[_difficulty](verida_web_helpers._internal_._Block.md#_difficulty) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:41 - -___ - -### baseFeePerGas - -• `Optional` **baseFeePerGas**: ``null`` \| [`BigNumber`](../classes/verida_web_helpers._internal_.BigNumber.md) - -#### Inherited from - -[_Block](verida_web_helpers._internal_._Block.md).[baseFeePerGas](verida_web_helpers._internal_._Block.md#basefeepergas) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:46 - -___ - -### difficulty - -• **difficulty**: `number` - -#### Inherited from - -[_Block](verida_web_helpers._internal_._Block.md).[difficulty](verida_web_helpers._internal_._Block.md#difficulty) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:40 - -___ - -### extraData - -• **extraData**: `string` - -#### Inherited from - -[_Block](verida_web_helpers._internal_._Block.md).[extraData](verida_web_helpers._internal_._Block.md#extradata) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:45 - -___ - -### gasLimit - -• **gasLimit**: [`BigNumber`](../classes/verida_web_helpers._internal_.BigNumber.md) - -#### Inherited from - -[_Block](verida_web_helpers._internal_._Block.md).[gasLimit](verida_web_helpers._internal_._Block.md#gaslimit) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:42 - -___ - -### gasUsed - -• **gasUsed**: [`BigNumber`](../classes/verida_web_helpers._internal_.BigNumber.md) - -#### Inherited from - -[_Block](verida_web_helpers._internal_._Block.md).[gasUsed](verida_web_helpers._internal_._Block.md#gasused) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:43 - -___ - -### hash - -• **hash**: `string` - -#### Inherited from - -[_Block](verida_web_helpers._internal_._Block.md).[hash](verida_web_helpers._internal_._Block.md#hash) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:35 - -___ - -### miner - -• **miner**: `string` - -#### Inherited from - -[_Block](verida_web_helpers._internal_._Block.md).[miner](verida_web_helpers._internal_._Block.md#miner) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:44 - -___ - -### nonce - -• **nonce**: `string` - -#### Inherited from - -[_Block](verida_web_helpers._internal_._Block.md).[nonce](verida_web_helpers._internal_._Block.md#nonce) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:39 - -___ - -### number - -• **number**: `number` - -#### Inherited from - -[_Block](verida_web_helpers._internal_._Block.md).[number](verida_web_helpers._internal_._Block.md#number) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:37 - -___ - -### parentHash - -• **parentHash**: `string` - -#### Inherited from - -[_Block](verida_web_helpers._internal_._Block.md).[parentHash](verida_web_helpers._internal_._Block.md#parenthash) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:36 - -___ - -### timestamp - -• **timestamp**: `number` - -#### Inherited from - -[_Block](verida_web_helpers._internal_._Block.md).[timestamp](verida_web_helpers._internal_._Block.md#timestamp) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:38 - -___ - -### transactions - -• **transactions**: `string`[] - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:49 diff --git a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.BlockWithTransactions.md b/docs/api/verida-js/interfaces/verida_web_helpers._internal_.BlockWithTransactions.md deleted file mode 100644 index da39d20..0000000 --- a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.BlockWithTransactions.md +++ /dev/null @@ -1,207 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / BlockWithTransactions - -# Interface: BlockWithTransactions - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).BlockWithTransactions - -## Hierarchy - -- [`_Block`](verida_web_helpers._internal_._Block.md) - - ↳ **`BlockWithTransactions`** - -## Table of contents - -### Properties - -- [\_difficulty](verida_web_helpers._internal_.BlockWithTransactions.md#_difficulty) -- [baseFeePerGas](verida_web_helpers._internal_.BlockWithTransactions.md#basefeepergas) -- [difficulty](verida_web_helpers._internal_.BlockWithTransactions.md#difficulty) -- [extraData](verida_web_helpers._internal_.BlockWithTransactions.md#extradata) -- [gasLimit](verida_web_helpers._internal_.BlockWithTransactions.md#gaslimit) -- [gasUsed](verida_web_helpers._internal_.BlockWithTransactions.md#gasused) -- [hash](verida_web_helpers._internal_.BlockWithTransactions.md#hash) -- [miner](verida_web_helpers._internal_.BlockWithTransactions.md#miner) -- [nonce](verida_web_helpers._internal_.BlockWithTransactions.md#nonce) -- [number](verida_web_helpers._internal_.BlockWithTransactions.md#number) -- [parentHash](verida_web_helpers._internal_.BlockWithTransactions.md#parenthash) -- [timestamp](verida_web_helpers._internal_.BlockWithTransactions.md#timestamp) -- [transactions](verida_web_helpers._internal_.BlockWithTransactions.md#transactions) - -## Properties - -### \_difficulty - -• **\_difficulty**: [`BigNumber`](../classes/verida_web_helpers._internal_.BigNumber.md) - -#### Inherited from - -[_Block](verida_web_helpers._internal_._Block.md).[_difficulty](verida_web_helpers._internal_._Block.md#_difficulty) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:41 - -___ - -### baseFeePerGas - -• `Optional` **baseFeePerGas**: ``null`` \| [`BigNumber`](../classes/verida_web_helpers._internal_.BigNumber.md) - -#### Inherited from - -[_Block](verida_web_helpers._internal_._Block.md).[baseFeePerGas](verida_web_helpers._internal_._Block.md#basefeepergas) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:46 - -___ - -### difficulty - -• **difficulty**: `number` - -#### Inherited from - -[_Block](verida_web_helpers._internal_._Block.md).[difficulty](verida_web_helpers._internal_._Block.md#difficulty) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:40 - -___ - -### extraData - -• **extraData**: `string` - -#### Inherited from - -[_Block](verida_web_helpers._internal_._Block.md).[extraData](verida_web_helpers._internal_._Block.md#extradata) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:45 - -___ - -### gasLimit - -• **gasLimit**: [`BigNumber`](../classes/verida_web_helpers._internal_.BigNumber.md) - -#### Inherited from - -[_Block](verida_web_helpers._internal_._Block.md).[gasLimit](verida_web_helpers._internal_._Block.md#gaslimit) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:42 - -___ - -### gasUsed - -• **gasUsed**: [`BigNumber`](../classes/verida_web_helpers._internal_.BigNumber.md) - -#### Inherited from - -[_Block](verida_web_helpers._internal_._Block.md).[gasUsed](verida_web_helpers._internal_._Block.md#gasused) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:43 - -___ - -### hash - -• **hash**: `string` - -#### Inherited from - -[_Block](verida_web_helpers._internal_._Block.md).[hash](verida_web_helpers._internal_._Block.md#hash) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:35 - -___ - -### miner - -• **miner**: `string` - -#### Inherited from - -[_Block](verida_web_helpers._internal_._Block.md).[miner](verida_web_helpers._internal_._Block.md#miner) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:44 - -___ - -### nonce - -• **nonce**: `string` - -#### Inherited from - -[_Block](verida_web_helpers._internal_._Block.md).[nonce](verida_web_helpers._internal_._Block.md#nonce) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:39 - -___ - -### number - -• **number**: `number` - -#### Inherited from - -[_Block](verida_web_helpers._internal_._Block.md).[number](verida_web_helpers._internal_._Block.md#number) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:37 - -___ - -### parentHash - -• **parentHash**: `string` - -#### Inherited from - -[_Block](verida_web_helpers._internal_._Block.md).[parentHash](verida_web_helpers._internal_._Block.md#parenthash) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:36 - -___ - -### timestamp - -• **timestamp**: `number` - -#### Inherited from - -[_Block](verida_web_helpers._internal_._Block.md).[timestamp](verida_web_helpers._internal_._Block.md#timestamp) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:38 - -___ - -### transactions - -• **transactions**: [`TransactionResponse`](verida_web_helpers._internal_.TransactionResponse.md)[] - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:52 diff --git a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.CallSite.md b/docs/api/verida-js/interfaces/verida_web_helpers._internal_.CallSite.md deleted file mode 100644 index 5065a65..0000000 --- a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.CallSite.md +++ /dev/null @@ -1,238 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / CallSite - -# Interface: CallSite - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).CallSite - -## Table of contents - -### Methods - -- [getColumnNumber](verida_web_helpers._internal_.CallSite.md#getcolumnnumber) -- [getEvalOrigin](verida_web_helpers._internal_.CallSite.md#getevalorigin) -- [getFileName](verida_web_helpers._internal_.CallSite.md#getfilename) -- [getFunction](verida_web_helpers._internal_.CallSite.md#getfunction) -- [getFunctionName](verida_web_helpers._internal_.CallSite.md#getfunctionname) -- [getLineNumber](verida_web_helpers._internal_.CallSite.md#getlinenumber) -- [getMethodName](verida_web_helpers._internal_.CallSite.md#getmethodname) -- [getThis](verida_web_helpers._internal_.CallSite.md#getthis) -- [getTypeName](verida_web_helpers._internal_.CallSite.md#gettypename) -- [isConstructor](verida_web_helpers._internal_.CallSite.md#isconstructor) -- [isEval](verida_web_helpers._internal_.CallSite.md#iseval) -- [isNative](verida_web_helpers._internal_.CallSite.md#isnative) -- [isToplevel](verida_web_helpers._internal_.CallSite.md#istoplevel) - -## Methods - -### getColumnNumber - -▸ **getColumnNumber**(): ``null`` \| `number` - -Current column number [if this function was defined in a script] - -#### Returns - -``null`` \| `number` - -#### Defined in - -node_modules/@types/node/globals.d.ts:154 - -___ - -### getEvalOrigin - -▸ **getEvalOrigin**(): `undefined` \| `string` - -A call site object representing the location where eval was called -[if this function was created using a call to eval] - -#### Returns - -`undefined` \| `string` - -#### Defined in - -node_modules/@types/node/globals.d.ts:160 - -___ - -### getFileName - -▸ **getFileName**(): ``null`` \| `string` - -Name of the script [if this function was defined in a script] - -#### Returns - -``null`` \| `string` - -#### Defined in - -node_modules/@types/node/globals.d.ts:144 - -___ - -### getFunction - -▸ **getFunction**(): `undefined` \| `Function` - -Current function - -#### Returns - -`undefined` \| `Function` - -#### Defined in - -node_modules/@types/node/globals.d.ts:126 - -___ - -### getFunctionName - -▸ **getFunctionName**(): ``null`` \| `string` - -Name of the current function, typically its name property. -If a name property is not available an attempt will be made to try -to infer a name from the function's context. - -#### Returns - -``null`` \| `string` - -#### Defined in - -node_modules/@types/node/globals.d.ts:133 - -___ - -### getLineNumber - -▸ **getLineNumber**(): ``null`` \| `number` - -Current line number [if this function was defined in a script] - -#### Returns - -``null`` \| `number` - -#### Defined in - -node_modules/@types/node/globals.d.ts:149 - -___ - -### getMethodName - -▸ **getMethodName**(): ``null`` \| `string` - -Name of the property [of "this" or one of its prototypes] that holds -the current function - -#### Returns - -``null`` \| `string` - -#### Defined in - -node_modules/@types/node/globals.d.ts:139 - -___ - -### getThis - -▸ **getThis**(): `unknown` - -Value of "this" - -#### Returns - -`unknown` - -#### Defined in - -node_modules/@types/node/globals.d.ts:113 - -___ - -### getTypeName - -▸ **getTypeName**(): ``null`` \| `string` - -Type of "this" as a string. -This is the name of the function stored in the constructor field of -"this", if available. Otherwise the object's [[Class]] internal -property. - -#### Returns - -``null`` \| `string` - -#### Defined in - -node_modules/@types/node/globals.d.ts:121 - -___ - -### isConstructor - -▸ **isConstructor**(): `boolean` - -Is this a constructor call? - -#### Returns - -`boolean` - -#### Defined in - -node_modules/@types/node/globals.d.ts:180 - -___ - -### isEval - -▸ **isEval**(): `boolean` - -Does this call take place in code defined by a call to eval? - -#### Returns - -`boolean` - -#### Defined in - -node_modules/@types/node/globals.d.ts:170 - -___ - -### isNative - -▸ **isNative**(): `boolean` - -Is this call in native V8 code? - -#### Returns - -`boolean` - -#### Defined in - -node_modules/@types/node/globals.d.ts:175 - -___ - -### isToplevel - -▸ **isToplevel**(): `boolean` - -Is this a toplevel invocation, that is, is "this" the global object? - -#### Returns - -`boolean` - -#### Defined in - -node_modules/@types/node/globals.d.ts:165 diff --git a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.ClientConfig.md b/docs/api/verida-js/interfaces/verida_web_helpers._internal_.ClientConfig.md deleted file mode 100644 index 401cba6..0000000 --- a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.ClientConfig.md +++ /dev/null @@ -1,64 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / ClientConfig - -# Interface: ClientConfig - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).ClientConfig - -Interface for ClientConfig - -## Table of contents - -### Properties - -- [didClientConfig](verida_web_helpers._internal_.ClientConfig.md#didclientconfig) -- [environment](verida_web_helpers._internal_.ClientConfig.md#environment) -- [schemaPaths](verida_web_helpers._internal_.ClientConfig.md#schemapaths) -- [vaultAppName](verida_web_helpers._internal_.ClientConfig.md#vaultappname) - -## Properties - -### didClientConfig - -• `Optional` **didClientConfig**: [`DIDClientConfig`](verida_web_helpers._internal_.DIDClientConfig.md) - -#### Defined in - -packages/types/dist/NetworkInterfaces.d.ts:39 - -___ - -### environment - -• `Optional` **environment**: [`EnvironmentType`](../enums/verida_web_helpers._internal_.EnvironmentType.md) - -Environment to load by default. - -Environment configuration can still be overridden by config items. - -#### Defined in - -packages/types/dist/NetworkInterfaces.d.ts:38 - -___ - -### schemaPaths - -• `Optional` **schemaPaths**: `object` - -Specify custom schema paths (typically for local development). - -#### Defined in - -packages/types/dist/NetworkInterfaces.d.ts:43 - -___ - -### vaultAppName - -• `Optional` **vaultAppName**: `string` - -Specify client's App name. - -#### Defined in - -packages/types/dist/NetworkInterfaces.d.ts:32 diff --git a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.CodeGenOptions.md b/docs/api/verida-js/interfaces/verida_web_helpers._internal_.CodeGenOptions.md deleted file mode 100644 index a67b63c..0000000 --- a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.CodeGenOptions.md +++ /dev/null @@ -1,43 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / CodeGenOptions - -# Interface: CodeGenOptions - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).CodeGenOptions - -## Table of contents - -### Properties - -- [es5](verida_web_helpers._internal_.CodeGenOptions.md#es5) -- [lines](verida_web_helpers._internal_.CodeGenOptions.md#lines) -- [ownProperties](verida_web_helpers._internal_.CodeGenOptions.md#ownproperties) - -## Properties - -### es5 - -• `Optional` **es5**: `boolean` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/index.d.ts:21 - -___ - -### lines - -• `Optional` **lines**: `boolean` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/index.d.ts:22 - -___ - -### ownProperties - -• `Optional` **ownProperties**: `boolean` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/index.d.ts:23 diff --git a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.CodeKeywordDefinition.md b/docs/api/verida-js/interfaces/verida_web_helpers._internal_.CodeKeywordDefinition.md deleted file mode 100644 index 04ac314..0000000 --- a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.CodeKeywordDefinition.md +++ /dev/null @@ -1,247 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / CodeKeywordDefinition - -# Interface: CodeKeywordDefinition - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).CodeKeywordDefinition - -## Hierarchy - -- [`_KeywordDef`](verida_web_helpers._internal_._KeywordDef.md) - - ↳ **`CodeKeywordDefinition`** - -## Table of contents - -### Properties - -- [$data](verida_web_helpers._internal_.CodeKeywordDefinition.md#$data) -- [$dataError](verida_web_helpers._internal_.CodeKeywordDefinition.md#$dataerror) -- [allowUndefined](verida_web_helpers._internal_.CodeKeywordDefinition.md#allowundefined) -- [before](verida_web_helpers._internal_.CodeKeywordDefinition.md#before) -- [dependencies](verida_web_helpers._internal_.CodeKeywordDefinition.md#dependencies) -- [error](verida_web_helpers._internal_.CodeKeywordDefinition.md#error) -- [implements](verida_web_helpers._internal_.CodeKeywordDefinition.md#implements) -- [keyword](verida_web_helpers._internal_.CodeKeywordDefinition.md#keyword) -- [metaSchema](verida_web_helpers._internal_.CodeKeywordDefinition.md#metaschema) -- [post](verida_web_helpers._internal_.CodeKeywordDefinition.md#post) -- [schemaType](verida_web_helpers._internal_.CodeKeywordDefinition.md#schematype) -- [trackErrors](verida_web_helpers._internal_.CodeKeywordDefinition.md#trackerrors) -- [type](verida_web_helpers._internal_.CodeKeywordDefinition.md#type) -- [validateSchema](verida_web_helpers._internal_.CodeKeywordDefinition.md#validateschema) - -### Methods - -- [code](verida_web_helpers._internal_.CodeKeywordDefinition.md#code) - -## Properties - -### $data - -• `Optional` **$data**: `boolean` - -#### Inherited from - -[_KeywordDef](verida_web_helpers._internal_._KeywordDef.md).[$data](verida_web_helpers._internal_._KeywordDef.md#$data) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:91 - -___ - -### $dataError - -• `Optional` **$dataError**: [`KeywordErrorDefinition`](verida_web_helpers._internal_.KeywordErrorDefinition.md) - -#### Inherited from - -[_KeywordDef](verida_web_helpers._internal_._KeywordDef.md).[$dataError](verida_web_helpers._internal_._KeywordDef.md#$dataerror) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:99 - -___ - -### allowUndefined - -• `Optional` **allowUndefined**: `boolean` - -#### Inherited from - -[_KeywordDef](verida_web_helpers._internal_._KeywordDef.md).[allowUndefined](verida_web_helpers._internal_._KeywordDef.md#allowundefined) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:90 - -___ - -### before - -• `Optional` **before**: `string` - -#### Inherited from - -[_KeywordDef](verida_web_helpers._internal_._KeywordDef.md).[before](verida_web_helpers._internal_._KeywordDef.md#before) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:93 - -___ - -### dependencies - -• `Optional` **dependencies**: `string`[] - -#### Inherited from - -[_KeywordDef](verida_web_helpers._internal_._KeywordDef.md).[dependencies](verida_web_helpers._internal_._KeywordDef.md#dependencies) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:97 - -___ - -### error - -• `Optional` **error**: [`KeywordErrorDefinition`](verida_web_helpers._internal_.KeywordErrorDefinition.md) - -#### Inherited from - -[_KeywordDef](verida_web_helpers._internal_._KeywordDef.md).[error](verida_web_helpers._internal_._KeywordDef.md#error) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:98 - -___ - -### implements - -• `Optional` **implements**: `string`[] - -#### Inherited from - -[_KeywordDef](verida_web_helpers._internal_._KeywordDef.md).[implements](verida_web_helpers._internal_._KeywordDef.md#implements) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:92 - -___ - -### keyword - -• **keyword**: `string` \| `string`[] - -#### Inherited from - -[_KeywordDef](verida_web_helpers._internal_._KeywordDef.md).[keyword](verida_web_helpers._internal_._KeywordDef.md#keyword) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:87 - -___ - -### metaSchema - -• `Optional` **metaSchema**: [`AnySchemaObject`](../modules/verida_web_helpers._internal_.md#anyschemaobject) - -#### Inherited from - -[_KeywordDef](verida_web_helpers._internal_._KeywordDef.md).[metaSchema](verida_web_helpers._internal_._KeywordDef.md#metaschema) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:95 - -___ - -### post - -• `Optional` **post**: `boolean` - -#### Inherited from - -[_KeywordDef](verida_web_helpers._internal_._KeywordDef.md).[post](verida_web_helpers._internal_._KeywordDef.md#post) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:94 - -___ - -### schemaType - -• `Optional` **schemaType**: ``"string"`` \| ``"number"`` \| ``"boolean"`` \| ``"object"`` \| ``"integer"`` \| ``"array"`` \| ``"null"`` \| (``"string"`` \| ``"number"`` \| ``"boolean"`` \| ``"object"`` \| ``"integer"`` \| ``"array"`` \| ``"null"``)[] - -#### Inherited from - -[_KeywordDef](verida_web_helpers._internal_._KeywordDef.md).[schemaType](verida_web_helpers._internal_._KeywordDef.md#schematype) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:89 - -___ - -### trackErrors - -• `Optional` **trackErrors**: `boolean` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:103 - -___ - -### type - -• `Optional` **type**: ``"string"`` \| ``"number"`` \| ``"boolean"`` \| ``"object"`` \| ``"integer"`` \| ``"array"`` \| ``"null"`` \| (``"string"`` \| ``"number"`` \| ``"boolean"`` \| ``"object"`` \| ``"integer"`` \| ``"array"`` \| ``"null"``)[] - -#### Inherited from - -[_KeywordDef](verida_web_helpers._internal_._KeywordDef.md).[type](verida_web_helpers._internal_._KeywordDef.md#type) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:88 - -___ - -### validateSchema - -• `Optional` **validateSchema**: [`AnyValidateFunction`](../modules/verida_web_helpers._internal_.md#anyvalidatefunction)<`any`\> - -#### Inherited from - -[_KeywordDef](verida_web_helpers._internal_._KeywordDef.md).[validateSchema](verida_web_helpers._internal_._KeywordDef.md#validateschema) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:96 - -## Methods - -### code - -▸ **code**(`cxt`, `ruleType?`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `cxt` | [`KeywordCxt`](../classes/verida_web_helpers._internal_.KeywordCxt.md) | -| `ruleType?` | `string` | - -#### Returns - -`void` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:102 diff --git a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.CodeOptions.md b/docs/api/verida-js/interfaces/verida_web_helpers._internal_.CodeOptions.md deleted file mode 100644 index 0e8e8de..0000000 --- a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.CodeOptions.md +++ /dev/null @@ -1,118 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / CodeOptions - -# Interface: CodeOptions - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).CodeOptions - -## Hierarchy - -- **`CodeOptions`** - - ↳ [`InstanceCodeOptions`](verida_web_helpers._internal_.InstanceCodeOptions.md) - -## Table of contents - -### Properties - -- [es5](verida_web_helpers._internal_.CodeOptions.md#es5) -- [esm](verida_web_helpers._internal_.CodeOptions.md#esm) -- [formats](verida_web_helpers._internal_.CodeOptions.md#formats) -- [lines](verida_web_helpers._internal_.CodeOptions.md#lines) -- [optimize](verida_web_helpers._internal_.CodeOptions.md#optimize) -- [regExp](verida_web_helpers._internal_.CodeOptions.md#regexp) -- [source](verida_web_helpers._internal_.CodeOptions.md#source) - -### Methods - -- [process](verida_web_helpers._internal_.CodeOptions.md#process) - -## Properties - -### es5 - -• `Optional` **es5**: `boolean` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:74 - -___ - -### esm - -• `Optional` **esm**: `boolean` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:75 - -___ - -### formats - -• `Optional` **formats**: [`Code`](../modules/verida_web_helpers._internal_.md#code) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:78 - -___ - -### lines - -• `Optional` **lines**: `boolean` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:76 - -___ - -### optimize - -• `Optional` **optimize**: `number` \| `boolean` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:77 - -___ - -### regExp - -• `Optional` **regExp**: [`RegExpEngine`](verida_web_helpers._internal_.RegExpEngine.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:81 - -___ - -### source - -• `Optional` **source**: `boolean` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:79 - -## Methods - -### process - -▸ `Optional` **process**(`code`, `schema?`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `code` | `string` | -| `schema?` | [`SchemaEnv`](../classes/verida_web_helpers._internal_.SchemaEnv.md) | - -#### Returns - -`string` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:80 diff --git a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.ContextCloseOptions.md b/docs/api/verida-js/interfaces/verida_web_helpers._internal_.ContextCloseOptions.md deleted file mode 100644 index d3f68f9..0000000 --- a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.ContextCloseOptions.md +++ /dev/null @@ -1,27 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / ContextCloseOptions - -# Interface: ContextCloseOptions - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).ContextCloseOptions - -## Hierarchy - -- **`ContextCloseOptions`** - - ↳ [`DatabaseCloseOptions`](verida_web_helpers._internal_.DatabaseCloseOptions.md) - -## Table of contents - -### Properties - -- [clearLocal](verida_web_helpers._internal_.ContextCloseOptions.md#clearlocal) - -## Properties - -### clearLocal - -• `Optional` **clearLocal**: `boolean` - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:71 diff --git a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.ContextConfig.md b/docs/api/verida-js/interfaces/verida_web_helpers._internal_.ContextConfig.md deleted file mode 100644 index abf34a1..0000000 --- a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.ContextConfig.md +++ /dev/null @@ -1,34 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / ContextConfig - -# Interface: ContextConfig - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).ContextConfig - -Interface for ContextConfig - -## Table of contents - -### Properties - -- [forceCreate](verida_web_helpers._internal_.ContextConfig.md#forcecreate) -- [name](verida_web_helpers._internal_.ContextConfig.md#name) - -## Properties - -### forceCreate - -• `Optional` **forceCreate**: `boolean` - -#### Defined in - -packages/types/dist/NetworkInterfaces.d.ts:50 - -___ - -### name - -• **name**: `string` - -#### Defined in - -packages/types/dist/NetworkInterfaces.d.ts:49 diff --git a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.ContextDatabaseInfo.md b/docs/api/verida-js/interfaces/verida_web_helpers._internal_.ContextDatabaseInfo.md deleted file mode 100644 index 48e5590..0000000 --- a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.ContextDatabaseInfo.md +++ /dev/null @@ -1,65 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / ContextDatabaseInfo - -# Interface: ContextDatabaseInfo - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).ContextDatabaseInfo - -## Table of contents - -### Properties - -- [activeEndpoint](verida_web_helpers._internal_.ContextDatabaseInfo.md#activeendpoint) -- [databases](verida_web_helpers._internal_.ContextDatabaseInfo.md#databases) -- [endpoints](verida_web_helpers._internal_.ContextDatabaseInfo.md#endpoints) -- [keys](verida_web_helpers._internal_.ContextDatabaseInfo.md#keys) -- [name](verida_web_helpers._internal_.ContextDatabaseInfo.md#name) - -## Properties - -### activeEndpoint - -• `Optional` **activeEndpoint**: `string` - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:136 - -___ - -### databases - -• **databases**: [`Record`](../modules/verida_web_helpers._internal_.md#record)<`string`, `object`\> - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:138 - -___ - -### endpoints - -• **endpoints**: [`Record`](../modules/verida_web_helpers._internal_.md#record)<`string`, `object`\> - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:137 - -___ - -### keys - -• **keys**: `any` - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:139 - -___ - -### name - -• **name**: `string` - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:135 diff --git a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.ContextInfo.md b/docs/api/verida-js/interfaces/verida_web_helpers._internal_.ContextInfo.md deleted file mode 100644 index 79e92d9..0000000 --- a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.ContextInfo.md +++ /dev/null @@ -1,21 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / ContextInfo - -# Interface: ContextInfo - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).ContextInfo - -## Table of contents - -### Properties - -- [databases](verida_web_helpers._internal_.ContextInfo.md#databases) - -## Properties - -### databases - -• **databases**: [`ContextDatabaseInfo`](verida_web_helpers._internal_.ContextDatabaseInfo.md) - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:142 diff --git a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.CurrentOptions.md b/docs/api/verida-js/interfaces/verida_web_helpers._internal_.CurrentOptions.md deleted file mode 100644 index 59316b4..0000000 --- a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.CurrentOptions.md +++ /dev/null @@ -1,518 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / CurrentOptions - -# Interface: CurrentOptions - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).CurrentOptions - -## Table of contents - -### Properties - -- [$comment](verida_web_helpers._internal_.CurrentOptions.md#$comment) -- [$data](verida_web_helpers._internal_.CurrentOptions.md#$data) -- [addUsedSchema](verida_web_helpers._internal_.CurrentOptions.md#addusedschema) -- [allErrors](verida_web_helpers._internal_.CurrentOptions.md#allerrors) -- [allowDate](verida_web_helpers._internal_.CurrentOptions.md#allowdate) -- [allowMatchingProperties](verida_web_helpers._internal_.CurrentOptions.md#allowmatchingproperties) -- [allowUnionTypes](verida_web_helpers._internal_.CurrentOptions.md#allowuniontypes) -- [code](verida_web_helpers._internal_.CurrentOptions.md#code) -- [coerceTypes](verida_web_helpers._internal_.CurrentOptions.md#coercetypes) -- [defaultMeta](verida_web_helpers._internal_.CurrentOptions.md#defaultmeta) -- [discriminator](verida_web_helpers._internal_.CurrentOptions.md#discriminator) -- [dynamicRef](verida_web_helpers._internal_.CurrentOptions.md#dynamicref) -- [formats](verida_web_helpers._internal_.CurrentOptions.md#formats) -- [inlineRefs](verida_web_helpers._internal_.CurrentOptions.md#inlinerefs) -- [int32range](verida_web_helpers._internal_.CurrentOptions.md#int32range) -- [jtd](verida_web_helpers._internal_.CurrentOptions.md#jtd) -- [keywords](verida_web_helpers._internal_.CurrentOptions.md#keywords) -- [logger](verida_web_helpers._internal_.CurrentOptions.md#logger) -- [loopEnum](verida_web_helpers._internal_.CurrentOptions.md#loopenum) -- [loopRequired](verida_web_helpers._internal_.CurrentOptions.md#looprequired) -- [messages](verida_web_helpers._internal_.CurrentOptions.md#messages) -- [meta](verida_web_helpers._internal_.CurrentOptions.md#meta) -- [multipleOfPrecision](verida_web_helpers._internal_.CurrentOptions.md#multipleofprecision) -- [next](verida_web_helpers._internal_.CurrentOptions.md#next) -- [ownProperties](verida_web_helpers._internal_.CurrentOptions.md#ownproperties) -- [parseDate](verida_web_helpers._internal_.CurrentOptions.md#parsedate) -- [passContext](verida_web_helpers._internal_.CurrentOptions.md#passcontext) -- [removeAdditional](verida_web_helpers._internal_.CurrentOptions.md#removeadditional) -- [schemaId](verida_web_helpers._internal_.CurrentOptions.md#schemaid) -- [schemas](verida_web_helpers._internal_.CurrentOptions.md#schemas) -- [strict](verida_web_helpers._internal_.CurrentOptions.md#strict) -- [strictNumbers](verida_web_helpers._internal_.CurrentOptions.md#strictnumbers) -- [strictRequired](verida_web_helpers._internal_.CurrentOptions.md#strictrequired) -- [strictSchema](verida_web_helpers._internal_.CurrentOptions.md#strictschema) -- [strictTuples](verida_web_helpers._internal_.CurrentOptions.md#stricttuples) -- [strictTypes](verida_web_helpers._internal_.CurrentOptions.md#stricttypes) -- [timestamp](verida_web_helpers._internal_.CurrentOptions.md#timestamp) -- [unevaluated](verida_web_helpers._internal_.CurrentOptions.md#unevaluated) -- [unicodeRegExp](verida_web_helpers._internal_.CurrentOptions.md#unicoderegexp) -- [uriResolver](verida_web_helpers._internal_.CurrentOptions.md#uriresolver) -- [useDefaults](verida_web_helpers._internal_.CurrentOptions.md#usedefaults) -- [validateFormats](verida_web_helpers._internal_.CurrentOptions.md#validateformats) -- [validateSchema](verida_web_helpers._internal_.CurrentOptions.md#validateschema) -- [verbose](verida_web_helpers._internal_.CurrentOptions.md#verbose) - -### Methods - -- [loadSchema](verida_web_helpers._internal_.CurrentOptions.md#loadschema) - -## Properties - -### $comment - -• `Optional` **$comment**: ``true`` \| (`comment`: `string`, `schemaPath?`: `string`, `rootSchema?`: [`AnySchemaObject`](../modules/verida_web_helpers._internal_.md#anyschemaobject)) => `unknown` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:40 - -___ - -### $data - -• `Optional` **$data**: `boolean` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:32 - -___ - -### addUsedSchema - -• `Optional` **addUsedSchema**: `boolean` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:61 - -___ - -### allErrors - -• `Optional` **allErrors**: `boolean` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:33 - -___ - -### allowDate - -• `Optional` **allowDate**: `boolean` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:39 - -___ - -### allowMatchingProperties - -• `Optional` **allowMatchingProperties**: `boolean` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:29 - -___ - -### allowUnionTypes - -• `Optional` **allowUnionTypes**: `boolean` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:30 - -___ - -### code - -• `Optional` **code**: [`CodeOptions`](verida_web_helpers._internal_.CodeOptions.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:70 - -___ - -### coerceTypes - -• `Optional` **coerceTypes**: `boolean` \| ``"array"`` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:52 - -___ - -### defaultMeta - -• `Optional` **defaultMeta**: `string` \| [`AnySchemaObject`](../modules/verida_web_helpers._internal_.md#anyschemaobject) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:59 - -___ - -### discriminator - -• `Optional` **discriminator**: `boolean` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:35 - -___ - -### dynamicRef - -• `Optional` **dynamicRef**: `boolean` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:55 - -___ - -### formats - -• `Optional` **formats**: `Object` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:41 - -___ - -### inlineRefs - -• `Optional` **inlineRefs**: `number` \| `boolean` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:62 - -___ - -### int32range - -• `Optional` **int32range**: `boolean` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:68 - -___ - -### jtd - -• `Optional` **jtd**: `boolean` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:57 - -___ - -### keywords - -• `Optional` **keywords**: [`Vocabulary`](../modules/verida_web_helpers._internal_.md#vocabulary) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:44 - -___ - -### logger - -• `Optional` **logger**: ``false`` \| [`Logger`](verida_web_helpers._internal_.Logger.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:48 - -___ - -### loopEnum - -• `Optional` **loopEnum**: `number` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:65 - -___ - -### loopRequired - -• `Optional` **loopRequired**: `number` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:64 - -___ - -### messages - -• `Optional` **messages**: `boolean` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:69 - -___ - -### meta - -• `Optional` **meta**: `boolean` \| [`SchemaObject`](verida_web_helpers._internal_.SchemaObject.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:58 - -___ - -### multipleOfPrecision - -• `Optional` **multipleOfPrecision**: `number` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:67 - -___ - -### next - -• `Optional` **next**: `boolean` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:53 - -___ - -### ownProperties - -• `Optional` **ownProperties**: `boolean` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:66 - -___ - -### parseDate - -• `Optional` **parseDate**: `boolean` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:38 - -___ - -### passContext - -• `Optional` **passContext**: `boolean` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:63 - -___ - -### removeAdditional - -• `Optional` **removeAdditional**: `boolean` \| ``"all"`` \| ``"failing"`` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:50 - -___ - -### schemaId - -• `Optional` **schemaId**: ``"id"`` \| ``"$id"`` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:56 - -___ - -### schemas - -• `Optional` **schemas**: [`AnySchema`](../modules/verida_web_helpers._internal_.md#anyschema)[] \| {} - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:45 - -___ - -### strict - -• `Optional` **strict**: `boolean` \| ``"log"`` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:23 - -___ - -### strictNumbers - -• `Optional` **strictNumbers**: `boolean` \| ``"log"`` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:25 - -___ - -### strictRequired - -• `Optional` **strictRequired**: `boolean` \| ``"log"`` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:28 - -___ - -### strictSchema - -• `Optional` **strictSchema**: `boolean` \| ``"log"`` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:24 - -___ - -### strictTuples - -• `Optional` **strictTuples**: `boolean` \| ``"log"`` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:27 - -___ - -### strictTypes - -• `Optional` **strictTypes**: `boolean` \| ``"log"`` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:26 - -___ - -### timestamp - -• `Optional` **timestamp**: ``"string"`` \| ``"date"`` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:37 - -___ - -### unevaluated - -• `Optional` **unevaluated**: `boolean` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:54 - -___ - -### unicodeRegExp - -• `Optional` **unicodeRegExp**: `boolean` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:36 - -___ - -### uriResolver - -• `Optional` **uriResolver**: [`UriResolver`](verida_web_helpers._internal_.UriResolver.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:71 - -___ - -### useDefaults - -• `Optional` **useDefaults**: `boolean` \| ``"empty"`` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:51 - -___ - -### validateFormats - -• `Optional` **validateFormats**: `boolean` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:31 - -___ - -### validateSchema - -• `Optional` **validateSchema**: `boolean` \| ``"log"`` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:60 - -___ - -### verbose - -• `Optional` **verbose**: `boolean` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:34 - -## Methods - -### loadSchema - -▸ `Optional` **loadSchema**(`uri`): `Promise`<[`AnySchemaObject`](../modules/verida_web_helpers._internal_.md#anyschemaobject)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `uri` | `string` | - -#### Returns - -`Promise`<[`AnySchemaObject`](../modules/verida_web_helpers._internal_.md#anyschemaobject)\> - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:49 diff --git a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.DIDClientConfig.md b/docs/api/verida-js/interfaces/verida_web_helpers._internal_.DIDClientConfig.md deleted file mode 100644 index 8efe7b1..0000000 --- a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.DIDClientConfig.md +++ /dev/null @@ -1,43 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / DIDClientConfig - -# Interface: DIDClientConfig - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).DIDClientConfig - -## Table of contents - -### Properties - -- [network](verida_web_helpers._internal_.DIDClientConfig.md#network) -- [rpcUrl](verida_web_helpers._internal_.DIDClientConfig.md#rpcurl) -- [timeout](verida_web_helpers._internal_.DIDClientConfig.md#timeout) - -## Properties - -### network - -• **network**: [`EnvironmentType`](../enums/verida_web_helpers._internal_.EnvironmentType.md) - -#### Defined in - -packages/types/dist/NetworkInterfaces.d.ts:21 - -___ - -### rpcUrl - -• `Optional` **rpcUrl**: `string` - -#### Defined in - -packages/types/dist/NetworkInterfaces.d.ts:22 - -___ - -### timeout - -• `Optional` **timeout**: `number` - -#### Defined in - -packages/types/dist/NetworkInterfaces.d.ts:23 diff --git a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.DOMEventTarget.md b/docs/api/verida-js/interfaces/verida_web_helpers._internal_.DOMEventTarget.md deleted file mode 100644 index fce502b..0000000 --- a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.DOMEventTarget.md +++ /dev/null @@ -1,34 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / DOMEventTarget - -# Interface: DOMEventTarget - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).DOMEventTarget - -## Table of contents - -### Methods - -- [addEventListener](verida_web_helpers._internal_.DOMEventTarget.md#addeventlistener) - -## Methods - -### addEventListener - -▸ **addEventListener**(`eventName`, `listener`, `opts?`): `any` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | `string` | -| `listener` | (...`args`: `any`[]) => `void` | -| `opts?` | `Object` | -| `opts.once` | `boolean` | - -#### Returns - -`any` - -#### Defined in - -node_modules/@types/node/events.d.ts:48 diff --git a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.DataValidateFunction.md b/docs/api/verida-js/interfaces/verida_web_helpers._internal_.DataValidateFunction.md deleted file mode 100644 index 757e60e..0000000 --- a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.DataValidateFunction.md +++ /dev/null @@ -1,41 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / DataValidateFunction - -# Interface: DataValidateFunction - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).DataValidateFunction - -## Callable - -### DataValidateFunction - -▸ **DataValidateFunction**(...`args`): `boolean` \| `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `...args` | [data: any, dataCxt?: DataValidationCxt] | - -#### Returns - -`boolean` \| `Promise`<`any`\> - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:108 - -## Table of contents - -### Properties - -- [errors](verida_web_helpers._internal_.DataValidateFunction.md#errors) - -## Properties - -### errors - -• `Optional` **errors**: [`Partial`](../modules/verida_web_helpers._internal_.md#partial)<[`ErrorObject`](verida_web_helpers._internal_.ErrorObject.md)<`string`, [`Record`](../modules/verida_web_helpers._internal_.md#record)<`string`, `any`\>, `unknown`\>\>[] - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:109 diff --git a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.DataValidationCxt.md b/docs/api/verida-js/interfaces/verida_web_helpers._internal_.DataValidationCxt.md deleted file mode 100644 index 1d789b8..0000000 --- a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.DataValidationCxt.md +++ /dev/null @@ -1,71 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / DataValidationCxt - -# Interface: DataValidationCxt - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).DataValidationCxt - -## Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | extends `string` \| `number` = `string` \| `number` | - -## Table of contents - -### Properties - -- [dynamicAnchors](verida_web_helpers._internal_.DataValidationCxt.md#dynamicanchors) -- [instancePath](verida_web_helpers._internal_.DataValidationCxt.md#instancepath) -- [parentData](verida_web_helpers._internal_.DataValidationCxt.md#parentdata) -- [parentDataProperty](verida_web_helpers._internal_.DataValidationCxt.md#parentdataproperty) -- [rootData](verida_web_helpers._internal_.DataValidationCxt.md#rootdata) - -## Properties - -### dynamicAnchors - -• **dynamicAnchors**: `Object` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:42 - -___ - -### instancePath - -• **instancePath**: `string` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:36 - -___ - -### parentData - -• **parentData**: { [K in string \| number]: any } - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:37 - -___ - -### parentDataProperty - -• **parentDataProperty**: `T` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:40 - -___ - -### rootData - -• **rootData**: `any`[] \| [`Record`](../modules/verida_web_helpers._internal_.md#record)<`string`, `any`\> - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:41 diff --git a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.DatabaseCloseOptions.md b/docs/api/verida-js/interfaces/verida_web_helpers._internal_.DatabaseCloseOptions.md deleted file mode 100644 index 5dc2a06..0000000 --- a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.DatabaseCloseOptions.md +++ /dev/null @@ -1,31 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / DatabaseCloseOptions - -# Interface: DatabaseCloseOptions - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).DatabaseCloseOptions - -## Hierarchy - -- [`ContextCloseOptions`](verida_web_helpers._internal_.ContextCloseOptions.md) - - ↳ **`DatabaseCloseOptions`** - -## Table of contents - -### Properties - -- [clearLocal](verida_web_helpers._internal_.DatabaseCloseOptions.md#clearlocal) - -## Properties - -### clearLocal - -• `Optional` **clearLocal**: `boolean` - -#### Inherited from - -[ContextCloseOptions](verida_web_helpers._internal_.ContextCloseOptions.md).[clearLocal](verida_web_helpers._internal_.ContextCloseOptions.md#clearlocal) - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:71 diff --git a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.DatabaseDeleteConfig.md b/docs/api/verida-js/interfaces/verida_web_helpers._internal_.DatabaseDeleteConfig.md deleted file mode 100644 index 5b7d3dd..0000000 --- a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.DatabaseDeleteConfig.md +++ /dev/null @@ -1,21 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / DatabaseDeleteConfig - -# Interface: DatabaseDeleteConfig - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).DatabaseDeleteConfig - -## Table of contents - -### Properties - -- [localOnly](verida_web_helpers._internal_.DatabaseDeleteConfig.md#localonly) - -## Properties - -### localOnly - -• `Optional` **localOnly**: `boolean` - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:68 diff --git a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.DatabaseOpenConfig.md b/docs/api/verida-js/interfaces/verida_web_helpers._internal_.DatabaseOpenConfig.md deleted file mode 100644 index 19762fd..0000000 --- a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.DatabaseOpenConfig.md +++ /dev/null @@ -1,187 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / DatabaseOpenConfig - -# Interface: DatabaseOpenConfig - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).DatabaseOpenConfig - -Interface for any DatabaseOpenConfig - -## Table of contents - -### Properties - -- [contextName](verida_web_helpers._internal_.DatabaseOpenConfig.md#contextname) -- [createContext](verida_web_helpers._internal_.DatabaseOpenConfig.md#createcontext) -- [did](verida_web_helpers._internal_.DatabaseOpenConfig.md#did) -- [encryptionKey](verida_web_helpers._internal_.DatabaseOpenConfig.md#encryptionkey) -- [endpoints](verida_web_helpers._internal_.DatabaseOpenConfig.md#endpoints) -- [ignoreCache](verida_web_helpers._internal_.DatabaseOpenConfig.md#ignorecache) -- [isOwner](verida_web_helpers._internal_.DatabaseOpenConfig.md#isowner) -- [permissions](verida_web_helpers._internal_.DatabaseOpenConfig.md#permissions) -- [readOnly](verida_web_helpers._internal_.DatabaseOpenConfig.md#readonly) -- [saveDatabase](verida_web_helpers._internal_.DatabaseOpenConfig.md#savedatabase) -- [signingContext](verida_web_helpers._internal_.DatabaseOpenConfig.md#signingcontext) -- [token](verida_web_helpers._internal_.DatabaseOpenConfig.md#token) -- [verifyEncryptionKey](verida_web_helpers._internal_.DatabaseOpenConfig.md#verifyencryptionkey) - -## Properties - -### contextName - -• `Optional` **contextName**: `string` - -Optionally specify an external context to open - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:53 - -___ - -### createContext - -• `Optional` **createContext**: `boolean` - -Create an application context if it doesn't already exist for the connected account. - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:49 - -___ - -### did - -• `Optional` **did**: `string` - -Specify the DID that owns the database. - -This ensures the Verida client connects to the correct database server hosting the data for the specified `did`. - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:17 - -___ - -### encryptionKey - -• `Optional` **encryptionKey**: `Buffer` - -An optional encryption key to use for encrypting / decrypting data. - -This encryption key will not apply if the database is marked as `public`. - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:45 - -___ - -### endpoints - -• `Optional` **endpoints**: `string` \| `string`[] - -Specify an array of possible database connection strings to use when opening the database. - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:21 - -___ - -### ignoreCache - -• `Optional` **ignoreCache**: `boolean` - -Ignore any cached instance already created - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:61 - -___ - -### isOwner - -• `Optional` **isOwner**: `boolean` - -Boolean indicating if it's expected the current connected account is the owner of this database. - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:39 - -___ - -### permissions - -• `Optional` **permissions**: [`DatabasePermissionsConfig`](verida_web_helpers._internal_.DatabasePermissionsConfig.md) - -Specify the permissions to use when opening this database. - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:11 - -___ - -### readOnly - -• `Optional` **readOnly**: `boolean` - -Open the database in read-only mode. - -This is useful when opening a database owned by an external `did` where the current authenticated account has no write access. - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:35 - -___ - -### saveDatabase - -• `Optional` **saveDatabase**: `boolean` - -Save this database into the user's master list of opened databases. - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:29 - -___ - -### signingContext - -• `Optional` **signingContext**: [`IContext`](verida_web_helpers._internal_.IContext.md) - -Optionally specify the context used to sign data - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:57 - -___ - -### token - -• `Optional` **token**: `string` - -Specify a JWT token to use when opening the database. - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:25 - -___ - -### verifyEncryptionKey - -• `Optional` **verifyEncryptionKey**: `boolean` - -Verify the encryption key is correct when opening the database - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:65 diff --git a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.DatabasePermissionsConfig.md b/docs/api/verida-js/interfaces/verida_web_helpers._internal_.DatabasePermissionsConfig.md deleted file mode 100644 index f675ee0..0000000 --- a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.DatabasePermissionsConfig.md +++ /dev/null @@ -1,56 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / DatabasePermissionsConfig - -# Interface: DatabasePermissionsConfig - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).DatabasePermissionsConfig - -Interface for any PermissionsConfig - -## Table of contents - -### Properties - -- [read](verida_web_helpers._internal_.DatabasePermissionsConfig.md#read) -- [readList](verida_web_helpers._internal_.DatabasePermissionsConfig.md#readlist) -- [write](verida_web_helpers._internal_.DatabasePermissionsConfig.md#write) -- [writeList](verida_web_helpers._internal_.DatabasePermissionsConfig.md#writelist) - -## Properties - -### read - -• **read**: [`DatabasePermissionOptionsEnum`](../enums/verida_web_helpers._internal_.DatabasePermissionOptionsEnum.md) - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:110 - -___ - -### readList - -• `Optional` **readList**: `string`[] - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:112 - -___ - -### write - -• **write**: [`DatabasePermissionOptionsEnum`](../enums/verida_web_helpers._internal_.DatabasePermissionOptionsEnum.md) - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:111 - -___ - -### writeList - -• `Optional` **writeList**: `string`[] - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:113 diff --git a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.DatastoreOpenConfig.md b/docs/api/verida-js/interfaces/verida_web_helpers._internal_.DatastoreOpenConfig.md deleted file mode 100644 index 3e9ae03..0000000 --- a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.DatastoreOpenConfig.md +++ /dev/null @@ -1,111 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / DatastoreOpenConfig - -# Interface: DatastoreOpenConfig - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).DatastoreOpenConfig - -Interface for any DatastoreOpenConfig - -## Table of contents - -### Properties - -- [contextName](verida_web_helpers._internal_.DatastoreOpenConfig.md#contextname) -- [createContext](verida_web_helpers._internal_.DatastoreOpenConfig.md#createcontext) -- [databaseName](verida_web_helpers._internal_.DatastoreOpenConfig.md#databasename) -- [did](verida_web_helpers._internal_.DatastoreOpenConfig.md#did) -- [encryptionKey](verida_web_helpers._internal_.DatastoreOpenConfig.md#encryptionkey) -- [external](verida_web_helpers._internal_.DatastoreOpenConfig.md#external) -- [permissions](verida_web_helpers._internal_.DatastoreOpenConfig.md#permissions) -- [readOnly](verida_web_helpers._internal_.DatastoreOpenConfig.md#readonly) -- [saveDatabase](verida_web_helpers._internal_.DatastoreOpenConfig.md#savedatabase) - -## Properties - -### contextName - -• `Optional` **contextName**: `string` - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:87 - -___ - -### createContext - -• `Optional` **createContext**: `boolean` - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:85 - -___ - -### databaseName - -• `Optional` **databaseName**: `string` - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:84 - -___ - -### did - -• `Optional` **did**: `string` - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:80 - -___ - -### encryptionKey - -• `Optional` **encryptionKey**: `string` - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:83 - -___ - -### external - -• `Optional` **external**: `boolean` - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:86 - -___ - -### permissions - -• `Optional` **permissions**: [`DatabasePermissionsConfig`](verida_web_helpers._internal_.DatabasePermissionsConfig.md) - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:79 - -___ - -### readOnly - -• `Optional` **readOnly**: `boolean` - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:82 - -___ - -### saveDatabase - -• `Optional` **saveDatabase**: `boolean` - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:81 diff --git a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.DbRegistryEntry.md b/docs/api/verida-js/interfaces/verida_web_helpers._internal_.DbRegistryEntry.md deleted file mode 100644 index ea7d0dd..0000000 --- a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.DbRegistryEntry.md +++ /dev/null @@ -1,100 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / DbRegistryEntry - -# Interface: DbRegistryEntry - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).DbRegistryEntry - -Interface for DbRegistryEntry - -## Table of contents - -### Properties - -- [contextName](verida_web_helpers._internal_.DbRegistryEntry.md#contextname) -- [dbHash](verida_web_helpers._internal_.DbRegistryEntry.md#dbhash) -- [dbName](verida_web_helpers._internal_.DbRegistryEntry.md#dbname) -- [did](verida_web_helpers._internal_.DbRegistryEntry.md#did) -- [encryptionKey](verida_web_helpers._internal_.DbRegistryEntry.md#encryptionkey) -- [endpoint](verida_web_helpers._internal_.DbRegistryEntry.md#endpoint) -- [endpointType](verida_web_helpers._internal_.DbRegistryEntry.md#endpointtype) -- [permissions](verida_web_helpers._internal_.DbRegistryEntry.md#permissions) - -## Properties - -### contextName - -• **contextName**: `string` - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:159 - -___ - -### dbHash - -• **dbHash**: `string` - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:155 - -___ - -### dbName - -• **dbName**: `string` - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:156 - -___ - -### did - -• **did**: `string` - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:158 - -___ - -### encryptionKey - -• `Optional` **encryptionKey**: [`DbRegistryEntryEncryptionKey`](verida_web_helpers._internal_.DbRegistryEntryEncryptionKey.md) - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:161 - -___ - -### endpoint - -• **endpoint**: `string` - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:162 - -___ - -### endpointType - -• **endpointType**: `string` - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:157 - -___ - -### permissions - -• **permissions**: [`DatabasePermissionsConfig`](verida_web_helpers._internal_.DatabasePermissionsConfig.md) - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:160 diff --git a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.DbRegistryEntryEncryptionKey.md b/docs/api/verida-js/interfaces/verida_web_helpers._internal_.DbRegistryEntryEncryptionKey.md deleted file mode 100644 index 8d68377..0000000 --- a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.DbRegistryEntryEncryptionKey.md +++ /dev/null @@ -1,34 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / DbRegistryEntryEncryptionKey - -# Interface: DbRegistryEntryEncryptionKey - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).DbRegistryEntryEncryptionKey - -Interface for DbRegistryEntryEncryptionKey - -## Table of contents - -### Properties - -- [key](verida_web_helpers._internal_.DbRegistryEntryEncryptionKey.md#key) -- [type](verida_web_helpers._internal_.DbRegistryEntryEncryptionKey.md#type) - -## Properties - -### key - -• **key**: `string` - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:148 - -___ - -### type - -• **type**: `string` - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:149 diff --git a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.DefaultClientConfig.md b/docs/api/verida-js/interfaces/verida_web_helpers._internal_.DefaultClientConfig.md deleted file mode 100644 index a99ca59..0000000 --- a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.DefaultClientConfig.md +++ /dev/null @@ -1,94 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / DefaultClientConfig - -# Interface: DefaultClientConfig - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).DefaultClientConfig - -## Hierarchy - -- [`DefaultEnvironmentConfig`](verida_web_helpers._internal_.DefaultEnvironmentConfig.md) - - ↳ **`DefaultClientConfig`** - -## Table of contents - -### Properties - -- [defaultDatabaseServerUrl](verida_web_helpers._internal_.DefaultClientConfig.md#defaultdatabaseserverurl) -- [defaultMessageServerUrl](verida_web_helpers._internal_.DefaultClientConfig.md#defaultmessageserverurl) -- [environment](verida_web_helpers._internal_.DefaultClientConfig.md#environment) -- [environments](verida_web_helpers._internal_.DefaultClientConfig.md#environments) -- [schemaPaths](verida_web_helpers._internal_.DefaultClientConfig.md#schemapaths) -- [vaultAppName](verida_web_helpers._internal_.DefaultClientConfig.md#vaultappname) - -## Properties - -### defaultDatabaseServerUrl - -• `Optional` **defaultDatabaseServerUrl**: `string` - -#### Inherited from - -[DefaultEnvironmentConfig](verida_web_helpers._internal_.DefaultEnvironmentConfig.md).[defaultDatabaseServerUrl](verida_web_helpers._internal_.DefaultEnvironmentConfig.md#defaultdatabaseserverurl) - -#### Defined in - -packages/types/dist/NetworkInterfaces.d.ts:11 - -___ - -### defaultMessageServerUrl - -• `Optional` **defaultMessageServerUrl**: `string` - -#### Inherited from - -[DefaultEnvironmentConfig](verida_web_helpers._internal_.DefaultEnvironmentConfig.md).[defaultMessageServerUrl](verida_web_helpers._internal_.DefaultEnvironmentConfig.md#defaultmessageserverurl) - -#### Defined in - -packages/types/dist/NetworkInterfaces.d.ts:12 - -___ - -### environment - -• **environment**: [`EnvironmentType`](../enums/verida_web_helpers._internal_.EnvironmentType.md) - -#### Defined in - -packages/types/dist/NetworkInterfaces.d.ts:16 - -___ - -### environments - -• **environments**: [`Record`](../modules/verida_web_helpers._internal_.md#record)<`string`, [`DefaultEnvironmentConfig`](verida_web_helpers._internal_.DefaultEnvironmentConfig.md)\> - -#### Defined in - -packages/types/dist/NetworkInterfaces.d.ts:17 - -___ - -### schemaPaths - -• `Optional` **schemaPaths**: [`Record`](../modules/verida_web_helpers._internal_.md#record)<`string`, `string`\> - -#### Inherited from - -[DefaultEnvironmentConfig](verida_web_helpers._internal_.DefaultEnvironmentConfig.md).[schemaPaths](verida_web_helpers._internal_.DefaultEnvironmentConfig.md#schemapaths) - -#### Defined in - -packages/types/dist/NetworkInterfaces.d.ts:13 - -___ - -### vaultAppName - -• **vaultAppName**: `string` - -#### Defined in - -packages/types/dist/NetworkInterfaces.d.ts:18 diff --git a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.DefaultEnvironmentConfig.md b/docs/api/verida-js/interfaces/verida_web_helpers._internal_.DefaultEnvironmentConfig.md deleted file mode 100644 index d41ea80..0000000 --- a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.DefaultEnvironmentConfig.md +++ /dev/null @@ -1,49 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / DefaultEnvironmentConfig - -# Interface: DefaultEnvironmentConfig - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).DefaultEnvironmentConfig - -## Hierarchy - -- **`DefaultEnvironmentConfig`** - - ↳ [`DefaultClientConfig`](verida_web_helpers._internal_.DefaultClientConfig.md) - -## Table of contents - -### Properties - -- [defaultDatabaseServerUrl](verida_web_helpers._internal_.DefaultEnvironmentConfig.md#defaultdatabaseserverurl) -- [defaultMessageServerUrl](verida_web_helpers._internal_.DefaultEnvironmentConfig.md#defaultmessageserverurl) -- [schemaPaths](verida_web_helpers._internal_.DefaultEnvironmentConfig.md#schemapaths) - -## Properties - -### defaultDatabaseServerUrl - -• `Optional` **defaultDatabaseServerUrl**: `string` - -#### Defined in - -packages/types/dist/NetworkInterfaces.d.ts:11 - -___ - -### defaultMessageServerUrl - -• `Optional` **defaultMessageServerUrl**: `string` - -#### Defined in - -packages/types/dist/NetworkInterfaces.d.ts:12 - -___ - -### schemaPaths - -• `Optional` **schemaPaths**: [`Record`](../modules/verida_web_helpers._internal_.md#record)<`string`, `string`\> - -#### Defined in - -packages/types/dist/NetworkInterfaces.d.ts:13 diff --git a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.DeprecatedOptions.md b/docs/api/verida-js/interfaces/verida_web_helpers._internal_.DeprecatedOptions.md deleted file mode 100644 index 3aa7035..0000000 --- a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.DeprecatedOptions.md +++ /dev/null @@ -1,49 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / DeprecatedOptions - -# Interface: DeprecatedOptions - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).DeprecatedOptions - -## Table of contents - -### Properties - -- [ignoreKeywordsWithRef](verida_web_helpers._internal_.DeprecatedOptions.md#ignorekeywordswithref) -- [jsPropertySyntax](verida_web_helpers._internal_.DeprecatedOptions.md#jspropertysyntax) -- [unicode](verida_web_helpers._internal_.DeprecatedOptions.md#unicode) - -## Properties - -### ignoreKeywordsWithRef - -• `Optional` **ignoreKeywordsWithRef**: `boolean` - -**`deprecated`** - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:89 - -___ - -### jsPropertySyntax - -• `Optional` **jsPropertySyntax**: `boolean` - -**`deprecated`** - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:91 - -___ - -### unicode - -• `Optional` **unicode**: `boolean` - -**`deprecated`** - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:93 diff --git a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.EndpointUsage.md b/docs/api/verida-js/interfaces/verida_web_helpers._internal_.EndpointUsage.md deleted file mode 100644 index 13a9ffe..0000000 --- a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.EndpointUsage.md +++ /dev/null @@ -1,43 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / EndpointUsage - -# Interface: EndpointUsage - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).EndpointUsage - -## Table of contents - -### Properties - -- [bytes](verida_web_helpers._internal_.EndpointUsage.md#bytes) -- [databases](verida_web_helpers._internal_.EndpointUsage.md#databases) -- [storageLimit](verida_web_helpers._internal_.EndpointUsage.md#storagelimit) - -## Properties - -### bytes - -• **bytes**: `number` - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:131 - -___ - -### databases - -• **databases**: `number` - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:130 - -___ - -### storageLimit - -• **storageLimit**: `number` - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:132 diff --git a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.Error.md b/docs/api/verida-js/interfaces/verida_web_helpers._internal_.Error.md deleted file mode 100644 index 8ce544c..0000000 --- a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.Error.md +++ /dev/null @@ -1,43 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / Error - -# Interface: Error - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).Error - -## Table of contents - -### Properties - -- [message](verida_web_helpers._internal_.Error.md#message) -- [name](verida_web_helpers._internal_.Error.md#name) -- [stack](verida_web_helpers._internal_.Error.md#stack) - -## Properties - -### message - -• **message**: `string` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:974 - -___ - -### name - -• **name**: `string` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:973 - -___ - -### stack - -• `Optional` **stack**: `string` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:975 diff --git a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.ErrorObject.md b/docs/api/verida-js/interfaces/verida_web_helpers._internal_.ErrorObject.md deleted file mode 100644 index 727c93c..0000000 --- a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.ErrorObject.md +++ /dev/null @@ -1,117 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / ErrorObject - -# Interface: ErrorObject - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).ErrorObject - -## Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends `string` = `string` | -| `P` | [`Record`](../modules/verida_web_helpers._internal_.md#record)<`string`, `any`\> | -| `S` | `unknown` | - -## Table of contents - -### Properties - -- [data](verida_web_helpers._internal_.ErrorObject.md#data) -- [instancePath](verida_web_helpers._internal_.ErrorObject.md#instancepath) -- [keyword](verida_web_helpers._internal_.ErrorObject.md#keyword) -- [message](verida_web_helpers._internal_.ErrorObject.md#message) -- [params](verida_web_helpers._internal_.ErrorObject.md#params) -- [parentSchema](verida_web_helpers._internal_.ErrorObject.md#parentschema) -- [propertyName](verida_web_helpers._internal_.ErrorObject.md#propertyname) -- [schema](verida_web_helpers._internal_.ErrorObject.md#schema) -- [schemaPath](verida_web_helpers._internal_.ErrorObject.md#schemapath) - -## Properties - -### data - -• `Optional` **data**: `unknown` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:83 - -___ - -### instancePath - -• **instancePath**: `string` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:76 - -___ - -### keyword - -• **keyword**: `K` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:75 - -___ - -### message - -• `Optional` **message**: `string` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:80 - -___ - -### params - -• **params**: `P` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:78 - -___ - -### parentSchema - -• `Optional` **parentSchema**: [`AnySchemaObject`](../modules/verida_web_helpers._internal_.md#anyschemaobject) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:82 - -___ - -### propertyName - -• `Optional` **propertyName**: `string` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:79 - -___ - -### schema - -• `Optional` **schema**: `S` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:81 - -___ - -### schemaPath - -• **schemaPath**: `string` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:77 diff --git a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.ErrorPaths.md b/docs/api/verida-js/interfaces/verida_web_helpers._internal_.ErrorPaths.md deleted file mode 100644 index 797d162..0000000 --- a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.ErrorPaths.md +++ /dev/null @@ -1,43 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / ErrorPaths - -# Interface: ErrorPaths - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).ErrorPaths - -## Table of contents - -### Properties - -- [instancePath](verida_web_helpers._internal_.ErrorPaths.md#instancepath) -- [parentSchema](verida_web_helpers._internal_.ErrorPaths.md#parentschema) -- [schemaPath](verida_web_helpers._internal_.ErrorPaths.md#schemapath) - -## Properties - -### instancePath - -• `Optional` **instancePath**: [`Code`](../modules/verida_web_helpers._internal_.md#code) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/errors.d.ts:6 - -___ - -### parentSchema - -• `Optional` **parentSchema**: `boolean` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/errors.d.ts:8 - -___ - -### schemaPath - -• `Optional` **schemaPath**: `string` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/errors.d.ts:7 diff --git a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.ErrorsTextOptions.md b/docs/api/verida-js/interfaces/verida_web_helpers._internal_.ErrorsTextOptions.md deleted file mode 100644 index e3ea583..0000000 --- a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.ErrorsTextOptions.md +++ /dev/null @@ -1,32 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / ErrorsTextOptions - -# Interface: ErrorsTextOptions - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).ErrorsTextOptions - -## Table of contents - -### Properties - -- [dataVar](verida_web_helpers._internal_.ErrorsTextOptions.md#datavar) -- [separator](verida_web_helpers._internal_.ErrorsTextOptions.md#separator) - -## Properties - -### dataVar - -• `Optional` **dataVar**: `string` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:172 - -___ - -### separator - -• `Optional` **separator**: `string` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:171 diff --git a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.Evaluated.md b/docs/api/verida-js/interfaces/verida_web_helpers._internal_.Evaluated.md deleted file mode 100644 index 4e60715..0000000 --- a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.Evaluated.md +++ /dev/null @@ -1,54 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / Evaluated - -# Interface: Evaluated - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).Evaluated - -## Table of contents - -### Properties - -- [dynamicItems](verida_web_helpers._internal_.Evaluated.md#dynamicitems) -- [dynamicProps](verida_web_helpers._internal_.Evaluated.md#dynamicprops) -- [items](verida_web_helpers._internal_.Evaluated.md#items) -- [props](verida_web_helpers._internal_.Evaluated.md#props) - -## Properties - -### dynamicItems - -• **dynamicItems**: `boolean` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:67 - -___ - -### dynamicProps - -• **dynamicProps**: `boolean` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:66 - -___ - -### items - -• `Optional` **items**: [`EvaluatedItems`](../modules/verida_web_helpers._internal_.md#evaluateditems) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:65 - -___ - -### props - -• `Optional` **props**: [`EvaluatedProperties`](../modules/verida_web_helpers._internal_.md#evaluatedproperties) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:64 diff --git a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.EventEmitter.Abortable.md b/docs/api/verida-js/interfaces/verida_web_helpers._internal_.EventEmitter.Abortable.md deleted file mode 100644 index 93e5c91..0000000 --- a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.EventEmitter.Abortable.md +++ /dev/null @@ -1,23 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / [EventEmitter](../modules/verida_web_helpers._internal_.EventEmitter.md) / Abortable - -# Interface: Abortable - -[](../modules/verida_web_helpers._internal_.md).[EventEmitter](../modules/verida_web_helpers._internal_.EventEmitter.md).Abortable - -## Table of contents - -### Properties - -- [signal](verida_web_helpers._internal_.EventEmitter.Abortable.md#signal) - -## Properties - -### signal - -• `Optional` **signal**: `AbortSignal` - -When provided the corresponding `AbortController` can be used to cancel an asynchronous action. - -#### Defined in - -node_modules/@types/node/events.d.ts:289 diff --git a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.EventEmitterOptions.md b/docs/api/verida-js/interfaces/verida_web_helpers._internal_.EventEmitterOptions.md deleted file mode 100644 index be32e16..0000000 --- a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.EventEmitterOptions.md +++ /dev/null @@ -1,23 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / EventEmitterOptions - -# Interface: EventEmitterOptions - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).EventEmitterOptions - -## Table of contents - -### Properties - -- [captureRejections](verida_web_helpers._internal_.EventEmitterOptions.md#capturerejections) - -## Properties - -### captureRejections - -• `Optional` **captureRejections**: `boolean` - -Enables automatic capturing of promise rejection. - -#### Defined in - -node_modules/@types/node/events.d.ts:42 diff --git a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.EventFilter.md b/docs/api/verida-js/interfaces/verida_web_helpers._internal_.EventFilter.md deleted file mode 100644 index 2541694..0000000 --- a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.EventFilter.md +++ /dev/null @@ -1,38 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / EventFilter - -# Interface: EventFilter - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).EventFilter - -## Hierarchy - -- **`EventFilter`** - - ↳ [`Filter`](verida_web_helpers._internal_.Filter.md) - -## Table of contents - -### Properties - -- [address](verida_web_helpers._internal_.EventFilter.md#address) -- [topics](verida_web_helpers._internal_.EventFilter.md#topics) - -## Properties - -### address - -• `Optional` **address**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:91 - -___ - -### topics - -• `Optional` **topics**: (``null`` \| `string` \| `string`[])[] - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:92 diff --git a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.FeeData.md b/docs/api/verida-js/interfaces/verida_web_helpers._internal_.FeeData.md deleted file mode 100644 index 98c1294..0000000 --- a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.FeeData.md +++ /dev/null @@ -1,54 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / FeeData - -# Interface: FeeData - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).FeeData - -## Table of contents - -### Properties - -- [gasPrice](verida_web_helpers._internal_.FeeData.md#gasprice) -- [lastBaseFeePerGas](verida_web_helpers._internal_.FeeData.md#lastbasefeepergas) -- [maxFeePerGas](verida_web_helpers._internal_.FeeData.md#maxfeepergas) -- [maxPriorityFeePerGas](verida_web_helpers._internal_.FeeData.md#maxpriorityfeepergas) - -## Properties - -### gasPrice - -• **gasPrice**: ``null`` \| [`BigNumber`](../classes/verida_web_helpers._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:88 - -___ - -### lastBaseFeePerGas - -• **lastBaseFeePerGas**: ``null`` \| [`BigNumber`](../classes/verida_web_helpers._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:85 - -___ - -### maxFeePerGas - -• **maxFeePerGas**: ``null`` \| [`BigNumber`](../classes/verida_web_helpers._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:86 - -___ - -### maxPriorityFeePerGas - -• **maxPriorityFeePerGas**: ``null`` \| [`BigNumber`](../classes/verida_web_helpers._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:87 diff --git a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.Filter.md b/docs/api/verida-js/interfaces/verida_web_helpers._internal_.Filter.md deleted file mode 100644 index cdda486..0000000 --- a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.Filter.md +++ /dev/null @@ -1,68 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / Filter - -# Interface: Filter - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).Filter - -## Hierarchy - -- [`EventFilter`](verida_web_helpers._internal_.EventFilter.md) - - ↳ **`Filter`** - -## Table of contents - -### Properties - -- [address](verida_web_helpers._internal_.Filter.md#address) -- [fromBlock](verida_web_helpers._internal_.Filter.md#fromblock) -- [toBlock](verida_web_helpers._internal_.Filter.md#toblock) -- [topics](verida_web_helpers._internal_.Filter.md#topics) - -## Properties - -### address - -• `Optional` **address**: `string` - -#### Inherited from - -[EventFilter](verida_web_helpers._internal_.EventFilter.md).[address](verida_web_helpers._internal_.EventFilter.md#address) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:91 - -___ - -### fromBlock - -• `Optional` **fromBlock**: [`BlockTag`](../modules/verida_web_helpers._internal_.md#blocktag) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:95 - -___ - -### toBlock - -• `Optional` **toBlock**: [`BlockTag`](../modules/verida_web_helpers._internal_.md#blocktag) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:96 - -___ - -### topics - -• `Optional` **topics**: (``null`` \| `string` \| `string`[])[] - -#### Inherited from - -[EventFilter](verida_web_helpers._internal_.EventFilter.md).[topics](verida_web_helpers._internal_.EventFilter.md#topics) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:92 diff --git a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.FormatDefinition.md b/docs/api/verida-js/interfaces/verida_web_helpers._internal_.FormatDefinition.md deleted file mode 100644 index 9d0f333..0000000 --- a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.FormatDefinition.md +++ /dev/null @@ -1,60 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / FormatDefinition - -# Interface: FormatDefinition - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).FormatDefinition - -## Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | extends `string` \| `number` | - -## Table of contents - -### Properties - -- [async](verida_web_helpers._internal_.FormatDefinition.md#async) -- [compare](verida_web_helpers._internal_.FormatDefinition.md#compare) -- [type](verida_web_helpers._internal_.FormatDefinition.md#type) -- [validate](verida_web_helpers._internal_.FormatDefinition.md#validate) - -## Properties - -### async - -• `Optional` **async**: ``false`` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:160 - -___ - -### compare - -• `Optional` **compare**: [`FormatCompare`](../modules/verida_web_helpers._internal_.md#formatcompare)<`T`\> - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:161 - -___ - -### type - -• `Optional` **type**: `T` extends `string` ? `undefined` \| ``"string"`` : ``"number"`` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:158 - -___ - -### validate - -• **validate**: [`FormatValidator`](../modules/verida_web_helpers._internal_.md#formatvalidator)<`T`\> \| `T` extends `string` ? `string` \| `RegExp` : `never` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:159 diff --git a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.FuncKeywordDefinition.md b/docs/api/verida-js/interfaces/verida_web_helpers._internal_.FuncKeywordDefinition.md deleted file mode 100644 index 7ca73ea..0000000 --- a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.FuncKeywordDefinition.md +++ /dev/null @@ -1,290 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / FuncKeywordDefinition - -# Interface: FuncKeywordDefinition - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).FuncKeywordDefinition - -## Hierarchy - -- [`_KeywordDef`](verida_web_helpers._internal_._KeywordDef.md) - - ↳ **`FuncKeywordDefinition`** - - ↳↳ [`MacroKeywordDefinition`](verida_web_helpers._internal_.MacroKeywordDefinition.md) - -## Table of contents - -### Properties - -- [$data](verida_web_helpers._internal_.FuncKeywordDefinition.md#$data) -- [$dataError](verida_web_helpers._internal_.FuncKeywordDefinition.md#$dataerror) -- [allowUndefined](verida_web_helpers._internal_.FuncKeywordDefinition.md#allowundefined) -- [async](verida_web_helpers._internal_.FuncKeywordDefinition.md#async) -- [before](verida_web_helpers._internal_.FuncKeywordDefinition.md#before) -- [compile](verida_web_helpers._internal_.FuncKeywordDefinition.md#compile) -- [dependencies](verida_web_helpers._internal_.FuncKeywordDefinition.md#dependencies) -- [error](verida_web_helpers._internal_.FuncKeywordDefinition.md#error) -- [errors](verida_web_helpers._internal_.FuncKeywordDefinition.md#errors) -- [implements](verida_web_helpers._internal_.FuncKeywordDefinition.md#implements) -- [keyword](verida_web_helpers._internal_.FuncKeywordDefinition.md#keyword) -- [metaSchema](verida_web_helpers._internal_.FuncKeywordDefinition.md#metaschema) -- [modifying](verida_web_helpers._internal_.FuncKeywordDefinition.md#modifying) -- [post](verida_web_helpers._internal_.FuncKeywordDefinition.md#post) -- [schema](verida_web_helpers._internal_.FuncKeywordDefinition.md#schema) -- [schemaType](verida_web_helpers._internal_.FuncKeywordDefinition.md#schematype) -- [type](verida_web_helpers._internal_.FuncKeywordDefinition.md#type) -- [valid](verida_web_helpers._internal_.FuncKeywordDefinition.md#valid) -- [validate](verida_web_helpers._internal_.FuncKeywordDefinition.md#validate) -- [validateSchema](verida_web_helpers._internal_.FuncKeywordDefinition.md#validateschema) - -## Properties - -### $data - -• `Optional` **$data**: `boolean` - -#### Inherited from - -[_KeywordDef](verida_web_helpers._internal_._KeywordDef.md).[$data](verida_web_helpers._internal_._KeywordDef.md#$data) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:91 - -___ - -### $dataError - -• `Optional` **$dataError**: [`KeywordErrorDefinition`](verida_web_helpers._internal_.KeywordErrorDefinition.md) - -#### Inherited from - -[_KeywordDef](verida_web_helpers._internal_._KeywordDef.md).[$dataError](verida_web_helpers._internal_._KeywordDef.md#$dataerror) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:99 - -___ - -### allowUndefined - -• `Optional` **allowUndefined**: `boolean` - -#### Inherited from - -[_KeywordDef](verida_web_helpers._internal_._KeywordDef.md).[allowUndefined](verida_web_helpers._internal_._KeywordDef.md#allowundefined) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:90 - -___ - -### async - -• `Optional` **async**: `boolean` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:120 - -___ - -### before - -• `Optional` **before**: `string` - -#### Inherited from - -[_KeywordDef](verida_web_helpers._internal_._KeywordDef.md).[before](verida_web_helpers._internal_._KeywordDef.md#before) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:93 - -___ - -### compile - -• `Optional` **compile**: [`CompileKeywordFunc`](../modules/verida_web_helpers._internal_.md#compilekeywordfunc) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:117 - -___ - -### dependencies - -• `Optional` **dependencies**: `string`[] - -#### Inherited from - -[_KeywordDef](verida_web_helpers._internal_._KeywordDef.md).[dependencies](verida_web_helpers._internal_._KeywordDef.md#dependencies) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:97 - -___ - -### error - -• `Optional` **error**: [`KeywordErrorDefinition`](verida_web_helpers._internal_.KeywordErrorDefinition.md) - -#### Inherited from - -[_KeywordDef](verida_web_helpers._internal_._KeywordDef.md).[error](verida_web_helpers._internal_._KeywordDef.md#error) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:98 - -___ - -### errors - -• `Optional` **errors**: `boolean` \| ``"full"`` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:122 - -___ - -### implements - -• `Optional` **implements**: `string`[] - -#### Inherited from - -[_KeywordDef](verida_web_helpers._internal_._KeywordDef.md).[implements](verida_web_helpers._internal_._KeywordDef.md#implements) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:92 - -___ - -### keyword - -• **keyword**: `string` \| `string`[] - -#### Inherited from - -[_KeywordDef](verida_web_helpers._internal_._KeywordDef.md).[keyword](verida_web_helpers._internal_._KeywordDef.md#keyword) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:87 - -___ - -### metaSchema - -• `Optional` **metaSchema**: [`AnySchemaObject`](../modules/verida_web_helpers._internal_.md#anyschemaobject) - -#### Inherited from - -[_KeywordDef](verida_web_helpers._internal_._KeywordDef.md).[metaSchema](verida_web_helpers._internal_._KeywordDef.md#metaschema) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:95 - -___ - -### modifying - -• `Optional` **modifying**: `boolean` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:119 - -___ - -### post - -• `Optional` **post**: `boolean` - -#### Inherited from - -[_KeywordDef](verida_web_helpers._internal_._KeywordDef.md).[post](verida_web_helpers._internal_._KeywordDef.md#post) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:94 - -___ - -### schema - -• `Optional` **schema**: `boolean` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:118 - -___ - -### schemaType - -• `Optional` **schemaType**: ``"string"`` \| ``"number"`` \| ``"boolean"`` \| ``"object"`` \| ``"integer"`` \| ``"array"`` \| ``"null"`` \| (``"string"`` \| ``"number"`` \| ``"boolean"`` \| ``"object"`` \| ``"integer"`` \| ``"array"`` \| ``"null"``)[] - -#### Inherited from - -[_KeywordDef](verida_web_helpers._internal_._KeywordDef.md).[schemaType](verida_web_helpers._internal_._KeywordDef.md#schematype) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:89 - -___ - -### type - -• `Optional` **type**: ``"string"`` \| ``"number"`` \| ``"boolean"`` \| ``"object"`` \| ``"integer"`` \| ``"array"`` \| ``"null"`` \| (``"string"`` \| ``"number"`` \| ``"boolean"`` \| ``"object"`` \| ``"integer"`` \| ``"array"`` \| ``"null"``)[] - -#### Inherited from - -[_KeywordDef](verida_web_helpers._internal_._KeywordDef.md).[type](verida_web_helpers._internal_._KeywordDef.md#type) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:88 - -___ - -### valid - -• `Optional` **valid**: `boolean` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:121 - -___ - -### validate - -• `Optional` **validate**: [`SchemaValidateFunction`](verida_web_helpers._internal_.SchemaValidateFunction.md) \| [`DataValidateFunction`](verida_web_helpers._internal_.DataValidateFunction.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:116 - -___ - -### validateSchema - -• `Optional` **validateSchema**: [`AnyValidateFunction`](../modules/verida_web_helpers._internal_.md#anyvalidatefunction)<`any`\> - -#### Inherited from - -[_KeywordDef](verida_web_helpers._internal_._KeywordDef.md).[validateSchema](verida_web_helpers._internal_._KeywordDef.md#validateschema) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:96 diff --git a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.Hexable.md b/docs/api/verida-js/interfaces/verida_web_helpers._internal_.Hexable.md deleted file mode 100644 index 07bf449..0000000 --- a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.Hexable.md +++ /dev/null @@ -1,29 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / Hexable - -# Interface: Hexable - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).Hexable - -## Implemented by - -- [`BigNumber`](../classes/verida_web_helpers._internal_.BigNumber.md) - -## Table of contents - -### Methods - -- [toHexString](verida_web_helpers._internal_.Hexable.md#tohexstring) - -## Methods - -### toHexString - -▸ **toHexString**(): `string` - -#### Returns - -`string` - -#### Defined in - -node_modules/@ethersproject/bytes/lib/index.d.ts:8 diff --git a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.IAccount.md b/docs/api/verida-js/interfaces/verida_web_helpers._internal_.IAccount.md deleted file mode 100644 index 08e0af2..0000000 --- a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.IAccount.md +++ /dev/null @@ -1,270 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / IAccount - -# Interface: IAccount - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).IAccount - -## Implemented by - -- [`default`](../classes/verida_web_helpers._internal_.default.md) - -## Table of contents - -### Methods - -- [createDidJwt](verida_web_helpers._internal_.IAccount.md#createdidjwt) -- [did](verida_web_helpers._internal_.IAccount.md#did) -- [disconnect](verida_web_helpers._internal_.IAccount.md#disconnect) -- [disconnectDevice](verida_web_helpers._internal_.IAccount.md#disconnectdevice) -- [getAuthContext](verida_web_helpers._internal_.IAccount.md#getauthcontext) -- [keyring](verida_web_helpers._internal_.IAccount.md#keyring) -- [linkStorage](verida_web_helpers._internal_.IAccount.md#linkstorage) -- [linkStorageContextService](verida_web_helpers._internal_.IAccount.md#linkstoragecontextservice) -- [setAccountConfig](verida_web_helpers._internal_.IAccount.md#setaccountconfig) -- [sign](verida_web_helpers._internal_.IAccount.md#sign) -- [storageConfig](verida_web_helpers._internal_.IAccount.md#storageconfig) -- [unlinkStorage](verida_web_helpers._internal_.IAccount.md#unlinkstorage) - -## Methods - -### createDidJwt - -▸ **createDidJwt**(`contextName`, `data`, `config`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | -| `data` | `object` | -| `config` | `any` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -packages/types/dist/IAccount.d.ts:13 - -___ - -### did - -▸ **did**(): `Promise`<`string`\> - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -packages/types/dist/IAccount.d.ts:7 - -___ - -### disconnect - -▸ **disconnect**(`contextName?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName?` | `string` | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -packages/types/dist/IAccount.d.ts:14 - -___ - -### disconnectDevice - -▸ **disconnectDevice**(`contextName`, `deviceId`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | -| `deviceId` | `string` | - -#### Returns - -`Promise`<`boolean`\> - -#### Defined in - -packages/types/dist/IAccount.d.ts:16 - -___ - -### getAuthContext - -▸ **getAuthContext**(`contextName`, `contextConfig`, `authConfig?`, `authType?`): `Promise`<[`AuthContext`](verida_web_helpers._internal_.AuthContext.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | -| `contextConfig` | [`SecureContextConfig`](verida_web_helpers._internal_.SecureContextConfig.md) | -| `authConfig?` | [`AuthTypeConfig`](verida_web_helpers._internal_.AuthTypeConfig.md) | -| `authType?` | `string` | - -#### Returns - -`Promise`<[`AuthContext`](verida_web_helpers._internal_.AuthContext.md)\> - -#### Defined in - -packages/types/dist/IAccount.d.ts:15 - -___ - -### keyring - -▸ **keyring**(`contextName`): `Promise`<[`IKeyring`](verida_web_helpers._internal_.IKeyring.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | - -#### Returns - -`Promise`<[`IKeyring`](verida_web_helpers._internal_.IKeyring.md)\> - -#### Defined in - -packages/types/dist/IAccount.d.ts:5 - -___ - -### linkStorage - -▸ **linkStorage**(`storageConfig`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `storageConfig` | [`SecureContextConfig`](verida_web_helpers._internal_.SecureContextConfig.md) | - -#### Returns - -`Promise`<`boolean`\> - -#### Defined in - -packages/types/dist/IAccount.d.ts:8 - -___ - -### linkStorageContextService - -▸ **linkStorageContextService**(`contextName`, `endpointType`, `serverType`, `endpointUris`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | -| `endpointType` | `string` | -| `serverType` | `string` | -| `endpointUris` | `string`[] | - -#### Returns - -`Promise`<`boolean`\> - -#### Defined in - -packages/types/dist/IAccount.d.ts:11 - -___ - -### setAccountConfig - -▸ **setAccountConfig**(`accountConfig`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `accountConfig` | [`AccountConfig`](verida_web_helpers._internal_.AccountConfig.md) | - -#### Returns - -`void` - -#### Defined in - -packages/types/dist/IAccount.d.ts:12 - -___ - -### sign - -▸ **sign**(`input`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `input` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -packages/types/dist/IAccount.d.ts:6 - -___ - -### storageConfig - -▸ **storageConfig**(`contextName`, `forceCreate`): `Promise`<`undefined` \| [`SecureContextConfig`](verida_web_helpers._internal_.SecureContextConfig.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | -| `forceCreate` | `boolean` | - -#### Returns - -`Promise`<`undefined` \| [`SecureContextConfig`](verida_web_helpers._internal_.SecureContextConfig.md)\> - -#### Defined in - -packages/types/dist/IAccount.d.ts:10 - -___ - -### unlinkStorage - -▸ **unlinkStorage**(`contextName`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | - -#### Returns - -`Promise`<`boolean`\> - -#### Defined in - -packages/types/dist/IAccount.d.ts:9 diff --git a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.IClient.md b/docs/api/verida-js/interfaces/verida_web_helpers._internal_.IClient.md deleted file mode 100644 index 22ee818..0000000 --- a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.IClient.md +++ /dev/null @@ -1,183 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / IClient - -# Interface: IClient - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).IClient - -## Implemented by - -- [`Client`](../classes/verida_web_helpers._internal_.Client.md) - -## Table of contents - -### Methods - -- [connect](verida_web_helpers._internal_.IClient.md#connect) -- [getContextConfig](verida_web_helpers._internal_.IClient.md#getcontextconfig) -- [getSchema](verida_web_helpers._internal_.IClient.md#getschema) -- [getValidDataSignatures](verida_web_helpers._internal_.IClient.md#getvaliddatasignatures) -- [isConnected](verida_web_helpers._internal_.IClient.md#isconnected) -- [openContext](verida_web_helpers._internal_.IClient.md#opencontext) -- [openExternalContext](verida_web_helpers._internal_.IClient.md#openexternalcontext) -- [openPublicProfile](verida_web_helpers._internal_.IClient.md#openpublicprofile) - -## Methods - -### connect - -▸ **connect**(`account`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `account` | [`IAccount`](verida_web_helpers._internal_.IAccount.md) | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -packages/types/dist/IClient.d.ts:7 - -___ - -### getContextConfig - -▸ **getContextConfig**(`did`, `contextName`): `Promise`<`undefined` \| [`SecureContextConfig`](verida_web_helpers._internal_.SecureContextConfig.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did` | `string` | -| `contextName` | `string` | - -#### Returns - -`Promise`<`undefined` \| [`SecureContextConfig`](verida_web_helpers._internal_.SecureContextConfig.md)\> - -#### Defined in - -packages/types/dist/IClient.d.ts:11 - -___ - -### getSchema - -▸ **getSchema**(`schemaUri`): `Promise`<[`ISchema`](verida_web_helpers._internal_.ISchema.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schemaUri` | `string` | - -#### Returns - -`Promise`<[`ISchema`](verida_web_helpers._internal_.ISchema.md)\> - -#### Defined in - -packages/types/dist/IClient.d.ts:14 - -___ - -### getValidDataSignatures - -▸ **getValidDataSignatures**(`data`, `did?`): `Promise`<`string`[]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `any` | -| `did?` | `string` | - -#### Returns - -`Promise`<`string`[]\> - -#### Defined in - -packages/types/dist/IClient.d.ts:13 - -___ - -### isConnected - -▸ **isConnected**(): `void` - -#### Returns - -`void` - -#### Defined in - -packages/types/dist/IClient.d.ts:8 - -___ - -### openContext - -▸ **openContext**(`contextName`, `forceCreate`): `Promise`<`undefined` \| [`IContext`](verida_web_helpers._internal_.IContext.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | -| `forceCreate` | `boolean` | - -#### Returns - -`Promise`<`undefined` \| [`IContext`](verida_web_helpers._internal_.IContext.md)\> - -#### Defined in - -packages/types/dist/IClient.d.ts:9 - -___ - -### openExternalContext - -▸ **openExternalContext**(`contextName`, `did`): `Promise`<[`IContext`](verida_web_helpers._internal_.IContext.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | -| `did` | `string` | - -#### Returns - -`Promise`<[`IContext`](verida_web_helpers._internal_.IContext.md)\> - -#### Defined in - -packages/types/dist/IClient.d.ts:10 - -___ - -### openPublicProfile - -▸ **openPublicProfile**(`did`, `contextName`, `profileName`, `fallbackContext`): `Promise`<`undefined` \| [`IProfile`](verida_web_helpers._internal_.IProfile.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did` | `string` | -| `contextName` | `string` | -| `profileName` | `string` | -| `fallbackContext` | ``null`` \| `string` | - -#### Returns - -`Promise`<`undefined` \| [`IProfile`](verida_web_helpers._internal_.IProfile.md)\> - -#### Defined in - -packages/types/dist/IClient.d.ts:12 diff --git a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.IContext.md b/docs/api/verida-js/interfaces/verida_web_helpers._internal_.IContext.md deleted file mode 100644 index c46121d..0000000 --- a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.IContext.md +++ /dev/null @@ -1,406 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / IContext - -# Interface: IContext - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).IContext - -## Implemented by - -- [`Context`](../classes/verida_web_helpers._internal_.Context.md) - -## Table of contents - -### Methods - -- [addEndpoint](verida_web_helpers._internal_.IContext.md#addendpoint) -- [clearDatabaseCache](verida_web_helpers._internal_.IContext.md#cleardatabasecache) -- [close](verida_web_helpers._internal_.IContext.md#close) -- [disconnect](verida_web_helpers._internal_.IContext.md#disconnect) -- [getAccount](verida_web_helpers._internal_.IContext.md#getaccount) -- [getAuthContext](verida_web_helpers._internal_.IContext.md#getauthcontext) -- [getClient](verida_web_helpers._internal_.IContext.md#getclient) -- [getContextConfig](verida_web_helpers._internal_.IContext.md#getcontextconfig) -- [getContextName](verida_web_helpers._internal_.IContext.md#getcontextname) -- [getDatabaseEngine](verida_web_helpers._internal_.IContext.md#getdatabaseengine) -- [getDbRegistry](verida_web_helpers._internal_.IContext.md#getdbregistry) -- [getDidContextManager](verida_web_helpers._internal_.IContext.md#getdidcontextmanager) -- [getMessaging](verida_web_helpers._internal_.IContext.md#getmessaging) -- [getNotification](verida_web_helpers._internal_.IContext.md#getnotification) -- [info](verida_web_helpers._internal_.IContext.md#info) -- [openDatabase](verida_web_helpers._internal_.IContext.md#opendatabase) -- [openDatastore](verida_web_helpers._internal_.IContext.md#opendatastore) -- [openExternalDatabase](verida_web_helpers._internal_.IContext.md#openexternaldatabase) -- [openExternalDatastore](verida_web_helpers._internal_.IContext.md#openexternaldatastore) -- [openProfile](verida_web_helpers._internal_.IContext.md#openprofile) - -## Methods - -### addEndpoint - -▸ **addEndpoint**(`engineType`, `endpointUri`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `engineType` | [`ContextEngineType`](../enums/verida_web_helpers._internal_.ContextEngineType.md) | -| `endpointUri` | `string` | - -#### Returns - -`void` - -#### Defined in - -packages/types/dist/IContext.d.ts:32 - -___ - -### clearDatabaseCache - -▸ **clearDatabaseCache**(`did`, `databaseName`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did` | `string` | -| `databaseName` | `string` | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -packages/types/dist/IContext.d.ts:34 - -___ - -### close - -▸ **close**(`options?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options?` | [`ContextCloseOptions`](verida_web_helpers._internal_.ContextCloseOptions.md) | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -packages/types/dist/IContext.d.ts:33 - -___ - -### disconnect - -▸ **disconnect**(): `Promise`<`boolean`\> - -#### Returns - -`Promise`<`boolean`\> - -#### Defined in - -packages/types/dist/IContext.d.ts:20 - -___ - -### getAccount - -▸ **getAccount**(): [`IAccount`](verida_web_helpers._internal_.IAccount.md) - -#### Returns - -[`IAccount`](verida_web_helpers._internal_.IAccount.md) - -#### Defined in - -packages/types/dist/IContext.d.ts:17 - -___ - -### getAuthContext - -▸ **getAuthContext**(`authConfig?`, `authType?`): `Promise`<[`AuthContext`](verida_web_helpers._internal_.AuthContext.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `authConfig?` | [`AuthTypeConfig`](verida_web_helpers._internal_.AuthTypeConfig.md) | -| `authType?` | `string` | - -#### Returns - -`Promise`<[`AuthContext`](verida_web_helpers._internal_.AuthContext.md)\> - -#### Defined in - -packages/types/dist/IContext.d.ts:31 - -___ - -### getClient - -▸ **getClient**(): [`IClient`](verida_web_helpers._internal_.IClient.md) - -#### Returns - -[`IClient`](verida_web_helpers._internal_.IClient.md) - -#### Defined in - -packages/types/dist/IContext.d.ts:19 - -___ - -### getContextConfig - -▸ **getContextConfig**(`did?`, `forceCreate?`, `customContextName?`): `Promise`<[`SecureContextConfig`](verida_web_helpers._internal_.SecureContextConfig.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did?` | `string` | -| `forceCreate?` | `boolean` | -| `customContextName?` | `string` | - -#### Returns - -`Promise`<[`SecureContextConfig`](verida_web_helpers._internal_.SecureContextConfig.md)\> - -#### Defined in - -packages/types/dist/IContext.d.ts:15 - -___ - -### getContextName - -▸ **getContextName**(): `string` - -#### Returns - -`string` - -#### Defined in - -packages/types/dist/IContext.d.ts:16 - -___ - -### getDatabaseEngine - -▸ **getDatabaseEngine**(`did`, `createContext?`): `Promise`<[`IStorageEngine`](verida_web_helpers._internal_.IStorageEngine.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did` | `string` | -| `createContext?` | `boolean` | - -#### Returns - -`Promise`<[`IStorageEngine`](verida_web_helpers._internal_.IStorageEngine.md)\> - -#### Defined in - -packages/types/dist/IContext.d.ts:21 - -___ - -### getDbRegistry - -▸ **getDbRegistry**(): [`IDbRegistry`](verida_web_helpers._internal_.IDbRegistry.md) - -#### Returns - -[`IDbRegistry`](verida_web_helpers._internal_.IDbRegistry.md) - -#### Defined in - -packages/types/dist/IContext.d.ts:29 - -___ - -### getDidContextManager - -▸ **getDidContextManager**(): [`IDIDContextManager`](verida_web_helpers._internal_.IDIDContextManager.md) - -#### Returns - -[`IDIDContextManager`](verida_web_helpers._internal_.IDIDContextManager.md) - -#### Defined in - -packages/types/dist/IContext.d.ts:18 - -___ - -### getMessaging - -▸ **getMessaging**(`messageConfig`): `Promise`<[`IMessaging`](verida_web_helpers._internal_.IMessaging.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `messageConfig` | [`MessagesConfig`](verida_web_helpers._internal_.MessagesConfig.md) | - -#### Returns - -`Promise`<[`IMessaging`](verida_web_helpers._internal_.IMessaging.md)\> - -#### Defined in - -packages/types/dist/IContext.d.ts:22 - -___ - -### getNotification - -▸ **getNotification**(`did`, `contextName`): `Promise`<`undefined` \| [`INotification`](verida_web_helpers._internal_.INotification.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did` | `string` | -| `contextName` | `string` | - -#### Returns - -`Promise`<`undefined` \| [`INotification`](verida_web_helpers._internal_.INotification.md)\> - -#### Defined in - -packages/types/dist/IContext.d.ts:23 - -___ - -### info - -▸ **info**(): `Promise`<[`ContextInfo`](verida_web_helpers._internal_.ContextInfo.md)\> - -#### Returns - -`Promise`<[`ContextInfo`](verida_web_helpers._internal_.ContextInfo.md)\> - -#### Defined in - -packages/types/dist/IContext.d.ts:30 - -___ - -### openDatabase - -▸ **openDatabase**(`databaseName`, `config?`): `Promise`<[`IDatabase`](verida_web_helpers._internal_.IDatabase.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `databaseName` | `string` | -| `config?` | [`DatabaseOpenConfig`](verida_web_helpers._internal_.DatabaseOpenConfig.md) | - -#### Returns - -`Promise`<[`IDatabase`](verida_web_helpers._internal_.IDatabase.md)\> - -#### Defined in - -packages/types/dist/IContext.d.ts:25 - -___ - -### openDatastore - -▸ **openDatastore**(`schemaUri`, `config?`): `Promise`<[`IDatastore`](verida_web_helpers._internal_.IDatastore.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schemaUri` | `string` | -| `config?` | [`DatastoreOpenConfig`](verida_web_helpers._internal_.DatastoreOpenConfig.md) | - -#### Returns - -`Promise`<[`IDatastore`](verida_web_helpers._internal_.IDatastore.md)\> - -#### Defined in - -packages/types/dist/IContext.d.ts:27 - -___ - -### openExternalDatabase - -▸ **openExternalDatabase**(`databaseName`, `did`, `config?`): `Promise`<[`IDatabase`](verida_web_helpers._internal_.IDatabase.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `databaseName` | `string` | -| `did` | `string` | -| `config?` | [`DatabaseOpenConfig`](verida_web_helpers._internal_.DatabaseOpenConfig.md) | - -#### Returns - -`Promise`<[`IDatabase`](verida_web_helpers._internal_.IDatabase.md)\> - -#### Defined in - -packages/types/dist/IContext.d.ts:26 - -___ - -### openExternalDatastore - -▸ **openExternalDatastore**(`schemaUri`, `did`, `options?`): `Promise`<[`IDatastore`](verida_web_helpers._internal_.IDatastore.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schemaUri` | `string` | -| `did` | `string` | -| `options?` | [`DatastoreOpenConfig`](verida_web_helpers._internal_.DatastoreOpenConfig.md) | - -#### Returns - -`Promise`<[`IDatastore`](verida_web_helpers._internal_.IDatastore.md)\> - -#### Defined in - -packages/types/dist/IContext.d.ts:28 - -___ - -### openProfile - -▸ **openProfile**(`profileName?`, `did?`): `Promise`<`undefined` \| [`IProfile`](verida_web_helpers._internal_.IProfile.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `profileName?` | `string` | -| `did?` | `string` | - -#### Returns - -`Promise`<`undefined` \| [`IProfile`](verida_web_helpers._internal_.IProfile.md)\> - -#### Defined in - -packages/types/dist/IContext.d.ts:24 diff --git a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.IDIDClient.md b/docs/api/verida-js/interfaces/verida_web_helpers._internal_.IDIDClient.md deleted file mode 100644 index 52bc29c..0000000 --- a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.IDIDClient.md +++ /dev/null @@ -1,155 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / IDIDClient - -# Interface: IDIDClient - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).IDIDClient - -## Implemented by - -- [`DIDClient`](../classes/verida_web_helpers._internal_.DIDClient.md) - -## Table of contents - -### Methods - -- [authenticate](verida_web_helpers._internal_.IDIDClient.md#authenticate) -- [authenticated](verida_web_helpers._internal_.IDIDClient.md#authenticated) -- [get](verida_web_helpers._internal_.IDIDClient.md#get) -- [getDid](verida_web_helpers._internal_.IDIDClient.md#getdid) -- [getLastEndpointErrors](verida_web_helpers._internal_.IDIDClient.md#getlastendpointerrors) -- [getPublicKey](verida_web_helpers._internal_.IDIDClient.md#getpublickey) -- [getRpcUrl](verida_web_helpers._internal_.IDIDClient.md#getrpcurl) -- [save](verida_web_helpers._internal_.IDIDClient.md#save) - -## Methods - -### authenticate - -▸ **authenticate**(`veridaPrivateKey`, `callType`, `web3Config`, `defaultEndpoints`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `veridaPrivateKey` | `string` | -| `callType` | [`Web3CallType`](../modules/verida_web_helpers._internal_.md#web3calltype) | -| `web3Config` | [`Web3SelfTransactionConfigPart`](verida_web_helpers._internal_.Web3SelfTransactionConfigPart.md) \| [`Web3MetaTransactionConfig`](verida_web_helpers._internal_.Web3MetaTransactionConfig.md) | -| `defaultEndpoints` | `string`[] | - -#### Returns - -`void` - -#### Defined in - -packages/types/dist/IDIDClient.d.ts:4 - -___ - -### authenticated - -▸ **authenticated**(): `boolean` - -#### Returns - -`boolean` - -#### Defined in - -packages/types/dist/IDIDClient.d.ts:5 - -___ - -### get - -▸ **get**(`did`): `Promise`<[`IDIDDocument`](verida_web_helpers._internal_.IDIDDocument.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did` | `string` | - -#### Returns - -`Promise`<[`IDIDDocument`](verida_web_helpers._internal_.IDIDDocument.md)\> - -#### Defined in - -packages/types/dist/IDIDClient.d.ts:10 - -___ - -### getDid - -▸ **getDid**(): `undefined` \| `string` - -#### Returns - -`undefined` \| `string` - -#### Defined in - -packages/types/dist/IDIDClient.d.ts:6 - -___ - -### getLastEndpointErrors - -▸ **getLastEndpointErrors**(): [`VdaDidEndpointResponses`](../modules/verida_web_helpers._internal_.md#vdadidendpointresponses) - -#### Returns - -[`VdaDidEndpointResponses`](../modules/verida_web_helpers._internal_.md#vdadidendpointresponses) - -#### Defined in - -packages/types/dist/IDIDClient.d.ts:9 - -___ - -### getPublicKey - -▸ **getPublicKey**(): `undefined` \| `string` - -#### Returns - -`undefined` \| `string` - -#### Defined in - -packages/types/dist/IDIDClient.d.ts:7 - -___ - -### getRpcUrl - -▸ **getRpcUrl**(): `string` - -#### Returns - -`string` - -#### Defined in - -packages/types/dist/IDIDClient.d.ts:11 - -___ - -### save - -▸ **save**(`document`): `Promise`<[`VdaDidEndpointResponses`](../modules/verida_web_helpers._internal_.md#vdadidendpointresponses)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `document` | [`IDIDDocument`](verida_web_helpers._internal_.IDIDDocument.md) | - -#### Returns - -`Promise`<[`VdaDidEndpointResponses`](../modules/verida_web_helpers._internal_.md#vdadidendpointresponses)\> - -#### Defined in - -packages/types/dist/IDIDClient.d.ts:8 diff --git a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.IDIDContextManager.md b/docs/api/verida-js/interfaces/verida_web_helpers._internal_.IDIDContextManager.md deleted file mode 100644 index e10eb7a..0000000 --- a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.IDIDContextManager.md +++ /dev/null @@ -1,145 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / IDIDContextManager - -# Interface: IDIDContextManager - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).IDIDContextManager - -## Table of contents - -### Methods - -- [getContextDatabaseServer](verida_web_helpers._internal_.IDIDContextManager.md#getcontextdatabaseserver) -- [getContextMessageServer](verida_web_helpers._internal_.IDIDContextManager.md#getcontextmessageserver) -- [getContextStorageServer](verida_web_helpers._internal_.IDIDContextManager.md#getcontextstorageserver) -- [getDIDContextConfig](verida_web_helpers._internal_.IDIDContextManager.md#getdidcontextconfig) -- [getDIDContextHashConfig](verida_web_helpers._internal_.IDIDContextManager.md#getdidcontexthashconfig) -- [setAccount](verida_web_helpers._internal_.IDIDContextManager.md#setaccount) - -## Methods - -### getContextDatabaseServer - -▸ **getContextDatabaseServer**(`did`, `contextName`, `forceCreate`): `Promise`<[`SecureContextEndpoint`](verida_web_helpers._internal_.SecureContextEndpoint.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did` | `string` | -| `contextName` | `string` | -| `forceCreate` | `boolean` | - -#### Returns - -`Promise`<[`SecureContextEndpoint`](verida_web_helpers._internal_.SecureContextEndpoint.md)\> - -#### Defined in - -packages/types/dist/IDIDContextManager.d.ts:6 - -___ - -### getContextMessageServer - -▸ **getContextMessageServer**(`did`, `contextName`, `forceCreate`): `Promise`<[`SecureContextEndpoint`](verida_web_helpers._internal_.SecureContextEndpoint.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did` | `string` | -| `contextName` | `string` | -| `forceCreate` | `boolean` | - -#### Returns - -`Promise`<[`SecureContextEndpoint`](verida_web_helpers._internal_.SecureContextEndpoint.md)\> - -#### Defined in - -packages/types/dist/IDIDContextManager.d.ts:8 - -___ - -### getContextStorageServer - -▸ **getContextStorageServer**(`did`, `contextName`, `forceCreate`): `Promise`<[`SecureContextEndpoint`](verida_web_helpers._internal_.SecureContextEndpoint.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did` | `string` | -| `contextName` | `string` | -| `forceCreate` | `boolean` | - -#### Returns - -`Promise`<[`SecureContextEndpoint`](verida_web_helpers._internal_.SecureContextEndpoint.md)\> - -#### Defined in - -packages/types/dist/IDIDContextManager.d.ts:7 - -___ - -### getDIDContextConfig - -▸ **getDIDContextConfig**(`did`, `contextName`, `forceCreate?`): `Promise`<[`SecureContextConfig`](verida_web_helpers._internal_.SecureContextConfig.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did` | `string` | -| `contextName` | `string` | -| `forceCreate?` | `boolean` | - -#### Returns - -`Promise`<[`SecureContextConfig`](verida_web_helpers._internal_.SecureContextConfig.md)\> - -#### Defined in - -packages/types/dist/IDIDContextManager.d.ts:10 - -___ - -### getDIDContextHashConfig - -▸ **getDIDContextHashConfig**(`did`, `contextHash`): `Promise`<[`SecureContextConfig`](verida_web_helpers._internal_.SecureContextConfig.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did` | `string` | -| `contextHash` | `string` | - -#### Returns - -`Promise`<[`SecureContextConfig`](verida_web_helpers._internal_.SecureContextConfig.md)\> - -#### Defined in - -packages/types/dist/IDIDContextManager.d.ts:9 - -___ - -### setAccount - -▸ **setAccount**(`account`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `account` | [`IAccount`](verida_web_helpers._internal_.IAccount.md) | - -#### Returns - -`void` - -#### Defined in - -packages/types/dist/IDIDContextManager.d.ts:5 diff --git a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.IDIDDocument.md b/docs/api/verida-js/interfaces/verida_web_helpers._internal_.IDIDDocument.md deleted file mode 100644 index 59f3e4a..0000000 --- a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.IDIDDocument.md +++ /dev/null @@ -1,364 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / IDIDDocument - -# Interface: IDIDDocument - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).IDIDDocument - -## Implemented by - -- [`default`](../classes/verida_web_helpers._internal_.default-2.md) - -## Table of contents - -### Accessors - -- [id](verida_web_helpers._internal_.IDIDDocument.md#id) - -### Methods - -- [addContext](verida_web_helpers._internal_.IDIDDocument.md#addcontext) -- [addContextAsymKey](verida_web_helpers._internal_.IDIDDocument.md#addcontextasymkey) -- [addContextService](verida_web_helpers._internal_.IDIDDocument.md#addcontextservice) -- [addContextSignKey](verida_web_helpers._internal_.IDIDDocument.md#addcontextsignkey) -- [buildTimestamp](verida_web_helpers._internal_.IDIDDocument.md#buildtimestamp) -- [export](verida_web_helpers._internal_.IDIDDocument.md#export) -- [getErrors](verida_web_helpers._internal_.IDIDDocument.md#geterrors) -- [import](verida_web_helpers._internal_.IDIDDocument.md#import) -- [locateContextProof](verida_web_helpers._internal_.IDIDDocument.md#locatecontextproof) -- [locateServiceEndpoint](verida_web_helpers._internal_.IDIDDocument.md#locateserviceendpoint) -- [removeContext](verida_web_helpers._internal_.IDIDDocument.md#removecontext) -- [setAttributes](verida_web_helpers._internal_.IDIDDocument.md#setattributes) -- [signProof](verida_web_helpers._internal_.IDIDDocument.md#signproof) -- [verifyContextSignature](verida_web_helpers._internal_.IDIDDocument.md#verifycontextsignature) -- [verifyProof](verida_web_helpers._internal_.IDIDDocument.md#verifyproof) -- [verifySig](verida_web_helpers._internal_.IDIDDocument.md#verifysig) - -## Accessors - -### id - -• `get` **id**(): `string` - -#### Returns - -`string` - -#### Defined in - -packages/types/dist/IDIDDocument.d.ts:5 - -## Methods - -### addContext - -▸ **addContext**(`contextName`, `keyring`, `privateKey`, `endpoints`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | -| `keyring` | [`IKeyring`](verida_web_helpers._internal_.IKeyring.md) | -| `privateKey` | `string` | -| `endpoints` | [`SecureContextEndpoints`](verida_web_helpers._internal_.SecureContextEndpoints.md) | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -packages/types/dist/IDIDDocument.d.ts:7 - -___ - -### addContextAsymKey - -▸ **addContextAsymKey**(`contextHash`, `publicKeyHex`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextHash` | `string` | -| `publicKeyHex` | `string` | - -#### Returns - -`void` - -#### Defined in - -packages/types/dist/IDIDDocument.d.ts:14 - -___ - -### addContextService - -▸ **addContextService**(`contextHash`, `endpointType`, `serviceType`, `endpointUris`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextHash` | `string` | -| `endpointType` | [`SecureContextEndpointType`](../enums/verida_web_helpers._internal_.SecureContextEndpointType.md) | -| `serviceType` | `string` | -| `endpointUris` | [`ServiceEndpoint`](../modules/verida_web_helpers._internal_.md#serviceendpoint)[] | - -#### Returns - -`void` - -#### Defined in - -packages/types/dist/IDIDDocument.d.ts:12 - -___ - -### addContextSignKey - -▸ **addContextSignKey**(`contextHash`, `publicKeyHex`, `proof`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextHash` | `string` | -| `publicKeyHex` | `string` | -| `proof` | `string` | - -#### Returns - -`void` - -#### Defined in - -packages/types/dist/IDIDDocument.d.ts:13 - -___ - -### buildTimestamp - -▸ **buildTimestamp**(`date`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `date` | `Date` | - -#### Returns - -`string` - -#### Defined in - -packages/types/dist/IDIDDocument.d.ts:21 - -___ - -### export - -▸ **export**(): [`VeridaDocInterface`](verida_web_helpers._internal_.VeridaDocInterface.md) - -#### Returns - -[`VeridaDocInterface`](verida_web_helpers._internal_.VeridaDocInterface.md) - -#### Defined in - -packages/types/dist/IDIDDocument.d.ts:11 - -___ - -### getErrors - -▸ **getErrors**(): `string`[] - -#### Returns - -`string`[] - -#### Defined in - -packages/types/dist/IDIDDocument.d.ts:6 - -___ - -### import - -▸ **import**(`doc`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `doc` | [`VeridaDocInterface`](verida_web_helpers._internal_.VeridaDocInterface.md) | - -#### Returns - -`void` - -#### Defined in - -packages/types/dist/IDIDDocument.d.ts:10 - -___ - -### locateContextProof - -▸ **locateContextProof**(`contextName`): `undefined` \| `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | - -#### Returns - -`undefined` \| `string` - -#### Defined in - -packages/types/dist/IDIDDocument.d.ts:18 - -___ - -### locateServiceEndpoint - -▸ **locateServiceEndpoint**(`contextName`, `endpointType`): `undefined` \| [`Service`](verida_web_helpers._internal_.Service.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | -| `endpointType` | [`SecureContextEndpointType`](../enums/verida_web_helpers._internal_.SecureContextEndpointType.md) | - -#### Returns - -`undefined` \| [`Service`](verida_web_helpers._internal_.Service.md) - -#### Defined in - -packages/types/dist/IDIDDocument.d.ts:17 - -___ - -### removeContext - -▸ **removeContext**(`contextName`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | - -#### Returns - -`boolean` - -#### Defined in - -packages/types/dist/IDIDDocument.d.ts:8 - -___ - -### setAttributes - -▸ **setAttributes**(`attributes`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `attributes` | [`Record`](../modules/verida_web_helpers._internal_.md#record)<`string`, `any`\> | - -#### Returns - -`void` - -#### Defined in - -packages/types/dist/IDIDDocument.d.ts:9 - -___ - -### signProof - -▸ **signProof**(`privateKey`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `privateKey` | `string` \| `Uint8Array` | - -#### Returns - -`void` - -#### Defined in - -packages/types/dist/IDIDDocument.d.ts:19 - -___ - -### verifyContextSignature - -▸ **verifyContextSignature**(`data`, `contextName`, `signature`, `contextIsHash`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `any` | -| `contextName` | `string` | -| `signature` | `string` | -| `contextIsHash` | `boolean` | - -#### Returns - -`boolean` - -#### Defined in - -packages/types/dist/IDIDDocument.d.ts:16 - -___ - -### verifyProof - -▸ **verifyProof**(): `boolean` - -#### Returns - -`boolean` - -#### Defined in - -packages/types/dist/IDIDDocument.d.ts:20 - -___ - -### verifySig - -▸ **verifySig**(`data`, `signature`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `any` | -| `signature` | `string` | - -#### Returns - -`boolean` - -#### Defined in - -packages/types/dist/IDIDDocument.d.ts:15 diff --git a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.IDatabase.md b/docs/api/verida-js/interfaces/verida_web_helpers._internal_.IDatabase.md deleted file mode 100644 index 2730078..0000000 --- a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.IDatabase.md +++ /dev/null @@ -1,261 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / IDatabase - -# Interface: IDatabase - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).IDatabase - -Interface for any database returned from a storage engine - -## Table of contents - -### Methods - -- [changes](verida_web_helpers._internal_.IDatabase.md#changes) -- [close](verida_web_helpers._internal_.IDatabase.md#close) -- [delete](verida_web_helpers._internal_.IDatabase.md#delete) -- [deleteAll](verida_web_helpers._internal_.IDatabase.md#deleteall) -- [destroy](verida_web_helpers._internal_.IDatabase.md#destroy) -- [get](verida_web_helpers._internal_.IDatabase.md#get) -- [getDb](verida_web_helpers._internal_.IDatabase.md#getdb) -- [getMany](verida_web_helpers._internal_.IDatabase.md#getmany) -- [info](verida_web_helpers._internal_.IDatabase.md#info) -- [registryEntry](verida_web_helpers._internal_.IDatabase.md#registryentry) -- [save](verida_web_helpers._internal_.IDatabase.md#save) -- [updateUsers](verida_web_helpers._internal_.IDatabase.md#updateusers) -- [usage](verida_web_helpers._internal_.IDatabase.md#usage) - -## Methods - -### changes - -▸ **changes**(`cb`, `options?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `cb` | `Function` | -| `options?` | `any` | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -packages/types/dist/IDatabase.d.ts:11 - -___ - -### close - -▸ **close**(`options?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options?` | [`DatabaseCloseOptions`](verida_web_helpers._internal_.DatabaseCloseOptions.md) | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -packages/types/dist/IDatabase.d.ts:16 - -___ - -### delete - -▸ **delete**(`doc`, `options?`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `doc` | `any` | -| `options?` | `any` | - -#### Returns - -`Promise`<`boolean`\> - -#### Defined in - -packages/types/dist/IDatabase.d.ts:9 - -___ - -### deleteAll - -▸ **deleteAll**(): `Promise`<`void`\> - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -packages/types/dist/IDatabase.d.ts:10 - -___ - -### destroy - -▸ **destroy**(`options?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options?` | [`DatabaseDeleteConfig`](verida_web_helpers._internal_.DatabaseDeleteConfig.md) | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -packages/types/dist/IDatabase.d.ts:17 - -___ - -### get - -▸ **get**(`docId`, `options?`): `Promise`<`undefined` \| `object`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `docId` | `any` | -| `options?` | `any` | - -#### Returns - -`Promise`<`undefined` \| `object`\> - -#### Defined in - -packages/types/dist/IDatabase.d.ts:8 - -___ - -### getDb - -▸ **getDb**(): `Promise`<`any`\> - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -packages/types/dist/IDatabase.d.ts:13 - -___ - -### getMany - -▸ **getMany**(`filter?`, `options?`): `Promise`<`object`[]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `filter?` | `any` | -| `options?` | `any` | - -#### Returns - -`Promise`<`object`[]\> - -#### Defined in - -packages/types/dist/IDatabase.d.ts:7 - -___ - -### info - -▸ **info**(): `Promise`<`any`\> - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -packages/types/dist/IDatabase.d.ts:14 - -___ - -### registryEntry - -▸ **registryEntry**(): `Promise`<[`DbRegistryEntry`](verida_web_helpers._internal_.DbRegistryEntry.md)\> - -#### Returns - -`Promise`<[`DbRegistryEntry`](verida_web_helpers._internal_.DbRegistryEntry.md)\> - -#### Defined in - -packages/types/dist/IDatabase.d.ts:15 - -___ - -### save - -▸ **save**(`data`, `options?`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `any` | -| `options?` | `any` | - -#### Returns - -`Promise`<`boolean`\> - -#### Defined in - -packages/types/dist/IDatabase.d.ts:6 - -___ - -### updateUsers - -▸ **updateUsers**(`readList`, `writeList`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `readList` | `string`[] | -| `writeList` | `string`[] | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -packages/types/dist/IDatabase.d.ts:12 - -___ - -### usage - -▸ **usage**(): `Promise`<[`EndpointUsage`](verida_web_helpers._internal_.EndpointUsage.md)\> - -#### Returns - -`Promise`<[`EndpointUsage`](verida_web_helpers._internal_.EndpointUsage.md)\> - -#### Defined in - -packages/types/dist/IDatabase.d.ts:18 diff --git a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.IDatastore.md b/docs/api/verida-js/interfaces/verida_web_helpers._internal_.IDatastore.md deleted file mode 100644 index cd1ffe2..0000000 --- a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.IDatastore.md +++ /dev/null @@ -1,253 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / IDatastore - -# Interface: IDatastore - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).IDatastore - -## Implemented by - -- [`Datastore`](../classes/verida_web_helpers._internal_.Datastore.md) - -## Table of contents - -### Properties - -- [errors](verida_web_helpers._internal_.IDatastore.md#errors) - -### Methods - -- [changes](verida_web_helpers._internal_.IDatastore.md#changes) -- [close](verida_web_helpers._internal_.IDatastore.md#close) -- [delete](verida_web_helpers._internal_.IDatastore.md#delete) -- [deleteAll](verida_web_helpers._internal_.IDatastore.md#deleteall) -- [ensureIndexes](verida_web_helpers._internal_.IDatastore.md#ensureindexes) -- [get](verida_web_helpers._internal_.IDatastore.md#get) -- [getDb](verida_web_helpers._internal_.IDatastore.md#getdb) -- [getMany](verida_web_helpers._internal_.IDatastore.md#getmany) -- [getOne](verida_web_helpers._internal_.IDatastore.md#getone) -- [save](verida_web_helpers._internal_.IDatastore.md#save) -- [updateUsers](verida_web_helpers._internal_.IDatastore.md#updateusers) - -## Properties - -### errors - -• **errors**: `any` - -#### Defined in - -packages/types/dist/IDatastore.d.ts:4 - -## Methods - -### changes - -▸ **changes**(`cb`, `options`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `cb` | `any` | -| `options` | `any` | - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -packages/types/dist/IDatastore.d.ts:12 - -___ - -### close - -▸ **close**(`options?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options?` | [`DatabaseCloseOptions`](verida_web_helpers._internal_.DatabaseCloseOptions.md) | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -packages/types/dist/IDatastore.d.ts:15 - -___ - -### delete - -▸ **delete**(`docId`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `docId` | `string` | - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -packages/types/dist/IDatastore.d.ts:9 - -___ - -### deleteAll - -▸ **deleteAll**(): `Promise`<`void`\> - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -packages/types/dist/IDatastore.d.ts:10 - -___ - -### ensureIndexes - -▸ **ensureIndexes**(`indexes`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `indexes` | `any` | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -packages/types/dist/IDatastore.d.ts:13 - -___ - -### get - -▸ **get**(`key`, `options`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `key` | `string` | -| `options` | `any` | - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -packages/types/dist/IDatastore.d.ts:8 - -___ - -### getDb - -▸ **getDb**(): `Promise`<[`IDatabase`](verida_web_helpers._internal_.IDatabase.md)\> - -#### Returns - -`Promise`<[`IDatabase`](verida_web_helpers._internal_.IDatabase.md)\> - -#### Defined in - -packages/types/dist/IDatastore.d.ts:11 - -___ - -### getMany - -▸ **getMany**(`customFilter?`, `options?`): `Promise`<`object`[]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `customFilter?` | `any` | -| `options?` | `any` | - -#### Returns - -`Promise`<`object`[]\> - -#### Defined in - -packages/types/dist/IDatastore.d.ts:6 - -___ - -### getOne - -▸ **getOne**(`customFilter?`, `options?`): `Promise`<`undefined` \| `object`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `customFilter?` | `any` | -| `options?` | `any` | - -#### Returns - -`Promise`<`undefined` \| `object`\> - -#### Defined in - -packages/types/dist/IDatastore.d.ts:7 - -___ - -### save - -▸ **save**(`data`, `options`): `Promise`<`boolean` \| `object`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `any` | -| `options` | `any` | - -#### Returns - -`Promise`<`boolean` \| `object`\> - -#### Defined in - -packages/types/dist/IDatastore.d.ts:5 - -___ - -### updateUsers - -▸ **updateUsers**(`readList`, `writeList`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `readList` | `string`[] | -| `writeList` | `string`[] | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -packages/types/dist/IDatastore.d.ts:14 diff --git a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.IDbRegistry.md b/docs/api/verida-js/interfaces/verida_web_helpers._internal_.IDbRegistry.md deleted file mode 100644 index cfc9417..0000000 --- a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.IDbRegistry.md +++ /dev/null @@ -1,119 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / IDbRegistry - -# Interface: IDbRegistry - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).IDbRegistry - -## Implemented by - -- [`DbRegistry`](../classes/verida_web_helpers._internal_.DbRegistry.md) - -## Table of contents - -### Methods - -- [get](verida_web_helpers._internal_.IDbRegistry.md#get) -- [getMany](verida_web_helpers._internal_.IDbRegistry.md#getmany) -- [init](verida_web_helpers._internal_.IDbRegistry.md#init) -- [removeDb](verida_web_helpers._internal_.IDbRegistry.md#removedb) -- [saveDb](verida_web_helpers._internal_.IDbRegistry.md#savedb) - -## Methods - -### get - -▸ **get**(`dbName`, `did`, `contextName`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `dbName` | `string` | -| `did` | `string` | -| `contextName` | `string` | - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -packages/types/dist/IDbRegistry.d.ts:6 - -___ - -### getMany - -▸ **getMany**(`filter`, `options`): `Promise`<`any`[]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `filter` | `any` | -| `options` | `any` | - -#### Returns - -`Promise`<`any`[]\> - -#### Defined in - -packages/types/dist/IDbRegistry.d.ts:5 - -___ - -### init - -▸ **init**(): `Promise`<`void`\> - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -packages/types/dist/IDbRegistry.d.ts:7 - -___ - -### removeDb - -▸ **removeDb**(`databaseName`, `did`, `contextName`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `databaseName` | `string` | -| `did` | `string` | -| `contextName` | `string` | - -#### Returns - -`Promise`<`boolean`\> - -#### Defined in - -packages/types/dist/IDbRegistry.d.ts:4 - -___ - -### saveDb - -▸ **saveDb**(`database`, `checkPermissions`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `database` | [`IDatabase`](verida_web_helpers._internal_.IDatabase.md) | -| `checkPermissions` | `boolean` | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -packages/types/dist/IDbRegistry.d.ts:3 diff --git a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.IKeyring.md b/docs/api/verida-js/interfaces/verida_web_helpers._internal_.IKeyring.md deleted file mode 100644 index 6e7b2dd..0000000 --- a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.IKeyring.md +++ /dev/null @@ -1,266 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / IKeyring - -# Interface: IKeyring - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).IKeyring - -## Implemented by - -- [`default`](../classes/verida_web_helpers._internal_.default-1.md) - -## Table of contents - -### Methods - -- [\_init](verida_web_helpers._internal_.IKeyring.md#_init) -- [asymDecrypt](verida_web_helpers._internal_.IKeyring.md#asymdecrypt) -- [asymEncrypt](verida_web_helpers._internal_.IKeyring.md#asymencrypt) -- [buildSharedKeyEnd](verida_web_helpers._internal_.IKeyring.md#buildsharedkeyend) -- [buildSharedKeyStart](verida_web_helpers._internal_.IKeyring.md#buildsharedkeystart) -- [getKeys](verida_web_helpers._internal_.IKeyring.md#getkeys) -- [getSeed](verida_web_helpers._internal_.IKeyring.md#getseed) -- [getStorageContextKey](verida_web_helpers._internal_.IKeyring.md#getstoragecontextkey) -- [publicKeys](verida_web_helpers._internal_.IKeyring.md#publickeys) -- [sign](verida_web_helpers._internal_.IKeyring.md#sign) -- [symDecrypt](verida_web_helpers._internal_.IKeyring.md#symdecrypt) -- [symEncrypt](verida_web_helpers._internal_.IKeyring.md#symencrypt) -- [verifySig](verida_web_helpers._internal_.IKeyring.md#verifysig) - -## Methods - -### \_init - -▸ **_init**(): `Promise`<`void`\> - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:3 - -___ - -### asymDecrypt - -▸ **asymDecrypt**(`messageWithNonce`, `secretOrSharedKey`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `messageWithNonce` | `string` | -| `secretOrSharedKey` | `Uint8Array` | - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:10 - -___ - -### asymEncrypt - -▸ **asymEncrypt**(`data`, `secretOrSharedKey`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `string` | -| `secretOrSharedKey` | `Uint8Array` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:9 - -___ - -### buildSharedKeyEnd - -▸ **buildSharedKeyEnd**(`publicKey`): `Promise`<`Uint8Array`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `publicKey` | `Uint8Array` | - -#### Returns - -`Promise`<`Uint8Array`\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:12 - -___ - -### buildSharedKeyStart - -▸ **buildSharedKeyStart**(`privateKey`): `Promise`<`Uint8Array`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `privateKey` | `Uint8Array` | - -#### Returns - -`Promise`<`Uint8Array`\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:11 - -___ - -### getKeys - -▸ **getKeys**(): `Promise`<`any`\> - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:2 - -___ - -### getSeed - -▸ **getSeed**(): `string` - -#### Returns - -`string` - -#### Defined in - -packages/types/dist/IKeyring.d.ts:13 - -___ - -### getStorageContextKey - -▸ **getStorageContextKey**(`databaseName`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `databaseName` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:14 - -___ - -### publicKeys - -▸ **publicKeys**(): `Promise`<[`KeyringPublicKeys`](verida_web_helpers._internal_.KeyringPublicKeys.md)\> - -#### Returns - -`Promise`<[`KeyringPublicKeys`](verida_web_helpers._internal_.KeyringPublicKeys.md)\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:4 - -___ - -### sign - -▸ **sign**(`data`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `any` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:5 - -___ - -### symDecrypt - -▸ **symDecrypt**(`data`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `string` | - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:8 - -___ - -### symEncrypt - -▸ **symEncrypt**(`data`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:7 - -___ - -### verifySig - -▸ **verifySig**(`data`, `sig`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `string` | -| `sig` | `string` | - -#### Returns - -`Promise`<`boolean`\> - -#### Defined in - -packages/types/dist/IKeyring.d.ts:6 diff --git a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.IMessaging.md b/docs/api/verida-js/interfaces/verida_web_helpers._internal_.IMessaging.md deleted file mode 100644 index 1c28077..0000000 --- a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.IMessaging.md +++ /dev/null @@ -1,180 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / IMessaging - -# Interface: IMessaging - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).IMessaging - -Interface Messaging - -## Table of contents - -### Methods - -- [connectAccount](verida_web_helpers._internal_.IMessaging.md#connectaccount) -- [getInbox](verida_web_helpers._internal_.IMessaging.md#getinbox) -- [getMessages](verida_web_helpers._internal_.IMessaging.md#getmessages) -- [init](verida_web_helpers._internal_.IMessaging.md#init) -- [offMessage](verida_web_helpers._internal_.IMessaging.md#offmessage) -- [onMessage](verida_web_helpers._internal_.IMessaging.md#onmessage) -- [send](verida_web_helpers._internal_.IMessaging.md#send) - -## Methods - -### connectAccount - -▸ **connectAccount**(`account`): `Promise`<`void`\> - -Connect an account to this messaging instance. - -Used internally. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `account` | [`IAccount`](verida_web_helpers._internal_.IAccount.md) | Account | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -packages/types/dist/IMessaging.d.ts:62 - -___ - -### getInbox - -▸ **getInbox**(): `Promise`<`any`\> - -Get the underlying inbox instance specific for the message storage type. - -#### Returns - -`Promise`<`any`\> - -any Currently returns a `Datastore` instance. - -#### Defined in - -packages/types/dist/IMessaging.d.ts:54 - -___ - -### getMessages - -▸ **getMessages**(`filter?`, `options?`): `Promise`<`any`\> - -Get messages from this inbox. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `filter?` | `object` | object An optional datastore filter | -| `options?` | `any` | object An optional list of datastore options | - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -packages/types/dist/IMessaging.d.ts:48 - -___ - -### init - -▸ **init**(): `Promise`<`void`\> - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -packages/types/dist/IMessaging.d.ts:9 - -___ - -### offMessage - -▸ **offMessage**(`callback`): `Promise`<`void`\> - -Unregister a callback to fire when a new message is received - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `callback` | `any` | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -packages/types/dist/IMessaging.d.ts:41 - -___ - -### onMessage - -▸ **onMessage**(`callback`): `Promise`<[`EventEmitter`](../classes/verida_web_helpers._internal_.EventEmitter-1.md)\> - -Register a callback to fire when a new message is received from another DID or application. - -Usage: - -``` -// configure the listener -const callback = (msg) => { console.log(msg) } -const emitter = messaging.onMessage(callback) -``` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `callback` | `any` | - -#### Returns - -`Promise`<[`EventEmitter`](../classes/verida_web_helpers._internal_.EventEmitter-1.md)\> - -Returns an event emitter - -#### Defined in - -packages/types/dist/IMessaging.d.ts:35 - -___ - -### send - -▸ **send**(`did`, `type`, `data`, `message`, `config`): `Promise`<``null`` \| `object`\> - -Send a message to another DID on the network. - -**`todo:`** Link to documentation - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `did` | `string` | string DID to receive the message | -| `type` | `string` | string Type of inbox message (See https://github.com/verida/schemas/tree/master/schemas/inbox/type). ie: `dataSend` | -| `data` | `object` | object Data to send. Structure of data will depend on the inbox message type. | -| `message` | `string` | string A human readable message that will be displayed to the user upon receipt of the message. Similar to an email subject. | -| `config` | [`MessageSendConfig`](verida_web_helpers._internal_.MessageSendConfig.md) | object Optional configuration. | - -#### Returns - -`Promise`<``null`` \| `object`\> - -#### Defined in - -packages/types/dist/IMessaging.d.ts:21 diff --git a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.INotification.md b/docs/api/verida-js/interfaces/verida_web_helpers._internal_.INotification.md deleted file mode 100644 index fb37944..0000000 --- a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.INotification.md +++ /dev/null @@ -1,71 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / INotification - -# Interface: INotification - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).INotification - -Interface for notifications - -## Table of contents - -### Methods - -- [getErrors](verida_web_helpers._internal_.INotification.md#geterrors) -- [init](verida_web_helpers._internal_.INotification.md#init) -- [ping](verida_web_helpers._internal_.INotification.md#ping) - -## Methods - -### getErrors - -▸ **getErrors**(): `string`[] - -#### Returns - -`string`[] - -#### Defined in - -packages/types/dist/INotification.d.ts:16 - -___ - -### init - -▸ **init**(): `Promise`<`void`\> - -Initialize notifications for the connected user - -(ie; connect to a notification server) - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -packages/types/dist/INotification.d.ts:10 - -___ - -### ping - -▸ **ping**(`recipientContextName`, `didToNotify`): `Promise`<`boolean`\> - -Ping a notification server to fetch new messages -TODO: Change this - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `recipientContextName` | `string` | -| `didToNotify` | `any` | - -#### Returns - -`Promise`<`boolean`\> - -#### Defined in - -packages/types/dist/INotification.d.ts:15 diff --git a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.IProfile.md b/docs/api/verida-js/interfaces/verida_web_helpers._internal_.IProfile.md deleted file mode 100644 index 7cd4944..0000000 --- a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.IProfile.md +++ /dev/null @@ -1,144 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / IProfile - -# Interface: IProfile - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).IProfile - -## Implemented by - -- [`Profile`](../classes/verida_web_helpers._internal_.Profile.md) - -## Table of contents - -### Methods - -- [delete](verida_web_helpers._internal_.IProfile.md#delete) -- [get](verida_web_helpers._internal_.IProfile.md#get) -- [getMany](verida_web_helpers._internal_.IProfile.md#getmany) -- [listen](verida_web_helpers._internal_.IProfile.md#listen) -- [set](verida_web_helpers._internal_.IProfile.md#set) -- [setMany](verida_web_helpers._internal_.IProfile.md#setmany) - -## Methods - -### delete - -▸ **delete**(`key`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `key` | `string` | - -#### Returns - -`Promise`<`boolean`\> - -#### Defined in - -packages/types/dist/IProfile.d.ts:7 - -___ - -### get - -▸ **get**(`key`, `options?`, `extended?`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `key` | `string` | -| `options?` | `any` | -| `extended?` | `boolean` | - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -packages/types/dist/IProfile.d.ts:6 - -___ - -### getMany - -▸ **getMany**(`filter`, `options`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `filter` | `any` | -| `options` | `any` | - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -packages/types/dist/IProfile.d.ts:8 - -___ - -### listen - -▸ **listen**(`callback`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `callback` | `any` | - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -packages/types/dist/IProfile.d.ts:11 - -___ - -### set - -▸ **set**(`key`, `value`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `key` | `string` | -| `value` | `any` | - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -packages/types/dist/IProfile.d.ts:9 - -___ - -### setMany - -▸ **setMany**(`data`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `any` | - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -packages/types/dist/IProfile.d.ts:10 diff --git a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.ISchema.md b/docs/api/verida-js/interfaces/verida_web_helpers._internal_.ISchema.md deleted file mode 100644 index fc9e140..0000000 --- a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.ISchema.md +++ /dev/null @@ -1,94 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / ISchema - -# Interface: ISchema - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).ISchema - -## Implemented by - -- [`Schema`](../classes/verida_web_helpers._internal_.Schema.md) - -## Table of contents - -### Properties - -- [errors](verida_web_helpers._internal_.ISchema.md#errors) - -### Methods - -- [getAppearance](verida_web_helpers._internal_.ISchema.md#getappearance) -- [getSchemaJson](verida_web_helpers._internal_.ISchema.md#getschemajson) -- [getSpecification](verida_web_helpers._internal_.ISchema.md#getspecification) -- [validate](verida_web_helpers._internal_.ISchema.md#validate) - -## Properties - -### errors - -• **errors**: `string`[] - -#### Defined in - -packages/types/dist/ISchema.d.ts:2 - -## Methods - -### getAppearance - -▸ **getAppearance**(): `Promise`<`any`\> - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -packages/types/dist/ISchema.d.ts:6 - -___ - -### getSchemaJson - -▸ **getSchemaJson**(): `Promise`<`object`\> - -#### Returns - -`Promise`<`object`\> - -#### Defined in - -packages/types/dist/ISchema.d.ts:5 - -___ - -### getSpecification - -▸ **getSpecification**(): `Promise`<`any`\> - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -packages/types/dist/ISchema.d.ts:3 - -___ - -### validate - -▸ **validate**(`data`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `any` | - -#### Returns - -`Promise`<`boolean`\> - -#### Defined in - -packages/types/dist/ISchema.d.ts:4 diff --git a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.IStorageEngine.md b/docs/api/verida-js/interfaces/verida_web_helpers._internal_.IStorageEngine.md deleted file mode 100644 index 5315b34..0000000 --- a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.IStorageEngine.md +++ /dev/null @@ -1,211 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / IStorageEngine - -# Interface: IStorageEngine - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).IStorageEngine - -**`emits`** EndpointUnavailable - -## Table of contents - -### Methods - -- [addEndpoint](verida_web_helpers._internal_.IStorageEngine.md#addendpoint) -- [connectAccount](verida_web_helpers._internal_.IStorageEngine.md#connectaccount) -- [deleteDatabase](verida_web_helpers._internal_.IStorageEngine.md#deletedatabase) -- [getAccount](verida_web_helpers._internal_.IStorageEngine.md#getaccount) -- [getContextConfig](verida_web_helpers._internal_.IStorageEngine.md#getcontextconfig) -- [getDbRegistry](verida_web_helpers._internal_.IStorageEngine.md#getdbregistry) -- [getKeyring](verida_web_helpers._internal_.IStorageEngine.md#getkeyring) -- [info](verida_web_helpers._internal_.IStorageEngine.md#info) -- [logout](verida_web_helpers._internal_.IStorageEngine.md#logout) -- [openDatabase](verida_web_helpers._internal_.IStorageEngine.md#opendatabase) -- [openDatastore](verida_web_helpers._internal_.IStorageEngine.md#opendatastore) - -## Methods - -### addEndpoint - -▸ **addEndpoint**(`context`, `uri`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `context` | [`IContext`](verida_web_helpers._internal_.IContext.md) | -| `uri` | `string` | - -#### Returns - -`Promise`<`boolean`\> - -#### Defined in - -packages/types/dist/IStorageEngine.d.ts:22 - -___ - -### connectAccount - -▸ **connectAccount**(`account`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `account` | [`IAccount`](verida_web_helpers._internal_.IAccount.md) | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -packages/types/dist/IStorageEngine.d.ts:16 - -___ - -### deleteDatabase - -▸ **deleteDatabase**(`databaseName`, `config?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `databaseName` | `string` | -| `config?` | [`DatabaseDeleteConfig`](verida_web_helpers._internal_.DatabaseDeleteConfig.md) | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -packages/types/dist/IStorageEngine.d.ts:20 - -___ - -### getAccount - -▸ **getAccount**(): [`IAccount`](verida_web_helpers._internal_.IAccount.md) - -#### Returns - -[`IAccount`](verida_web_helpers._internal_.IAccount.md) - -#### Defined in - -packages/types/dist/IStorageEngine.d.ts:15 - -___ - -### getContextConfig - -▸ **getContextConfig**(): [`SecureContextConfig`](verida_web_helpers._internal_.SecureContextConfig.md) - -#### Returns - -[`SecureContextConfig`](verida_web_helpers._internal_.SecureContextConfig.md) - -#### Defined in - -packages/types/dist/IStorageEngine.d.ts:14 - -___ - -### getDbRegistry - -▸ **getDbRegistry**(): [`IDbRegistry`](verida_web_helpers._internal_.IDbRegistry.md) - -#### Returns - -[`IDbRegistry`](verida_web_helpers._internal_.IDbRegistry.md) - -#### Defined in - -packages/types/dist/IStorageEngine.d.ts:17 - -___ - -### getKeyring - -▸ **getKeyring**(): [`IKeyring`](verida_web_helpers._internal_.IKeyring.md) - -#### Returns - -[`IKeyring`](verida_web_helpers._internal_.IKeyring.md) - -#### Defined in - -packages/types/dist/IStorageEngine.d.ts:13 - -___ - -### info - -▸ **info**(): `Promise`<[`ContextDatabaseInfo`](verida_web_helpers._internal_.ContextDatabaseInfo.md)\> - -#### Returns - -`Promise`<[`ContextDatabaseInfo`](verida_web_helpers._internal_.ContextDatabaseInfo.md)\> - -#### Defined in - -packages/types/dist/IStorageEngine.d.ts:23 - -___ - -### logout - -▸ **logout**(): `void` - -#### Returns - -`void` - -#### Defined in - -packages/types/dist/IStorageEngine.d.ts:21 - -___ - -### openDatabase - -▸ **openDatabase**(`databaseName`, `config`): `Promise`<[`IDatabase`](verida_web_helpers._internal_.IDatabase.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `databaseName` | `string` | -| `config` | [`DatabaseOpenConfig`](verida_web_helpers._internal_.DatabaseOpenConfig.md) | - -#### Returns - -`Promise`<[`IDatabase`](verida_web_helpers._internal_.IDatabase.md)\> - -#### Defined in - -packages/types/dist/IStorageEngine.d.ts:18 - -___ - -### openDatastore - -▸ **openDatastore**(`schemaName`, `config`): `Promise`<[`IDatastore`](verida_web_helpers._internal_.IDatastore.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schemaName` | `string` | -| `config` | [`DatastoreOpenConfig`](verida_web_helpers._internal_.DatastoreOpenConfig.md) | - -#### Returns - -`Promise`<[`IDatastore`](verida_web_helpers._internal_.IDatastore.md)\> - -#### Defined in - -packages/types/dist/IStorageEngine.d.ts:19 diff --git a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.InstanceCodeOptions.md b/docs/api/verida-js/interfaces/verida_web_helpers._internal_.InstanceCodeOptions.md deleted file mode 100644 index c9987a9..0000000 --- a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.InstanceCodeOptions.md +++ /dev/null @@ -1,150 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / InstanceCodeOptions - -# Interface: InstanceCodeOptions - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).InstanceCodeOptions - -## Hierarchy - -- [`CodeOptions`](verida_web_helpers._internal_.CodeOptions.md) - - ↳ **`InstanceCodeOptions`** - -## Table of contents - -### Properties - -- [es5](verida_web_helpers._internal_.InstanceCodeOptions.md#es5) -- [esm](verida_web_helpers._internal_.InstanceCodeOptions.md#esm) -- [formats](verida_web_helpers._internal_.InstanceCodeOptions.md#formats) -- [lines](verida_web_helpers._internal_.InstanceCodeOptions.md#lines) -- [optimize](verida_web_helpers._internal_.InstanceCodeOptions.md#optimize) -- [regExp](verida_web_helpers._internal_.InstanceCodeOptions.md#regexp) -- [source](verida_web_helpers._internal_.InstanceCodeOptions.md#source) - -### Methods - -- [process](verida_web_helpers._internal_.InstanceCodeOptions.md#process) - -## Properties - -### es5 - -• `Optional` **es5**: `boolean` - -#### Inherited from - -[CodeOptions](verida_web_helpers._internal_.CodeOptions.md).[es5](verida_web_helpers._internal_.CodeOptions.md#es5) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:74 - -___ - -### esm - -• `Optional` **esm**: `boolean` - -#### Inherited from - -[CodeOptions](verida_web_helpers._internal_.CodeOptions.md).[esm](verida_web_helpers._internal_.CodeOptions.md#esm) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:75 - -___ - -### formats - -• `Optional` **formats**: [`Code`](../modules/verida_web_helpers._internal_.md#code) - -#### Inherited from - -[CodeOptions](verida_web_helpers._internal_.CodeOptions.md).[formats](verida_web_helpers._internal_.CodeOptions.md#formats) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:78 - -___ - -### lines - -• `Optional` **lines**: `boolean` - -#### Inherited from - -[CodeOptions](verida_web_helpers._internal_.CodeOptions.md).[lines](verida_web_helpers._internal_.CodeOptions.md#lines) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:76 - -___ - -### optimize - -• **optimize**: `number` - -#### Overrides - -[CodeOptions](verida_web_helpers._internal_.CodeOptions.md).[optimize](verida_web_helpers._internal_.CodeOptions.md#optimize) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:85 - -___ - -### regExp - -• **regExp**: [`RegExpEngine`](verida_web_helpers._internal_.RegExpEngine.md) - -#### Overrides - -[CodeOptions](verida_web_helpers._internal_.CodeOptions.md).[regExp](verida_web_helpers._internal_.CodeOptions.md#regexp) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:84 - -___ - -### source - -• `Optional` **source**: `boolean` - -#### Inherited from - -[CodeOptions](verida_web_helpers._internal_.CodeOptions.md).[source](verida_web_helpers._internal_.CodeOptions.md#source) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:79 - -## Methods - -### process - -▸ `Optional` **process**(`code`, `schema?`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `code` | `string` | -| `schema?` | [`SchemaEnv`](../classes/verida_web_helpers._internal_.SchemaEnv.md) | - -#### Returns - -`string` - -#### Inherited from - -[CodeOptions](verida_web_helpers._internal_.CodeOptions.md).[process](verida_web_helpers._internal_.CodeOptions.md#process) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:80 diff --git a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.IteratorReturnResult.md b/docs/api/verida-js/interfaces/verida_web_helpers._internal_.IteratorReturnResult.md deleted file mode 100644 index 5adacdf..0000000 --- a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.IteratorReturnResult.md +++ /dev/null @@ -1,38 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / IteratorReturnResult - -# Interface: IteratorReturnResult - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).IteratorReturnResult - -## Type parameters - -| Name | -| :------ | -| `TReturn` | - -## Table of contents - -### Properties - -- [done](verida_web_helpers._internal_.IteratorReturnResult.md#done) -- [value](verida_web_helpers._internal_.IteratorReturnResult.md#value) - -## Properties - -### done - -• **done**: ``true`` - -#### Defined in - -node_modules/typescript/lib/lib.es2015.iterable.d.ts:37 - -___ - -### value - -• **value**: `TReturn` - -#### Defined in - -node_modules/typescript/lib/lib.es2015.iterable.d.ts:38 diff --git a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.IteratorYieldResult.md b/docs/api/verida-js/interfaces/verida_web_helpers._internal_.IteratorYieldResult.md deleted file mode 100644 index 2c45534..0000000 --- a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.IteratorYieldResult.md +++ /dev/null @@ -1,38 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / IteratorYieldResult - -# Interface: IteratorYieldResult - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).IteratorYieldResult - -## Type parameters - -| Name | -| :------ | -| `TYield` | - -## Table of contents - -### Properties - -- [done](verida_web_helpers._internal_.IteratorYieldResult.md#done) -- [value](verida_web_helpers._internal_.IteratorYieldResult.md#value) - -## Properties - -### done - -• `Optional` **done**: ``false`` - -#### Defined in - -node_modules/typescript/lib/lib.es2015.iterable.d.ts:32 - -___ - -### value - -• **value**: `TYield` - -#### Defined in - -node_modules/typescript/lib/lib.es2015.iterable.d.ts:33 diff --git a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.JsonWebKey.md b/docs/api/verida-js/interfaces/verida_web_helpers._internal_.JsonWebKey.md deleted file mode 100644 index 258c732..0000000 --- a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.JsonWebKey.md +++ /dev/null @@ -1,145 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / JsonWebKey - -# Interface: JsonWebKey - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).JsonWebKey - -Encapsulates a JSON web key type that includes only the public properties that -can be used in DID documents. - -The private properties are intentionally omitted to discourage the use -(and accidental disclosure) of private keys in DID documents. - -**`see`** [RFC7517 JsonWebKey (JWK)](https://www.rfc-editor.org/rfc/rfc7517) - -## Hierarchy - -- [`Extensible`](../modules/verida_web_helpers._internal_.md#extensible) - - ↳ **`JsonWebKey`** - -## Table of contents - -### Properties - -- [alg](verida_web_helpers._internal_.JsonWebKey.md#alg) -- [crv](verida_web_helpers._internal_.JsonWebKey.md#crv) -- [e](verida_web_helpers._internal_.JsonWebKey.md#e) -- [ext](verida_web_helpers._internal_.JsonWebKey.md#ext) -- [key\_ops](verida_web_helpers._internal_.JsonWebKey.md#key_ops) -- [kid](verida_web_helpers._internal_.JsonWebKey.md#kid) -- [kty](verida_web_helpers._internal_.JsonWebKey.md#kty) -- [n](verida_web_helpers._internal_.JsonWebKey.md#n) -- [use](verida_web_helpers._internal_.JsonWebKey.md#use) -- [x](verida_web_helpers._internal_.JsonWebKey.md#x) -- [y](verida_web_helpers._internal_.JsonWebKey.md#y) - -## Properties - -### alg - -• `Optional` **alg**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:103 - -___ - -### crv - -• `Optional` **crv**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:104 - -___ - -### e - -• `Optional` **e**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:105 - -___ - -### ext - -• `Optional` **ext**: `boolean` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:106 - -___ - -### key\_ops - -• `Optional` **key\_ops**: `string`[] - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:107 - -___ - -### kid - -• `Optional` **kid**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:108 - -___ - -### kty - -• **kty**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:109 - -___ - -### n - -• `Optional` **n**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:110 - -___ - -### use - -• `Optional` **use**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:111 - -___ - -### x - -• `Optional` **x**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:112 - -___ - -### y - -• `Optional` **y**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:113 diff --git a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.KeyringPublicKeys.md b/docs/api/verida-js/interfaces/verida_web_helpers._internal_.KeyringPublicKeys.md deleted file mode 100644 index a094142..0000000 --- a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.KeyringPublicKeys.md +++ /dev/null @@ -1,76 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / KeyringPublicKeys - -# Interface: KeyringPublicKeys - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).KeyringPublicKeys - -## Table of contents - -### Properties - -- [asymPublicKey](verida_web_helpers._internal_.KeyringPublicKeys.md#asympublickey) -- [asymPublicKeyBase58](verida_web_helpers._internal_.KeyringPublicKeys.md#asympublickeybase58) -- [asymPublicKeyHex](verida_web_helpers._internal_.KeyringPublicKeys.md#asympublickeyhex) -- [signPublicKey](verida_web_helpers._internal_.KeyringPublicKeys.md#signpublickey) -- [signPublicKeyBase58](verida_web_helpers._internal_.KeyringPublicKeys.md#signpublickeybase58) -- [signPublicKeyHex](verida_web_helpers._internal_.KeyringPublicKeys.md#signpublickeyhex) - -## Properties - -### asymPublicKey - -• **asymPublicKey**: `Uint8Array` - -#### Defined in - -packages/types/dist/IKeyring.d.ts:17 - -___ - -### asymPublicKeyBase58 - -• **asymPublicKeyBase58**: `string` - -#### Defined in - -packages/types/dist/IKeyring.d.ts:19 - -___ - -### asymPublicKeyHex - -• **asymPublicKeyHex**: `string` - -#### Defined in - -packages/types/dist/IKeyring.d.ts:18 - -___ - -### signPublicKey - -• **signPublicKey**: `Uint8Array` - -#### Defined in - -packages/types/dist/IKeyring.d.ts:20 - -___ - -### signPublicKeyBase58 - -• **signPublicKeyBase58**: `string` - -#### Defined in - -packages/types/dist/IKeyring.d.ts:22 - -___ - -### signPublicKeyHex - -• **signPublicKeyHex**: `string` - -#### Defined in - -packages/types/dist/IKeyring.d.ts:21 diff --git a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.KeywordErrorCxt.md b/docs/api/verida-js/interfaces/verida_web_helpers._internal_.KeywordErrorCxt.md deleted file mode 100644 index dec4eb9..0000000 --- a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.KeywordErrorCxt.md +++ /dev/null @@ -1,146 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / KeywordErrorCxt - -# Interface: KeywordErrorCxt - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).KeywordErrorCxt - -## Implemented by - -- [`KeywordCxt`](../classes/verida_web_helpers._internal_.KeywordCxt.md) - -## Table of contents - -### Properties - -- [$data](verida_web_helpers._internal_.KeywordErrorCxt.md#$data) -- [data](verida_web_helpers._internal_.KeywordErrorCxt.md#data) -- [errsCount](verida_web_helpers._internal_.KeywordErrorCxt.md#errscount) -- [gen](verida_web_helpers._internal_.KeywordErrorCxt.md#gen) -- [it](verida_web_helpers._internal_.KeywordErrorCxt.md#it) -- [keyword](verida_web_helpers._internal_.KeywordErrorCxt.md#keyword) -- [params](verida_web_helpers._internal_.KeywordErrorCxt.md#params) -- [parentSchema](verida_web_helpers._internal_.KeywordErrorCxt.md#parentschema) -- [schema](verida_web_helpers._internal_.KeywordErrorCxt.md#schema) -- [schemaCode](verida_web_helpers._internal_.KeywordErrorCxt.md#schemacode) -- [schemaType](verida_web_helpers._internal_.KeywordErrorCxt.md#schematype) -- [schemaValue](verida_web_helpers._internal_.KeywordErrorCxt.md#schemavalue) - -## Properties - -### $data - -• `Optional` **$data**: `string` \| ``false`` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:141 - -___ - -### data - -• **data**: [`Name`](../classes/verida_web_helpers._internal_.Name.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:140 - -___ - -### errsCount - -• `Optional` **errsCount**: [`Name`](../classes/verida_web_helpers._internal_.Name.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:147 - -___ - -### gen - -• **gen**: [`CodeGen`](../classes/verida_web_helpers._internal_.CodeGen.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:138 - -___ - -### it - -• **it**: [`SchemaCxt`](verida_web_helpers._internal_.SchemaCxt.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:149 - -___ - -### keyword - -• **keyword**: `string` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:139 - -___ - -### params - -• **params**: [`KeywordCxtParams`](../modules/verida_web_helpers._internal_.md#keywordcxtparams) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:148 - -___ - -### parentSchema - -• `Optional` **parentSchema**: [`AnySchemaObject`](../modules/verida_web_helpers._internal_.md#anyschemaobject) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:143 - -___ - -### schema - -• **schema**: `any` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:142 - -___ - -### schemaCode - -• **schemaCode**: `number` \| `boolean` \| [`Code`](../modules/verida_web_helpers._internal_.md#code) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:144 - -___ - -### schemaType - -• `Optional` **schemaType**: (``"string"`` \| ``"number"`` \| ``"boolean"`` \| ``"object"`` \| ``"integer"`` \| ``"array"`` \| ``"null"``)[] - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:146 - -___ - -### schemaValue - -• **schemaValue**: `number` \| `boolean` \| [`Code`](../modules/verida_web_helpers._internal_.md#code) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:145 diff --git a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.KeywordErrorDefinition.md b/docs/api/verida-js/interfaces/verida_web_helpers._internal_.KeywordErrorDefinition.md deleted file mode 100644 index 6433e03..0000000 --- a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.KeywordErrorDefinition.md +++ /dev/null @@ -1,32 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / KeywordErrorDefinition - -# Interface: KeywordErrorDefinition - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).KeywordErrorDefinition - -## Table of contents - -### Properties - -- [message](verida_web_helpers._internal_.KeywordErrorDefinition.md#message) -- [params](verida_web_helpers._internal_.KeywordErrorDefinition.md#params) - -## Properties - -### message - -• **message**: `string` \| [`Code`](../modules/verida_web_helpers._internal_.md#code) \| (`cxt`: [`KeywordErrorCxt`](verida_web_helpers._internal_.KeywordErrorCxt.md)) => `string` \| [`Code`](../modules/verida_web_helpers._internal_.md#code) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:133 - -___ - -### params - -• `Optional` **params**: [`Code`](../modules/verida_web_helpers._internal_.md#code) \| (`cxt`: [`KeywordErrorCxt`](verida_web_helpers._internal_.KeywordErrorCxt.md)) => [`Code`](../modules/verida_web_helpers._internal_.md#code) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:134 diff --git a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.Log.md b/docs/api/verida-js/interfaces/verida_web_helpers._internal_.Log.md deleted file mode 100644 index 9bae166..0000000 --- a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.Log.md +++ /dev/null @@ -1,109 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / Log - -# Interface: Log - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).Log - -## Table of contents - -### Properties - -- [address](verida_web_helpers._internal_.Log.md#address) -- [blockHash](verida_web_helpers._internal_.Log.md#blockhash) -- [blockNumber](verida_web_helpers._internal_.Log.md#blocknumber) -- [data](verida_web_helpers._internal_.Log.md#data) -- [logIndex](verida_web_helpers._internal_.Log.md#logindex) -- [removed](verida_web_helpers._internal_.Log.md#removed) -- [topics](verida_web_helpers._internal_.Log.md#topics) -- [transactionHash](verida_web_helpers._internal_.Log.md#transactionhash) -- [transactionIndex](verida_web_helpers._internal_.Log.md#transactionindex) - -## Properties - -### address - -• **address**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:59 - -___ - -### blockHash - -• **blockHash**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:56 - -___ - -### blockNumber - -• **blockNumber**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:55 - -___ - -### data - -• **data**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:60 - -___ - -### logIndex - -• **logIndex**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:63 - -___ - -### removed - -• **removed**: `boolean` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:58 - -___ - -### topics - -• **topics**: `string`[] - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:61 - -___ - -### transactionHash - -• **transactionHash**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:62 - -___ - -### transactionIndex - -• **transactionIndex**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:57 diff --git a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.Logger.md b/docs/api/verida-js/interfaces/verida_web_helpers._internal_.Logger.md deleted file mode 100644 index 824f2cc..0000000 --- a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.Logger.md +++ /dev/null @@ -1,73 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / Logger - -# Interface: Logger - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).Logger - -## Table of contents - -### Methods - -- [error](verida_web_helpers._internal_.Logger.md#error) -- [log](verida_web_helpers._internal_.Logger.md#log) -- [warn](verida_web_helpers._internal_.Logger.md#warn) - -## Methods - -### error - -▸ **error**(...`args`): `unknown` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `...args` | `unknown`[] | - -#### Returns - -`unknown` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:104 - -___ - -### log - -▸ **log**(...`args`): `unknown` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `...args` | `unknown`[] | - -#### Returns - -`unknown` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:102 - -___ - -### warn - -▸ **warn**(...`args`): `unknown` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `...args` | `unknown`[] | - -#### Returns - -`unknown` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:103 diff --git a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.MacroKeywordDefinition.md b/docs/api/verida-js/interfaces/verida_web_helpers._internal_.MacroKeywordDefinition.md deleted file mode 100644 index 6658e9a..0000000 --- a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.MacroKeywordDefinition.md +++ /dev/null @@ -1,327 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / MacroKeywordDefinition - -# Interface: MacroKeywordDefinition - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).MacroKeywordDefinition - -## Hierarchy - -- [`FuncKeywordDefinition`](verida_web_helpers._internal_.FuncKeywordDefinition.md) - - ↳ **`MacroKeywordDefinition`** - -## Table of contents - -### Properties - -- [$data](verida_web_helpers._internal_.MacroKeywordDefinition.md#$data) -- [$dataError](verida_web_helpers._internal_.MacroKeywordDefinition.md#$dataerror) -- [allowUndefined](verida_web_helpers._internal_.MacroKeywordDefinition.md#allowundefined) -- [async](verida_web_helpers._internal_.MacroKeywordDefinition.md#async) -- [before](verida_web_helpers._internal_.MacroKeywordDefinition.md#before) -- [compile](verida_web_helpers._internal_.MacroKeywordDefinition.md#compile) -- [dependencies](verida_web_helpers._internal_.MacroKeywordDefinition.md#dependencies) -- [error](verida_web_helpers._internal_.MacroKeywordDefinition.md#error) -- [errors](verida_web_helpers._internal_.MacroKeywordDefinition.md#errors) -- [implements](verida_web_helpers._internal_.MacroKeywordDefinition.md#implements) -- [keyword](verida_web_helpers._internal_.MacroKeywordDefinition.md#keyword) -- [macro](verida_web_helpers._internal_.MacroKeywordDefinition.md#macro) -- [metaSchema](verida_web_helpers._internal_.MacroKeywordDefinition.md#metaschema) -- [modifying](verida_web_helpers._internal_.MacroKeywordDefinition.md#modifying) -- [post](verida_web_helpers._internal_.MacroKeywordDefinition.md#post) -- [schema](verida_web_helpers._internal_.MacroKeywordDefinition.md#schema) -- [schemaType](verida_web_helpers._internal_.MacroKeywordDefinition.md#schematype) -- [type](verida_web_helpers._internal_.MacroKeywordDefinition.md#type) -- [valid](verida_web_helpers._internal_.MacroKeywordDefinition.md#valid) -- [validate](verida_web_helpers._internal_.MacroKeywordDefinition.md#validate) -- [validateSchema](verida_web_helpers._internal_.MacroKeywordDefinition.md#validateschema) - -## Properties - -### $data - -• `Optional` **$data**: `boolean` - -#### Inherited from - -[FuncKeywordDefinition](verida_web_helpers._internal_.FuncKeywordDefinition.md).[$data](verida_web_helpers._internal_.FuncKeywordDefinition.md#$data) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:91 - -___ - -### $dataError - -• `Optional` **$dataError**: [`KeywordErrorDefinition`](verida_web_helpers._internal_.KeywordErrorDefinition.md) - -#### Inherited from - -[FuncKeywordDefinition](verida_web_helpers._internal_.FuncKeywordDefinition.md).[$dataError](verida_web_helpers._internal_.FuncKeywordDefinition.md#$dataerror) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:99 - -___ - -### allowUndefined - -• `Optional` **allowUndefined**: `boolean` - -#### Inherited from - -[FuncKeywordDefinition](verida_web_helpers._internal_.FuncKeywordDefinition.md).[allowUndefined](verida_web_helpers._internal_.FuncKeywordDefinition.md#allowundefined) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:90 - -___ - -### async - -• `Optional` **async**: `boolean` - -#### Inherited from - -[FuncKeywordDefinition](verida_web_helpers._internal_.FuncKeywordDefinition.md).[async](verida_web_helpers._internal_.FuncKeywordDefinition.md#async) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:120 - -___ - -### before - -• `Optional` **before**: `string` - -#### Inherited from - -[FuncKeywordDefinition](verida_web_helpers._internal_.FuncKeywordDefinition.md).[before](verida_web_helpers._internal_.FuncKeywordDefinition.md#before) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:93 - -___ - -### compile - -• `Optional` **compile**: [`CompileKeywordFunc`](../modules/verida_web_helpers._internal_.md#compilekeywordfunc) - -#### Inherited from - -[FuncKeywordDefinition](verida_web_helpers._internal_.FuncKeywordDefinition.md).[compile](verida_web_helpers._internal_.FuncKeywordDefinition.md#compile) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:117 - -___ - -### dependencies - -• `Optional` **dependencies**: `string`[] - -#### Inherited from - -[FuncKeywordDefinition](verida_web_helpers._internal_.FuncKeywordDefinition.md).[dependencies](verida_web_helpers._internal_.FuncKeywordDefinition.md#dependencies) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:97 - -___ - -### error - -• `Optional` **error**: [`KeywordErrorDefinition`](verida_web_helpers._internal_.KeywordErrorDefinition.md) - -#### Inherited from - -[FuncKeywordDefinition](verida_web_helpers._internal_.FuncKeywordDefinition.md).[error](verida_web_helpers._internal_.FuncKeywordDefinition.md#error) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:98 - -___ - -### errors - -• `Optional` **errors**: `boolean` \| ``"full"`` - -#### Inherited from - -[FuncKeywordDefinition](verida_web_helpers._internal_.FuncKeywordDefinition.md).[errors](verida_web_helpers._internal_.FuncKeywordDefinition.md#errors) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:122 - -___ - -### implements - -• `Optional` **implements**: `string`[] - -#### Inherited from - -[FuncKeywordDefinition](verida_web_helpers._internal_.FuncKeywordDefinition.md).[implements](verida_web_helpers._internal_.FuncKeywordDefinition.md#implements) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:92 - -___ - -### keyword - -• **keyword**: `string` \| `string`[] - -#### Inherited from - -[FuncKeywordDefinition](verida_web_helpers._internal_.FuncKeywordDefinition.md).[keyword](verida_web_helpers._internal_.FuncKeywordDefinition.md#keyword) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:87 - -___ - -### macro - -• **macro**: [`MacroKeywordFunc`](../modules/verida_web_helpers._internal_.md#macrokeywordfunc) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:125 - -___ - -### metaSchema - -• `Optional` **metaSchema**: [`AnySchemaObject`](../modules/verida_web_helpers._internal_.md#anyschemaobject) - -#### Inherited from - -[FuncKeywordDefinition](verida_web_helpers._internal_.FuncKeywordDefinition.md).[metaSchema](verida_web_helpers._internal_.FuncKeywordDefinition.md#metaschema) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:95 - -___ - -### modifying - -• `Optional` **modifying**: `boolean` - -#### Inherited from - -[FuncKeywordDefinition](verida_web_helpers._internal_.FuncKeywordDefinition.md).[modifying](verida_web_helpers._internal_.FuncKeywordDefinition.md#modifying) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:119 - -___ - -### post - -• `Optional` **post**: `boolean` - -#### Inherited from - -[FuncKeywordDefinition](verida_web_helpers._internal_.FuncKeywordDefinition.md).[post](verida_web_helpers._internal_.FuncKeywordDefinition.md#post) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:94 - -___ - -### schema - -• `Optional` **schema**: `boolean` - -#### Inherited from - -[FuncKeywordDefinition](verida_web_helpers._internal_.FuncKeywordDefinition.md).[schema](verida_web_helpers._internal_.FuncKeywordDefinition.md#schema) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:118 - -___ - -### schemaType - -• `Optional` **schemaType**: ``"string"`` \| ``"number"`` \| ``"boolean"`` \| ``"object"`` \| ``"integer"`` \| ``"array"`` \| ``"null"`` \| (``"string"`` \| ``"number"`` \| ``"boolean"`` \| ``"object"`` \| ``"integer"`` \| ``"array"`` \| ``"null"``)[] - -#### Inherited from - -[FuncKeywordDefinition](verida_web_helpers._internal_.FuncKeywordDefinition.md).[schemaType](verida_web_helpers._internal_.FuncKeywordDefinition.md#schematype) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:89 - -___ - -### type - -• `Optional` **type**: ``"string"`` \| ``"number"`` \| ``"boolean"`` \| ``"object"`` \| ``"integer"`` \| ``"array"`` \| ``"null"`` \| (``"string"`` \| ``"number"`` \| ``"boolean"`` \| ``"object"`` \| ``"integer"`` \| ``"array"`` \| ``"null"``)[] - -#### Inherited from - -[FuncKeywordDefinition](verida_web_helpers._internal_.FuncKeywordDefinition.md).[type](verida_web_helpers._internal_.FuncKeywordDefinition.md#type) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:88 - -___ - -### valid - -• `Optional` **valid**: `boolean` - -#### Inherited from - -[FuncKeywordDefinition](verida_web_helpers._internal_.FuncKeywordDefinition.md).[valid](verida_web_helpers._internal_.FuncKeywordDefinition.md#valid) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:121 - -___ - -### validate - -• `Optional` **validate**: [`SchemaValidateFunction`](verida_web_helpers._internal_.SchemaValidateFunction.md) \| [`DataValidateFunction`](verida_web_helpers._internal_.DataValidateFunction.md) - -#### Inherited from - -[FuncKeywordDefinition](verida_web_helpers._internal_.FuncKeywordDefinition.md).[validate](verida_web_helpers._internal_.FuncKeywordDefinition.md#validate) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:116 - -___ - -### validateSchema - -• `Optional` **validateSchema**: [`AnyValidateFunction`](../modules/verida_web_helpers._internal_.md#anyvalidatefunction)<`any`\> - -#### Inherited from - -[FuncKeywordDefinition](verida_web_helpers._internal_.FuncKeywordDefinition.md).[validateSchema](verida_web_helpers._internal_.FuncKeywordDefinition.md#validateschema) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:96 diff --git a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.MessageSendConfig.md b/docs/api/verida-js/interfaces/verida_web_helpers._internal_.MessageSendConfig.md deleted file mode 100644 index ae4db87..0000000 --- a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.MessageSendConfig.md +++ /dev/null @@ -1,56 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / MessageSendConfig - -# Interface: MessageSendConfig - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).MessageSendConfig - -Interface for any MessageSendConfig - -## Table of contents - -### Properties - -- [did](verida_web_helpers._internal_.MessageSendConfig.md#did) -- [expiry](verida_web_helpers._internal_.MessageSendConfig.md#expiry) -- [openUrl](verida_web_helpers._internal_.MessageSendConfig.md#openurl) -- [recipientContextName](verida_web_helpers._internal_.MessageSendConfig.md#recipientcontextname) - -## Properties - -### did - -• **did**: `string` - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:124 - -___ - -### expiry - -• `Optional` **expiry**: [`Number`](../modules/verida_web_helpers._internal_.md#number) - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:125 - -___ - -### openUrl - -• `Optional` **openUrl**: `string` - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:127 - -___ - -### recipientContextName - -• `Optional` **recipientContextName**: `string` - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:126 diff --git a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.MessagesConfig.md b/docs/api/verida-js/interfaces/verida_web_helpers._internal_.MessagesConfig.md deleted file mode 100644 index 19cb3a3..0000000 --- a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.MessagesConfig.md +++ /dev/null @@ -1,23 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / MessagesConfig - -# Interface: MessagesConfig - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).MessagesConfig - -Interface for any MessagesConfig - -## Table of contents - -### Properties - -- [maxItems](verida_web_helpers._internal_.MessagesConfig.md#maxitems) - -## Properties - -### maxItems - -• `Optional` **maxItems**: [`Number`](../modules/verida_web_helpers._internal_.md#number) - -#### Defined in - -packages/types/dist/ContextInterfaces.d.ts:93 diff --git a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.NameValue.md b/docs/api/verida-js/interfaces/verida_web_helpers._internal_.NameValue.md deleted file mode 100644 index 1c7a840..0000000 --- a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.NameValue.md +++ /dev/null @@ -1,43 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / NameValue - -# Interface: NameValue - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).NameValue - -## Table of contents - -### Properties - -- [code](verida_web_helpers._internal_.NameValue.md#code) -- [key](verida_web_helpers._internal_.NameValue.md#key) -- [ref](verida_web_helpers._internal_.NameValue.md#ref) - -## Properties - -### code - -• `Optional` **code**: [`Code`](../modules/verida_web_helpers._internal_.md#code) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/scope.d.ts:9 - -___ - -### key - -• `Optional` **key**: `unknown` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/scope.d.ts:8 - -___ - -### ref - -• **ref**: `unknown` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/scope.d.ts:7 diff --git a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.NodeEventTarget.md b/docs/api/verida-js/interfaces/verida_web_helpers._internal_.NodeEventTarget.md deleted file mode 100644 index 5ce869f..0000000 --- a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.NodeEventTarget.md +++ /dev/null @@ -1,32 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / NodeEventTarget - -# Interface: NodeEventTarget - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).NodeEventTarget - -## Table of contents - -### Methods - -- [once](verida_web_helpers._internal_.NodeEventTarget.md#once) - -## Methods - -### once - -▸ **once**(`eventName`, `listener`): [`NodeEventTarget`](verida_web_helpers._internal_.NodeEventTarget.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | `string` \| `symbol` | -| `listener` | (...`args`: `any`[]) => `void` | - -#### Returns - -[`NodeEventTarget`](verida_web_helpers._internal_.NodeEventTarget.md) - -#### Defined in - -node_modules/@types/node/events.d.ts:45 diff --git a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.Number.md b/docs/api/verida-js/interfaces/verida_web_helpers._internal_.Number.md deleted file mode 100644 index c247734..0000000 --- a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.Number.md +++ /dev/null @@ -1,143 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / Number - -# Interface: Number - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).Number - -## Table of contents - -### Methods - -- [toExponential](verida_web_helpers._internal_.Number.md#toexponential) -- [toFixed](verida_web_helpers._internal_.Number.md#tofixed) -- [toLocaleString](verida_web_helpers._internal_.Number.md#tolocalestring) -- [toPrecision](verida_web_helpers._internal_.Number.md#toprecision) -- [toString](verida_web_helpers._internal_.Number.md#tostring) -- [valueOf](verida_web_helpers._internal_.Number.md#valueof) - -## Methods - -### toExponential - -▸ **toExponential**(`fractionDigits?`): `string` - -Returns a string containing a number represented in exponential notation. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `fractionDigits?` | `number` | Number of digits after the decimal point. Must be in the range 0 - 20, inclusive. | - -#### Returns - -`string` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:559 - -___ - -### toFixed - -▸ **toFixed**(`fractionDigits?`): `string` - -Returns a string representing a number in fixed-point notation. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `fractionDigits?` | `number` | Number of digits after the decimal point. Must be in the range 0 - 20, inclusive. | - -#### Returns - -`string` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:553 - -___ - -### toLocaleString - -▸ **toLocaleString**(`locales?`, `options?`): `string` - -Converts a number to a string by using the current or specified locale. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `locales?` | `string` \| `string`[] | A locale string or array of locale strings that contain one or more language or locale tags. If you include more than one locale string, list them in descending order of priority so that the first entry is the preferred locale. If you omit this parameter, the default locale of the JavaScript runtime is used. | -| `options?` | `NumberFormatOptions` | An object that contains one or more properties that specify comparison options. | - -#### Returns - -`string` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:4412 - -___ - -### toPrecision - -▸ **toPrecision**(`precision?`): `string` - -Returns a string containing a number represented either in exponential or fixed-point notation with a specified number of digits. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `precision?` | `number` | Number of significant digits. Must be in the range 1 - 21, inclusive. | - -#### Returns - -`string` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:565 - -___ - -### toString - -▸ **toString**(`radix?`): `string` - -Returns a string representation of an object. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `radix?` | `number` | Specifies a radix for converting numeric values to strings. This value is only used for numbers. | - -#### Returns - -`string` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:547 - -___ - -### valueOf - -▸ **valueOf**(): `number` - -Returns the primitive value of the specified object. - -#### Returns - -`number` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:568 diff --git a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.NumberKeywords.md b/docs/api/verida-js/interfaces/verida_web_helpers._internal_.NumberKeywords.md deleted file mode 100644 index 3728571..0000000 --- a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.NumberKeywords.md +++ /dev/null @@ -1,76 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / NumberKeywords - -# Interface: NumberKeywords - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).NumberKeywords - -## Table of contents - -### Properties - -- [exclusiveMaximum](verida_web_helpers._internal_.NumberKeywords.md#exclusivemaximum) -- [exclusiveMinimum](verida_web_helpers._internal_.NumberKeywords.md#exclusiveminimum) -- [format](verida_web_helpers._internal_.NumberKeywords.md#format) -- [maximum](verida_web_helpers._internal_.NumberKeywords.md#maximum) -- [minimum](verida_web_helpers._internal_.NumberKeywords.md#minimum) -- [multipleOf](verida_web_helpers._internal_.NumberKeywords.md#multipleof) - -## Properties - -### exclusiveMaximum - -• `Optional` **exclusiveMaximum**: `number` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/json-schema.d.ts:11 - -___ - -### exclusiveMinimum - -• `Optional` **exclusiveMinimum**: `number` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/json-schema.d.ts:10 - -___ - -### format - -• `Optional` **format**: `string` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/json-schema.d.ts:13 - -___ - -### maximum - -• `Optional` **maximum**: `number` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/json-schema.d.ts:9 - -___ - -### minimum - -• `Optional` **minimum**: `number` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/json-schema.d.ts:8 - -___ - -### multipleOf - -• `Optional` **multipleOf**: `number` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/json-schema.d.ts:12 diff --git a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.OnceBlockable.md b/docs/api/verida-js/interfaces/verida_web_helpers._internal_.OnceBlockable.md deleted file mode 100644 index 100eb33..0000000 --- a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.OnceBlockable.md +++ /dev/null @@ -1,36 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / OnceBlockable - -# Interface: OnceBlockable - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).OnceBlockable - -## Implemented by - -- [`Provider`](../classes/verida_web_helpers._internal_.Provider.md) - -## Table of contents - -### Methods - -- [once](verida_web_helpers._internal_.OnceBlockable.md#once) - -## Methods - -### once - -▸ **once**(`eventName`, `handler`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | ``"block"`` | -| `handler` | () => `void` | - -#### Returns - -`void` - -#### Defined in - -node_modules/@ethersproject/web/lib/index.d.ts:19 diff --git a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.PromiseLike.md b/docs/api/verida-js/interfaces/verida_web_helpers._internal_.PromiseLike.md deleted file mode 100644 index 292638a..0000000 --- a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.PromiseLike.md +++ /dev/null @@ -1,49 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / PromiseLike - -# Interface: PromiseLike - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).PromiseLike - -## Type parameters - -| Name | -| :------ | -| `T` | - -## Table of contents - -### Methods - -- [then](verida_web_helpers._internal_.PromiseLike.md#then) - -## Methods - -### then - -▸ **then**<`TResult1`, `TResult2`\>(`onfulfilled?`, `onrejected?`): [`PromiseLike`](verida_web_helpers._internal_.PromiseLike.md)<`TResult1` \| `TResult2`\> - -Attaches callbacks for the resolution and/or rejection of the Promise. - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `TResult1` | `T` | -| `TResult2` | `never` | - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `onfulfilled?` | ``null`` \| (`value`: `T`) => `TResult1` \| [`PromiseLike`](verida_web_helpers._internal_.PromiseLike.md)<`TResult1`\> | The callback to execute when the Promise is resolved. | -| `onrejected?` | ``null`` \| (`reason`: `any`) => `TResult2` \| [`PromiseLike`](verida_web_helpers._internal_.PromiseLike.md)<`TResult2`\> | The callback to execute when the Promise is rejected. | - -#### Returns - -[`PromiseLike`](verida_web_helpers._internal_.PromiseLike.md)<`TResult1` \| `TResult2`\> - -A Promise for the completion of which ever callback is executed. - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1440 diff --git a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.ProofInterface.md b/docs/api/verida-js/interfaces/verida_web_helpers._internal_.ProofInterface.md deleted file mode 100644 index 8c0d215..0000000 --- a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.ProofInterface.md +++ /dev/null @@ -1,54 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / ProofInterface - -# Interface: ProofInterface - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).ProofInterface - -## Table of contents - -### Properties - -- [proofPurpose](verida_web_helpers._internal_.ProofInterface.md#proofpurpose) -- [proofValue](verida_web_helpers._internal_.ProofInterface.md#proofvalue) -- [type](verida_web_helpers._internal_.ProofInterface.md#type) -- [verificationMethod](verida_web_helpers._internal_.ProofInterface.md#verificationmethod) - -## Properties - -### proofPurpose - -• **proofPurpose**: `string` - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:34 - -___ - -### proofValue - -• **proofValue**: `string` - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:35 - -___ - -### type - -• **type**: `string` - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:32 - -___ - -### verificationMethod - -• **verificationMethod**: `string` - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:33 diff --git a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.RegExpEngine.md b/docs/api/verida-js/interfaces/verida_web_helpers._internal_.RegExpEngine.md deleted file mode 100644 index da28534..0000000 --- a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.RegExpEngine.md +++ /dev/null @@ -1,42 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / RegExpEngine - -# Interface: RegExpEngine - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).RegExpEngine - -## Callable - -### RegExpEngine - -▸ **RegExpEngine**(`pattern`, `u`): [`RegExpLike`](verida_web_helpers._internal_.RegExpLike.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `pattern` | `string` | -| `u` | `string` | - -#### Returns - -[`RegExpLike`](verida_web_helpers._internal_.RegExpLike.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:172 - -## Table of contents - -### Properties - -- [code](verida_web_helpers._internal_.RegExpEngine.md#code) - -## Properties - -### code - -• **code**: `string` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:173 diff --git a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.RegExpLike.md b/docs/api/verida-js/interfaces/verida_web_helpers._internal_.RegExpLike.md deleted file mode 100644 index 3a7db9c..0000000 --- a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.RegExpLike.md +++ /dev/null @@ -1,31 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / RegExpLike - -# Interface: RegExpLike - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).RegExpLike - -## Table of contents - -### Methods - -- [test](verida_web_helpers._internal_.RegExpLike.md#test) - -## Methods - -### test - -▸ **test**(`s`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `s` | `string` | - -#### Returns - -`boolean` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:176 diff --git a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.Rule.md b/docs/api/verida-js/interfaces/verida_web_helpers._internal_.Rule.md deleted file mode 100644 index 7145826..0000000 --- a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.Rule.md +++ /dev/null @@ -1,32 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / Rule - -# Interface: Rule - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).Rule - -## Table of contents - -### Properties - -- [definition](verida_web_helpers._internal_.Rule.md#definition) -- [keyword](verida_web_helpers._internal_.Rule.md#keyword) - -## Properties - -### definition - -• **definition**: [`AddedKeywordDefinition`](../modules/verida_web_helpers._internal_.md#addedkeyworddefinition) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/rules.d.ts:25 - -___ - -### keyword - -• **keyword**: `string` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/rules.d.ts:24 diff --git a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.RuleGroup.md b/docs/api/verida-js/interfaces/verida_web_helpers._internal_.RuleGroup.md deleted file mode 100644 index d57101b..0000000 --- a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.RuleGroup.md +++ /dev/null @@ -1,32 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / RuleGroup - -# Interface: RuleGroup - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).RuleGroup - -## Table of contents - -### Properties - -- [rules](verida_web_helpers._internal_.RuleGroup.md#rules) -- [type](verida_web_helpers._internal_.RuleGroup.md#type) - -## Properties - -### rules - -• **rules**: [`Rule`](verida_web_helpers._internal_.Rule.md)[] - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/rules.d.ts:21 - -___ - -### type - -• `Optional` **type**: ``"string"`` \| ``"number"`` \| ``"boolean"`` \| ``"object"`` \| ``"integer"`` \| ``"array"`` \| ``"null"`` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/rules.d.ts:20 diff --git a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.SchemaCxt.md b/docs/api/verida-js/interfaces/verida_web_helpers._internal_.SchemaCxt.md deleted file mode 100644 index 3bc6498..0000000 --- a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.SchemaCxt.md +++ /dev/null @@ -1,346 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / SchemaCxt - -# Interface: SchemaCxt - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).SchemaCxt - -## Hierarchy - -- **`SchemaCxt`** - - ↳ [`SchemaObjCxt`](verida_web_helpers._internal_.SchemaObjCxt.md) - -## Table of contents - -### Properties - -- [ValidationError](verida_web_helpers._internal_.SchemaCxt.md#validationerror) -- [allErrors](verida_web_helpers._internal_.SchemaCxt.md#allerrors) -- [baseId](verida_web_helpers._internal_.SchemaCxt.md#baseid) -- [compositeRule](verida_web_helpers._internal_.SchemaCxt.md#compositerule) -- [createErrors](verida_web_helpers._internal_.SchemaCxt.md#createerrors) -- [data](verida_web_helpers._internal_.SchemaCxt.md#data) -- [dataLevel](verida_web_helpers._internal_.SchemaCxt.md#datalevel) -- [dataNames](verida_web_helpers._internal_.SchemaCxt.md#datanames) -- [dataPathArr](verida_web_helpers._internal_.SchemaCxt.md#datapatharr) -- [dataTypes](verida_web_helpers._internal_.SchemaCxt.md#datatypes) -- [definedProperties](verida_web_helpers._internal_.SchemaCxt.md#definedproperties) -- [errSchemaPath](verida_web_helpers._internal_.SchemaCxt.md#errschemapath) -- [errorPath](verida_web_helpers._internal_.SchemaCxt.md#errorpath) -- [evaluated](verida_web_helpers._internal_.SchemaCxt.md#evaluated) -- [gen](verida_web_helpers._internal_.SchemaCxt.md#gen) -- [items](verida_web_helpers._internal_.SchemaCxt.md#items) -- [jtdDiscriminator](verida_web_helpers._internal_.SchemaCxt.md#jtddiscriminator) -- [jtdMetadata](verida_web_helpers._internal_.SchemaCxt.md#jtdmetadata) -- [opts](verida_web_helpers._internal_.SchemaCxt.md#opts) -- [parentData](verida_web_helpers._internal_.SchemaCxt.md#parentdata) -- [parentDataProperty](verida_web_helpers._internal_.SchemaCxt.md#parentdataproperty) -- [propertyName](verida_web_helpers._internal_.SchemaCxt.md#propertyname) -- [props](verida_web_helpers._internal_.SchemaCxt.md#props) -- [rootId](verida_web_helpers._internal_.SchemaCxt.md#rootid) -- [schema](verida_web_helpers._internal_.SchemaCxt.md#schema) -- [schemaEnv](verida_web_helpers._internal_.SchemaCxt.md#schemaenv) -- [schemaPath](verida_web_helpers._internal_.SchemaCxt.md#schemapath) -- [self](verida_web_helpers._internal_.SchemaCxt.md#self) -- [topSchemaRef](verida_web_helpers._internal_.SchemaCxt.md#topschemaref) -- [validateName](verida_web_helpers._internal_.SchemaCxt.md#validatename) - -## Properties - -### ValidationError - -• `Optional` `Readonly` **ValidationError**: [`Name`](../classes/verida_web_helpers._internal_.Name.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:24 - -___ - -### allErrors - -• `Optional` `Readonly` **allErrors**: `boolean` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:12 - -___ - -### baseId - -• **baseId**: `string` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:28 - -___ - -### compositeRule - -• `Optional` `Readonly` **compositeRule**: `boolean` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:33 - -___ - -### createErrors - -• `Optional` `Readonly` **createErrors**: `boolean` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:38 - -___ - -### data - -• `Readonly` **data**: [`Name`](../classes/verida_web_helpers._internal_.Name.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:13 - -___ - -### dataLevel - -• `Readonly` **dataLevel**: `number` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:18 - -___ - -### dataNames - -• `Readonly` **dataNames**: [`Name`](../classes/verida_web_helpers._internal_.Name.md)[] - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:16 - -___ - -### dataPathArr - -• `Readonly` **dataPathArr**: (`number` \| [`Code`](../modules/verida_web_helpers._internal_.md#code))[] - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:17 - -___ - -### dataTypes - -• **dataTypes**: (``"string"`` \| ``"number"`` \| ``"boolean"`` \| ``"object"`` \| ``"integer"`` \| ``"array"`` \| ``"null"``)[] - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:19 - -___ - -### definedProperties - -• **definedProperties**: `Set`<`string`\> - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:20 - -___ - -### errSchemaPath - -• `Readonly` **errSchemaPath**: `string` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:30 - -___ - -### errorPath - -• `Readonly` **errorPath**: [`Code`](../modules/verida_web_helpers._internal_.md#code) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:31 - -___ - -### evaluated - -• `Optional` **evaluated**: [`Name`](../classes/verida_web_helpers._internal_.Name.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:23 - -___ - -### gen - -• `Readonly` **gen**: [`CodeGen`](../classes/verida_web_helpers._internal_.CodeGen.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:11 - -___ - -### items - -• `Optional` **items**: [`Name`](../classes/verida_web_helpers._internal_.Name.md) \| [`EvaluatedItems`](../modules/verida_web_helpers._internal_.md#evaluateditems) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:35 - -___ - -### jtdDiscriminator - -• `Optional` **jtdDiscriminator**: `string` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:36 - -___ - -### jtdMetadata - -• `Optional` **jtdMetadata**: `boolean` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:37 - -___ - -### opts - -• `Readonly` **opts**: [`InstanceOptions`](../modules/verida_web_helpers._internal_.md#instanceoptions) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:39 - -___ - -### parentData - -• `Readonly` **parentData**: [`Name`](../classes/verida_web_helpers._internal_.Name.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:14 - -___ - -### parentDataProperty - -• `Readonly` **parentDataProperty**: `number` \| [`Code`](../modules/verida_web_helpers._internal_.md#code) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:15 - -___ - -### propertyName - -• `Optional` `Readonly` **propertyName**: [`Name`](../classes/verida_web_helpers._internal_.Name.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:32 - -___ - -### props - -• `Optional` **props**: [`Name`](../classes/verida_web_helpers._internal_.Name.md) \| [`EvaluatedProperties`](../modules/verida_web_helpers._internal_.md#evaluatedproperties) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:34 - -___ - -### rootId - -• `Readonly` **rootId**: `string` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:27 - -___ - -### schema - -• `Readonly` **schema**: [`AnySchema`](../modules/verida_web_helpers._internal_.md#anyschema) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:25 - -___ - -### schemaEnv - -• `Readonly` **schemaEnv**: [`SchemaEnv`](../classes/verida_web_helpers._internal_.SchemaEnv.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:26 - -___ - -### schemaPath - -• `Readonly` **schemaPath**: [`Code`](../modules/verida_web_helpers._internal_.md#code) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:29 - -___ - -### self - -• `Readonly` **self**: [`default`](../classes/verida_web_helpers._internal_.default-3.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:40 - -___ - -### topSchemaRef - -• `Readonly` **topSchemaRef**: [`Code`](../modules/verida_web_helpers._internal_.md#code) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:21 - -___ - -### validateName - -• `Readonly` **validateName**: [`Name`](../classes/verida_web_helpers._internal_.Name.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:22 diff --git a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.SchemaEnvArgs.md b/docs/api/verida-js/interfaces/verida_web_helpers._internal_.SchemaEnvArgs.md deleted file mode 100644 index 28beeb2..0000000 --- a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.SchemaEnvArgs.md +++ /dev/null @@ -1,91 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / SchemaEnvArgs - -# Interface: SchemaEnvArgs - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).SchemaEnvArgs - -## Implemented by - -- [`SchemaEnv`](../classes/verida_web_helpers._internal_.SchemaEnv.md) - -## Table of contents - -### Properties - -- [baseId](verida_web_helpers._internal_.SchemaEnvArgs.md#baseid) -- [localRefs](verida_web_helpers._internal_.SchemaEnvArgs.md#localrefs) -- [meta](verida_web_helpers._internal_.SchemaEnvArgs.md#meta) -- [root](verida_web_helpers._internal_.SchemaEnvArgs.md#root) -- [schema](verida_web_helpers._internal_.SchemaEnvArgs.md#schema) -- [schemaId](verida_web_helpers._internal_.SchemaEnvArgs.md#schemaid) -- [schemaPath](verida_web_helpers._internal_.SchemaEnvArgs.md#schemapath) - -## Properties - -### baseId - -• `Optional` `Readonly` **baseId**: `string` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:49 - -___ - -### localRefs - -• `Optional` `Readonly` **localRefs**: [`LocalRefs`](../modules/verida_web_helpers._internal_.md#localrefs) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:51 - -___ - -### meta - -• `Optional` `Readonly` **meta**: `boolean` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:52 - -___ - -### root - -• `Optional` `Readonly` **root**: [`SchemaEnv`](../classes/verida_web_helpers._internal_.SchemaEnv.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:48 - -___ - -### schema - -• `Readonly` **schema**: [`AnySchema`](../modules/verida_web_helpers._internal_.md#anyschema) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:46 - -___ - -### schemaId - -• `Optional` `Readonly` **schemaId**: ``"id"`` \| ``"$id"`` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:47 - -___ - -### schemaPath - -• `Optional` `Readonly` **schemaPath**: `string` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:50 diff --git a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.SchemaObjCxt.md b/docs/api/verida-js/interfaces/verida_web_helpers._internal_.SchemaObjCxt.md deleted file mode 100644 index 0bf3815..0000000 --- a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.SchemaObjCxt.md +++ /dev/null @@ -1,466 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / SchemaObjCxt - -# Interface: SchemaObjCxt - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).SchemaObjCxt - -## Hierarchy - -- [`SchemaCxt`](verida_web_helpers._internal_.SchemaCxt.md) - - ↳ **`SchemaObjCxt`** - -## Table of contents - -### Properties - -- [ValidationError](verida_web_helpers._internal_.SchemaObjCxt.md#validationerror) -- [allErrors](verida_web_helpers._internal_.SchemaObjCxt.md#allerrors) -- [baseId](verida_web_helpers._internal_.SchemaObjCxt.md#baseid) -- [compositeRule](verida_web_helpers._internal_.SchemaObjCxt.md#compositerule) -- [createErrors](verida_web_helpers._internal_.SchemaObjCxt.md#createerrors) -- [data](verida_web_helpers._internal_.SchemaObjCxt.md#data) -- [dataLevel](verida_web_helpers._internal_.SchemaObjCxt.md#datalevel) -- [dataNames](verida_web_helpers._internal_.SchemaObjCxt.md#datanames) -- [dataPathArr](verida_web_helpers._internal_.SchemaObjCxt.md#datapatharr) -- [dataTypes](verida_web_helpers._internal_.SchemaObjCxt.md#datatypes) -- [definedProperties](verida_web_helpers._internal_.SchemaObjCxt.md#definedproperties) -- [errSchemaPath](verida_web_helpers._internal_.SchemaObjCxt.md#errschemapath) -- [errorPath](verida_web_helpers._internal_.SchemaObjCxt.md#errorpath) -- [evaluated](verida_web_helpers._internal_.SchemaObjCxt.md#evaluated) -- [gen](verida_web_helpers._internal_.SchemaObjCxt.md#gen) -- [items](verida_web_helpers._internal_.SchemaObjCxt.md#items) -- [jtdDiscriminator](verida_web_helpers._internal_.SchemaObjCxt.md#jtddiscriminator) -- [jtdMetadata](verida_web_helpers._internal_.SchemaObjCxt.md#jtdmetadata) -- [opts](verida_web_helpers._internal_.SchemaObjCxt.md#opts) -- [parentData](verida_web_helpers._internal_.SchemaObjCxt.md#parentdata) -- [parentDataProperty](verida_web_helpers._internal_.SchemaObjCxt.md#parentdataproperty) -- [propertyName](verida_web_helpers._internal_.SchemaObjCxt.md#propertyname) -- [props](verida_web_helpers._internal_.SchemaObjCxt.md#props) -- [rootId](verida_web_helpers._internal_.SchemaObjCxt.md#rootid) -- [schema](verida_web_helpers._internal_.SchemaObjCxt.md#schema) -- [schemaEnv](verida_web_helpers._internal_.SchemaObjCxt.md#schemaenv) -- [schemaPath](verida_web_helpers._internal_.SchemaObjCxt.md#schemapath) -- [self](verida_web_helpers._internal_.SchemaObjCxt.md#self) -- [topSchemaRef](verida_web_helpers._internal_.SchemaObjCxt.md#topschemaref) -- [validateName](verida_web_helpers._internal_.SchemaObjCxt.md#validatename) - -## Properties - -### ValidationError - -• `Optional` `Readonly` **ValidationError**: [`Name`](../classes/verida_web_helpers._internal_.Name.md) - -#### Inherited from - -[SchemaCxt](verida_web_helpers._internal_.SchemaCxt.md).[ValidationError](verida_web_helpers._internal_.SchemaCxt.md#validationerror) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:24 - -___ - -### allErrors - -• `Optional` `Readonly` **allErrors**: `boolean` - -#### Inherited from - -[SchemaCxt](verida_web_helpers._internal_.SchemaCxt.md).[allErrors](verida_web_helpers._internal_.SchemaCxt.md#allerrors) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:12 - -___ - -### baseId - -• **baseId**: `string` - -#### Inherited from - -[SchemaCxt](verida_web_helpers._internal_.SchemaCxt.md).[baseId](verida_web_helpers._internal_.SchemaCxt.md#baseid) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:28 - -___ - -### compositeRule - -• `Optional` `Readonly` **compositeRule**: `boolean` - -#### Inherited from - -[SchemaCxt](verida_web_helpers._internal_.SchemaCxt.md).[compositeRule](verida_web_helpers._internal_.SchemaCxt.md#compositerule) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:33 - -___ - -### createErrors - -• `Optional` `Readonly` **createErrors**: `boolean` - -#### Inherited from - -[SchemaCxt](verida_web_helpers._internal_.SchemaCxt.md).[createErrors](verida_web_helpers._internal_.SchemaCxt.md#createerrors) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:38 - -___ - -### data - -• `Readonly` **data**: [`Name`](../classes/verida_web_helpers._internal_.Name.md) - -#### Inherited from - -[SchemaCxt](verida_web_helpers._internal_.SchemaCxt.md).[data](verida_web_helpers._internal_.SchemaCxt.md#data) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:13 - -___ - -### dataLevel - -• `Readonly` **dataLevel**: `number` - -#### Inherited from - -[SchemaCxt](verida_web_helpers._internal_.SchemaCxt.md).[dataLevel](verida_web_helpers._internal_.SchemaCxt.md#datalevel) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:18 - -___ - -### dataNames - -• `Readonly` **dataNames**: [`Name`](../classes/verida_web_helpers._internal_.Name.md)[] - -#### Inherited from - -[SchemaCxt](verida_web_helpers._internal_.SchemaCxt.md).[dataNames](verida_web_helpers._internal_.SchemaCxt.md#datanames) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:16 - -___ - -### dataPathArr - -• `Readonly` **dataPathArr**: (`number` \| [`Code`](../modules/verida_web_helpers._internal_.md#code))[] - -#### Inherited from - -[SchemaCxt](verida_web_helpers._internal_.SchemaCxt.md).[dataPathArr](verida_web_helpers._internal_.SchemaCxt.md#datapatharr) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:17 - -___ - -### dataTypes - -• **dataTypes**: (``"string"`` \| ``"number"`` \| ``"boolean"`` \| ``"object"`` \| ``"integer"`` \| ``"array"`` \| ``"null"``)[] - -#### Inherited from - -[SchemaCxt](verida_web_helpers._internal_.SchemaCxt.md).[dataTypes](verida_web_helpers._internal_.SchemaCxt.md#datatypes) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:19 - -___ - -### definedProperties - -• **definedProperties**: `Set`<`string`\> - -#### Inherited from - -[SchemaCxt](verida_web_helpers._internal_.SchemaCxt.md).[definedProperties](verida_web_helpers._internal_.SchemaCxt.md#definedproperties) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:20 - -___ - -### errSchemaPath - -• `Readonly` **errSchemaPath**: `string` - -#### Inherited from - -[SchemaCxt](verida_web_helpers._internal_.SchemaCxt.md).[errSchemaPath](verida_web_helpers._internal_.SchemaCxt.md#errschemapath) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:30 - -___ - -### errorPath - -• `Readonly` **errorPath**: [`Code`](../modules/verida_web_helpers._internal_.md#code) - -#### Inherited from - -[SchemaCxt](verida_web_helpers._internal_.SchemaCxt.md).[errorPath](verida_web_helpers._internal_.SchemaCxt.md#errorpath) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:31 - -___ - -### evaluated - -• `Optional` **evaluated**: [`Name`](../classes/verida_web_helpers._internal_.Name.md) - -#### Inherited from - -[SchemaCxt](verida_web_helpers._internal_.SchemaCxt.md).[evaluated](verida_web_helpers._internal_.SchemaCxt.md#evaluated) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:23 - -___ - -### gen - -• `Readonly` **gen**: [`CodeGen`](../classes/verida_web_helpers._internal_.CodeGen.md) - -#### Inherited from - -[SchemaCxt](verida_web_helpers._internal_.SchemaCxt.md).[gen](verida_web_helpers._internal_.SchemaCxt.md#gen) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:11 - -___ - -### items - -• `Optional` **items**: [`Name`](../classes/verida_web_helpers._internal_.Name.md) \| [`EvaluatedItems`](../modules/verida_web_helpers._internal_.md#evaluateditems) - -#### Inherited from - -[SchemaCxt](verida_web_helpers._internal_.SchemaCxt.md).[items](verida_web_helpers._internal_.SchemaCxt.md#items) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:35 - -___ - -### jtdDiscriminator - -• `Optional` **jtdDiscriminator**: `string` - -#### Inherited from - -[SchemaCxt](verida_web_helpers._internal_.SchemaCxt.md).[jtdDiscriminator](verida_web_helpers._internal_.SchemaCxt.md#jtddiscriminator) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:36 - -___ - -### jtdMetadata - -• `Optional` **jtdMetadata**: `boolean` - -#### Inherited from - -[SchemaCxt](verida_web_helpers._internal_.SchemaCxt.md).[jtdMetadata](verida_web_helpers._internal_.SchemaCxt.md#jtdmetadata) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:37 - -___ - -### opts - -• `Readonly` **opts**: [`InstanceOptions`](../modules/verida_web_helpers._internal_.md#instanceoptions) - -#### Inherited from - -[SchemaCxt](verida_web_helpers._internal_.SchemaCxt.md).[opts](verida_web_helpers._internal_.SchemaCxt.md#opts) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:39 - -___ - -### parentData - -• `Readonly` **parentData**: [`Name`](../classes/verida_web_helpers._internal_.Name.md) - -#### Inherited from - -[SchemaCxt](verida_web_helpers._internal_.SchemaCxt.md).[parentData](verida_web_helpers._internal_.SchemaCxt.md#parentdata) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:14 - -___ - -### parentDataProperty - -• `Readonly` **parentDataProperty**: `number` \| [`Code`](../modules/verida_web_helpers._internal_.md#code) - -#### Inherited from - -[SchemaCxt](verida_web_helpers._internal_.SchemaCxt.md).[parentDataProperty](verida_web_helpers._internal_.SchemaCxt.md#parentdataproperty) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:15 - -___ - -### propertyName - -• `Optional` `Readonly` **propertyName**: [`Name`](../classes/verida_web_helpers._internal_.Name.md) - -#### Inherited from - -[SchemaCxt](verida_web_helpers._internal_.SchemaCxt.md).[propertyName](verida_web_helpers._internal_.SchemaCxt.md#propertyname) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:32 - -___ - -### props - -• `Optional` **props**: [`Name`](../classes/verida_web_helpers._internal_.Name.md) \| [`EvaluatedProperties`](../modules/verida_web_helpers._internal_.md#evaluatedproperties) - -#### Inherited from - -[SchemaCxt](verida_web_helpers._internal_.SchemaCxt.md).[props](verida_web_helpers._internal_.SchemaCxt.md#props) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:34 - -___ - -### rootId - -• `Readonly` **rootId**: `string` - -#### Inherited from - -[SchemaCxt](verida_web_helpers._internal_.SchemaCxt.md).[rootId](verida_web_helpers._internal_.SchemaCxt.md#rootid) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:27 - -___ - -### schema - -• `Readonly` **schema**: [`AnySchemaObject`](../modules/verida_web_helpers._internal_.md#anyschemaobject) - -#### Overrides - -[SchemaCxt](verida_web_helpers._internal_.SchemaCxt.md).[schema](verida_web_helpers._internal_.SchemaCxt.md#schema) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:43 - -___ - -### schemaEnv - -• `Readonly` **schemaEnv**: [`SchemaEnv`](../classes/verida_web_helpers._internal_.SchemaEnv.md) - -#### Inherited from - -[SchemaCxt](verida_web_helpers._internal_.SchemaCxt.md).[schemaEnv](verida_web_helpers._internal_.SchemaCxt.md#schemaenv) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:26 - -___ - -### schemaPath - -• `Readonly` **schemaPath**: [`Code`](../modules/verida_web_helpers._internal_.md#code) - -#### Inherited from - -[SchemaCxt](verida_web_helpers._internal_.SchemaCxt.md).[schemaPath](verida_web_helpers._internal_.SchemaCxt.md#schemapath) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:29 - -___ - -### self - -• `Readonly` **self**: [`default`](../classes/verida_web_helpers._internal_.default-3.md) - -#### Inherited from - -[SchemaCxt](verida_web_helpers._internal_.SchemaCxt.md).[self](verida_web_helpers._internal_.SchemaCxt.md#self) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:40 - -___ - -### topSchemaRef - -• `Readonly` **topSchemaRef**: [`Code`](../modules/verida_web_helpers._internal_.md#code) - -#### Inherited from - -[SchemaCxt](verida_web_helpers._internal_.SchemaCxt.md).[topSchemaRef](verida_web_helpers._internal_.SchemaCxt.md#topschemaref) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:21 - -___ - -### validateName - -• `Readonly` **validateName**: [`Name`](../classes/verida_web_helpers._internal_.Name.md) - -#### Inherited from - -[SchemaCxt](verida_web_helpers._internal_.SchemaCxt.md).[validateName](verida_web_helpers._internal_.SchemaCxt.md#validatename) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:22 diff --git a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.SchemaObject.md b/docs/api/verida-js/interfaces/verida_web_helpers._internal_.SchemaObject.md deleted file mode 100644 index aed7e33..0000000 --- a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.SchemaObject.md +++ /dev/null @@ -1,76 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / SchemaObject - -# Interface: SchemaObject - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).SchemaObject - -## Hierarchy - -- [`_SchemaObject`](verida_web_helpers._internal_._SchemaObject.md) - - ↳ **`SchemaObject`** - -## Indexable - -▪ [x: `string`]: `any` - -## Table of contents - -### Properties - -- [$async](verida_web_helpers._internal_.SchemaObject.md#$async) -- [$id](verida_web_helpers._internal_.SchemaObject.md#$id) -- [$schema](verida_web_helpers._internal_.SchemaObject.md#$schema) -- [id](verida_web_helpers._internal_.SchemaObject.md#id) - -## Properties - -### $async - -• `Optional` **$async**: ``false`` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:17 - -___ - -### $id - -• `Optional` **$id**: `string` - -#### Overrides - -[_SchemaObject](verida_web_helpers._internal_._SchemaObject.md).[$id](verida_web_helpers._internal_._SchemaObject.md#$id) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:15 - -___ - -### $schema - -• `Optional` **$schema**: `string` - -#### Overrides - -[_SchemaObject](verida_web_helpers._internal_._SchemaObject.md).[$schema](verida_web_helpers._internal_._SchemaObject.md#$schema) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:16 - -___ - -### id - -• `Optional` **id**: `string` - -#### Overrides - -[_SchemaObject](verida_web_helpers._internal_._SchemaObject.md).[id](verida_web_helpers._internal_._SchemaObject.md#id) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:14 diff --git a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.SchemaValidateFunction.md b/docs/api/verida-js/interfaces/verida_web_helpers._internal_.SchemaValidateFunction.md deleted file mode 100644 index 899b4a0..0000000 --- a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.SchemaValidateFunction.md +++ /dev/null @@ -1,44 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / SchemaValidateFunction - -# Interface: SchemaValidateFunction - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).SchemaValidateFunction - -## Callable - -### SchemaValidateFunction - -▸ **SchemaValidateFunction**(`schema`, `data`, `parentSchema?`, `dataCxt?`): `boolean` \| `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schema` | `any` | -| `data` | `any` | -| `parentSchema?` | [`AnySchemaObject`](../modules/verida_web_helpers._internal_.md#anyschemaobject) | -| `dataCxt?` | [`DataValidationCxt`](verida_web_helpers._internal_.DataValidationCxt.md)<`string` \| `number`\> | - -#### Returns - -`boolean` \| `Promise`<`any`\> - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:112 - -## Table of contents - -### Properties - -- [errors](verida_web_helpers._internal_.SchemaValidateFunction.md#errors) - -## Properties - -### errors - -• `Optional` **errors**: [`Partial`](../modules/verida_web_helpers._internal_.md#partial)<[`ErrorObject`](verida_web_helpers._internal_.ErrorObject.md)<`string`, [`Record`](../modules/verida_web_helpers._internal_.md#record)<`string`, `any`\>, `unknown`\>\>[] - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:113 diff --git a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.ScopeOptions.md b/docs/api/verida-js/interfaces/verida_web_helpers._internal_.ScopeOptions.md deleted file mode 100644 index 7588eb0..0000000 --- a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.ScopeOptions.md +++ /dev/null @@ -1,38 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / ScopeOptions - -# Interface: ScopeOptions - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).ScopeOptions - -## Hierarchy - -- **`ScopeOptions`** - - ↳ [`ValueScopeOptions`](verida_web_helpers._internal_.ValueScopeOptions.md) - -## Table of contents - -### Properties - -- [parent](verida_web_helpers._internal_.ScopeOptions.md#parent) -- [prefixes](verida_web_helpers._internal_.ScopeOptions.md#prefixes) - -## Properties - -### parent - -• `Optional` **parent**: [`Scope`](../classes/verida_web_helpers._internal_.Scope.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/scope.d.ts:14 - -___ - -### prefixes - -• `Optional` **prefixes**: `Set`<`string`\> - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/scope.d.ts:13 diff --git a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.ScopePath.md b/docs/api/verida-js/interfaces/verida_web_helpers._internal_.ScopePath.md deleted file mode 100644 index 8f54113..0000000 --- a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.ScopePath.md +++ /dev/null @@ -1,32 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / ScopePath - -# Interface: ScopePath - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).ScopePath - -## Table of contents - -### Properties - -- [itemIndex](verida_web_helpers._internal_.ScopePath.md#itemindex) -- [property](verida_web_helpers._internal_.ScopePath.md#property) - -## Properties - -### itemIndex - -• **itemIndex**: `number` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/scope.d.ts:54 - -___ - -### property - -• **property**: `string` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/scope.d.ts:53 diff --git a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.SecureContextConfig.md b/docs/api/verida-js/interfaces/verida_web_helpers._internal_.SecureContextConfig.md deleted file mode 100644 index 2e12e98..0000000 --- a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.SecureContextConfig.md +++ /dev/null @@ -1,43 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / SecureContextConfig - -# Interface: SecureContextConfig - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).SecureContextConfig - -## Table of contents - -### Properties - -- [id](verida_web_helpers._internal_.SecureContextConfig.md#id) -- [publicKeys](verida_web_helpers._internal_.SecureContextConfig.md#publickeys) -- [services](verida_web_helpers._internal_.SecureContextConfig.md#services) - -## Properties - -### id - -• **id**: `string` - -#### Defined in - -packages/types/dist/StorageLinkInterfaces.d.ts:17 - -___ - -### publicKeys - -• **publicKeys**: [`SecureStorageContextPublicKeys`](verida_web_helpers._internal_.SecureStorageContextPublicKeys.md) - -#### Defined in - -packages/types/dist/StorageLinkInterfaces.d.ts:18 - -___ - -### services - -• **services**: [`SecureContextServices`](verida_web_helpers._internal_.SecureContextServices.md) - -#### Defined in - -packages/types/dist/StorageLinkInterfaces.d.ts:19 diff --git a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.SecureContextEndpoint.md b/docs/api/verida-js/interfaces/verida_web_helpers._internal_.SecureContextEndpoint.md deleted file mode 100644 index 3b30c8e..0000000 --- a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.SecureContextEndpoint.md +++ /dev/null @@ -1,43 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / SecureContextEndpoint - -# Interface: SecureContextEndpoint - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).SecureContextEndpoint - -## Table of contents - -### Properties - -- [config](verida_web_helpers._internal_.SecureContextEndpoint.md#config) -- [endpointUri](verida_web_helpers._internal_.SecureContextEndpoint.md#endpointuri) -- [type](verida_web_helpers._internal_.SecureContextEndpoint.md#type) - -## Properties - -### config - -• `Optional` **config**: `object` - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:5 - -___ - -### endpointUri - -• **endpointUri**: [`ServiceEndpoint`](../modules/verida_web_helpers._internal_.md#serviceendpoint)[] - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:4 - -___ - -### type - -• **type**: `string` - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:3 diff --git a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.SecureContextEndpoints.md b/docs/api/verida-js/interfaces/verida_web_helpers._internal_.SecureContextEndpoints.md deleted file mode 100644 index b54e671..0000000 --- a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.SecureContextEndpoints.md +++ /dev/null @@ -1,54 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / SecureContextEndpoints - -# Interface: SecureContextEndpoints - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).SecureContextEndpoints - -## Table of contents - -### Properties - -- [database](verida_web_helpers._internal_.SecureContextEndpoints.md#database) -- [messaging](verida_web_helpers._internal_.SecureContextEndpoints.md#messaging) -- [notification](verida_web_helpers._internal_.SecureContextEndpoints.md#notification) -- [storage](verida_web_helpers._internal_.SecureContextEndpoints.md#storage) - -## Properties - -### database - -• **database**: [`SecureContextEndpoint`](verida_web_helpers._internal_.SecureContextEndpoint.md) - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:8 - -___ - -### messaging - -• **messaging**: [`SecureContextEndpoint`](verida_web_helpers._internal_.SecureContextEndpoint.md) - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:9 - -___ - -### notification - -• `Optional` **notification**: [`SecureContextEndpoint`](verida_web_helpers._internal_.SecureContextEndpoint.md) - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:11 - -___ - -### storage - -• `Optional` **storage**: [`SecureContextEndpoint`](verida_web_helpers._internal_.SecureContextEndpoint.md) - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:10 diff --git a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.SecureContextPublicKey.md b/docs/api/verida-js/interfaces/verida_web_helpers._internal_.SecureContextPublicKey.md deleted file mode 100644 index 506ad77..0000000 --- a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.SecureContextPublicKey.md +++ /dev/null @@ -1,32 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / SecureContextPublicKey - -# Interface: SecureContextPublicKey - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).SecureContextPublicKey - -## Table of contents - -### Properties - -- [publicKeyHex](verida_web_helpers._internal_.SecureContextPublicKey.md#publickeyhex) -- [type](verida_web_helpers._internal_.SecureContextPublicKey.md#type) - -## Properties - -### publicKeyHex - -• **publicKeyHex**: `string` - -#### Defined in - -packages/types/dist/StorageLinkInterfaces.d.ts:4 - -___ - -### type - -• **type**: `string` - -#### Defined in - -packages/types/dist/StorageLinkInterfaces.d.ts:3 diff --git a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.SecureContextServices.md b/docs/api/verida-js/interfaces/verida_web_helpers._internal_.SecureContextServices.md deleted file mode 100644 index 0ff28e3..0000000 --- a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.SecureContextServices.md +++ /dev/null @@ -1,54 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / SecureContextServices - -# Interface: SecureContextServices - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).SecureContextServices - -## Table of contents - -### Properties - -- [databaseServer](verida_web_helpers._internal_.SecureContextServices.md#databaseserver) -- [messageServer](verida_web_helpers._internal_.SecureContextServices.md#messageserver) -- [notificationServer](verida_web_helpers._internal_.SecureContextServices.md#notificationserver) -- [storageServer](verida_web_helpers._internal_.SecureContextServices.md#storageserver) - -## Properties - -### databaseServer - -• **databaseServer**: [`SecureContextEndpoint`](verida_web_helpers._internal_.SecureContextEndpoint.md) - -#### Defined in - -packages/types/dist/StorageLinkInterfaces.d.ts:11 - -___ - -### messageServer - -• **messageServer**: [`SecureContextEndpoint`](verida_web_helpers._internal_.SecureContextEndpoint.md) - -#### Defined in - -packages/types/dist/StorageLinkInterfaces.d.ts:12 - -___ - -### notificationServer - -• `Optional` **notificationServer**: [`SecureContextEndpoint`](verida_web_helpers._internal_.SecureContextEndpoint.md) - -#### Defined in - -packages/types/dist/StorageLinkInterfaces.d.ts:14 - -___ - -### storageServer - -• `Optional` **storageServer**: [`SecureContextEndpoint`](verida_web_helpers._internal_.SecureContextEndpoint.md) - -#### Defined in - -packages/types/dist/StorageLinkInterfaces.d.ts:13 diff --git a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.SecureStorageContextPublicKeys.md b/docs/api/verida-js/interfaces/verida_web_helpers._internal_.SecureStorageContextPublicKeys.md deleted file mode 100644 index f4670ba..0000000 --- a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.SecureStorageContextPublicKeys.md +++ /dev/null @@ -1,32 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / SecureStorageContextPublicKeys - -# Interface: SecureStorageContextPublicKeys - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).SecureStorageContextPublicKeys - -## Table of contents - -### Properties - -- [asymKey](verida_web_helpers._internal_.SecureStorageContextPublicKeys.md#asymkey) -- [signKey](verida_web_helpers._internal_.SecureStorageContextPublicKeys.md#signkey) - -## Properties - -### asymKey - -• **asymKey**: [`SecureContextPublicKey`](verida_web_helpers._internal_.SecureContextPublicKey.md) - -#### Defined in - -packages/types/dist/StorageLinkInterfaces.d.ts:7 - -___ - -### signKey - -• **signKey**: [`SecureContextPublicKey`](verida_web_helpers._internal_.SecureContextPublicKey.md) - -#### Defined in - -packages/types/dist/StorageLinkInterfaces.d.ts:8 diff --git a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.Service.md b/docs/api/verida-js/interfaces/verida_web_helpers._internal_.Service.md deleted file mode 100644 index 9397431..0000000 --- a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.Service.md +++ /dev/null @@ -1,53 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / Service - -# Interface: Service - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).Service - -Represents a Service entry in a [DID document](https://www.w3.org/TR/did-core/#did-document-properties). - -**`see`** [https://www.w3.org/TR/did-core/#services](https://www.w3.org/TR/did-core/#services) - -**`see`** [https://www.w3.org/TR/did-core/#service-properties](https://www.w3.org/TR/did-core/#service-properties) - -## Indexable - -▪ [x: `string`]: `any` - -## Table of contents - -### Properties - -- [id](verida_web_helpers._internal_.Service.md#id) -- [serviceEndpoint](verida_web_helpers._internal_.Service.md#serviceendpoint) -- [type](verida_web_helpers._internal_.Service.md#type) - -## Properties - -### id - -• **id**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:81 - -___ - -### serviceEndpoint - -• **serviceEndpoint**: [`ServiceEndpoint`](../modules/verida_web_helpers._internal_.md#serviceendpoint) \| [`ServiceEndpoint`](../modules/verida_web_helpers._internal_.md#serviceendpoint)[] - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:83 - -___ - -### type - -• **type**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:82 diff --git a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.SourceCode.md b/docs/api/verida-js/interfaces/verida_web_helpers._internal_.SourceCode.md deleted file mode 100644 index 5681166..0000000 --- a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.SourceCode.md +++ /dev/null @@ -1,54 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / SourceCode - -# Interface: SourceCode - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).SourceCode - -## Table of contents - -### Properties - -- [evaluated](verida_web_helpers._internal_.SourceCode.md#evaluated) -- [scopeValues](verida_web_helpers._internal_.SourceCode.md#scopevalues) -- [validateCode](verida_web_helpers._internal_.SourceCode.md#validatecode) -- [validateName](verida_web_helpers._internal_.SourceCode.md#validatename) - -## Properties - -### evaluated - -• `Optional` **evaluated**: [`Code`](../modules/verida_web_helpers._internal_.md#code) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:33 - -___ - -### scopeValues - -• **scopeValues**: [`ScopeValueSets`](../modules/verida_web_helpers._internal_.md#scopevaluesets) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:32 - -___ - -### validateCode - -• **validateCode**: `string` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:31 - -___ - -### validateName - -• **validateName**: [`ValueScopeName`](../classes/verida_web_helpers._internal_.ValueScopeName.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:30 diff --git a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.StaticEventEmitterOptions.md b/docs/api/verida-js/interfaces/verida_web_helpers._internal_.StaticEventEmitterOptions.md deleted file mode 100644 index 7968a6b..0000000 --- a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.StaticEventEmitterOptions.md +++ /dev/null @@ -1,21 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / StaticEventEmitterOptions - -# Interface: StaticEventEmitterOptions - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).StaticEventEmitterOptions - -## Table of contents - -### Properties - -- [signal](verida_web_helpers._internal_.StaticEventEmitterOptions.md#signal) - -## Properties - -### signal - -• `Optional` **signal**: `AbortSignal` - -#### Defined in - -node_modules/@types/node/events.d.ts:57 diff --git a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.StringKeywords.md b/docs/api/verida-js/interfaces/verida_web_helpers._internal_.StringKeywords.md deleted file mode 100644 index b3116c7..0000000 --- a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.StringKeywords.md +++ /dev/null @@ -1,54 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / StringKeywords - -# Interface: StringKeywords - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).StringKeywords - -## Table of contents - -### Properties - -- [format](verida_web_helpers._internal_.StringKeywords.md#format) -- [maxLength](verida_web_helpers._internal_.StringKeywords.md#maxlength) -- [minLength](verida_web_helpers._internal_.StringKeywords.md#minlength) -- [pattern](verida_web_helpers._internal_.StringKeywords.md#pattern) - -## Properties - -### format - -• `Optional` **format**: `string` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/json-schema.d.ts:19 - -___ - -### maxLength - -• `Optional` **maxLength**: `number` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/json-schema.d.ts:17 - -___ - -### minLength - -• `Optional` **minLength**: `number` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/json-schema.d.ts:16 - -___ - -### pattern - -• `Optional` **pattern**: `string` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/json-schema.d.ts:18 diff --git a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.Transaction.md b/docs/api/verida-js/interfaces/verida_web_helpers._internal_.Transaction.md deleted file mode 100644 index 8887009..0000000 --- a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.Transaction.md +++ /dev/null @@ -1,192 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / Transaction - -# Interface: Transaction - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).Transaction - -## Hierarchy - -- **`Transaction`** - - ↳ [`TransactionResponse`](verida_web_helpers._internal_.TransactionResponse.md) - -## Table of contents - -### Properties - -- [accessList](verida_web_helpers._internal_.Transaction.md#accesslist) -- [chainId](verida_web_helpers._internal_.Transaction.md#chainid) -- [data](verida_web_helpers._internal_.Transaction.md#data) -- [from](verida_web_helpers._internal_.Transaction.md#from) -- [gasLimit](verida_web_helpers._internal_.Transaction.md#gaslimit) -- [gasPrice](verida_web_helpers._internal_.Transaction.md#gasprice) -- [hash](verida_web_helpers._internal_.Transaction.md#hash) -- [maxFeePerGas](verida_web_helpers._internal_.Transaction.md#maxfeepergas) -- [maxPriorityFeePerGas](verida_web_helpers._internal_.Transaction.md#maxpriorityfeepergas) -- [nonce](verida_web_helpers._internal_.Transaction.md#nonce) -- [r](verida_web_helpers._internal_.Transaction.md#r) -- [s](verida_web_helpers._internal_.Transaction.md#s) -- [to](verida_web_helpers._internal_.Transaction.md#to) -- [type](verida_web_helpers._internal_.Transaction.md#type) -- [v](verida_web_helpers._internal_.Transaction.md#v) -- [value](verida_web_helpers._internal_.Transaction.md#value) - -## Properties - -### accessList - -• `Optional` **accessList**: [`AccessList`](../modules/verida_web_helpers._internal_.md#accesslist) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:40 - -___ - -### chainId - -• **chainId**: `number` - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:35 - -___ - -### data - -• **data**: `string` - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:33 - -___ - -### from - -• `Optional` **from**: `string` - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:29 - -___ - -### gasLimit - -• **gasLimit**: [`BigNumber`](../classes/verida_web_helpers._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:31 - -___ - -### gasPrice - -• `Optional` **gasPrice**: [`BigNumber`](../classes/verida_web_helpers._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:32 - -___ - -### hash - -• `Optional` **hash**: `string` - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:27 - -___ - -### maxFeePerGas - -• `Optional` **maxFeePerGas**: [`BigNumber`](../classes/verida_web_helpers._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:42 - -___ - -### maxPriorityFeePerGas - -• `Optional` **maxPriorityFeePerGas**: [`BigNumber`](../classes/verida_web_helpers._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:41 - -___ - -### nonce - -• **nonce**: `number` - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:30 - -___ - -### r - -• `Optional` **r**: `string` - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:36 - -___ - -### s - -• `Optional` **s**: `string` - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:37 - -___ - -### to - -• `Optional` **to**: `string` - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:28 - -___ - -### type - -• `Optional` **type**: ``null`` \| `number` - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:39 - -___ - -### v - -• `Optional` **v**: `number` - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:38 - -___ - -### value - -• **value**: [`BigNumber`](../classes/verida_web_helpers._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:34 diff --git a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.TransactionReceipt.md b/docs/api/verida-js/interfaces/verida_web_helpers._internal_.TransactionReceipt.md deleted file mode 100644 index cdacd7c..0000000 --- a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.TransactionReceipt.md +++ /dev/null @@ -1,197 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / TransactionReceipt - -# Interface: TransactionReceipt - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).TransactionReceipt - -## Table of contents - -### Properties - -- [blockHash](verida_web_helpers._internal_.TransactionReceipt.md#blockhash) -- [blockNumber](verida_web_helpers._internal_.TransactionReceipt.md#blocknumber) -- [byzantium](verida_web_helpers._internal_.TransactionReceipt.md#byzantium) -- [confirmations](verida_web_helpers._internal_.TransactionReceipt.md#confirmations) -- [contractAddress](verida_web_helpers._internal_.TransactionReceipt.md#contractaddress) -- [cumulativeGasUsed](verida_web_helpers._internal_.TransactionReceipt.md#cumulativegasused) -- [effectiveGasPrice](verida_web_helpers._internal_.TransactionReceipt.md#effectivegasprice) -- [from](verida_web_helpers._internal_.TransactionReceipt.md#from) -- [gasUsed](verida_web_helpers._internal_.TransactionReceipt.md#gasused) -- [logs](verida_web_helpers._internal_.TransactionReceipt.md#logs) -- [logsBloom](verida_web_helpers._internal_.TransactionReceipt.md#logsbloom) -- [root](verida_web_helpers._internal_.TransactionReceipt.md#root) -- [status](verida_web_helpers._internal_.TransactionReceipt.md#status) -- [to](verida_web_helpers._internal_.TransactionReceipt.md#to) -- [transactionHash](verida_web_helpers._internal_.TransactionReceipt.md#transactionhash) -- [transactionIndex](verida_web_helpers._internal_.TransactionReceipt.md#transactionindex) -- [type](verida_web_helpers._internal_.TransactionReceipt.md#type) - -## Properties - -### blockHash - -• **blockHash**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:73 - -___ - -### blockNumber - -• **blockNumber**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:76 - -___ - -### byzantium - -• **byzantium**: `boolean` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:80 - -___ - -### confirmations - -• **confirmations**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:77 - -___ - -### contractAddress - -• **contractAddress**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:68 - -___ - -### cumulativeGasUsed - -• **cumulativeGasUsed**: [`BigNumber`](../classes/verida_web_helpers._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:78 - -___ - -### effectiveGasPrice - -• **effectiveGasPrice**: [`BigNumber`](../classes/verida_web_helpers._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:79 - -___ - -### from - -• **from**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:67 - -___ - -### gasUsed - -• **gasUsed**: [`BigNumber`](../classes/verida_web_helpers._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:71 - -___ - -### logs - -• **logs**: [`Log`](verida_web_helpers._internal_.Log.md)[] - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:75 - -___ - -### logsBloom - -• **logsBloom**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:72 - -___ - -### root - -• `Optional` **root**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:70 - -___ - -### status - -• `Optional` **status**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:82 - -___ - -### to - -• **to**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:66 - -___ - -### transactionHash - -• **transactionHash**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:74 - -___ - -### transactionIndex - -• **transactionIndex**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:69 - -___ - -### type - -• **type**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:81 diff --git a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.TransactionResponse.md b/docs/api/verida-js/interfaces/verida_web_helpers._internal_.TransactionResponse.md deleted file mode 100644 index 110420a..0000000 --- a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.TransactionResponse.md +++ /dev/null @@ -1,335 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / TransactionResponse - -# Interface: TransactionResponse - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).TransactionResponse - -## Hierarchy - -- [`Transaction`](verida_web_helpers._internal_.Transaction.md) - - ↳ **`TransactionResponse`** - -## Table of contents - -### Properties - -- [accessList](verida_web_helpers._internal_.TransactionResponse.md#accesslist) -- [blockHash](verida_web_helpers._internal_.TransactionResponse.md#blockhash) -- [blockNumber](verida_web_helpers._internal_.TransactionResponse.md#blocknumber) -- [chainId](verida_web_helpers._internal_.TransactionResponse.md#chainid) -- [confirmations](verida_web_helpers._internal_.TransactionResponse.md#confirmations) -- [data](verida_web_helpers._internal_.TransactionResponse.md#data) -- [from](verida_web_helpers._internal_.TransactionResponse.md#from) -- [gasLimit](verida_web_helpers._internal_.TransactionResponse.md#gaslimit) -- [gasPrice](verida_web_helpers._internal_.TransactionResponse.md#gasprice) -- [hash](verida_web_helpers._internal_.TransactionResponse.md#hash) -- [maxFeePerGas](verida_web_helpers._internal_.TransactionResponse.md#maxfeepergas) -- [maxPriorityFeePerGas](verida_web_helpers._internal_.TransactionResponse.md#maxpriorityfeepergas) -- [nonce](verida_web_helpers._internal_.TransactionResponse.md#nonce) -- [r](verida_web_helpers._internal_.TransactionResponse.md#r) -- [raw](verida_web_helpers._internal_.TransactionResponse.md#raw) -- [s](verida_web_helpers._internal_.TransactionResponse.md#s) -- [timestamp](verida_web_helpers._internal_.TransactionResponse.md#timestamp) -- [to](verida_web_helpers._internal_.TransactionResponse.md#to) -- [type](verida_web_helpers._internal_.TransactionResponse.md#type) -- [v](verida_web_helpers._internal_.TransactionResponse.md#v) -- [value](verida_web_helpers._internal_.TransactionResponse.md#value) - -### Methods - -- [wait](verida_web_helpers._internal_.TransactionResponse.md#wait) - -## Properties - -### accessList - -• `Optional` **accessList**: [`AccessList`](../modules/verida_web_helpers._internal_.md#accesslist) - -#### Inherited from - -[Transaction](verida_web_helpers._internal_.Transaction.md).[accessList](verida_web_helpers._internal_.Transaction.md#accesslist) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:40 - -___ - -### blockHash - -• `Optional` **blockHash**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:26 - -___ - -### blockNumber - -• `Optional` **blockNumber**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:25 - -___ - -### chainId - -• **chainId**: `number` - -#### Inherited from - -[Transaction](verida_web_helpers._internal_.Transaction.md).[chainId](verida_web_helpers._internal_.Transaction.md#chainid) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:35 - -___ - -### confirmations - -• **confirmations**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:28 - -___ - -### data - -• **data**: `string` - -#### Inherited from - -[Transaction](verida_web_helpers._internal_.Transaction.md).[data](verida_web_helpers._internal_.Transaction.md#data) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:33 - -___ - -### from - -• **from**: `string` - -#### Overrides - -[Transaction](verida_web_helpers._internal_.Transaction.md).[from](verida_web_helpers._internal_.Transaction.md#from) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:29 - -___ - -### gasLimit - -• **gasLimit**: [`BigNumber`](../classes/verida_web_helpers._internal_.BigNumber.md) - -#### Inherited from - -[Transaction](verida_web_helpers._internal_.Transaction.md).[gasLimit](verida_web_helpers._internal_.Transaction.md#gaslimit) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:31 - -___ - -### gasPrice - -• `Optional` **gasPrice**: [`BigNumber`](../classes/verida_web_helpers._internal_.BigNumber.md) - -#### Inherited from - -[Transaction](verida_web_helpers._internal_.Transaction.md).[gasPrice](verida_web_helpers._internal_.Transaction.md#gasprice) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:32 - -___ - -### hash - -• **hash**: `string` - -#### Overrides - -[Transaction](verida_web_helpers._internal_.Transaction.md).[hash](verida_web_helpers._internal_.Transaction.md#hash) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:24 - -___ - -### maxFeePerGas - -• `Optional` **maxFeePerGas**: [`BigNumber`](../classes/verida_web_helpers._internal_.BigNumber.md) - -#### Inherited from - -[Transaction](verida_web_helpers._internal_.Transaction.md).[maxFeePerGas](verida_web_helpers._internal_.Transaction.md#maxfeepergas) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:42 - -___ - -### maxPriorityFeePerGas - -• `Optional` **maxPriorityFeePerGas**: [`BigNumber`](../classes/verida_web_helpers._internal_.BigNumber.md) - -#### Inherited from - -[Transaction](verida_web_helpers._internal_.Transaction.md).[maxPriorityFeePerGas](verida_web_helpers._internal_.Transaction.md#maxpriorityfeepergas) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:41 - -___ - -### nonce - -• **nonce**: `number` - -#### Inherited from - -[Transaction](verida_web_helpers._internal_.Transaction.md).[nonce](verida_web_helpers._internal_.Transaction.md#nonce) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:30 - -___ - -### r - -• `Optional` **r**: `string` - -#### Inherited from - -[Transaction](verida_web_helpers._internal_.Transaction.md).[r](verida_web_helpers._internal_.Transaction.md#r) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:36 - -___ - -### raw - -• `Optional` **raw**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:30 - -___ - -### s - -• `Optional` **s**: `string` - -#### Inherited from - -[Transaction](verida_web_helpers._internal_.Transaction.md).[s](verida_web_helpers._internal_.Transaction.md#s) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:37 - -___ - -### timestamp - -• `Optional` **timestamp**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:27 - -___ - -### to - -• `Optional` **to**: `string` - -#### Inherited from - -[Transaction](verida_web_helpers._internal_.Transaction.md).[to](verida_web_helpers._internal_.Transaction.md#to) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:28 - -___ - -### type - -• `Optional` **type**: ``null`` \| `number` - -#### Inherited from - -[Transaction](verida_web_helpers._internal_.Transaction.md).[type](verida_web_helpers._internal_.Transaction.md#type) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:39 - -___ - -### v - -• `Optional` **v**: `number` - -#### Inherited from - -[Transaction](verida_web_helpers._internal_.Transaction.md).[v](verida_web_helpers._internal_.Transaction.md#v) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:38 - -___ - -### value - -• **value**: [`BigNumber`](../classes/verida_web_helpers._internal_.BigNumber.md) - -#### Inherited from - -[Transaction](verida_web_helpers._internal_.Transaction.md).[value](verida_web_helpers._internal_.Transaction.md#value) - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:34 - -## Methods - -### wait - -▸ **wait**(`confirmations?`): `Promise`<[`TransactionReceipt`](verida_web_helpers._internal_.TransactionReceipt.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `confirmations?` | `number` | - -#### Returns - -`Promise`<[`TransactionReceipt`](verida_web_helpers._internal_.TransactionReceipt.md)\> - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:31 diff --git a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.URIComponents.md b/docs/api/verida-js/interfaces/verida_web_helpers._internal_.URIComponents.md deleted file mode 100644 index bfd7bc4..0000000 --- a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.URIComponents.md +++ /dev/null @@ -1,109 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / URIComponents - -# Interface: URIComponents - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).URIComponents - -## Table of contents - -### Properties - -- [error](verida_web_helpers._internal_.URIComponents.md#error) -- [fragment](verida_web_helpers._internal_.URIComponents.md#fragment) -- [host](verida_web_helpers._internal_.URIComponents.md#host) -- [path](verida_web_helpers._internal_.URIComponents.md#path) -- [port](verida_web_helpers._internal_.URIComponents.md#port) -- [query](verida_web_helpers._internal_.URIComponents.md#query) -- [reference](verida_web_helpers._internal_.URIComponents.md#reference) -- [scheme](verida_web_helpers._internal_.URIComponents.md#scheme) -- [userinfo](verida_web_helpers._internal_.URIComponents.md#userinfo) - -## Properties - -### error - -• `Optional` **error**: `string` - -#### Defined in - -node_modules/uri-js/dist/es5/uri.all.d.ts:10 - -___ - -### fragment - -• `Optional` **fragment**: `string` - -#### Defined in - -node_modules/uri-js/dist/es5/uri.all.d.ts:8 - -___ - -### host - -• `Optional` **host**: `string` - -#### Defined in - -node_modules/uri-js/dist/es5/uri.all.d.ts:4 - -___ - -### path - -• `Optional` **path**: `string` - -#### Defined in - -node_modules/uri-js/dist/es5/uri.all.d.ts:6 - -___ - -### port - -• `Optional` **port**: `string` \| `number` - -#### Defined in - -node_modules/uri-js/dist/es5/uri.all.d.ts:5 - -___ - -### query - -• `Optional` **query**: `string` - -#### Defined in - -node_modules/uri-js/dist/es5/uri.all.d.ts:7 - -___ - -### reference - -• `Optional` **reference**: `string` - -#### Defined in - -node_modules/uri-js/dist/es5/uri.all.d.ts:9 - -___ - -### scheme - -• `Optional` **scheme**: `string` - -#### Defined in - -node_modules/uri-js/dist/es5/uri.all.d.ts:2 - -___ - -### userinfo - -• `Optional` **userinfo**: `string` - -#### Defined in - -node_modules/uri-js/dist/es5/uri.all.d.ts:3 diff --git a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.UriResolver.md b/docs/api/verida-js/interfaces/verida_web_helpers._internal_.UriResolver.md deleted file mode 100644 index 8a9700c..0000000 --- a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.UriResolver.md +++ /dev/null @@ -1,74 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / UriResolver - -# Interface: UriResolver - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).UriResolver - -## Table of contents - -### Methods - -- [parse](verida_web_helpers._internal_.UriResolver.md#parse) -- [resolve](verida_web_helpers._internal_.UriResolver.md#resolve) -- [serialize](verida_web_helpers._internal_.UriResolver.md#serialize) - -## Methods - -### parse - -▸ **parse**(`uri`): [`URIComponents`](verida_web_helpers._internal_.URIComponents.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `uri` | `string` | - -#### Returns - -[`URIComponents`](verida_web_helpers._internal_.URIComponents.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:179 - -___ - -### resolve - -▸ **resolve**(`base`, `path`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `base` | `string` | -| `path` | `string` | - -#### Returns - -`string` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:180 - -___ - -### serialize - -▸ **serialize**(`component`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `component` | [`URIComponents`](verida_web_helpers._internal_.URIComponents.md) | - -#### Returns - -`string` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:181 diff --git a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.VSOptions.md b/docs/api/verida-js/interfaces/verida_web_helpers._internal_.VSOptions.md deleted file mode 100644 index 60f0825..0000000 --- a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.VSOptions.md +++ /dev/null @@ -1,102 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / VSOptions - -# Interface: VSOptions - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).VSOptions - -## Hierarchy - -- [`ValueScopeOptions`](verida_web_helpers._internal_.ValueScopeOptions.md) - - ↳ **`VSOptions`** - -## Table of contents - -### Properties - -- [\_n](verida_web_helpers._internal_.VSOptions.md#_n) -- [es5](verida_web_helpers._internal_.VSOptions.md#es5) -- [lines](verida_web_helpers._internal_.VSOptions.md#lines) -- [parent](verida_web_helpers._internal_.VSOptions.md#parent) -- [prefixes](verida_web_helpers._internal_.VSOptions.md#prefixes) -- [scope](verida_web_helpers._internal_.VSOptions.md#scope) - -## Properties - -### \_n - -• **\_n**: [`Code`](../modules/verida_web_helpers._internal_.md#code) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/scope.d.ts:64 - -___ - -### es5 - -• `Optional` **es5**: `boolean` - -#### Inherited from - -[ValueScopeOptions](verida_web_helpers._internal_.ValueScopeOptions.md).[es5](verida_web_helpers._internal_.ValueScopeOptions.md#es5) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/scope.d.ts:18 - -___ - -### lines - -• `Optional` **lines**: `boolean` - -#### Inherited from - -[ValueScopeOptions](verida_web_helpers._internal_.ValueScopeOptions.md).[lines](verida_web_helpers._internal_.ValueScopeOptions.md#lines) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/scope.d.ts:19 - -___ - -### parent - -• `Optional` **parent**: [`Scope`](../classes/verida_web_helpers._internal_.Scope.md) - -#### Inherited from - -[ValueScopeOptions](verida_web_helpers._internal_.ValueScopeOptions.md).[parent](verida_web_helpers._internal_.ValueScopeOptions.md#parent) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/scope.d.ts:14 - -___ - -### prefixes - -• `Optional` **prefixes**: `Set`<`string`\> - -#### Inherited from - -[ValueScopeOptions](verida_web_helpers._internal_.ValueScopeOptions.md).[prefixes](verida_web_helpers._internal_.ValueScopeOptions.md#prefixes) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/scope.d.ts:13 - -___ - -### scope - -• **scope**: [`ScopeStore`](../modules/verida_web_helpers._internal_.md#scopestore) - -#### Inherited from - -[ValueScopeOptions](verida_web_helpers._internal_.ValueScopeOptions.md).[scope](verida_web_helpers._internal_.ValueScopeOptions.md#scope) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/scope.d.ts:17 diff --git a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.ValidateFunction.md b/docs/api/verida-js/interfaces/verida_web_helpers._internal_.ValidateFunction.md deleted file mode 100644 index 87b562a..0000000 --- a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.ValidateFunction.md +++ /dev/null @@ -1,98 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / ValidateFunction - -# Interface: ValidateFunction - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).ValidateFunction - -## Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `unknown` | - -## Hierarchy - -- **`ValidateFunction`** - - ↳ [`AsyncValidateFunction`](verida_web_helpers._internal_.AsyncValidateFunction.md) - -## Callable - -### ValidateFunction - -▸ **ValidateFunction**(`data`, `dataCxt?`): data is T - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `any` | -| `dataCxt?` | [`DataValidationCxt`](verida_web_helpers._internal_.DataValidationCxt.md)<`string` \| `number`\> | - -#### Returns - -data is T - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:47 - -## Table of contents - -### Properties - -- [errors](verida_web_helpers._internal_.ValidateFunction.md#errors) -- [evaluated](verida_web_helpers._internal_.ValidateFunction.md#evaluated) -- [schema](verida_web_helpers._internal_.ValidateFunction.md#schema) -- [schemaEnv](verida_web_helpers._internal_.ValidateFunction.md#schemaenv) -- [source](verida_web_helpers._internal_.ValidateFunction.md#source) - -## Properties - -### errors - -• `Optional` **errors**: ``null`` \| [`ErrorObject`](verida_web_helpers._internal_.ErrorObject.md)<`string`, [`Record`](../modules/verida_web_helpers._internal_.md#record)<`string`, `any`\>, `unknown`\>[] - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:48 - -___ - -### evaluated - -• `Optional` **evaluated**: [`Evaluated`](verida_web_helpers._internal_.Evaluated.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:49 - -___ - -### schema - -• **schema**: [`AnySchema`](../modules/verida_web_helpers._internal_.md#anyschema) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:50 - -___ - -### schemaEnv - -• **schemaEnv**: [`SchemaEnv`](../classes/verida_web_helpers._internal_.SchemaEnv.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:51 - -___ - -### source - -• `Optional` **source**: [`SourceCode`](verida_web_helpers._internal_.SourceCode.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:52 diff --git a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.ValidationRules.md b/docs/api/verida-js/interfaces/verida_web_helpers._internal_.ValidationRules.md deleted file mode 100644 index 42e53cf..0000000 --- a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.ValidationRules.md +++ /dev/null @@ -1,65 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / ValidationRules - -# Interface: ValidationRules - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).ValidationRules - -## Table of contents - -### Properties - -- [all](verida_web_helpers._internal_.ValidationRules.md#all) -- [keywords](verida_web_helpers._internal_.ValidationRules.md#keywords) -- [post](verida_web_helpers._internal_.ValidationRules.md#post) -- [rules](verida_web_helpers._internal_.ValidationRules.md#rules) -- [types](verida_web_helpers._internal_.ValidationRules.md#types) - -## Properties - -### all - -• **all**: `Object` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/rules.d.ts:11 - -___ - -### keywords - -• **keywords**: `Object` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/rules.d.ts:14 - -___ - -### post - -• **post**: [`RuleGroup`](verida_web_helpers._internal_.RuleGroup.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/rules.d.ts:10 - -___ - -### rules - -• **rules**: [`RuleGroup`](verida_web_helpers._internal_.RuleGroup.md)[] - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/rules.d.ts:9 - -___ - -### types - -• **types**: [`ValidationTypes`](../modules/verida_web_helpers._internal_.md#validationtypes) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/rules.d.ts:17 diff --git a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.ValueScopeOptions.md b/docs/api/verida-js/interfaces/verida_web_helpers._internal_.ValueScopeOptions.md deleted file mode 100644 index d26991a..0000000 --- a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.ValueScopeOptions.md +++ /dev/null @@ -1,81 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / ValueScopeOptions - -# Interface: ValueScopeOptions - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).ValueScopeOptions - -## Hierarchy - -- [`ScopeOptions`](verida_web_helpers._internal_.ScopeOptions.md) - - ↳ **`ValueScopeOptions`** - - ↳↳ [`VSOptions`](verida_web_helpers._internal_.VSOptions.md) - -## Table of contents - -### Properties - -- [es5](verida_web_helpers._internal_.ValueScopeOptions.md#es5) -- [lines](verida_web_helpers._internal_.ValueScopeOptions.md#lines) -- [parent](verida_web_helpers._internal_.ValueScopeOptions.md#parent) -- [prefixes](verida_web_helpers._internal_.ValueScopeOptions.md#prefixes) -- [scope](verida_web_helpers._internal_.ValueScopeOptions.md#scope) - -## Properties - -### es5 - -• `Optional` **es5**: `boolean` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/scope.d.ts:18 - -___ - -### lines - -• `Optional` **lines**: `boolean` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/scope.d.ts:19 - -___ - -### parent - -• `Optional` **parent**: [`Scope`](../classes/verida_web_helpers._internal_.Scope.md) - -#### Inherited from - -[ScopeOptions](verida_web_helpers._internal_.ScopeOptions.md).[parent](verida_web_helpers._internal_.ScopeOptions.md#parent) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/scope.d.ts:14 - -___ - -### prefixes - -• `Optional` **prefixes**: `Set`<`string`\> - -#### Inherited from - -[ScopeOptions](verida_web_helpers._internal_.ScopeOptions.md).[prefixes](verida_web_helpers._internal_.ScopeOptions.md#prefixes) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/scope.d.ts:13 - -___ - -### scope - -• **scope**: [`ScopeStore`](../modules/verida_web_helpers._internal_.md#scopestore) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/scope.d.ts:17 diff --git a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.VdaDidEndpointResponse.md b/docs/api/verida-js/interfaces/verida_web_helpers._internal_.VdaDidEndpointResponse.md deleted file mode 100644 index 3100a1b..0000000 --- a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.VdaDidEndpointResponse.md +++ /dev/null @@ -1,32 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / VdaDidEndpointResponse - -# Interface: VdaDidEndpointResponse - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).VdaDidEndpointResponse - -## Table of contents - -### Properties - -- [message](verida_web_helpers._internal_.VdaDidEndpointResponse.md#message) -- [status](verida_web_helpers._internal_.VdaDidEndpointResponse.md#status) - -## Properties - -### message - -• `Optional` **message**: `string` - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:111 - -___ - -### status - -• **status**: ``"success"`` \| ``"fail"`` - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:110 diff --git a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.VeridaDatabaseAuthContext.md b/docs/api/verida-js/interfaces/verida_web_helpers._internal_.VeridaDatabaseAuthContext.md deleted file mode 100644 index 9b206b6..0000000 --- a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.VeridaDatabaseAuthContext.md +++ /dev/null @@ -1,75 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / VeridaDatabaseAuthContext - -# Interface: VeridaDatabaseAuthContext - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).VeridaDatabaseAuthContext - -## Hierarchy - -- [`AuthContext`](verida_web_helpers._internal_.AuthContext.md) - - ↳ **`VeridaDatabaseAuthContext`** - -## Table of contents - -### Properties - -- [accessToken](verida_web_helpers._internal_.VeridaDatabaseAuthContext.md#accesstoken) -- [endpointUri](verida_web_helpers._internal_.VeridaDatabaseAuthContext.md#endpointuri) -- [host](verida_web_helpers._internal_.VeridaDatabaseAuthContext.md#host) -- [publicSigningKey](verida_web_helpers._internal_.VeridaDatabaseAuthContext.md#publicsigningkey) -- [refreshToken](verida_web_helpers._internal_.VeridaDatabaseAuthContext.md#refreshtoken) - -## Properties - -### accessToken - -• `Optional` **accessToken**: `string` - -#### Defined in - -packages/types/dist/AccountInterfaces.d.ts:20 - -___ - -### endpointUri - -• **endpointUri**: [`ServiceEndpoint`](../modules/verida_web_helpers._internal_.md#serviceendpoint) - -#### Defined in - -packages/types/dist/AccountInterfaces.d.ts:21 - -___ - -### host - -• **host**: `string` - -#### Defined in - -packages/types/dist/AccountInterfaces.d.ts:22 - -___ - -### publicSigningKey - -• **publicSigningKey**: [`SecureContextPublicKey`](verida_web_helpers._internal_.SecureContextPublicKey.md) - -#### Inherited from - -[AuthContext](verida_web_helpers._internal_.AuthContext.md).[publicSigningKey](verida_web_helpers._internal_.AuthContext.md#publicsigningkey) - -#### Defined in - -packages/types/dist/AccountInterfaces.d.ts:13 - -___ - -### refreshToken - -• `Optional` **refreshToken**: `string` - -#### Defined in - -packages/types/dist/AccountInterfaces.d.ts:19 diff --git a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.VeridaDocInterface.md b/docs/api/verida-js/interfaces/verida_web_helpers._internal_.VeridaDocInterface.md deleted file mode 100644 index 6d92fd5..0000000 --- a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.VeridaDocInterface.md +++ /dev/null @@ -1,233 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / VeridaDocInterface - -# Interface: VeridaDocInterface - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).VeridaDocInterface - -## Hierarchy - -- [`DIDDocument`](../modules/verida_web_helpers._internal_.md#diddocument) - - ↳ **`VeridaDocInterface`** - -## Table of contents - -### Properties - -- [@context](verida_web_helpers._internal_.VeridaDocInterface.md#@context) -- [alsoKnownAs](verida_web_helpers._internal_.VeridaDocInterface.md#alsoknownas) -- [assertionMethod](verida_web_helpers._internal_.VeridaDocInterface.md#assertionmethod) -- [authentication](verida_web_helpers._internal_.VeridaDocInterface.md#authentication) -- [capabilityDelegation](verida_web_helpers._internal_.VeridaDocInterface.md#capabilitydelegation) -- [capabilityInvocation](verida_web_helpers._internal_.VeridaDocInterface.md#capabilityinvocation) -- [controller](verida_web_helpers._internal_.VeridaDocInterface.md#controller) -- [created](verida_web_helpers._internal_.VeridaDocInterface.md#created) -- [deactivated](verida_web_helpers._internal_.VeridaDocInterface.md#deactivated) -- [id](verida_web_helpers._internal_.VeridaDocInterface.md#id) -- [keyAgreement](verida_web_helpers._internal_.VeridaDocInterface.md#keyagreement) -- [proof](verida_web_helpers._internal_.VeridaDocInterface.md#proof) -- [publicKey](verida_web_helpers._internal_.VeridaDocInterface.md#publickey) -- [service](verida_web_helpers._internal_.VeridaDocInterface.md#service) -- [updated](verida_web_helpers._internal_.VeridaDocInterface.md#updated) -- [verificationMethod](verida_web_helpers._internal_.VeridaDocInterface.md#verificationmethod) -- [versionId](verida_web_helpers._internal_.VeridaDocInterface.md#versionid) - -## Properties - -### @context - -• `Optional` **@context**: `string` \| `string`[] - -#### Inherited from - -DocInterface.@context - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:61 - -___ - -### alsoKnownAs - -• `Optional` **alsoKnownAs**: `string`[] - -#### Inherited from - -DocInterface.alsoKnownAs - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:63 - -___ - -### assertionMethod - -• **assertionMethod**: `undefined` \| (`string` \| [`VerificationMethod`](verida_web_helpers._internal_.VerificationMethod.md))[] - -#### Inherited from - -DocInterface.assertionMethod - -___ - -### authentication - -• **authentication**: `undefined` \| (`string` \| [`VerificationMethod`](verida_web_helpers._internal_.VerificationMethod.md))[] - -#### Inherited from - -DocInterface.authentication - -___ - -### capabilityDelegation - -• **capabilityDelegation**: `undefined` \| (`string` \| [`VerificationMethod`](verida_web_helpers._internal_.VerificationMethod.md))[] - -#### Inherited from - -DocInterface.capabilityDelegation - -___ - -### capabilityInvocation - -• **capabilityInvocation**: `undefined` \| (`string` \| [`VerificationMethod`](verida_web_helpers._internal_.VerificationMethod.md))[] - -#### Inherited from - -DocInterface.capabilityInvocation - -___ - -### controller - -• `Optional` **controller**: `string` \| `string`[] - -#### Inherited from - -DocInterface.controller - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:64 - -___ - -### created - -• `Optional` **created**: `string` - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:39 - -___ - -### deactivated - -• `Optional` **deactivated**: `string` - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:41 - -___ - -### id - -• **id**: `string` - -#### Inherited from - -DocInterface.id - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:62 - -___ - -### keyAgreement - -• **keyAgreement**: `undefined` \| (`string` \| [`VerificationMethod`](verida_web_helpers._internal_.VerificationMethod.md))[] - -#### Inherited from - -DocInterface.keyAgreement - -___ - -### proof - -• `Optional` **proof**: [`ProofInterface`](verida_web_helpers._internal_.ProofInterface.md) - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:42 - -___ - -### publicKey - -• `Optional` **publicKey**: [`VerificationMethod`](verida_web_helpers._internal_.VerificationMethod.md)[] - -**`deprecated`** - -#### Inherited from - -DocInterface.publicKey - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:70 - -___ - -### service - -• `Optional` **service**: [`Service`](verida_web_helpers._internal_.Service.md)[] - -#### Inherited from - -DocInterface.service - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:66 - -___ - -### updated - -• `Optional` **updated**: `string` - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:40 - -___ - -### verificationMethod - -• `Optional` **verificationMethod**: [`VerificationMethod`](verida_web_helpers._internal_.VerificationMethod.md)[] - -#### Inherited from - -DocInterface.verificationMethod - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:65 - -___ - -### versionId - -• **versionId**: `number` - -#### Defined in - -packages/types/dist/DocumentInterfaces.d.ts:38 diff --git a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.VerificationMethod.md b/docs/api/verida-js/interfaces/verida_web_helpers._internal_.VerificationMethod.md deleted file mode 100644 index 142d82e..0000000 --- a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.VerificationMethod.md +++ /dev/null @@ -1,129 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / VerificationMethod - -# Interface: VerificationMethod - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).VerificationMethod - -Represents the properties of a Verification Method listed in a DID document. - -This data type includes public key representations that are no longer present in the spec but are still used by -several DID methods / resolvers and kept for backward compatibility. - -**`see`** [https://www.w3.org/TR/did-core/#verification-methods](https://www.w3.org/TR/did-core/#verification-methods) - -**`see`** [https://www.w3.org/TR/did-core/#verification-method-properties](https://www.w3.org/TR/did-core/#verification-method-properties) - -## Table of contents - -### Properties - -- [blockchainAccountId](verida_web_helpers._internal_.VerificationMethod.md#blockchainaccountid) -- [controller](verida_web_helpers._internal_.VerificationMethod.md#controller) -- [ethereumAddress](verida_web_helpers._internal_.VerificationMethod.md#ethereumaddress) -- [id](verida_web_helpers._internal_.VerificationMethod.md#id) -- [publicKeyBase58](verida_web_helpers._internal_.VerificationMethod.md#publickeybase58) -- [publicKeyBase64](verida_web_helpers._internal_.VerificationMethod.md#publickeybase64) -- [publicKeyHex](verida_web_helpers._internal_.VerificationMethod.md#publickeyhex) -- [publicKeyJwk](verida_web_helpers._internal_.VerificationMethod.md#publickeyjwk) -- [publicKeyMultibase](verida_web_helpers._internal_.VerificationMethod.md#publickeymultibase) -- [type](verida_web_helpers._internal_.VerificationMethod.md#type) - -## Properties - -### blockchainAccountId - -• `Optional` **blockchainAccountId**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:133 - -___ - -### controller - -• **controller**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:127 - -___ - -### ethereumAddress - -• `Optional` **ethereumAddress**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:134 - -___ - -### id - -• **id**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:125 - -___ - -### publicKeyBase58 - -• `Optional` **publicKeyBase58**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:128 - -___ - -### publicKeyBase64 - -• `Optional` **publicKeyBase64**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:129 - -___ - -### publicKeyHex - -• `Optional` **publicKeyHex**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:131 - -___ - -### publicKeyJwk - -• `Optional` **publicKeyJwk**: [`JsonWebKey`](verida_web_helpers._internal_.JsonWebKey.md) - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:130 - -___ - -### publicKeyMultibase - -• `Optional` **publicKeyMultibase**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:132 - -___ - -### type - -• **type**: `string` - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:126 diff --git a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.Web3GaslessPostConfig.md b/docs/api/verida-js/interfaces/verida_web_helpers._internal_.Web3GaslessPostConfig.md deleted file mode 100644 index 431fb40..0000000 --- a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.Web3GaslessPostConfig.md +++ /dev/null @@ -1,37 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / Web3GaslessPostConfig - -# Interface: Web3GaslessPostConfig - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).Web3GaslessPostConfig - -Configuration type for gasless post - -## Indexable - -▪ [key: `string`]: `any` - -## Table of contents - -### Properties - -- [headers](verida_web_helpers._internal_.Web3GaslessPostConfig.md#headers) - -## Properties - -### headers - -• **headers**: `Object` - -#### Index signature - -▪ [key: `string`]: `any` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `user-agent` | `string` | - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:64 diff --git a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.Web3GaslessRequestConfig.md b/docs/api/verida-js/interfaces/verida_web_helpers._internal_.Web3GaslessRequestConfig.md deleted file mode 100644 index 734aa21..0000000 --- a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.Web3GaslessRequestConfig.md +++ /dev/null @@ -1,37 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / Web3GaslessRequestConfig - -# Interface: Web3GaslessRequestConfig - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).Web3GaslessRequestConfig - -Configuration type for gasless request - -## Indexable - -▪ [key: `string`]: `any` - -## Table of contents - -### Properties - -- [headers](verida_web_helpers._internal_.Web3GaslessRequestConfig.md#headers) - -## Properties - -### headers - -• **headers**: `Object` - -#### Index signature - -▪ [key: `string`]: `any` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `context-name` | `string` | - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:56 diff --git a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.Web3MetaTransactionConfig.md b/docs/api/verida-js/interfaces/verida_web_helpers._internal_.Web3MetaTransactionConfig.md deleted file mode 100644 index e9e4744..0000000 --- a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.Web3MetaTransactionConfig.md +++ /dev/null @@ -1,45 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / Web3MetaTransactionConfig - -# Interface: Web3MetaTransactionConfig - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).Web3MetaTransactionConfig - -Configuration type for gasless mode - -## Table of contents - -### Properties - -- [endpointUrl](verida_web_helpers._internal_.Web3MetaTransactionConfig.md#endpointurl) -- [postConfig](verida_web_helpers._internal_.Web3MetaTransactionConfig.md#postconfig) -- [serverConfig](verida_web_helpers._internal_.Web3MetaTransactionConfig.md#serverconfig) - -## Properties - -### endpointUrl - -• **endpointUrl**: `string` - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:51 - -___ - -### postConfig - -• **postConfig**: [`Web3GaslessPostConfig`](verida_web_helpers._internal_.Web3GaslessPostConfig.md) - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:50 - -___ - -### serverConfig - -• **serverConfig**: [`Web3GaslessRequestConfig`](verida_web_helpers._internal_.Web3GaslessRequestConfig.md) - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:49 diff --git a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.Web3SelfTransactionConfigPart.md b/docs/api/verida-js/interfaces/verida_web_helpers._internal_.Web3SelfTransactionConfigPart.md deleted file mode 100644 index 382d42d..0000000 --- a/docs/api/verida-js/interfaces/verida_web_helpers._internal_.Web3SelfTransactionConfigPart.md +++ /dev/null @@ -1,32 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / Web3SelfTransactionConfigPart - -# Interface: Web3SelfTransactionConfigPart - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md).Web3SelfTransactionConfigPart - -## Table of contents - -### Properties - -- [privateKey](verida_web_helpers._internal_.Web3SelfTransactionConfigPart.md#privatekey) -- [signer](verida_web_helpers._internal_.Web3SelfTransactionConfigPart.md#signer) - -## Properties - -### privateKey - -• `Optional` **privateKey**: `string` - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:116 - -___ - -### signer - -• `Optional` **signer**: [`Signer`](../classes/verida_web_helpers._internal_.Signer.md) - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:115 diff --git a/docs/api/verida-js/interfaces/verida_web_helpers._internal_._Block.md b/docs/api/verida-js/interfaces/verida_web_helpers._internal_._Block.md deleted file mode 100644 index 98ef3c7..0000000 --- a/docs/api/verida-js/interfaces/verida_web_helpers._internal_._Block.md +++ /dev/null @@ -1,150 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / \_Block - -# Interface: \_Block - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md)._Block - -## Hierarchy - -- **`_Block`** - - ↳ [`Block`](verida_web_helpers._internal_.Block.md) - - ↳ [`BlockWithTransactions`](verida_web_helpers._internal_.BlockWithTransactions.md) - -## Table of contents - -### Properties - -- [\_difficulty](verida_web_helpers._internal_._Block.md#_difficulty) -- [baseFeePerGas](verida_web_helpers._internal_._Block.md#basefeepergas) -- [difficulty](verida_web_helpers._internal_._Block.md#difficulty) -- [extraData](verida_web_helpers._internal_._Block.md#extradata) -- [gasLimit](verida_web_helpers._internal_._Block.md#gaslimit) -- [gasUsed](verida_web_helpers._internal_._Block.md#gasused) -- [hash](verida_web_helpers._internal_._Block.md#hash) -- [miner](verida_web_helpers._internal_._Block.md#miner) -- [nonce](verida_web_helpers._internal_._Block.md#nonce) -- [number](verida_web_helpers._internal_._Block.md#number) -- [parentHash](verida_web_helpers._internal_._Block.md#parenthash) -- [timestamp](verida_web_helpers._internal_._Block.md#timestamp) - -## Properties - -### \_difficulty - -• **\_difficulty**: [`BigNumber`](../classes/verida_web_helpers._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:41 - -___ - -### baseFeePerGas - -• `Optional` **baseFeePerGas**: ``null`` \| [`BigNumber`](../classes/verida_web_helpers._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:46 - -___ - -### difficulty - -• **difficulty**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:40 - -___ - -### extraData - -• **extraData**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:45 - -___ - -### gasLimit - -• **gasLimit**: [`BigNumber`](../classes/verida_web_helpers._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:42 - -___ - -### gasUsed - -• **gasUsed**: [`BigNumber`](../classes/verida_web_helpers._internal_.BigNumber.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:43 - -___ - -### hash - -• **hash**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:35 - -___ - -### miner - -• **miner**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:44 - -___ - -### nonce - -• **nonce**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:39 - -___ - -### number - -• **number**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:37 - -___ - -### parentHash - -• **parentHash**: `string` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:36 - -___ - -### timestamp - -• **timestamp**: `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:38 diff --git a/docs/api/verida-js/interfaces/verida_web_helpers._internal_._KeywordDef.md b/docs/api/verida-js/interfaces/verida_web_helpers._internal_._KeywordDef.md deleted file mode 100644 index 9d635dd..0000000 --- a/docs/api/verida-js/interfaces/verida_web_helpers._internal_._KeywordDef.md +++ /dev/null @@ -1,161 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / \_KeywordDef - -# Interface: \_KeywordDef - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md)._KeywordDef - -## Hierarchy - -- **`_KeywordDef`** - - ↳ [`CodeKeywordDefinition`](verida_web_helpers._internal_.CodeKeywordDefinition.md) - - ↳ [`FuncKeywordDefinition`](verida_web_helpers._internal_.FuncKeywordDefinition.md) - -## Table of contents - -### Properties - -- [$data](verida_web_helpers._internal_._KeywordDef.md#$data) -- [$dataError](verida_web_helpers._internal_._KeywordDef.md#$dataerror) -- [allowUndefined](verida_web_helpers._internal_._KeywordDef.md#allowundefined) -- [before](verida_web_helpers._internal_._KeywordDef.md#before) -- [dependencies](verida_web_helpers._internal_._KeywordDef.md#dependencies) -- [error](verida_web_helpers._internal_._KeywordDef.md#error) -- [implements](verida_web_helpers._internal_._KeywordDef.md#implements) -- [keyword](verida_web_helpers._internal_._KeywordDef.md#keyword) -- [metaSchema](verida_web_helpers._internal_._KeywordDef.md#metaschema) -- [post](verida_web_helpers._internal_._KeywordDef.md#post) -- [schemaType](verida_web_helpers._internal_._KeywordDef.md#schematype) -- [type](verida_web_helpers._internal_._KeywordDef.md#type) -- [validateSchema](verida_web_helpers._internal_._KeywordDef.md#validateschema) - -## Properties - -### $data - -• `Optional` **$data**: `boolean` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:91 - -___ - -### $dataError - -• `Optional` **$dataError**: [`KeywordErrorDefinition`](verida_web_helpers._internal_.KeywordErrorDefinition.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:99 - -___ - -### allowUndefined - -• `Optional` **allowUndefined**: `boolean` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:90 - -___ - -### before - -• `Optional` **before**: `string` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:93 - -___ - -### dependencies - -• `Optional` **dependencies**: `string`[] - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:97 - -___ - -### error - -• `Optional` **error**: [`KeywordErrorDefinition`](verida_web_helpers._internal_.KeywordErrorDefinition.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:98 - -___ - -### implements - -• `Optional` **implements**: `string`[] - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:92 - -___ - -### keyword - -• **keyword**: `string` \| `string`[] - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:87 - -___ - -### metaSchema - -• `Optional` **metaSchema**: [`AnySchemaObject`](../modules/verida_web_helpers._internal_.md#anyschemaobject) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:95 - -___ - -### post - -• `Optional` **post**: `boolean` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:94 - -___ - -### schemaType - -• `Optional` **schemaType**: ``"string"`` \| ``"number"`` \| ``"boolean"`` \| ``"object"`` \| ``"integer"`` \| ``"array"`` \| ``"null"`` \| (``"string"`` \| ``"number"`` \| ``"boolean"`` \| ``"object"`` \| ``"integer"`` \| ``"array"`` \| ``"null"``)[] - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:89 - -___ - -### type - -• `Optional` **type**: ``"string"`` \| ``"number"`` \| ``"boolean"`` \| ``"object"`` \| ``"integer"`` \| ``"array"`` \| ``"null"`` \| (``"string"`` \| ``"number"`` \| ``"boolean"`` \| ``"object"`` \| ``"integer"`` \| ``"array"`` \| ``"null"``)[] - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:88 - -___ - -### validateSchema - -• `Optional` **validateSchema**: [`AnyValidateFunction`](../modules/verida_web_helpers._internal_.md#anyvalidatefunction)<`any`\> - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:96 diff --git a/docs/api/verida-js/interfaces/verida_web_helpers._internal_._SchemaObject.md b/docs/api/verida-js/interfaces/verida_web_helpers._internal_._SchemaObject.md deleted file mode 100644 index e34fd25..0000000 --- a/docs/api/verida-js/interfaces/verida_web_helpers._internal_._SchemaObject.md +++ /dev/null @@ -1,55 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](../modules/verida_web_helpers.md) / [](../modules/verida_web_helpers._internal_.md) / \_SchemaObject - -# Interface: \_SchemaObject - -[@verida/web-helpers](../modules/verida_web_helpers.md).[](../modules/verida_web_helpers._internal_.md)._SchemaObject - -## Hierarchy - -- **`_SchemaObject`** - - ↳ [`AsyncSchema`](verida_web_helpers._internal_.AsyncSchema.md) - - ↳ [`SchemaObject`](verida_web_helpers._internal_.SchemaObject.md) - -## Indexable - -▪ [x: `string`]: `any` - -## Table of contents - -### Properties - -- [$id](verida_web_helpers._internal_._SchemaObject.md#$id) -- [$schema](verida_web_helpers._internal_._SchemaObject.md#$schema) -- [id](verida_web_helpers._internal_._SchemaObject.md#id) - -## Properties - -### $id - -• `Optional` **$id**: `string` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:9 - -___ - -### $schema - -• `Optional` **$schema**: `string` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:10 - -___ - -### id - -• `Optional` **id**: `string` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:8 diff --git a/docs/api/verida-js/modules.md b/docs/api/verida-js/modules.md deleted file mode 100644 index 05e0646..0000000 --- a/docs/api/verida-js/modules.md +++ /dev/null @@ -1,28 +0,0 @@ -[root](README.md) / Modules - -# root - -## Table of contents - -### Modules - -- [@verida/account](modules/verida_account.md) -- [@verida/account-node](modules/verida_account_node.md) -- [@verida/account-web-vault](modules/verida_account_web_vault.md) -- [@verida/client-ts](modules/verida_client_ts.md) -- [@verida/did-client](modules/verida_did_client.md) -- [@verida/did-document](modules/verida_did_document.md) -- [@verida/encryption-utils](modules/verida_encryption_utils.md) -- [@verida/helpers](modules/verida_helpers.md) -- [@verida/keyring](modules/verida_keyring.md) -- [@verida/storage-link](modules/verida_storage_link.md) -- [@verida/types](modules/verida_types.md) -- [@verida/vda-common](modules/verida_vda_common.md) -- [@verida/vda-common-test](modules/verida_vda_common_test.md) -- [@verida/vda-did](modules/verida_vda_did.md) -- [@verida/vda-did-resolver](modules/verida_vda_did_resolver.md) -- [@verida/vda-name-client](modules/verida_vda_name_client.md) -- [@verida/vda-sbt-client](modules/verida_vda_sbt_client.md) -- [@verida/verifiable-credentials](modules/verida_verifiable_credentials.md) -- [@verida/web-helpers](modules/verida_web_helpers.md) -- [@verida/web3](modules/verida_web3.md) diff --git a/docs/api/verida-js/modules/verida_account._internal_.md b/docs/api/verida-js/modules/verida_account._internal_.md deleted file mode 100644 index 612ea8e..0000000 --- a/docs/api/verida-js/modules/verida_account._internal_.md +++ /dev/null @@ -1,65 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account](verida_account.md) / - -# Namespace: - -[@verida/account](verida_account.md). - -## Table of contents - -### Classes - -- [default](../classes/verida_account._internal_.default.md) - -### Interfaces - -- [AccountConfig](../interfaces/verida_account._internal_.AccountConfig.md) -- [AuthContext](../interfaces/verida_account._internal_.AuthContext.md) -- [AuthTypeConfig](../interfaces/verida_account._internal_.AuthTypeConfig.md) -- [IAccount](../interfaces/verida_account._internal_.IAccount.md) -- [IKeyring](../interfaces/verida_account._internal_.IKeyring.md) -- [KeyringPublicKeys](../interfaces/verida_account._internal_.KeyringPublicKeys.md) -- [SecureContextConfig](../interfaces/verida_account._internal_.SecureContextConfig.md) -- [SecureContextEndpoint](../interfaces/verida_account._internal_.SecureContextEndpoint.md) -- [SecureContextPublicKey](../interfaces/verida_account._internal_.SecureContextPublicKey.md) -- [SecureContextServices](../interfaces/verida_account._internal_.SecureContextServices.md) -- [SecureStorageContextPublicKeys](../interfaces/verida_account._internal_.SecureStorageContextPublicKeys.md) - -### Type aliases - -- [Record](verida_account._internal_.md#record) -- [ServiceEndpoint](verida_account._internal_.md#serviceendpoint) - -## Type aliases - -### Record - -Ƭ **Record**<`K`, `T`\>: { [P in K]: T } - -Construct a type with a set of properties K of type T - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof `any` | -| `T` | `T` | - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1499 - -___ - -### ServiceEndpoint - -Ƭ **ServiceEndpoint**: `string` \| [`Record`](verida_account._internal_.md#record)<`string`, `any`\> - -Represents an endpoint of a Service entry in a DID document. - -**`see`** [https://www.w3.org/TR/did-core/#dfn-serviceendpoint](https://www.w3.org/TR/did-core/#dfn-serviceendpoint) - -**`see`** [https://www.w3.org/TR/did-core/#services](https://www.w3.org/TR/did-core/#services) - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:92 diff --git a/docs/api/verida-js/modules/verida_account.md b/docs/api/verida-js/modules/verida_account.md deleted file mode 100644 index ae37ccf..0000000 --- a/docs/api/verida-js/modules/verida_account.md +++ /dev/null @@ -1,28 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / @verida/account - -# Module: @verida/account - -## Table of contents - -### Namespaces - -- [<internal\>](verida_account._internal_.md) - -### Classes - -- [Account](../classes/verida_account.Account.md) -- [AuthType](../classes/verida_account.AuthType.md) - -### Variables - -- [Config](verida_account.md#config) - -## Variables - -### Config - -• `Const` **Config**: `any` - -#### Defined in - -[packages/account/src/config.ts:3](https://github.com/verida/verida-js/blob/5040472/packages/account/src/config.ts#L3) diff --git a/docs/api/verida-js/modules/verida_account_node._internal_.md b/docs/api/verida-js/modules/verida_account_node._internal_.md deleted file mode 100644 index 9fb4154..0000000 --- a/docs/api/verida-js/modules/verida_account_node._internal_.md +++ /dev/null @@ -1,494 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account-node](verida_account_node.md) / - -# Namespace: - -[@verida/account-node](verida_account_node.md). - -## Table of contents - -### Enumerations - -- [EnvironmentType](../enums/verida_account_node._internal_.EnvironmentType.md) -- [SecureContextEndpointType](../enums/verida_account_node._internal_.SecureContextEndpointType.md) - -### Classes - -- [AuthType](../classes/verida_account_node._internal_.AuthType.md) -- [Axios](../classes/verida_account_node._internal_.Axios.md) -- [BigNumber](../classes/verida_account_node._internal_.BigNumber.md) -- [DIDClient](../classes/verida_account_node._internal_.DIDClient.md) -- [Description](../classes/verida_account_node._internal_.Description.md) -- [ForkEvent](../classes/verida_account_node._internal_.ForkEvent.md) -- [Provider](../classes/verida_account_node._internal_.Provider.md) -- [Signer](../classes/verida_account_node._internal_.Signer.md) -- [default](../classes/verida_account_node._internal_.default.md) -- [default](../classes/verida_account_node._internal_.default-1.md) -- [default](../classes/verida_account_node._internal_.default-2.md) -- [default](../classes/verida_account_node._internal_.default-3.md) - -### Interfaces - -- [AbortSignal](../interfaces/verida_account_node._internal_.AbortSignal.md) -- [AccountConfig](../interfaces/verida_account_node._internal_.AccountConfig.md) -- [AccountNodeConfig](../interfaces/verida_account_node._internal_.AccountNodeConfig.md) -- [AccountNodeDIDClientConfig](../interfaces/verida_account_node._internal_.AccountNodeDIDClientConfig.md) -- [ArrayLike](../interfaces/verida_account_node._internal_.ArrayLike.md) -- [AuthContext](../interfaces/verida_account_node._internal_.AuthContext.md) -- [AuthTypeConfig](../interfaces/verida_account_node._internal_.AuthTypeConfig.md) -- [AxiosAdapter](../interfaces/verida_account_node._internal_.AxiosAdapter.md) -- [AxiosBasicCredentials](../interfaces/verida_account_node._internal_.AxiosBasicCredentials.md) -- [AxiosDefaults](../interfaces/verida_account_node._internal_.AxiosDefaults.md) -- [AxiosInstance](../interfaces/verida_account_node._internal_.AxiosInstance.md) -- [AxiosInterceptorManager](../interfaces/verida_account_node._internal_.AxiosInterceptorManager.md) -- [AxiosInterceptorOptions](../interfaces/verida_account_node._internal_.AxiosInterceptorOptions.md) -- [AxiosPromise](../interfaces/verida_account_node._internal_.AxiosPromise.md) -- [AxiosProxyConfig](../interfaces/verida_account_node._internal_.AxiosProxyConfig.md) -- [AxiosRequestConfig](../interfaces/verida_account_node._internal_.AxiosRequestConfig.md) -- [AxiosRequestTransformer](../interfaces/verida_account_node._internal_.AxiosRequestTransformer.md) -- [AxiosResponse](../interfaces/verida_account_node._internal_.AxiosResponse.md) -- [AxiosResponseTransformer](../interfaces/verida_account_node._internal_.AxiosResponseTransformer.md) -- [Block](../interfaces/verida_account_node._internal_.Block.md) -- [BlockWithTransactions](../interfaces/verida_account_node._internal_.BlockWithTransactions.md) -- [Cancel](../interfaces/verida_account_node._internal_.Cancel.md) -- [CancelToken](../interfaces/verida_account_node._internal_.CancelToken.md) -- [DIDClientConfig](../interfaces/verida_account_node._internal_.DIDClientConfig.md) -- [EventFilter](../interfaces/verida_account_node._internal_.EventFilter.md) -- [FeeData](../interfaces/verida_account_node._internal_.FeeData.md) -- [Filter](../interfaces/verida_account_node._internal_.Filter.md) -- [HeadersDefaults](../interfaces/verida_account_node._internal_.HeadersDefaults.md) -- [Hexable](../interfaces/verida_account_node._internal_.Hexable.md) -- [IAccount](../interfaces/verida_account_node._internal_.IAccount.md) -- [IDIDClient](../interfaces/verida_account_node._internal_.IDIDClient.md) -- [IDIDDocument](../interfaces/verida_account_node._internal_.IDIDDocument.md) -- [IKeyring](../interfaces/verida_account_node._internal_.IKeyring.md) -- [JsonWebKey](../interfaces/verida_account_node._internal_.JsonWebKey.md) -- [KeyringPublicKeys](../interfaces/verida_account_node._internal_.KeyringPublicKeys.md) -- [Log](../interfaces/verida_account_node._internal_.Log.md) -- [OnceBlockable](../interfaces/verida_account_node._internal_.OnceBlockable.md) -- [PromiseLike](../interfaces/verida_account_node._internal_.PromiseLike.md) -- [ProofInterface](../interfaces/verida_account_node._internal_.ProofInterface.md) -- [SecureContextConfig](../interfaces/verida_account_node._internal_.SecureContextConfig.md) -- [SecureContextEndpoint](../interfaces/verida_account_node._internal_.SecureContextEndpoint.md) -- [SecureContextEndpoints](../interfaces/verida_account_node._internal_.SecureContextEndpoints.md) -- [SecureContextPublicKey](../interfaces/verida_account_node._internal_.SecureContextPublicKey.md) -- [SecureContextServices](../interfaces/verida_account_node._internal_.SecureContextServices.md) -- [SecureStorageContextPublicKeys](../interfaces/verida_account_node._internal_.SecureStorageContextPublicKeys.md) -- [Service](../interfaces/verida_account_node._internal_.Service.md) -- [Transaction](../interfaces/verida_account_node._internal_.Transaction.md) -- [TransactionReceipt](../interfaces/verida_account_node._internal_.TransactionReceipt.md) -- [TransactionResponse](../interfaces/verida_account_node._internal_.TransactionResponse.md) -- [TransitionalOptions](../interfaces/verida_account_node._internal_.TransitionalOptions.md) -- [VdaDidEndpointResponse](../interfaces/verida_account_node._internal_.VdaDidEndpointResponse.md) -- [VeridaDatabaseAuthContext](../interfaces/verida_account_node._internal_.VeridaDatabaseAuthContext.md) -- [VeridaDatabaseAuthTypeConfig](../interfaces/verida_account_node._internal_.VeridaDatabaseAuthTypeConfig.md) -- [VeridaDocInterface](../interfaces/verida_account_node._internal_.VeridaDocInterface.md) -- [VerificationMethod](../interfaces/verida_account_node._internal_.VerificationMethod.md) -- [Web3GasConfiguration](../interfaces/verida_account_node._internal_.Web3GasConfiguration.md) -- [Web3GaslessPostConfig](../interfaces/verida_account_node._internal_.Web3GaslessPostConfig.md) -- [Web3GaslessRequestConfig](../interfaces/verida_account_node._internal_.Web3GaslessRequestConfig.md) -- [Web3MetaTransactionConfig](../interfaces/verida_account_node._internal_.Web3MetaTransactionConfig.md) -- [Web3SelfTransactionConfig](../interfaces/verida_account_node._internal_.Web3SelfTransactionConfig.md) -- [Web3SelfTransactionConfigPart](../interfaces/verida_account_node._internal_.Web3SelfTransactionConfigPart.md) -- [\_Block](../interfaces/verida_account_node._internal_._Block.md) - -### Type aliases - -- [AccessList](verida_account_node._internal_.md#accesslist) -- [AccessListish](verida_account_node._internal_.md#accesslistish) -- [AxiosRequestHeaders](verida_account_node._internal_.md#axiosrequestheaders) -- [AxiosResponseHeaders](verida_account_node._internal_.md#axiosresponseheaders) -- [BigNumberish](verida_account_node._internal_.md#bignumberish) -- [BlockTag](verida_account_node._internal_.md#blocktag) -- [Bytes](verida_account_node._internal_.md#bytes) -- [BytesLike](verida_account_node._internal_.md#byteslike) -- [DIDDocument](verida_account_node._internal_.md#diddocument) -- [Deferrable](verida_account_node._internal_.md#deferrable) -- [EIP1559GasMode](verida_account_node._internal_.md#eip1559gasmode) -- [EventType](verida_account_node._internal_.md#eventtype) -- [Exclude](verida_account_node._internal_.md#exclude) -- [Extensible](verida_account_node._internal_.md#extensible) -- [KeyCapabilitySection](verida_account_node._internal_.md#keycapabilitysection) -- [Listener](verida_account_node._internal_.md#listener) -- [Network](verida_account_node._internal_.md#network) -- [Omit](verida_account_node._internal_.md#omit) -- [Pick](verida_account_node._internal_.md#pick) -- [Record](verida_account_node._internal_.md#record) -- [ResponseType](verida_account_node._internal_.md#responsetype) -- [ServiceEndpoint](verida_account_node._internal_.md#serviceendpoint) -- [TransactionRequest](verida_account_node._internal_.md#transactionrequest) -- [VdaDidEndpointResponses](verida_account_node._internal_.md#vdadidendpointresponses) -- [Web3CallType](verida_account_node._internal_.md#web3calltype) - -### Variables - -- [AbortSignal](verida_account_node._internal_.md#abortsignal) - -## Type aliases - -### AccessList - -Ƭ **AccessList**: { `address`: `string` ; `storageKeys`: `string`[] }[] - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:3 - -___ - -### AccessListish - -Ƭ **AccessListish**: [`AccessList`](verida_account_node._internal_.md#accesslist) \| [`string`, `string`[]][] \| [`Record`](verida_account_node._internal_.md#record)<`string`, `string`[]\> - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:7 - -___ - -### AxiosRequestHeaders - -Ƭ **AxiosRequestHeaders**: [`Record`](verida_account_node._internal_.md#record)<`string`, `string` \| `number` \| `boolean`\> - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:2 - -___ - -### AxiosResponseHeaders - -Ƭ **AxiosResponseHeaders**: [`Record`](verida_account_node._internal_.md#record)<`string`, `string`\> & { `set-cookie?`: `string`[] } - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:4 - -___ - -### BigNumberish - -Ƭ **BigNumberish**: [`BigNumber`](../classes/verida_account_node._internal_.BigNumber.md) \| [`Bytes`](verida_account_node._internal_.md#bytes) \| `bigint` \| `string` \| `number` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:2 - -___ - -### BlockTag - -Ƭ **BlockTag**: `string` \| `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:33 - -___ - -### Bytes - -Ƭ **Bytes**: [`ArrayLike`](../interfaces/verida_account_node._internal_.ArrayLike.md)<`number`\> - -#### Defined in - -node_modules/@ethersproject/bytes/lib/index.d.ts:1 - -___ - -### BytesLike - -Ƭ **BytesLike**: [`Bytes`](verida_account_node._internal_.md#bytes) \| `string` - -#### Defined in - -node_modules/@ethersproject/bytes/lib/index.d.ts:2 - -___ - -### DIDDocument - -Ƭ **DIDDocument**: { `@context?`: ``"https://www.w3.org/ns/did/v1"`` \| `string` \| `string`[] ; `alsoKnownAs?`: `string`[] ; `controller?`: `string` \| `string`[] ; `id`: `string` ; `publicKey?`: [`VerificationMethod`](../interfaces/verida_account_node._internal_.VerificationMethod.md)[] ; `service?`: [`Service`](../interfaces/verida_account_node._internal_.Service.md)[] ; `verificationMethod?`: [`VerificationMethod`](../interfaces/verida_account_node._internal_.VerificationMethod.md)[] } & { [x in KeyCapabilitySection]?: (string \| VerificationMethod)[] } - -Represents a DID document. - -**`see`** [https://www.w3.org/TR/did-core/#did-document-properties](https://www.w3.org/TR/did-core/#did-document-properties) - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:60 - -___ - -### Deferrable - -Ƭ **Deferrable**<`T`\>: { [K in keyof T]: T[K] \| Promise } - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Defined in - -node_modules/@ethersproject/properties/lib/index.d.ts:3 - -___ - -### EIP1559GasMode - -Ƭ **EIP1559GasMode**: ``"safeLow"`` \| ``"standard"`` \| ``"fast"`` - -EIP1559 Gas Configuration speed - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:13 - -___ - -### EventType - -Ƭ **EventType**: `string` \| (`string` \| `string`[])[] \| [`EventFilter`](../interfaces/verida_account_node._internal_.EventFilter.md) \| [`ForkEvent`](../classes/verida_account_node._internal_.ForkEvent.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:121 - -___ - -### Exclude - -Ƭ **Exclude**<`T`, `U`\>: `T` extends `U` ? `never` : `T` - -Exclude from T those types that are assignable to U - -#### Type parameters - -| Name | -| :------ | -| `T` | -| `U` | - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1506 - -___ - -### Extensible - -Ƭ **Extensible**: [`Record`](verida_account_node._internal_.md#record)<`string`, `any`\> - -Defines an object type that can be extended with other properties. - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:4 - -___ - -### KeyCapabilitySection - -Ƭ **KeyCapabilitySection**: ``"authentication"`` \| ``"assertionMethod"`` \| ``"keyAgreement"`` \| ``"capabilityInvocation"`` \| ``"capabilityDelegation"`` - -Represents the Verification Relationship between a DID subject and a Verification Method. - -**`see`** [https://www.w3.org/TR/did-core/#verification-relationships](https://www.w3.org/TR/did-core/#verification-relationships) - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:54 - -___ - -### Listener - -Ƭ **Listener**: (...`args`: `any`[]) => `void` - -#### Type declaration - -▸ (...`args`): `void` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `...args` | `any`[] | - -##### Returns - -`void` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:122 - -___ - -### Network - -Ƭ **Network**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `chainId` | `number` | -| `ensAddress?` | `string` | -| `name` | `string` | -| `_defaultProvider?` | (`providers`: `any`, `options?`: `any`) => `any` | - -#### Defined in - -node_modules/@ethersproject/networks/lib/types.d.ts:1 - -___ - -### Omit - -Ƭ **Omit**<`T`, `K`\>: [`Pick`](verida_account_node._internal_.md#pick)<`T`, [`Exclude`](verida_account_node._internal_.md#exclude)\> - -Construct a type with the properties of T except for those in type K. - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `T` | -| `K` | extends keyof `any` | - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1516 - -___ - -### Pick - -Ƭ **Pick**<`T`, `K`\>: { [P in K]: T[P] } - -From T, pick a set of properties whose keys are in the union K - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `T` | -| `K` | extends keyof `T` | - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1492 - -___ - -### Record - -Ƭ **Record**<`K`, `T`\>: { [P in K]: T } - -Construct a type with a set of properties K of type T - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof `any` | -| `T` | `T` | - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1499 - -___ - -### ResponseType - -Ƭ **ResponseType**: ``"arraybuffer"`` \| ``"blob"`` \| ``"document"`` \| ``"json"`` \| ``"text"`` \| ``"stream"`` - -#### Defined in - -packages/account-node/node_modules/axios/index.d.ts:47 - -___ - -### ServiceEndpoint - -Ƭ **ServiceEndpoint**: `string` \| [`Record`](verida_account_node._internal_.md#record)<`string`, `any`\> - -Represents an endpoint of a Service entry in a DID document. - -**`see`** [https://www.w3.org/TR/did-core/#dfn-serviceendpoint](https://www.w3.org/TR/did-core/#dfn-serviceendpoint) - -**`see`** [https://www.w3.org/TR/did-core/#services](https://www.w3.org/TR/did-core/#services) - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:92 - -___ - -### TransactionRequest - -Ƭ **TransactionRequest**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `accessList?` | [`AccessListish`](verida_account_node._internal_.md#accesslistish) | -| `ccipReadEnabled?` | `boolean` | -| `chainId?` | `number` | -| `customData?` | [`Record`](verida_account_node._internal_.md#record)<`string`, `any`\> | -| `data?` | [`BytesLike`](verida_account_node._internal_.md#byteslike) | -| `from?` | `string` | -| `gasLimit?` | [`BigNumberish`](verida_account_node._internal_.md#bignumberish) | -| `gasPrice?` | [`BigNumberish`](verida_account_node._internal_.md#bignumberish) | -| `maxFeePerGas?` | [`BigNumberish`](verida_account_node._internal_.md#bignumberish) | -| `maxPriorityFeePerGas?` | [`BigNumberish`](verida_account_node._internal_.md#bignumberish) | -| `nonce?` | [`BigNumberish`](verida_account_node._internal_.md#bignumberish) | -| `to?` | `string` | -| `type?` | `number` | -| `value?` | [`BigNumberish`](verida_account_node._internal_.md#bignumberish) | - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:7 - -___ - -### VdaDidEndpointResponses - -Ƭ **VdaDidEndpointResponses**: [`Record`](verida_account_node._internal_.md#record)<`string`, [`VdaDidEndpointResponse`](../interfaces/verida_account_node._internal_.VdaDidEndpointResponse.md)\> - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:113 - -___ - -### Web3CallType - -Ƭ **Web3CallType**: ``"web3"`` \| ``"gasless"`` - -Web3 SDK running mode - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:5 - -## Variables - -### AbortSignal - -• **AbortSignal**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `prototype` | [`AbortSignal`](verida_account_node._internal_.md#abortsignal) | - -#### Defined in - -node_modules/@types/node/globals.d.ts:72 diff --git a/docs/api/verida-js/modules/verida_account_node.md b/docs/api/verida-js/modules/verida_account_node.md deleted file mode 100644 index eb7690e..0000000 --- a/docs/api/verida-js/modules/verida_account_node.md +++ /dev/null @@ -1,23 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / @verida/account-node - -# Module: @verida/account-node - -## Table of contents - -### Namespaces - -- [<internal\>](verida_account_node._internal_.md) - -### Classes - -- [AuthContextAccount](../classes/verida_account_node.AuthContextAccount.md) -- [AutoAccount](../classes/verida_account_node.AutoAccount.md) -- [LimitedAccount](../classes/verida_account_node.LimitedAccount.md) -- [NodeSelector](../classes/verida_account_node.NodeSelector.md) -- [VeridaDatabaseAuthType](../classes/verida_account_node.VeridaDatabaseAuthType.md) - -### Interfaces - -- [NodeSelectorConfig](../interfaces/verida_account_node.NodeSelectorConfig.md) -- [NodeSelectorParams](../interfaces/verida_account_node.NodeSelectorParams.md) -- [StorageNode](../interfaces/verida_account_node.StorageNode.md) diff --git a/docs/api/verida-js/modules/verida_account_web_vault._internal_.md b/docs/api/verida-js/modules/verida_account_web_vault._internal_.md deleted file mode 100644 index d4e4d85..0000000 --- a/docs/api/verida-js/modules/verida_account_web_vault._internal_.md +++ /dev/null @@ -1,185 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/account-web-vault](verida_account_web_vault.md) / - -# Namespace: - -[@verida/account-web-vault](verida_account_web_vault.md). - -## Table of contents - -### Enumerations - -- [EnvironmentType](../enums/verida_account_web_vault._internal_.EnvironmentType.md) - -### Classes - -- [Axios](../classes/verida_account_web_vault._internal_.Axios.md) -- [default](../classes/verida_account_web_vault._internal_.default.md) -- [default](../classes/verida_account_web_vault._internal_.default-1.md) - -### Interfaces - -- [AccountConfig](../interfaces/verida_account_web_vault._internal_.AccountConfig.md) -- [AccountVaultConfig](../interfaces/verida_account_web_vault._internal_.AccountVaultConfig.md) -- [AccountVaultRequest](../interfaces/verida_account_web_vault._internal_.AccountVaultRequest.md) -- [AuthContext](../interfaces/verida_account_web_vault._internal_.AuthContext.md) -- [AuthResponse](../interfaces/verida_account_web_vault._internal_.AuthResponse.md) -- [AuthTypeConfig](../interfaces/verida_account_web_vault._internal_.AuthTypeConfig.md) -- [AxiosAdapter](../interfaces/verida_account_web_vault._internal_.AxiosAdapter.md) -- [AxiosBasicCredentials](../interfaces/verida_account_web_vault._internal_.AxiosBasicCredentials.md) -- [AxiosDefaults](../interfaces/verida_account_web_vault._internal_.AxiosDefaults.md) -- [AxiosInstance](../interfaces/verida_account_web_vault._internal_.AxiosInstance.md) -- [AxiosInterceptorManager](../interfaces/verida_account_web_vault._internal_.AxiosInterceptorManager.md) -- [AxiosInterceptorOptions](../interfaces/verida_account_web_vault._internal_.AxiosInterceptorOptions.md) -- [AxiosPromise](../interfaces/verida_account_web_vault._internal_.AxiosPromise.md) -- [AxiosProxyConfig](../interfaces/verida_account_web_vault._internal_.AxiosProxyConfig.md) -- [AxiosRequestConfig](../interfaces/verida_account_web_vault._internal_.AxiosRequestConfig.md) -- [AxiosRequestTransformer](../interfaces/verida_account_web_vault._internal_.AxiosRequestTransformer.md) -- [AxiosResponse](../interfaces/verida_account_web_vault._internal_.AxiosResponse.md) -- [AxiosResponseTransformer](../interfaces/verida_account_web_vault._internal_.AxiosResponseTransformer.md) -- [Cancel](../interfaces/verida_account_web_vault._internal_.Cancel.md) -- [CancelToken](../interfaces/verida_account_web_vault._internal_.CancelToken.md) -- [HeadersDefaults](../interfaces/verida_account_web_vault._internal_.HeadersDefaults.md) -- [IAccount](../interfaces/verida_account_web_vault._internal_.IAccount.md) -- [IKeyring](../interfaces/verida_account_web_vault._internal_.IKeyring.md) -- [KeyringPublicKeys](../interfaces/verida_account_web_vault._internal_.KeyringPublicKeys.md) -- [PromiseLike](../interfaces/verida_account_web_vault._internal_.PromiseLike.md) -- [SecureContextConfig](../interfaces/verida_account_web_vault._internal_.SecureContextConfig.md) -- [SecureContextEndpoint](../interfaces/verida_account_web_vault._internal_.SecureContextEndpoint.md) -- [SecureContextPublicKey](../interfaces/verida_account_web_vault._internal_.SecureContextPublicKey.md) -- [SecureContextServices](../interfaces/verida_account_web_vault._internal_.SecureContextServices.md) -- [SecureStorageContextPublicKeys](../interfaces/verida_account_web_vault._internal_.SecureStorageContextPublicKeys.md) -- [TransitionalOptions](../interfaces/verida_account_web_vault._internal_.TransitionalOptions.md) -- [VeridaDatabaseAuthContext](../interfaces/verida_account_web_vault._internal_.VeridaDatabaseAuthContext.md) - -### Type aliases - -- [AxiosRequestHeaders](verida_account_web_vault._internal_.md#axiosrequestheaders) -- [AxiosResponseHeaders](verida_account_web_vault._internal_.md#axiosresponseheaders) -- [Exclude](verida_account_web_vault._internal_.md#exclude) -- [Omit](verida_account_web_vault._internal_.md#omit) -- [Pick](verida_account_web_vault._internal_.md#pick) -- [Record](verida_account_web_vault._internal_.md#record) -- [ResponseType](verida_account_web_vault._internal_.md#responsetype) -- [ServiceEndpoint](verida_account_web_vault._internal_.md#serviceendpoint) - -## Type aliases - -### AxiosRequestHeaders - -Ƭ **AxiosRequestHeaders**: [`Record`](verida_account_web_vault._internal_.md#record)<`string`, `string` \| `number` \| `boolean`\> - -#### Defined in - -node_modules/axios/index.d.ts:2 - -___ - -### AxiosResponseHeaders - -Ƭ **AxiosResponseHeaders**: [`Record`](verida_account_web_vault._internal_.md#record)<`string`, `string`\> & { `set-cookie?`: `string`[] } - -#### Defined in - -node_modules/axios/index.d.ts:4 - -___ - -### Exclude - -Ƭ **Exclude**<`T`, `U`\>: `T` extends `U` ? `never` : `T` - -Exclude from T those types that are assignable to U - -#### Type parameters - -| Name | -| :------ | -| `T` | -| `U` | - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1506 - -___ - -### Omit - -Ƭ **Omit**<`T`, `K`\>: [`Pick`](verida_account_web_vault._internal_.md#pick)<`T`, [`Exclude`](verida_account_web_vault._internal_.md#exclude)\> - -Construct a type with the properties of T except for those in type K. - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `T` | -| `K` | extends keyof `any` | - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1516 - -___ - -### Pick - -Ƭ **Pick**<`T`, `K`\>: { [P in K]: T[P] } - -From T, pick a set of properties whose keys are in the union K - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `T` | -| `K` | extends keyof `T` | - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1492 - -___ - -### Record - -Ƭ **Record**<`K`, `T`\>: { [P in K]: T } - -Construct a type with a set of properties K of type T - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof `any` | -| `T` | `T` | - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1499 - -___ - -### ResponseType - -Ƭ **ResponseType**: ``"arraybuffer"`` \| ``"blob"`` \| ``"document"`` \| ``"json"`` \| ``"text"`` \| ``"stream"`` - -#### Defined in - -node_modules/axios/index.d.ts:47 - -___ - -### ServiceEndpoint - -Ƭ **ServiceEndpoint**: `string` \| [`Record`](verida_account_web_vault._internal_.md#record)<`string`, `any`\> - -Represents an endpoint of a Service entry in a DID document. - -**`see`** [https://www.w3.org/TR/did-core/#dfn-serviceendpoint](https://www.w3.org/TR/did-core/#dfn-serviceendpoint) - -**`see`** [https://www.w3.org/TR/did-core/#services](https://www.w3.org/TR/did-core/#services) - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:92 diff --git a/docs/api/verida-js/modules/verida_account_web_vault.md b/docs/api/verida-js/modules/verida_account_web_vault.md deleted file mode 100644 index 648bf2f..0000000 --- a/docs/api/verida-js/modules/verida_account_web_vault.md +++ /dev/null @@ -1,37 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / @verida/account-web-vault - -# Module: @verida/account-web-vault - -## Table of contents - -### Namespaces - -- [<internal\>](verida_account_web_vault._internal_.md) - -### Classes - -- [VaultAccount](../classes/verida_account_web_vault.VaultAccount.md) - -### Functions - -- [hasSession](verida_account_web_vault.md#hassession) - -## Functions - -### hasSession - -▸ **hasSession**(`contextName`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contextName` | `string` | - -#### Returns - -`boolean` - -#### Defined in - -[packages/account-web-vault/src/vault-account.ts:57](https://github.com/verida/verida-js/blob/5040472/packages/account-web-vault/src/vault-account.ts#L57) diff --git a/docs/api/verida-js/modules/verida_client_ts.ContextInterfaces.md b/docs/api/verida-js/modules/verida_client_ts.ContextInterfaces.md deleted file mode 100644 index 7cead54..0000000 --- a/docs/api/verida-js/modules/verida_client_ts.ContextInterfaces.md +++ /dev/null @@ -1,20 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](verida_client_ts.md) / ContextInterfaces - -# Namespace: ContextInterfaces - -[@verida/client-ts](verida_client_ts.md).ContextInterfaces - -## Table of contents - -### Enumerations - -- [PermissionOptionsEnum](../enums/verida_client_ts.ContextInterfaces.PermissionOptionsEnum.md) - -### Interfaces - -- [DatabaseOpenConfig](../interfaces/verida_client_ts.ContextInterfaces.DatabaseOpenConfig.md) -- [DatastoreOpenConfig](../interfaces/verida_client_ts.ContextInterfaces.DatastoreOpenConfig.md) -- [MessageSendConfig](../interfaces/verida_client_ts.ContextInterfaces.MessageSendConfig.md) -- [MessagesConfig](../interfaces/verida_client_ts.ContextInterfaces.MessagesConfig.md) -- [PermissionsConfig](../interfaces/verida_client_ts.ContextInterfaces.PermissionsConfig.md) -- [StorageEngineTypes](../interfaces/verida_client_ts.ContextInterfaces.StorageEngineTypes.md) diff --git a/docs/api/verida-js/modules/verida_client_ts.DbRegistry.md b/docs/api/verida-js/modules/verida_client_ts.DbRegistry.md deleted file mode 100644 index d3b65da..0000000 --- a/docs/api/verida-js/modules/verida_client_ts.DbRegistry.md +++ /dev/null @@ -1,16 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](verida_client_ts.md) / DbRegistry - -# Namespace: DbRegistry - -[@verida/client-ts](verida_client_ts.md).DbRegistry - -## Table of contents - -### Modules Classes - -- [default](../classes/verida_client_ts.DbRegistry.default.md) - -### Interfaces - -- [DbRegistryEntry](../interfaces/verida_client_ts.DbRegistry.DbRegistryEntry.md) -- [DbRegistryEntryEncryptionKey](../interfaces/verida_client_ts.DbRegistry.DbRegistryEntryEncryptionKey.md) diff --git a/docs/api/verida-js/modules/verida_client_ts.Utils.md b/docs/api/verida-js/modules/verida_client_ts.Utils.md deleted file mode 100644 index 9360cad..0000000 --- a/docs/api/verida-js/modules/verida_client_ts.Utils.md +++ /dev/null @@ -1,85 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](verida_client_ts.md) / Utils - -# Namespace: Utils - -[@verida/client-ts](verida_client_ts.md).Utils - -## Table of contents - -### Functions - -- [buildVeridaUri](verida_client_ts.Utils.md#buildveridauri) -- [explodeVeridaUri](verida_client_ts.Utils.md#explodeveridauri) -- [fetchVeridaUri](verida_client_ts.Utils.md#fetchveridauri) - -## Functions - -### buildVeridaUri - -▸ **buildVeridaUri**(`did`, `contextName`, `databaseName`, `itemId?`, `params?`): `string` - -Build a URI that represents a specific record in a database - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did` | `string` | -| `contextName` | `string` | -| `databaseName` | `string` | -| `itemId?` | `string` | -| `params?` | `Object` | -| `params.key?` | `string` | - -#### Returns - -`string` - -#### Defined in - -[packages/client-ts/src/utils.ts:17](https://github.com/verida/verida-js/blob/c03b336/packages/client-ts/src/utils.ts#L17) - -___ - -### explodeVeridaUri - -▸ **explodeVeridaUri**(`uri`): [`FetchUriParams`](../interfaces/verida_client_ts._internal_.FetchUriParams.md) - -Explode a Verida URI into it's individual pieces - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `uri` | `string` | - -#### Returns - -[`FetchUriParams`](../interfaces/verida_client_ts._internal_.FetchUriParams.md) - -#### Defined in - -[packages/client-ts/src/utils.ts:50](https://github.com/verida/verida-js/blob/c03b336/packages/client-ts/src/utils.ts#L50) - -___ - -### fetchVeridaUri - -▸ **fetchVeridaUri**(`uri`, `context`): `Promise`<`string`\> - -Fetch the data accessible from a Verida URI - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `uri` | `string` | Verida URI of the record to access | -| `context` | `any` | An existing context used to open the external database | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -[packages/client-ts/src/utils.ts:82](https://github.com/verida/verida-js/blob/c03b336/packages/client-ts/src/utils.ts#L82) diff --git a/docs/api/verida-js/modules/verida_client_ts._internal_.EventEmitter.md b/docs/api/verida-js/modules/verida_client_ts._internal_.EventEmitter.md deleted file mode 100644 index 1babf15..0000000 --- a/docs/api/verida-js/modules/verida_client_ts._internal_.EventEmitter.md +++ /dev/null @@ -1,21 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](verida_client_ts.md) / [](verida_client_ts._internal_.md) / EventEmitter - -# Namespace: EventEmitter - -[@verida/client-ts](verida_client_ts.md).[](verida_client_ts._internal_.md).EventEmitter - -## Table of contents - -### References - -- [EventEmitter](verida_client_ts._internal_.EventEmitter.md#eventemitter) - -### Interfaces - -- [Abortable](../interfaces/verida_client_ts._internal_.EventEmitter.Abortable.md) - -## References - -### EventEmitter - -Re-exports [EventEmitter](../classes/verida_client_ts._internal_.EventEmitter-1.md) diff --git a/docs/api/verida-js/modules/verida_client_ts._internal_.md b/docs/api/verida-js/modules/verida_client_ts._internal_.md deleted file mode 100644 index 62470b0..0000000 --- a/docs/api/verida-js/modules/verida_client_ts._internal_.md +++ /dev/null @@ -1,1609 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/client-ts](verida_client_ts.md) / - -# Namespace: - -[@verida/client-ts](verida_client_ts.md). - -## Table of contents - -### Namespaces - -- [EventEmitter](verida_client_ts._internal_.EventEmitter.md) - -### Enumerations - -- [ContextEngineType](../enums/verida_client_ts._internal_.ContextEngineType.md) -- [DatabasePermissionOptionsEnum](../enums/verida_client_ts._internal_.DatabasePermissionOptionsEnum.md) -- [EnvironmentType](../enums/verida_client_ts._internal_.EnvironmentType.md) -- [SecureContextEndpointType](../enums/verida_client_ts._internal_.SecureContextEndpointType.md) -- [Type](../enums/verida_client_ts._internal_.Type.md) -- [UsedValueState](../enums/verida_client_ts._internal_.UsedValueState.md) - -### Modules Classes - -- [DIDContextManager](../classes/verida_client_ts._internal_.DIDContextManager.md) -- [Datastore](../classes/verida_client_ts._internal_.Datastore.md) -- [DbRegistry](../classes/verida_client_ts._internal_.DbRegistry.md) -- [Profile](../classes/verida_client_ts._internal_.Profile.md) -- [Schema](../classes/verida_client_ts._internal_.Schema.md) - -### Other Classes - -- [Ajv2020](../classes/verida_client_ts._internal_.Ajv2020.md) -- [BigNumber](../classes/verida_client_ts._internal_.BigNumber.md) -- [CodeGen](../classes/verida_client_ts._internal_.CodeGen.md) -- [DIDClient](../classes/verida_client_ts._internal_.DIDClient.md) -- [Description](../classes/verida_client_ts._internal_.Description.md) -- [EventEmitter](../classes/verida_client_ts._internal_.EventEmitter-1.md) -- [ForkEvent](../classes/verida_client_ts._internal_.ForkEvent.md) -- [KeywordCxt](../classes/verida_client_ts._internal_.KeywordCxt.md) -- [Name](../classes/verida_client_ts._internal_.Name.md) -- [Provider](../classes/verida_client_ts._internal_.Provider.md) -- [SchemaEnv](../classes/verida_client_ts._internal_.SchemaEnv.md) -- [Scope](../classes/verida_client_ts._internal_.Scope.md) -- [Signer](../classes/verida_client_ts._internal_.Signer.md) -- [ValueScope](../classes/verida_client_ts._internal_.ValueScope.md) -- [ValueScopeName](../classes/verida_client_ts._internal_.ValueScopeName.md) -- [VeridaNameClient](../classes/verida_client_ts._internal_.VeridaNameClient.md) -- [\_Code](../classes/verida_client_ts._internal_._Code.md) -- [\_CodeOrName](../classes/verida_client_ts._internal_._CodeOrName.md) -- [default](../classes/verida_client_ts._internal_.default.md) -- [default](../classes/verida_client_ts._internal_.default-1.md) -- [default](../classes/verida_client_ts._internal_.default-2.md) -- [default](../classes/verida_client_ts._internal_.default-3.md) -- [default](../classes/verida_client_ts._internal_.default-4.md) -- [default](../classes/verida_client_ts._internal_.default-5.md) - -### Interfaces - -- [AbortSignal](../interfaces/verida_client_ts._internal_.AbortSignal.md) -- [AccountConfig](../interfaces/verida_client_ts._internal_.AccountConfig.md) -- [ArrayLike](../interfaces/verida_client_ts._internal_.ArrayLike.md) -- [AsyncFormatDefinition](../interfaces/verida_client_ts._internal_.AsyncFormatDefinition.md) -- [AsyncIterableIterator](../interfaces/verida_client_ts._internal_.AsyncIterableIterator.md) -- [AsyncIterator](../interfaces/verida_client_ts._internal_.AsyncIterator.md) -- [AsyncSchema](../interfaces/verida_client_ts._internal_.AsyncSchema.md) -- [AsyncValidateFunction](../interfaces/verida_client_ts._internal_.AsyncValidateFunction.md) -- [AuthContext](../interfaces/verida_client_ts._internal_.AuthContext.md) -- [AuthTypeConfig](../interfaces/verida_client_ts._internal_.AuthTypeConfig.md) -- [Block](../interfaces/verida_client_ts._internal_.Block.md) -- [BlockWithTransactions](../interfaces/verida_client_ts._internal_.BlockWithTransactions.md) -- [BoxKeyPair](../interfaces/verida_client_ts._internal_.BoxKeyPair.md) -- [CallSite](../interfaces/verida_client_ts._internal_.CallSite.md) -- [ClientConfig](../interfaces/verida_client_ts._internal_.ClientConfig.md) -- [CodeGenOptions](../interfaces/verida_client_ts._internal_.CodeGenOptions.md) -- [CodeKeywordDefinition](../interfaces/verida_client_ts._internal_.CodeKeywordDefinition.md) -- [CodeOptions](../interfaces/verida_client_ts._internal_.CodeOptions.md) -- [ContextCloseOptions](../interfaces/verida_client_ts._internal_.ContextCloseOptions.md) -- [ContextConfig](../interfaces/verida_client_ts._internal_.ContextConfig.md) -- [ContextDatabaseInfo](../interfaces/verida_client_ts._internal_.ContextDatabaseInfo.md) -- [ContextInfo](../interfaces/verida_client_ts._internal_.ContextInfo.md) -- [CurrentOptions](../interfaces/verida_client_ts._internal_.CurrentOptions.md) -- [DIDClientConfig](../interfaces/verida_client_ts._internal_.DIDClientConfig.md) -- [DIDContextConfigs](../interfaces/verida_client_ts._internal_.DIDContextConfigs.md) -- [DOMEventTarget](../interfaces/verida_client_ts._internal_.DOMEventTarget.md) -- [DataValidateFunction](../interfaces/verida_client_ts._internal_.DataValidateFunction.md) -- [DataValidationCxt](../interfaces/verida_client_ts._internal_.DataValidationCxt.md) -- [DatabaseCloseOptions](../interfaces/verida_client_ts._internal_.DatabaseCloseOptions.md) -- [DatabaseDeleteConfig](../interfaces/verida_client_ts._internal_.DatabaseDeleteConfig.md) -- [DatabaseEngines](../interfaces/verida_client_ts._internal_.DatabaseEngines.md) -- [DatabaseOpenConfig](../interfaces/verida_client_ts._internal_.DatabaseOpenConfig.md) -- [DatabasePermissionsConfig](../interfaces/verida_client_ts._internal_.DatabasePermissionsConfig.md) -- [DatastoreOpenConfig](../interfaces/verida_client_ts._internal_.DatastoreOpenConfig.md) -- [DbRegistryEntry](../interfaces/verida_client_ts._internal_.DbRegistryEntry.md) -- [DbRegistryEntryEncryptionKey](../interfaces/verida_client_ts._internal_.DbRegistryEntryEncryptionKey.md) -- [DefaultClientConfig](../interfaces/verida_client_ts._internal_.DefaultClientConfig.md) -- [DefaultEnvironmentConfig](../interfaces/verida_client_ts._internal_.DefaultEnvironmentConfig.md) -- [DeprecatedOptions](../interfaces/verida_client_ts._internal_.DeprecatedOptions.md) -- [EndpointUsage](../interfaces/verida_client_ts._internal_.EndpointUsage.md) -- [Error](../interfaces/verida_client_ts._internal_.Error.md) -- [ErrorObject](../interfaces/verida_client_ts._internal_.ErrorObject.md) -- [ErrorPaths](../interfaces/verida_client_ts._internal_.ErrorPaths.md) -- [ErrorsTextOptions](../interfaces/verida_client_ts._internal_.ErrorsTextOptions.md) -- [Evaluated](../interfaces/verida_client_ts._internal_.Evaluated.md) -- [EventEmitterOptions](../interfaces/verida_client_ts._internal_.EventEmitterOptions.md) -- [EventFilter](../interfaces/verida_client_ts._internal_.EventFilter.md) -- [FeeData](../interfaces/verida_client_ts._internal_.FeeData.md) -- [Filter](../interfaces/verida_client_ts._internal_.Filter.md) -- [FormatDefinition](../interfaces/verida_client_ts._internal_.FormatDefinition.md) -- [FuncKeywordDefinition](../interfaces/verida_client_ts._internal_.FuncKeywordDefinition.md) -- [Hexable](../interfaces/verida_client_ts._internal_.Hexable.md) -- [IAccount](../interfaces/verida_client_ts._internal_.IAccount.md) -- [IClient](../interfaces/verida_client_ts._internal_.IClient.md) -- [IContext](../interfaces/verida_client_ts._internal_.IContext.md) -- [IDIDClient](../interfaces/verida_client_ts._internal_.IDIDClient.md) -- [IDIDContextManager](../interfaces/verida_client_ts._internal_.IDIDContextManager.md) -- [IDIDDocument](../interfaces/verida_client_ts._internal_.IDIDDocument.md) -- [IDatabase](../interfaces/verida_client_ts._internal_.IDatabase.md) -- [IDatastore](../interfaces/verida_client_ts._internal_.IDatastore.md) -- [IDbRegistry](../interfaces/verida_client_ts._internal_.IDbRegistry.md) -- [IKeyring](../interfaces/verida_client_ts._internal_.IKeyring.md) -- [IMessaging](../interfaces/verida_client_ts._internal_.IMessaging.md) -- [INotification](../interfaces/verida_client_ts._internal_.INotification.md) -- [IProfile](../interfaces/verida_client_ts._internal_.IProfile.md) -- [ISchema](../interfaces/verida_client_ts._internal_.ISchema.md) -- [IStorageEngine](../interfaces/verida_client_ts._internal_.IStorageEngine.md) -- [InstanceCodeOptions](../interfaces/verida_client_ts._internal_.InstanceCodeOptions.md) -- [IteratorReturnResult](../interfaces/verida_client_ts._internal_.IteratorReturnResult.md) -- [IteratorYieldResult](../interfaces/verida_client_ts._internal_.IteratorYieldResult.md) -- [JsonWebKey](../interfaces/verida_client_ts._internal_.JsonWebKey.md) -- [KeyringPublicKeys](../interfaces/verida_client_ts._internal_.KeyringPublicKeys.md) -- [KeywordErrorCxt](../interfaces/verida_client_ts._internal_.KeywordErrorCxt.md) -- [KeywordErrorDefinition](../interfaces/verida_client_ts._internal_.KeywordErrorDefinition.md) -- [Log](../interfaces/verida_client_ts._internal_.Log.md) -- [Logger](../interfaces/verida_client_ts._internal_.Logger.md) -- [MacroKeywordDefinition](../interfaces/verida_client_ts._internal_.MacroKeywordDefinition.md) -- [MessageSendConfig](../interfaces/verida_client_ts._internal_.MessageSendConfig.md) -- [MessagesConfig](../interfaces/verida_client_ts._internal_.MessagesConfig.md) -- [NameValue](../interfaces/verida_client_ts._internal_.NameValue.md) -- [NetworkConnectionConfig](../interfaces/verida_client_ts._internal_.NetworkConnectionConfig.md) -- [NodeEventTarget](../interfaces/verida_client_ts._internal_.NodeEventTarget.md) -- [Number](../interfaces/verida_client_ts._internal_.Number.md) -- [NumberKeywords](../interfaces/verida_client_ts._internal_.NumberKeywords.md) -- [OnceBlockable](../interfaces/verida_client_ts._internal_.OnceBlockable.md) -- [ProfileDocument](../interfaces/verida_client_ts._internal_.ProfileDocument.md) -- [PromiseLike](../interfaces/verida_client_ts._internal_.PromiseLike.md) -- [ProofInterface](../interfaces/verida_client_ts._internal_.ProofInterface.md) -- [RegExpEngine](../interfaces/verida_client_ts._internal_.RegExpEngine.md) -- [RegExpLike](../interfaces/verida_client_ts._internal_.RegExpLike.md) -- [Rule](../interfaces/verida_client_ts._internal_.Rule.md) -- [RuleGroup](../interfaces/verida_client_ts._internal_.RuleGroup.md) -- [SchemaCxt](../interfaces/verida_client_ts._internal_.SchemaCxt.md) -- [SchemaEnvArgs](../interfaces/verida_client_ts._internal_.SchemaEnvArgs.md) -- [SchemaObjCxt](../interfaces/verida_client_ts._internal_.SchemaObjCxt.md) -- [SchemaObject](../interfaces/verida_client_ts._internal_.SchemaObject.md) -- [SchemaValidateFunction](../interfaces/verida_client_ts._internal_.SchemaValidateFunction.md) -- [ScopeOptions](../interfaces/verida_client_ts._internal_.ScopeOptions.md) -- [ScopePath](../interfaces/verida_client_ts._internal_.ScopePath.md) -- [SecureContextConfig](../interfaces/verida_client_ts._internal_.SecureContextConfig.md) -- [SecureContextEndpoint](../interfaces/verida_client_ts._internal_.SecureContextEndpoint.md) -- [SecureContextEndpoints](../interfaces/verida_client_ts._internal_.SecureContextEndpoints.md) -- [SecureContextPublicKey](../interfaces/verida_client_ts._internal_.SecureContextPublicKey.md) -- [SecureContextServices](../interfaces/verida_client_ts._internal_.SecureContextServices.md) -- [SecureStorageContextPublicKeys](../interfaces/verida_client_ts._internal_.SecureStorageContextPublicKeys.md) -- [Service](../interfaces/verida_client_ts._internal_.Service.md) -- [SignKeyPair](../interfaces/verida_client_ts._internal_.SignKeyPair.md) -- [SourceCode](../interfaces/verida_client_ts._internal_.SourceCode.md) -- [StaticEventEmitterOptions](../interfaces/verida_client_ts._internal_.StaticEventEmitterOptions.md) -- [StringKeywords](../interfaces/verida_client_ts._internal_.StringKeywords.md) -- [Transaction](../interfaces/verida_client_ts._internal_.Transaction.md) -- [TransactionReceipt](../interfaces/verida_client_ts._internal_.TransactionReceipt.md) -- [TransactionResponse](../interfaces/verida_client_ts._internal_.TransactionResponse.md) -- [URIComponents](../interfaces/verida_client_ts._internal_.URIComponents.md) -- [UriResolver](../interfaces/verida_client_ts._internal_.UriResolver.md) -- [VSOptions](../interfaces/verida_client_ts._internal_.VSOptions.md) -- [ValidateFunction](../interfaces/verida_client_ts._internal_.ValidateFunction.md) -- [ValidationRules](../interfaces/verida_client_ts._internal_.ValidationRules.md) -- [ValueScopeOptions](../interfaces/verida_client_ts._internal_.ValueScopeOptions.md) -- [VdaClientConfig](../interfaces/verida_client_ts._internal_.VdaClientConfig.md) -- [VdaDidEndpointResponse](../interfaces/verida_client_ts._internal_.VdaDidEndpointResponse.md) -- [VeridaDocInterface](../interfaces/verida_client_ts._internal_.VeridaDocInterface.md) -- [VerificationMethod](../interfaces/verida_client_ts._internal_.VerificationMethod.md) -- [Web3GasConfiguration](../interfaces/verida_client_ts._internal_.Web3GasConfiguration.md) -- [Web3GaslessPostConfig](../interfaces/verida_client_ts._internal_.Web3GaslessPostConfig.md) -- [Web3GaslessRequestConfig](../interfaces/verida_client_ts._internal_.Web3GaslessRequestConfig.md) -- [Web3MetaTransactionConfig](../interfaces/verida_client_ts._internal_.Web3MetaTransactionConfig.md) -- [Web3SelfTransactionConfig](../interfaces/verida_client_ts._internal_.Web3SelfTransactionConfig.md) -- [Web3SelfTransactionConfigPart](../interfaces/verida_client_ts._internal_.Web3SelfTransactionConfigPart.md) -- [\_Block](../interfaces/verida_client_ts._internal_._Block.md) -- [\_KeywordDef](../interfaces/verida_client_ts._internal_._KeywordDef.md) -- [\_SchemaObject](../interfaces/verida_client_ts._internal_._SchemaObject.md) - -### Type aliases - -- [AccessList](verida_client_ts._internal_.md#accesslist) -- [AccessListish](verida_client_ts._internal_.md#accesslistish) -- [AddedFormat](verida_client_ts._internal_.md#addedformat) -- [AddedKeywordDefinition](verida_client_ts._internal_.md#addedkeyworddefinition) -- [AnySchema](verida_client_ts._internal_.md#anyschema) -- [AnySchemaObject](verida_client_ts._internal_.md#anyschemaobject) -- [AnyValidateFunction](verida_client_ts._internal_.md#anyvalidatefunction) -- [AsyncFormatValidator](verida_client_ts._internal_.md#asyncformatvalidator) -- [BigNumberish](verida_client_ts._internal_.md#bignumberish) -- [Block](verida_client_ts._internal_.md#block) -- [BlockTag](verida_client_ts._internal_.md#blocktag) -- [Bytes](verida_client_ts._internal_.md#bytes) -- [BytesLike](verida_client_ts._internal_.md#byteslike) -- [Code](verida_client_ts._internal_.md#code) -- [CodeItem](verida_client_ts._internal_.md#codeitem) -- [CompileKeywordFunc](verida_client_ts._internal_.md#compilekeywordfunc) -- [DIDDocument](verida_client_ts._internal_.md#diddocument) -- [Deferrable](verida_client_ts._internal_.md#deferrable) -- [EIP1559GasMode](verida_client_ts._internal_.md#eip1559gasmode) -- [EnumString](verida_client_ts._internal_.md#enumstring) -- [EvaluatedItems](verida_client_ts._internal_.md#evaluateditems) -- [EvaluatedProperties](verida_client_ts._internal_.md#evaluatedproperties) -- [EventType](verida_client_ts._internal_.md#eventtype) -- [Exclude](verida_client_ts._internal_.md#exclude) -- [Extensible](verida_client_ts._internal_.md#extensible) -- [Format](verida_client_ts._internal_.md#format) -- [FormatCompare](verida_client_ts._internal_.md#formatcompare) -- [FormatValidator](verida_client_ts._internal_.md#formatvalidator) -- [InstanceOptions](verida_client_ts._internal_.md#instanceoptions) -- [IsElements](verida_client_ts._internal_.md#iselements) -- [IsEmptyRecord](verida_client_ts._internal_.md#isemptyrecord) -- [IsEnum](verida_client_ts._internal_.md#isenum) -- [IsRecord](verida_client_ts._internal_.md#isrecord) -- [IsUnion](verida_client_ts._internal_.md#isunion) -- [IsUnion\_](verida_client_ts._internal_.md#isunion_) -- [IsValues](verida_client_ts._internal_.md#isvalues) -- [IteratorResult](verida_client_ts._internal_.md#iteratorresult) -- [JSONType](verida_client_ts._internal_.md#jsontype) -- [JSONType](verida_client_ts._internal_.md#jsontype) -- [JTDDataDef](verida_client_ts._internal_.md#jtddatadef) -- [JTDDataType](verida_client_ts._internal_.md#jtddatatype) -- [JTDSchemaType](verida_client_ts._internal_.md#jtdschematype) -- [KeyCapabilitySection](verida_client_ts._internal_.md#keycapabilitysection) -- [KeywordCxtParams](verida_client_ts._internal_.md#keywordcxtparams) -- [KeywordDefinition](verida_client_ts._internal_.md#keyworddefinition) -- [Known](verida_client_ts._internal_.md#known) -- [Listener](verida_client_ts._internal_.md#listener) -- [LocalRefs](verida_client_ts._internal_.md#localrefs) -- [MacroKeywordFunc](verida_client_ts._internal_.md#macrokeywordfunc) -- [Network](verida_client_ts._internal_.md#network) -- [NonNullable](verida_client_ts._internal_.md#nonnullable) -- [NullTypeEquality](verida_client_ts._internal_.md#nulltypeequality) -- [Nullable](verida_client_ts._internal_.md#nullable) -- [NumberType](verida_client_ts._internal_.md#numbertype) -- [Omit](verida_client_ts._internal_.md#omit) -- [OptionalKeys](verida_client_ts._internal_.md#optionalkeys) -- [Options](verida_client_ts._internal_.md#options) -- [Partial](verida_client_ts._internal_.md#partial) -- [Pick](verida_client_ts._internal_.md#pick) -- [Readonly](verida_client_ts._internal_.md#readonly) -- [Record](verida_client_ts._internal_.md#record) -- [RequiredInstanceOptions](verida_client_ts._internal_.md#requiredinstanceoptions) -- [RequiredKeys](verida_client_ts._internal_.md#requiredkeys) -- [SafeExpr](verida_client_ts._internal_.md#safeexpr) -- [Schema](verida_client_ts._internal_.md#schema) -- [SchemaRefs](verida_client_ts._internal_.md#schemarefs) -- [ScopeStore](verida_client_ts._internal_.md#scopestore) -- [ScopeValueSets](verida_client_ts._internal_.md#scopevaluesets) -- [ScopeValues](verida_client_ts._internal_.md#scopevalues) -- [ServiceEndpoint](verida_client_ts._internal_.md#serviceendpoint) -- [SomeJTDSchemaType](verida_client_ts._internal_.md#somejtdschematype) -- [StringType](verida_client_ts._internal_.md#stringtype) -- [TransactionRequest](verida_client_ts._internal_.md#transactionrequest) -- [TypeEquality](verida_client_ts._internal_.md#typeequality) -- [UncheckedJSONSchemaType](verida_client_ts._internal_.md#uncheckedjsonschematype) -- [UncheckedPartialSchema](verida_client_ts._internal_.md#uncheckedpartialschema) -- [UncheckedPropertiesSchema](verida_client_ts._internal_.md#uncheckedpropertiesschema) -- [UncheckedRequiredMembers](verida_client_ts._internal_.md#uncheckedrequiredmembers) -- [UnionToIntersection](verida_client_ts._internal_.md#uniontointersection) -- [UsedNames](verida_client_ts._internal_.md#usednames) -- [UsedScopeValues](verida_client_ts._internal_.md#usedscopevalues) -- [ValidationTypes](verida_client_ts._internal_.md#validationtypes) -- [ValueReference](verida_client_ts._internal_.md#valuereference) -- [VdaDidEndpointResponses](verida_client_ts._internal_.md#vdadidendpointresponses) -- [Vocabulary](verida_client_ts._internal_.md#vocabulary) -- [Web3CallType](verida_client_ts._internal_.md#web3calltype) - -### Variables - -- [AbortSignal](verida_client_ts._internal_.md#abortsignal) -- [Error](verida_client_ts._internal_.md#error) -- [EventEmitter](verida_client_ts._internal_.md#eventemitter) -- [Number](verida_client_ts._internal_.md#number) -- [\_jsonTypes](verida_client_ts._internal_.md#_jsontypes) - -## Type aliases - -### AccessList - -Ƭ **AccessList**: { `address`: `string` ; `storageKeys`: `string`[] }[] - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:3 - -___ - -### AccessListish - -Ƭ **AccessListish**: [`AccessList`](verida_client_ts._internal_.md#accesslist) \| [`string`, `string`[]][] \| [`Record`](verida_client_ts._internal_.md#record)<`string`, `string`[]\> - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:7 - -___ - -### AddedFormat - -Ƭ **AddedFormat**: ``true`` \| `RegExp` \| [`FormatValidator`](verida_client_ts._internal_.md#formatvalidator)<`string`\> \| [`FormatDefinition`](../interfaces/verida_client_ts._internal_.FormatDefinition.md)<`string`\> \| [`FormatDefinition`](../interfaces/verida_client_ts._internal_.FormatDefinition.md)<`number`\> \| [`AsyncFormatDefinition`](../interfaces/verida_client_ts._internal_.AsyncFormatDefinition.md)<`string`\> \| [`AsyncFormatDefinition`](../interfaces/verida_client_ts._internal_.AsyncFormatDefinition.md)<`number`\> - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:169 - -___ - -### AddedKeywordDefinition - -Ƭ **AddedKeywordDefinition**: [`KeywordDefinition`](verida_client_ts._internal_.md#keyworddefinition) & { `schemaType`: [`JSONType`](verida_client_ts._internal_.md#jsontype)[] ; `type`: [`JSONType`](verida_client_ts._internal_.md#jsontype)[] } - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:128 - -___ - -### AnySchema - -Ƭ **AnySchema**: [`Schema`](verida_client_ts._internal_.md#schema) \| [`AsyncSchema`](../interfaces/verida_client_ts._internal_.AsyncSchema.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:25 - -___ - -### AnySchemaObject - -Ƭ **AnySchemaObject**: [`SchemaObject`](../interfaces/verida_client_ts._internal_.SchemaObject.md) \| [`AsyncSchema`](../interfaces/verida_client_ts._internal_.AsyncSchema.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:23 - -___ - -### AnyValidateFunction - -Ƭ **AnyValidateFunction**<`T`\>: [`ValidateFunction`](../interfaces/verida_client_ts._internal_.ValidateFunction.md)<`T`\> \| [`AsyncValidateFunction`](../interfaces/verida_client_ts._internal_.AsyncValidateFunction.md)<`T`\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `any` | - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:73 - -___ - -### AsyncFormatValidator - -Ƭ **AsyncFormatValidator**<`T`\>: (`data`: `T`) => `Promise`<`boolean`\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | extends `string` \| `number` | - -#### Type declaration - -▸ (`data`): `Promise`<`boolean`\> - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `T` | - -##### Returns - -`Promise`<`boolean`\> - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:156 - -___ - -### BigNumberish - -Ƭ **BigNumberish**: [`BigNumber`](../classes/verida_client_ts._internal_.BigNumber.md) \| [`Bytes`](verida_client_ts._internal_.md#bytes) \| `bigint` \| `string` \| `number` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:2 - -___ - -### Block - -Ƭ **Block**: [`Code`](verida_client_ts._internal_.md#code) \| () => `void` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/index.d.ts:7 - -___ - -### BlockTag - -Ƭ **BlockTag**: `string` \| `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:33 - -___ - -### Bytes - -Ƭ **Bytes**: [`ArrayLike`](../interfaces/verida_client_ts._internal_.ArrayLike.md)<`number`\> - -#### Defined in - -node_modules/@ethersproject/bytes/lib/index.d.ts:1 - -___ - -### BytesLike - -Ƭ **BytesLike**: [`Bytes`](verida_client_ts._internal_.md#bytes) \| `string` - -#### Defined in - -node_modules/@ethersproject/bytes/lib/index.d.ts:2 - -___ - -### Code - -Ƭ **Code**: [`_Code`](../classes/verida_client_ts._internal_._Code.md) \| [`Name`](../classes/verida_client_ts._internal_.Name.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/code.d.ts:27 - -___ - -### CodeItem - -Ƭ **CodeItem**: [`Name`](../classes/verida_client_ts._internal_.Name.md) \| `string` \| `number` \| `boolean` \| ``null`` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/code.d.ts:25 - -___ - -### CompileKeywordFunc - -Ƭ **CompileKeywordFunc**: (`schema`: `any`, `parentSchema`: [`AnySchemaObject`](verida_client_ts._internal_.md#anyschemaobject), `it`: [`SchemaObjCxt`](../interfaces/verida_client_ts._internal_.SchemaObjCxt.md)) => [`DataValidateFunction`](../interfaces/verida_client_ts._internal_.DataValidateFunction.md) - -#### Type declaration - -▸ (`schema`, `parentSchema`, `it`): [`DataValidateFunction`](../interfaces/verida_client_ts._internal_.DataValidateFunction.md) - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `schema` | `any` | -| `parentSchema` | [`AnySchemaObject`](verida_client_ts._internal_.md#anyschemaobject) | -| `it` | [`SchemaObjCxt`](../interfaces/verida_client_ts._internal_.SchemaObjCxt.md) | - -##### Returns - -[`DataValidateFunction`](../interfaces/verida_client_ts._internal_.DataValidateFunction.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:106 - -___ - -### DIDDocument - -Ƭ **DIDDocument**: { `@context?`: ``"https://www.w3.org/ns/did/v1"`` \| `string` \| `string`[] ; `alsoKnownAs?`: `string`[] ; `controller?`: `string` \| `string`[] ; `id`: `string` ; `publicKey?`: [`VerificationMethod`](../interfaces/verida_client_ts._internal_.VerificationMethod.md)[] ; `service?`: [`Service`](../interfaces/verida_client_ts._internal_.Service.md)[] ; `verificationMethod?`: [`VerificationMethod`](../interfaces/verida_client_ts._internal_.VerificationMethod.md)[] } & { [x in KeyCapabilitySection]?: (string \| VerificationMethod)[] } - -Represents a DID document. - -**`see`** [https://www.w3.org/TR/did-core/#did-document-properties](https://www.w3.org/TR/did-core/#did-document-properties) - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:60 - -___ - -### Deferrable - -Ƭ **Deferrable**<`T`\>: { [K in keyof T]: T[K] \| Promise } - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Defined in - -node_modules/@ethersproject/properties/lib/index.d.ts:3 - -___ - -### EIP1559GasMode - -Ƭ **EIP1559GasMode**: ``"safeLow"`` \| ``"standard"`` \| ``"fast"`` - -EIP1559 Gas Configuration speed - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:13 - -___ - -### EnumString - -Ƭ **EnumString**<`T`\>: [`T`] extends [`never`] ? ``null`` : `T` extends `string` ? `string` extends `T` ? ``null`` : `T` : ``null`` - -gets only the string literals of a type or null if a type isn't a string literal - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/jtd-schema.d.ts:49 - -___ - -### EvaluatedItems - -Ƭ **EvaluatedItems**: `number` \| ``true`` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:62 - -___ - -### EvaluatedProperties - -Ƭ **EvaluatedProperties**: { [K in string]?: true } \| ``true`` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:59 - -___ - -### EventType - -Ƭ **EventType**: `string` \| (`string` \| `string`[])[] \| [`EventFilter`](../interfaces/verida_client_ts._internal_.EventFilter.md) \| [`ForkEvent`](../classes/verida_client_ts._internal_.ForkEvent.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:121 - -___ - -### Exclude - -Ƭ **Exclude**<`T`, `U`\>: `T` extends `U` ? `never` : `T` - -Exclude from T those types that are assignable to U - -#### Type parameters - -| Name | -| :------ | -| `T` | -| `U` | - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1506 - -___ - -### Extensible - -Ƭ **Extensible**: [`Record`](verida_client_ts._internal_.md#record)<`string`, `any`\> - -Defines an object type that can be extended with other properties. - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:4 - -___ - -### Format - -Ƭ **Format**: [`AddedFormat`](verida_client_ts._internal_.md#addedformat) \| `string` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:170 - -___ - -### FormatCompare - -Ƭ **FormatCompare**<`T`\>: (`data1`: `T`, `data2`: `T`) => `number` \| `undefined` - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | extends `string` \| `number` | - -#### Type declaration - -▸ (`data1`, `data2`): `number` \| `undefined` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `data1` | `T` | -| `data2` | `T` | - -##### Returns - -`number` \| `undefined` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:155 - -___ - -### FormatValidator - -Ƭ **FormatValidator**<`T`\>: (`data`: `T`) => `boolean` - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | extends `string` \| `number` | - -#### Type declaration - -▸ (`data`): `boolean` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `T` | - -##### Returns - -`boolean` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:154 - -___ - -### InstanceOptions - -Ƭ **InstanceOptions**: [`Options`](verida_client_ts._internal_.md#options) & [`RequiredInstanceOptions`](verida_client_ts._internal_.md#requiredinstanceoptions) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:100 - -___ - -### IsElements - -Ƭ **IsElements**<`T`\>: ``false`` extends [`IsUnion`](verida_client_ts._internal_.md#isunion)<`T`\> ? [`T`] extends [readonly `unknown`[]] ? `undefined` extends `T`[``0.5``] ? ``false`` : ``true`` : ``false`` : ``false`` - -true only if all types are array types (not tuples) - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/jtd-schema.d.ts:53 - -___ - -### IsEmptyRecord - -Ƭ **IsEmptyRecord**<`T`\>: [`T`] extends [[`Record`](verida_client_ts._internal_.md#record)<`string`, `never`\>] ? [`T`] extends [`never`] ? ``false`` : ``true`` : ``false`` - -true if type represents an empty record - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/jtd-schema.d.ts:59 - -___ - -### IsEnum - -Ƭ **IsEnum**<`T`\>: ``null`` extends [`EnumString`](verida_client_ts._internal_.md#enumstring)<`T`\> ? ``false`` : ``true`` - -true if type is a union of string literals - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/jtd-schema.d.ts:51 - -___ - -### IsRecord - -Ƭ **IsRecord**<`T`, `Union`\>: `Union` extends [`IsUnion`](verida_client_ts._internal_.md#isunion)<`T`\> ? ``null`` extends [`EnumString`](verida_client_ts._internal_.md#enumstring) ? ``false`` : ``true`` : ``false`` - -true if type is a properties type and Union is false, or type is a discriminator type and Union is true - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `T` | -| `Union` | extends `boolean` | - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/jtd-schema.d.ts:57 - -___ - -### IsUnion - -Ƭ **IsUnion**<`T`\>: [`IsUnion_`](verida_client_ts._internal_.md#isunion_)<`T`\> - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/jtd-schema.d.ts:43 - -___ - -### IsUnion\_ - -Ƭ **IsUnion\_**<`T`, `U`\>: ``false`` extends `T` extends `unknown` ? [`U`] extends [`T`] ? ``false`` : ``true`` : `never` ? ``false`` : ``true`` - -type is true if T is a union type - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `T` | -| `U` | extends `T` = `T` | - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/jtd-schema.d.ts:42 - -___ - -### IsValues - -Ƭ **IsValues**<`T`\>: ``false`` extends [`IsUnion`](verida_client_ts._internal_.md#isunion)<`T`\> ? [`TypeEquality`](verida_client_ts._internal_.md#typeequality) : ``false`` - -true if the the type is a values type - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/jtd-schema.d.ts:55 - -___ - -### IteratorResult - -Ƭ **IteratorResult**<`T`, `TReturn`\>: [`IteratorYieldResult`](../interfaces/verida_client_ts._internal_.IteratorYieldResult.md)<`T`\> \| [`IteratorReturnResult`](../interfaces/verida_client_ts._internal_.IteratorReturnResult.md)<`TReturn`\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `T` | -| `TReturn` | `any` | - -#### Defined in - -node_modules/typescript/lib/lib.es2015.iterable.d.ts:41 - -___ - -### JSONType - -Ƭ **JSONType**: typeof [`_jsonTypes`](verida_client_ts._internal_.md#_jsontypes)[`number`] - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/rules.d.ts:3 - -___ - -### JSONType - -Ƭ **JSONType**<`T`, `IsPartial`\>: `IsPartial` extends ``true`` ? `T` \| `undefined` : `T` - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | extends `string` | -| `IsPartial` | extends `boolean` | - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/json-schema.d.ts:6 - -___ - -### JTDDataDef - -Ƭ **JTDDataDef**<`S`, `D`\>: `S` extends { `ref`: `string` } ? `D` extends { [K in S["ref"]]: infer V } ? [`JTDDataDef`](verida_client_ts._internal_.md#jtddatadef)<`V`, `D`\> : `never` : `S` extends { `type`: [`NumberType`](verida_client_ts._internal_.md#numbertype) } ? `number` : `S` extends { `type`: ``"boolean"`` } ? `boolean` : `S` extends { `type`: ``"string"`` } ? `string` : `S` extends { `type`: ``"timestamp"`` } ? `string` \| `Date` : `S` extends { `enum`: readonly infer E[] } ? `string` extends `E` ? `never` : [`E`] extends [`string`] ? `E` : `never` : `S` extends { `elements`: infer E } ? [`JTDDataDef`](verida_client_ts._internal_.md#jtddatadef)<`E`, `D`\>[] : `S` extends { `additionalProperties?`: `boolean` ; `optionalProperties?`: [`Record`](verida_client_ts._internal_.md#record)<`string`, `unknown`\> ; `properties`: [`Record`](verida_client_ts._internal_.md#record)<`string`, `unknown`\> } ? { -readonly [K in keyof S["properties"]]-?: JTDDataDef } & { -readonly [K in keyof S["optionalProperties"]]?: JTDDataDef } & [`S`[``"additionalProperties"``]] extends [``true``] ? [`Record`](verida_client_ts._internal_.md#record)<`string`, `unknown`\> : `unknown` : `S` extends { `additionalProperties?`: `boolean` ; `optionalProperties`: [`Record`](verida_client_ts._internal_.md#record)<`string`, `unknown`\> ; `properties?`: [`Record`](verida_client_ts._internal_.md#record)<`string`, `unknown`\> } ? { -readonly [K in keyof S["properties"]]-?: JTDDataDef } & { -readonly [K in keyof S["optionalProperties"]]?: JTDDataDef } & [`S`[``"additionalProperties"``]] extends [``true``] ? [`Record`](verida_client_ts._internal_.md#record)<`string`, `unknown`\> : `unknown` : `S` extends { `values`: infer V } ? [`Record`](verida_client_ts._internal_.md#record)<`string`, [`JTDDataDef`](verida_client_ts._internal_.md#jtddatadef)<`V`, `D`\>\> : `S` extends { `discriminator`: infer M ; `mapping`: [`Record`](verida_client_ts._internal_.md#record)<`string`, `unknown`\> } ? [`M`] extends [`string`] ? { [K in keyof S["mapping"]]: JTDDataDef & { [KM in M]: K } }[keyof `S`[``"mapping"``]] : `never` : `unknown` \| `S` extends { `nullable`: ``true`` } ? ``null`` : `never` - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `S` | `S` | -| `D` | extends [`Record`](verida_client_ts._internal_.md#record)<`string`, `unknown`\> | - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/jtd-schema.d.ts:126 - -___ - -### JTDDataType - -Ƭ **JTDDataType**<`S`\>: `S` extends { `definitions`: [`Record`](verida_client_ts._internal_.md#record)<`string`, `unknown`\> } ? [`JTDDataDef`](verida_client_ts._internal_.md#jtddatadef)<`S`, `S`[``"definitions"``]\> : [`JTDDataDef`](verida_client_ts._internal_.md#jtddatadef)<`S`, [`Record`](verida_client_ts._internal_.md#record)<`string`, `never`\>\> - -#### Type parameters - -| Name | -| :------ | -| `S` | - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/jtd-schema.d.ts:171 - -___ - -### JTDSchemaType - -Ƭ **JTDSchemaType**<`T`, `D`\>: ``null`` extends [`EnumString`](verida_client_ts._internal_.md#enumstring) ? `never` : { [K in keyof D]: [T] extends [D[K]] ? Object : never }[keyof `D`] & { `nullable?`: ``false`` } \| ``null`` extends `T` ? { [K in keyof D]: [Exclude] extends [Exclude] ? Object : never }[keyof `D`] & { `nullable`: ``true`` } : `never` \| `unknown` extends `T` ? { `nullable?`: `boolean` } : `never` \| ``true`` extends [`NullTypeEquality`](verida_client_ts._internal_.md#nulltypeequality)<`T`, `number`\> ? { `type`: [`NumberType`](verida_client_ts._internal_.md#numbertype) } : ``true`` extends [`NullTypeEquality`](verida_client_ts._internal_.md#nulltypeequality)<`T`, `boolean`\> ? { `type`: ``"boolean"`` } : ``true`` extends [`NullTypeEquality`](verida_client_ts._internal_.md#nulltypeequality)<`T`, `string`\> ? { `type`: [`StringType`](verida_client_ts._internal_.md#stringtype) } : ``true`` extends [`NullTypeEquality`](verida_client_ts._internal_.md#nulltypeequality)<`T`, `Date`\> ? { `type`: ``"timestamp"`` } : ``true`` extends [`IsEnum`](verida_client_ts._internal_.md#isenum)<[`Exclude`](verida_client_ts._internal_.md#exclude)<`T`, ``null``\>\> ? { `enum`: [`EnumString`](verida_client_ts._internal_.md#enumstring)<[`Exclude`](verida_client_ts._internal_.md#exclude)<`T`, ``null``\>\>[] } : ``true`` extends [`IsElements`](verida_client_ts._internal_.md#iselements)<[`Exclude`](verida_client_ts._internal_.md#exclude)<`T`, ``null``\>\> ? `T` extends readonly infer E[] ? { `elements`: [`JTDSchemaType`](verida_client_ts._internal_.md#jtdschematype)<`E`, `D`\> } : `never` : ``true`` extends [`IsEmptyRecord`](verida_client_ts._internal_.md#isemptyrecord)<[`Exclude`](verida_client_ts._internal_.md#exclude)<`T`, ``null``\>\> ? { `optionalProperties?`: [`Record`](verida_client_ts._internal_.md#record)<`string`, `never`\> ; `properties`: [`Record`](verida_client_ts._internal_.md#record)<`string`, `never`\> } \| { `optionalProperties`: [`Record`](verida_client_ts._internal_.md#record)<`string`, `never`\> } : ``true`` extends [`IsValues`](verida_client_ts._internal_.md#isvalues)<[`Exclude`](verida_client_ts._internal_.md#exclude)<`T`, ``null``\>\> ? `T` extends [`Record`](verida_client_ts._internal_.md#record)<`string`, infer V\> ? { `values`: [`JTDSchemaType`](verida_client_ts._internal_.md#jtdschematype)<`V`, `D`\> } : `never` : ``true`` extends [`IsRecord`](verida_client_ts._internal_.md#isrecord)<[`Exclude`](verida_client_ts._internal_.md#exclude)<`T`, ``null``\>, ``false``\> ? [[`RequiredKeys`](verida_client_ts._internal_.md#requiredkeys)<[`Exclude`](verida_client_ts._internal_.md#exclude)<`T`, ``null``\>\>] extends [`never`] ? { `properties?`: [`Record`](verida_client_ts._internal_.md#record)<`string`, `never`\> } : { `properties`: { [K in RequiredKeys]: JTDSchemaType } } & [[`OptionalKeys`](verida_client_ts._internal_.md#optionalkeys)<[`Exclude`](verida_client_ts._internal_.md#exclude)<`T`, ``null``\>\>] extends [`never`] ? { `optionalProperties?`: [`Record`](verida_client_ts._internal_.md#record)<`string`, `never`\> } : { `optionalProperties`: { [K in OptionalKeys]: JTDSchemaType, D\> } } & { `additionalProperties?`: `boolean` } : ``true`` extends [`IsRecord`](verida_client_ts._internal_.md#isrecord)<[`Exclude`](verida_client_ts._internal_.md#exclude)<`T`, ``null``\>, ``true``\> ? { [K in keyof Exclude]-?: Exclude[K] extends string ? Object : never }[keyof [`Exclude`](verida_client_ts._internal_.md#exclude)<`T`, ``null``\>] : `never` & ``null`` extends `T` ? { `nullable`: ``true`` } : { `nullable?`: ``false`` } & { `definitions?`: { [K in keyof D]: JTDSchemaType } ; `metadata?`: [`Record`](verida_client_ts._internal_.md#record)<`string`, `unknown`\> } - -actual schema - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `T` | -| `D` | extends [`Record`](verida_client_ts._internal_.md#record)<`string`, `unknown`\> = [`Record`](verida_client_ts._internal_.md#record)<`string`, `never`\> | - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/jtd-schema.d.ts:61 - -___ - -### KeyCapabilitySection - -Ƭ **KeyCapabilitySection**: ``"authentication"`` \| ``"assertionMethod"`` \| ``"keyAgreement"`` \| ``"capabilityInvocation"`` \| ``"capabilityDelegation"`` - -Represents the Verification Relationship between a DID subject and a Verification Method. - -**`see`** [https://www.w3.org/TR/did-core/#verification-relationships](https://www.w3.org/TR/did-core/#verification-relationships) - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:54 - -___ - -### KeywordCxtParams - -Ƭ **KeywordCxtParams**: { [P in string]?: Code \| string \| number } - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:151 - -___ - -### KeywordDefinition - -Ƭ **KeywordDefinition**: [`CodeKeywordDefinition`](../interfaces/verida_client_ts._internal_.CodeKeywordDefinition.md) \| [`FuncKeywordDefinition`](../interfaces/verida_client_ts._internal_.FuncKeywordDefinition.md) \| [`MacroKeywordDefinition`](../interfaces/verida_client_ts._internal_.MacroKeywordDefinition.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:127 - -___ - -### Known - -Ƭ **Known**: { `[key: string]`: [`Known`](verida_client_ts._internal_.md#known); } \| [[`Known`](verida_client_ts._internal_.md#known), ...Known[]] \| [`Known`](verida_client_ts._internal_.md#known)[] \| `number` \| `string` \| `boolean` \| ``null`` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/json-schema.d.ts:101 - -___ - -### Listener - -Ƭ **Listener**: (...`args`: `any`[]) => `void` - -#### Type declaration - -▸ (...`args`): `void` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `...args` | `any`[] | - -##### Returns - -`void` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:122 - -___ - -### LocalRefs - -Ƭ **LocalRefs**: { [Ref in string]?: AnySchemaObject } - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/resolve.d.ts:4 - -___ - -### MacroKeywordFunc - -Ƭ **MacroKeywordFunc**: (`schema`: `any`, `parentSchema`: [`AnySchemaObject`](verida_client_ts._internal_.md#anyschemaobject), `it`: [`SchemaCxt`](../interfaces/verida_client_ts._internal_.SchemaCxt.md)) => [`AnySchema`](verida_client_ts._internal_.md#anyschema) - -#### Type declaration - -▸ (`schema`, `parentSchema`, `it`): [`AnySchema`](verida_client_ts._internal_.md#anyschema) - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `schema` | `any` | -| `parentSchema` | [`AnySchemaObject`](verida_client_ts._internal_.md#anyschemaobject) | -| `it` | [`SchemaCxt`](../interfaces/verida_client_ts._internal_.SchemaCxt.md) | - -##### Returns - -[`AnySchema`](verida_client_ts._internal_.md#anyschema) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:105 - -___ - -### Network - -Ƭ **Network**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `chainId` | `number` | -| `ensAddress?` | `string` | -| `name` | `string` | -| `_defaultProvider?` | (`providers`: `any`, `options?`: `any`) => `any` | - -#### Defined in - -node_modules/@ethersproject/networks/lib/types.d.ts:1 - -___ - -### NonNullable - -Ƭ **NonNullable**<`T`\>: `T` extends ``null`` \| `undefined` ? `never` : `T` - -Exclude null and undefined from T - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1521 - -___ - -### NullTypeEquality - -Ƭ **NullTypeEquality**<`T`, `E`\>: [`TypeEquality`](verida_client_ts._internal_.md#typeequality)<`T` \| ``null``, `E` \| ``null``\> - -type is true if T or null is identically E or null - -#### Type parameters - -| Name | -| :------ | -| `T` | -| `E` | - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/jtd-schema.d.ts:47 - -___ - -### Nullable - -Ƭ **Nullable**<`T`\>: `undefined` extends `T` ? { `const?`: ``null`` ; `default?`: `T` \| ``null`` ; `enum?`: [`Readonly`](verida_client_ts._internal_.md#readonly)<(`T` \| ``null``)[]\> ; `nullable`: ``true`` } : { `const?`: `T` ; `default?`: `T` ; `enum?`: [`Readonly`](verida_client_ts._internal_.md#readonly)<`T`[]\> ; `nullable?`: ``false`` } - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/json-schema.d.ts:114 - -___ - -### NumberType - -Ƭ **NumberType**: ``"float32"`` \| ``"float64"`` \| ``"int8"`` \| ``"uint8"`` \| ``"int16"`` \| ``"uint16"`` \| ``"int32"`` \| ``"uint32"`` - -numeric strings - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/jtd-schema.d.ts:2 - -___ - -### Omit - -Ƭ **Omit**<`T`, `K`\>: [`Pick`](verida_client_ts._internal_.md#pick)<`T`, [`Exclude`](verida_client_ts._internal_.md#exclude)\> - -Construct a type with the properties of T except for those in type K. - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `T` | -| `K` | extends keyof `any` | - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1516 - -___ - -### OptionalKeys - -Ƭ **OptionalKeys**<`T`\>: { [K in keyof T]-?: undefined extends T[K] ? K : never }[keyof `T`] - -optional or undifined-able keys of an object - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/jtd-schema.d.ts:38 - -___ - -### Options - -Ƭ **Options**: [`CurrentOptions`](../interfaces/verida_client_ts._internal_.CurrentOptions.md) & [`DeprecatedOptions`](../interfaces/verida_client_ts._internal_.DeprecatedOptions.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:21 - -___ - -### Partial - -Ƭ **Partial**<`T`\>: { [P in keyof T]?: T[P] } - -Make all properties in T optional - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1471 - -___ - -### Pick - -Ƭ **Pick**<`T`, `K`\>: { [P in K]: T[P] } - -From T, pick a set of properties whose keys are in the union K - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `T` | -| `K` | extends keyof `T` | - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1492 - -___ - -### Readonly - -Ƭ **Readonly**<`T`\>: { readonly [P in keyof T]: T[P] } - -Make all properties in T readonly - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1485 - -___ - -### Record - -Ƭ **Record**<`K`, `T`\>: { [P in K]: T } - -Construct a type with a set of properties K of type T - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof `any` | -| `T` | `T` | - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1499 - -___ - -### RequiredInstanceOptions - -Ƭ **RequiredInstanceOptions**: { [K in "strictSchema" \| "strictNumbers" \| "strictTypes" \| "strictTuples" \| "strictRequired" \| "inlineRefs" \| "loopRequired" \| "loopEnum" \| "meta" \| "messages" \| "schemaId" \| "addUsedSchema" \| "validateSchema" \| "validateFormats" \| "int32range" \| "unicodeRegExp" \| "uriResolver"]: NonNullable } & { `code`: [`InstanceCodeOptions`](../interfaces/verida_client_ts._internal_.InstanceCodeOptions.md) } - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:95 - -___ - -### RequiredKeys - -Ƭ **RequiredKeys**<`T`\>: { [K in keyof T]-?: undefined extends T[K] ? never : K }[keyof `T`] - -required keys of an object, not undefined - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/jtd-schema.d.ts:34 - -___ - -### SafeExpr - -Ƭ **SafeExpr**: [`Code`](verida_client_ts._internal_.md#code) \| `number` \| `boolean` \| ``null`` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/index.d.ts:6 - -___ - -### Schema - -Ƭ **Schema**: [`SchemaObject`](../interfaces/verida_client_ts._internal_.SchemaObject.md) \| `boolean` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:24 - -___ - -### SchemaRefs - -Ƭ **SchemaRefs**: { [Ref in string]?: SchemaEnv \| AnySchema } - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:7 - -___ - -### ScopeStore - -Ƭ **ScopeStore**: [`Record`](verida_client_ts._internal_.md#record)<`string`, [`ValueReference`](verida_client_ts._internal_.md#valuereference)[] \| `undefined`\> - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/scope.d.ts:21 - -___ - -### ScopeValueSets - -Ƭ **ScopeValueSets**: { [Prefix in string]?: Set } - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/scope.d.ts:25 - -___ - -### ScopeValues - -Ƭ **ScopeValues**: { [Prefix in string]?: Map } - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/scope.d.ts:22 - -___ - -### ServiceEndpoint - -Ƭ **ServiceEndpoint**: `string` \| [`Record`](verida_client_ts._internal_.md#record)<`string`, `any`\> - -Represents an endpoint of a Service entry in a DID document. - -**`see`** [https://www.w3.org/TR/did-core/#dfn-serviceendpoint](https://www.w3.org/TR/did-core/#dfn-serviceendpoint) - -**`see`** [https://www.w3.org/TR/did-core/#services](https://www.w3.org/TR/did-core/#services) - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:92 - -___ - -### SomeJTDSchemaType - -Ƭ **SomeJTDSchemaType**: { `ref`: `string` } \| { `type`: [`NumberType`](verida_client_ts._internal_.md#numbertype) \| [`StringType`](verida_client_ts._internal_.md#stringtype) \| ``"boolean"`` } \| { `enum`: `string`[] } \| { `elements`: [`SomeJTDSchemaType`](verida_client_ts._internal_.md#somejtdschematype) } \| { `values`: [`SomeJTDSchemaType`](verida_client_ts._internal_.md#somejtdschematype) } \| { `additionalProperties?`: `boolean` ; `optionalProperties?`: [`Record`](verida_client_ts._internal_.md#record)<`string`, [`SomeJTDSchemaType`](verida_client_ts._internal_.md#somejtdschematype)\> ; `properties`: [`Record`](verida_client_ts._internal_.md#record)<`string`, [`SomeJTDSchemaType`](verida_client_ts._internal_.md#somejtdschematype)\> } \| { `additionalProperties?`: `boolean` ; `optionalProperties`: [`Record`](verida_client_ts._internal_.md#record)<`string`, [`SomeJTDSchemaType`](verida_client_ts._internal_.md#somejtdschematype)\> ; `properties?`: [`Record`](verida_client_ts._internal_.md#record)<`string`, [`SomeJTDSchemaType`](verida_client_ts._internal_.md#somejtdschematype)\> } \| { `discriminator`: `string` ; `mapping`: [`Record`](verida_client_ts._internal_.md#record)<`string`, [`SomeJTDSchemaType`](verida_client_ts._internal_.md#somejtdschematype)\> } \| {} & { `definitions?`: [`Record`](verida_client_ts._internal_.md#record)<`string`, [`SomeJTDSchemaType`](verida_client_ts._internal_.md#somejtdschematype)\> ; `metadata?`: [`Record`](verida_client_ts._internal_.md#record)<`string`, `unknown`\> ; `nullable?`: `boolean` } - -Generic JTD Schema without inference of the represented type - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/jtd-schema.d.ts:6 - -___ - -### StringType - -Ƭ **StringType**: ``"string"`` \| ``"timestamp"`` - -string strings - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/jtd-schema.d.ts:4 - -___ - -### TransactionRequest - -Ƭ **TransactionRequest**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `accessList?` | [`AccessListish`](verida_client_ts._internal_.md#accesslistish) | -| `ccipReadEnabled?` | `boolean` | -| `chainId?` | `number` | -| `customData?` | [`Record`](verida_client_ts._internal_.md#record)<`string`, `any`\> | -| `data?` | [`BytesLike`](verida_client_ts._internal_.md#byteslike) | -| `from?` | `string` | -| `gasLimit?` | [`BigNumberish`](verida_client_ts._internal_.md#bignumberish) | -| `gasPrice?` | [`BigNumberish`](verida_client_ts._internal_.md#bignumberish) | -| `maxFeePerGas?` | [`BigNumberish`](verida_client_ts._internal_.md#bignumberish) | -| `maxPriorityFeePerGas?` | [`BigNumberish`](verida_client_ts._internal_.md#bignumberish) | -| `nonce?` | [`BigNumberish`](verida_client_ts._internal_.md#bignumberish) | -| `to?` | `string` | -| `type?` | `number` | -| `value?` | [`BigNumberish`](verida_client_ts._internal_.md#bignumberish) | - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:7 - -___ - -### TypeEquality - -Ƭ **TypeEquality**<`T`, `E`\>: [`T`] extends [`E`] ? [`E`] extends [`T`] ? ``true`` : ``false`` : ``false`` - -type is true if T is identically E - -#### Type parameters - -| Name | -| :------ | -| `T` | -| `E` | - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/jtd-schema.d.ts:45 - -___ - -### UncheckedJSONSchemaType - -Ƭ **UncheckedJSONSchemaType**<`T`, `IsPartial`\>: { `anyOf`: readonly [`UncheckedJSONSchemaType`](verida_client_ts._internal_.md#uncheckedjsonschematype)<`T`, `IsPartial`\>[] } \| { `oneOf`: readonly [`UncheckedJSONSchemaType`](verida_client_ts._internal_.md#uncheckedjsonschematype)<`T`, `IsPartial`\>[] } \| { `type`: readonly `T` extends `number` ? [`JSONType`](verida_client_ts._internal_.md#jsontype)<``"number"`` \| ``"integer"``, `IsPartial`\> : `T` extends `string` ? [`JSONType`](verida_client_ts._internal_.md#jsontype)<``"string"``, `IsPartial`\> : `T` extends `boolean` ? [`JSONType`](verida_client_ts._internal_.md#jsontype)<``"boolean"``, `IsPartial`\> : `never`[] } & [`UnionToIntersection`](verida_client_ts._internal_.md#uniontointersection)<`T` extends `number` ? [`NumberKeywords`](../interfaces/verida_client_ts._internal_.NumberKeywords.md) : `T` extends `string` ? [`StringKeywords`](../interfaces/verida_client_ts._internal_.StringKeywords.md) : `T` extends `boolean` ? {} : `never`\> \| `T` extends `number` ? { `type`: [`JSONType`](verida_client_ts._internal_.md#jsontype)<``"number"`` \| ``"integer"``, `IsPartial`\> } & [`NumberKeywords`](../interfaces/verida_client_ts._internal_.NumberKeywords.md) : `T` extends `string` ? { `type`: [`JSONType`](verida_client_ts._internal_.md#jsontype)<``"string"``, `IsPartial`\> } & [`StringKeywords`](../interfaces/verida_client_ts._internal_.StringKeywords.md) : `T` extends `boolean` ? { `type`: [`JSONType`](verida_client_ts._internal_.md#jsontype)<``"boolean"``, `IsPartial`\> } : `T` extends readonly [`any`, ...any[]] ? { `items`: { readonly [K in keyof T]-?: UncheckedJSONSchemaType & Nullable } & { `length`: `T`[``"length"``] } ; `minItems`: `T`[``"length"``] ; `type`: [`JSONType`](verida_client_ts._internal_.md#jsontype)<``"array"``, `IsPartial`\> } & { `maxItems`: `T`[``"length"``] } \| { `additionalItems`: ``false`` } : `T` extends readonly `any`[] ? { `additionalItems?`: `never` ; `contains?`: [`UncheckedPartialSchema`](verida_client_ts._internal_.md#uncheckedpartialschema)<`T`[``0``]\> ; `items`: [`UncheckedJSONSchemaType`](verida_client_ts._internal_.md#uncheckedjsonschematype)<`T`[``0``], ``false``\> ; `maxContains?`: `number` ; `maxItems?`: `number` ; `minContains?`: `number` ; `minItems?`: `number` ; `type`: [`JSONType`](verida_client_ts._internal_.md#jsontype)<``"array"``, `IsPartial`\> ; `uniqueItems?`: ``true`` } : `T` extends [`Record`](verida_client_ts._internal_.md#record)<`string`, `any`\> ? { `additionalProperties?`: `boolean` \| [`UncheckedJSONSchemaType`](verida_client_ts._internal_.md#uncheckedjsonschematype)<`T`[`string`], ``false``\> ; `dependencies?`: { [K in keyof T]?: Readonly<(keyof T)[]\> \| UncheckedPartialSchema } ; `dependentRequired?`: { [K in keyof T]?: Readonly<(keyof T)[]\> } ; `dependentSchemas?`: { [K in keyof T]?: UncheckedPartialSchema } ; `maxProperties?`: `number` ; `minProperties?`: `number` ; `patternProperties?`: [`Record`](verida_client_ts._internal_.md#record)<`string`, [`UncheckedJSONSchemaType`](verida_client_ts._internal_.md#uncheckedjsonschematype)<`T`[`string`], ``false``\>\> ; `properties?`: `IsPartial` extends ``true`` ? [`Partial`](verida_client_ts._internal_.md#partial)<[`UncheckedPropertiesSchema`](verida_client_ts._internal_.md#uncheckedpropertiesschema)<`T`\>\> : [`UncheckedPropertiesSchema`](verida_client_ts._internal_.md#uncheckedpropertiesschema)<`T`\> ; `propertyNames?`: [`Omit`](verida_client_ts._internal_.md#omit)<[`UncheckedJSONSchemaType`](verida_client_ts._internal_.md#uncheckedjsonschematype)<`string`, ``false``\>, ``"type"``\> & { `type?`: ``"string"`` } ; `type`: [`JSONType`](verida_client_ts._internal_.md#jsontype)<``"object"``, `IsPartial`\> ; `unevaluatedProperties?`: `boolean` \| [`UncheckedJSONSchemaType`](verida_client_ts._internal_.md#uncheckedjsonschematype)<`T`[`string`], ``false``\> } & `IsPartial` extends ``true`` ? { `required`: [`Readonly`](verida_client_ts._internal_.md#readonly) } : [[`UncheckedRequiredMembers`](verida_client_ts._internal_.md#uncheckedrequiredmembers)<`T`\>] extends [`never`] ? { `required?`: [`Readonly`](verida_client_ts._internal_.md#readonly)<[`UncheckedRequiredMembers`](verida_client_ts._internal_.md#uncheckedrequiredmembers)<`T`\>[]\> } : { `required`: [`Readonly`](verida_client_ts._internal_.md#readonly)<[`UncheckedRequiredMembers`](verida_client_ts._internal_.md#uncheckedrequiredmembers)<`T`\>[]\> } : `T` extends ``null`` ? { `nullable`: ``true`` ; `type`: [`JSONType`](verida_client_ts._internal_.md#jsontype)<``"null"``, `IsPartial`\> } : `never` & { `allOf?`: [`Readonly`](verida_client_ts._internal_.md#readonly)<[`UncheckedPartialSchema`](verida_client_ts._internal_.md#uncheckedpartialschema)<`T`\>[]\> ; `anyOf?`: [`Readonly`](verida_client_ts._internal_.md#readonly)<[`UncheckedPartialSchema`](verida_client_ts._internal_.md#uncheckedpartialschema)<`T`\>[]\> ; `else?`: [`UncheckedPartialSchema`](verida_client_ts._internal_.md#uncheckedpartialschema)<`T`\> ; `if?`: [`UncheckedPartialSchema`](verida_client_ts._internal_.md#uncheckedpartialschema)<`T`\> ; `not?`: [`UncheckedPartialSchema`](verida_client_ts._internal_.md#uncheckedpartialschema)<`T`\> ; `oneOf?`: [`Readonly`](verida_client_ts._internal_.md#readonly)<[`UncheckedPartialSchema`](verida_client_ts._internal_.md#uncheckedpartialschema)<`T`\>[]\> ; `then?`: [`UncheckedPartialSchema`](verida_client_ts._internal_.md#uncheckedpartialschema)<`T`\> } & { `[keyword: string]`: `any`; `$defs?`: [`Record`](verida_client_ts._internal_.md#record)<`string`, [`UncheckedJSONSchemaType`](verida_client_ts._internal_.md#uncheckedjsonschematype)<[`Known`](verida_client_ts._internal_.md#known), ``true``\>\> ; `$id?`: `string` ; `$ref?`: `string` ; `definitions?`: [`Record`](verida_client_ts._internal_.md#record)<`string`, [`UncheckedJSONSchemaType`](verida_client_ts._internal_.md#uncheckedjsonschematype)<[`Known`](verida_client_ts._internal_.md#known), ``true``\>\> } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `T` | -| `IsPartial` | extends `boolean` | - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/json-schema.d.ts:21 - -___ - -### UncheckedPartialSchema - -Ƭ **UncheckedPartialSchema**<`T`\>: [`Partial`](verida_client_ts._internal_.md#partial)<[`UncheckedJSONSchemaType`](verida_client_ts._internal_.md#uncheckedjsonschematype)<`T`, ``true``\>\> - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/json-schema.d.ts:4 - -___ - -### UncheckedPropertiesSchema - -Ƭ **UncheckedPropertiesSchema**<`T`\>: { [K in keyof T]-?: UncheckedJSONSchemaType & Nullable \| Object } - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/json-schema.d.ts:104 - -___ - -### UncheckedRequiredMembers - -Ƭ **UncheckedRequiredMembers**<`T`\>: { [K in keyof T]-?: undefined extends T[K] ? never : K }[keyof `T`] - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/json-schema.d.ts:110 - -___ - -### UnionToIntersection - -Ƭ **UnionToIntersection**<`U`\>: `U` extends `any` ? (`_`: `U`) => `void` : `never` extends (`_`: infer I) => `void` ? `I` : `never` - -#### Type parameters - -| Name | -| :------ | -| `U` | - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/json-schema.d.ts:2 - -___ - -### UsedNames - -Ƭ **UsedNames**: [`Record`](verida_client_ts._internal_.md#record)<`string`, `number` \| `undefined`\> - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/code.d.ts:26 - -___ - -### UsedScopeValues - -Ƭ **UsedScopeValues**: { [Prefix in string]?: Map } - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/scope.d.ts:32 - -___ - -### ValidationTypes - -Ƭ **ValidationTypes**: { [K in JSONType]: boolean \| RuleGroup \| undefined } - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/rules.d.ts:5 - -___ - -### ValueReference - -Ƭ **ValueReference**: `unknown` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/scope.d.ts:11 - -___ - -### VdaDidEndpointResponses - -Ƭ **VdaDidEndpointResponses**: [`Record`](verida_client_ts._internal_.md#record)<`string`, [`VdaDidEndpointResponse`](../interfaces/verida_client_ts._internal_.VdaDidEndpointResponse.md)\> - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:113 - -___ - -### Vocabulary - -Ƭ **Vocabulary**: ([`KeywordDefinition`](verida_client_ts._internal_.md#keyworddefinition) \| `string`)[] - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:136 - -___ - -### Web3CallType - -Ƭ **Web3CallType**: ``"web3"`` \| ``"gasless"`` - -Web3 SDK running mode - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:5 - -## Variables - -### AbortSignal - -• **AbortSignal**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `prototype` | [`AbortSignal`](verida_client_ts._internal_.md#abortsignal) | - -#### Defined in - -node_modules/@types/node/globals.d.ts:72 - -___ - -### Error - -• **Error**: `ErrorConstructor` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:984 - -___ - -### EventEmitter - -• `Const` **EventEmitter**: `any` - -#### Defined in - -[packages/client-ts/src/context/profiles/profile.ts:1](https://github.com/verida/verida-js/blob/5040472/packages/client-ts/src/context/profiles/profile.ts#L1) - -___ - -### Number - -• **Number**: `NumberConstructor` - -An object that represents a number of any kind. All JavaScript numbers are 64-bit floating-point numbers. - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:602 - -___ - -### \_jsonTypes - -• `Const` **\_jsonTypes**: readonly [``"string"``, ``"number"``, ``"integer"``, ``"boolean"``, ``"null"``, ``"object"``, ``"array"``] - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/rules.d.ts:2 diff --git a/docs/api/verida-js/modules/verida_client_ts.md b/docs/api/verida-js/modules/verida_client_ts.md deleted file mode 100644 index 0fc98f2..0000000 --- a/docs/api/verida-js/modules/verida_client_ts.md +++ /dev/null @@ -1,64 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / @verida/client-ts - -# Module: @verida/client-ts - -## Table of contents - -### Namespaces - -- [<internal\>](verida_client_ts._internal_.md) - -### Modules Classes - -- [Client](../classes/verida_client_ts.Client.md) -- [Context](../classes/verida_client_ts.Context.md) -- [Network](../classes/verida_client_ts.Network.md) - -### Functions - -- [migrateContext](verida_client_ts.md#migratecontext) -- [migrateDatabase](verida_client_ts.md#migratedatabase) - -## Functions - -### migrateContext - -▸ **migrateContext**(`sourceContext`, `destinationContext`): [`EventEmitter`](../classes/verida_client_ts._internal_.EventEmitter-1.md) - -Note: May need the ability to force override the DID if migrating data between testnet -> mainnet? - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `sourceContext` | [`IContext`](../interfaces/verida_client_ts._internal_.IContext.md) | -| `destinationContext` | [`IContext`](../interfaces/verida_client_ts._internal_.IContext.md) | - -#### Returns - -[`EventEmitter`](../classes/verida_client_ts._internal_.EventEmitter-1.md) - -#### Defined in - -[packages/client-ts/src/utils/migration.ts:13](https://github.com/verida/verida-js/blob/5040472/packages/client-ts/src/utils/migration.ts#L13) - -___ - -### migrateDatabase - -▸ **migrateDatabase**(`sourceDb`, `destinationDb`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `sourceDb` | [`IDatabase`](../interfaces/verida_client_ts._internal_.IDatabase.md) | -| `destinationDb` | [`IDatabase`](../interfaces/verida_client_ts._internal_.IDatabase.md) | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -[packages/client-ts/src/utils/migration.ts:72](https://github.com/verida/verida-js/blob/5040472/packages/client-ts/src/utils/migration.ts#L72) diff --git a/docs/api/verida-js/modules/verida_did_client._internal_.md b/docs/api/verida-js/modules/verida_did_client._internal_.md deleted file mode 100644 index 1cc2416..0000000 --- a/docs/api/verida-js/modules/verida_did_client._internal_.md +++ /dev/null @@ -1,481 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/did-client](verida_did_client.md) / - -# Namespace: - -[@verida/did-client](verida_did_client.md). - -## Table of contents - -### Enumerations - -- [EnvironmentType](../enums/verida_did_client._internal_.EnvironmentType.md) -- [SecureContextEndpointType](../enums/verida_did_client._internal_.SecureContextEndpointType.md) - -### Classes - -- [BigNumber](../classes/verida_did_client._internal_.BigNumber.md) -- [Description](../classes/verida_did_client._internal_.Description.md) -- [ForkEvent](../classes/verida_did_client._internal_.ForkEvent.md) -- [Provider](../classes/verida_did_client._internal_.Provider.md) -- [Resolver](../classes/verida_did_client._internal_.Resolver.md) -- [Signer](../classes/verida_did_client._internal_.Signer.md) -- [default](../classes/verida_did_client._internal_.default.md) -- [default](../classes/verida_did_client._internal_.default-1.md) - -### Interfaces - -- [ArrayLike](../interfaces/verida_did_client._internal_.ArrayLike.md) -- [Block](../interfaces/verida_did_client._internal_.Block.md) -- [BlockWithTransactions](../interfaces/verida_did_client._internal_.BlockWithTransactions.md) -- [DIDClientConfig](../interfaces/verida_did_client._internal_.DIDClientConfig.md) -- [DIDDocumentMetadata](../interfaces/verida_did_client._internal_.DIDDocumentMetadata.md) -- [DIDResolutionMetadata](../interfaces/verida_did_client._internal_.DIDResolutionMetadata.md) -- [DIDResolutionOptions](../interfaces/verida_did_client._internal_.DIDResolutionOptions.md) -- [DIDResolutionResult](../interfaces/verida_did_client._internal_.DIDResolutionResult.md) -- [EventFilter](../interfaces/verida_did_client._internal_.EventFilter.md) -- [FeeData](../interfaces/verida_did_client._internal_.FeeData.md) -- [Filter](../interfaces/verida_did_client._internal_.Filter.md) -- [Hexable](../interfaces/verida_did_client._internal_.Hexable.md) -- [IDIDClient](../interfaces/verida_did_client._internal_.IDIDClient.md) -- [IDIDDocument](../interfaces/verida_did_client._internal_.IDIDDocument.md) -- [IKeyring](../interfaces/verida_did_client._internal_.IKeyring.md) -- [JsonWebKey](../interfaces/verida_did_client._internal_.JsonWebKey.md) -- [KeyringPublicKeys](../interfaces/verida_did_client._internal_.KeyringPublicKeys.md) -- [LegacyResolverRegistry](../interfaces/verida_did_client._internal_.LegacyResolverRegistry.md) -- [Log](../interfaces/verida_did_client._internal_.Log.md) -- [OnceBlockable](../interfaces/verida_did_client._internal_.OnceBlockable.md) -- [Params](../interfaces/verida_did_client._internal_.Params.md) -- [ParsedDID](../interfaces/verida_did_client._internal_.ParsedDID.md) -- [ProofInterface](../interfaces/verida_did_client._internal_.ProofInterface.md) -- [Resolvable](../interfaces/verida_did_client._internal_.Resolvable.md) -- [ResolverOptions](../interfaces/verida_did_client._internal_.ResolverOptions.md) -- [SecureContextEndpoint](../interfaces/verida_did_client._internal_.SecureContextEndpoint.md) -- [SecureContextEndpoints](../interfaces/verida_did_client._internal_.SecureContextEndpoints.md) -- [Service](../interfaces/verida_did_client._internal_.Service.md) -- [Transaction](../interfaces/verida_did_client._internal_.Transaction.md) -- [TransactionReceipt](../interfaces/verida_did_client._internal_.TransactionReceipt.md) -- [TransactionResponse](../interfaces/verida_did_client._internal_.TransactionResponse.md) -- [VdaDidConfigurationOptions](../interfaces/verida_did_client._internal_.VdaDidConfigurationOptions.md) -- [VdaDidEndpointResponse](../interfaces/verida_did_client._internal_.VdaDidEndpointResponse.md) -- [VeridaDocInterface](../interfaces/verida_did_client._internal_.VeridaDocInterface.md) -- [VerificationMethod](../interfaces/verida_did_client._internal_.VerificationMethod.md) -- [Web3GasConfiguration](../interfaces/verida_did_client._internal_.Web3GasConfiguration.md) -- [Web3GaslessPostConfig](../interfaces/verida_did_client._internal_.Web3GaslessPostConfig.md) -- [Web3GaslessRequestConfig](../interfaces/verida_did_client._internal_.Web3GaslessRequestConfig.md) -- [Web3MetaTransactionConfig](../interfaces/verida_did_client._internal_.Web3MetaTransactionConfig.md) -- [Web3SelfTransactionConfig](../interfaces/verida_did_client._internal_.Web3SelfTransactionConfig.md) -- [Web3SelfTransactionConfigPart](../interfaces/verida_did_client._internal_.Web3SelfTransactionConfigPart.md) -- [\_Block](../interfaces/verida_did_client._internal_._Block.md) - -### Type aliases - -- [AccessList](verida_did_client._internal_.md#accesslist) -- [AccessListish](verida_did_client._internal_.md#accesslistish) -- [BigNumberish](verida_did_client._internal_.md#bignumberish) -- [BlockTag](verida_did_client._internal_.md#blocktag) -- [Bytes](verida_did_client._internal_.md#bytes) -- [BytesLike](verida_did_client._internal_.md#byteslike) -- [DIDCache](verida_did_client._internal_.md#didcache) -- [DIDDocument](verida_did_client._internal_.md#diddocument) -- [DIDResolver](verida_did_client._internal_.md#didresolver) -- [Deferrable](verida_did_client._internal_.md#deferrable) -- [EIP1559GasMode](verida_did_client._internal_.md#eip1559gasmode) -- [EventType](verida_did_client._internal_.md#eventtype) -- [Extensible](verida_did_client._internal_.md#extensible) -- [KeyCapabilitySection](verida_did_client._internal_.md#keycapabilitysection) -- [LegacyDIDResolver](verida_did_client._internal_.md#legacydidresolver) -- [Listener](verida_did_client._internal_.md#listener) -- [Network](verida_did_client._internal_.md#network) -- [Record](verida_did_client._internal_.md#record) -- [ResolverRegistry](verida_did_client._internal_.md#resolverregistry) -- [ServiceEndpoint](verida_did_client._internal_.md#serviceendpoint) -- [TransactionRequest](verida_did_client._internal_.md#transactionrequest) -- [VdaDidEndpointResponses](verida_did_client._internal_.md#vdadidendpointresponses) -- [VeridaWeb3ConfigurationOptions](verida_did_client._internal_.md#veridaweb3configurationoptions) -- [Web3CallType](verida_did_client._internal_.md#web3calltype) -- [WrappedResolver](verida_did_client._internal_.md#wrappedresolver) - -## Type aliases - -### AccessList - -Ƭ **AccessList**: { `address`: `string` ; `storageKeys`: `string`[] }[] - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:3 - -___ - -### AccessListish - -Ƭ **AccessListish**: [`AccessList`](verida_did_client._internal_.md#accesslist) \| [`string`, `string`[]][] \| [`Record`](verida_did_client._internal_.md#record)<`string`, `string`[]\> - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:7 - -___ - -### BigNumberish - -Ƭ **BigNumberish**: [`BigNumber`](../classes/verida_did_client._internal_.BigNumber.md) \| [`Bytes`](verida_did_client._internal_.md#bytes) \| `bigint` \| `string` \| `number` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:2 - -___ - -### BlockTag - -Ƭ **BlockTag**: `string` \| `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:33 - -___ - -### Bytes - -Ƭ **Bytes**: [`ArrayLike`](../interfaces/verida_did_client._internal_.ArrayLike.md)<`number`\> - -#### Defined in - -node_modules/@ethersproject/bytes/lib/index.d.ts:1 - -___ - -### BytesLike - -Ƭ **BytesLike**: [`Bytes`](verida_did_client._internal_.md#bytes) \| `string` - -#### Defined in - -node_modules/@ethersproject/bytes/lib/index.d.ts:2 - -___ - -### DIDCache - -Ƭ **DIDCache**: (`parsed`: [`ParsedDID`](../interfaces/verida_did_client._internal_.ParsedDID.md), `resolve`: [`WrappedResolver`](verida_did_client._internal_.md#wrappedresolver)) => `Promise`<[`DIDResolutionResult`](../interfaces/verida_did_client._internal_.DIDResolutionResult.md)\> - -#### Type declaration - -▸ (`parsed`, `resolve`): `Promise`<[`DIDResolutionResult`](../interfaces/verida_did_client._internal_.DIDResolutionResult.md)\> - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `parsed` | [`ParsedDID`](../interfaces/verida_did_client._internal_.ParsedDID.md) | -| `resolve` | [`WrappedResolver`](verida_did_client._internal_.md#wrappedresolver) | - -##### Returns - -`Promise`<[`DIDResolutionResult`](../interfaces/verida_did_client._internal_.DIDResolutionResult.md)\> - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:165 - -___ - -### DIDDocument - -Ƭ **DIDDocument**: { `@context?`: ``"https://www.w3.org/ns/did/v1"`` \| `string` \| `string`[] ; `alsoKnownAs?`: `string`[] ; `controller?`: `string` \| `string`[] ; `id`: `string` ; `publicKey?`: [`VerificationMethod`](../interfaces/verida_did_client._internal_.VerificationMethod.md)[] ; `service?`: [`Service`](../interfaces/verida_did_client._internal_.Service.md)[] ; `verificationMethod?`: [`VerificationMethod`](../interfaces/verida_did_client._internal_.VerificationMethod.md)[] } & { [x in KeyCapabilitySection]?: (string \| VerificationMethod)[] } - -Represents a DID document. - -**`see`** [https://www.w3.org/TR/did-core/#did-document-properties](https://www.w3.org/TR/did-core/#did-document-properties) - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:60 - -___ - -### DIDResolver - -Ƭ **DIDResolver**: (`did`: `string`, `parsed`: [`ParsedDID`](../interfaces/verida_did_client._internal_.ParsedDID.md), `resolver`: [`Resolvable`](../interfaces/verida_did_client._internal_.Resolvable.md), `options`: [`DIDResolutionOptions`](../interfaces/verida_did_client._internal_.DIDResolutionOptions.md)) => `Promise`<[`DIDResolutionResult`](../interfaces/verida_did_client._internal_.DIDResolutionResult.md)\> - -#### Type declaration - -▸ (`did`, `parsed`, `resolver`, `options`): `Promise`<[`DIDResolutionResult`](../interfaces/verida_did_client._internal_.DIDResolutionResult.md)\> - -The DID resolution function that DID Resolver implementations must implement. - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `did` | `string` | -| `parsed` | [`ParsedDID`](../interfaces/verida_did_client._internal_.ParsedDID.md) | -| `resolver` | [`Resolvable`](../interfaces/verida_did_client._internal_.Resolvable.md) | -| `options` | [`DIDResolutionOptions`](../interfaces/verida_did_client._internal_.DIDResolutionOptions.md) | - -##### Returns - -`Promise`<[`DIDResolutionResult`](../interfaces/verida_did_client._internal_.DIDResolutionResult.md)\> - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:163 - -___ - -### Deferrable - -Ƭ **Deferrable**<`T`\>: { [K in keyof T]: T[K] \| Promise } - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Defined in - -node_modules/@ethersproject/properties/lib/index.d.ts:3 - -___ - -### EIP1559GasMode - -Ƭ **EIP1559GasMode**: ``"safeLow"`` \| ``"standard"`` \| ``"fast"`` - -EIP1559 Gas Configuration speed - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:13 - -___ - -### EventType - -Ƭ **EventType**: `string` \| (`string` \| `string`[])[] \| [`EventFilter`](../interfaces/verida_did_client._internal_.EventFilter.md) \| [`ForkEvent`](../classes/verida_did_client._internal_.ForkEvent.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:121 - -___ - -### Extensible - -Ƭ **Extensible**: [`Record`](verida_did_client._internal_.md#record)<`string`, `any`\> - -Defines an object type that can be extended with other properties. - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:4 - -___ - -### KeyCapabilitySection - -Ƭ **KeyCapabilitySection**: ``"authentication"`` \| ``"assertionMethod"`` \| ``"keyAgreement"`` \| ``"capabilityInvocation"`` \| ``"capabilityDelegation"`` - -Represents the Verification Relationship between a DID subject and a Verification Method. - -**`see`** [https://www.w3.org/TR/did-core/#verification-relationships](https://www.w3.org/TR/did-core/#verification-relationships) - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:54 - -___ - -### LegacyDIDResolver - -Ƭ **LegacyDIDResolver**: (`did`: `string`, `parsed`: [`ParsedDID`](../interfaces/verida_did_client._internal_.ParsedDID.md), `resolver`: [`Resolvable`](../interfaces/verida_did_client._internal_.Resolvable.md)) => `Promise`<[`DIDDocument`](verida_did_client._internal_.md#diddocument)\> - -#### Type declaration - -▸ (`did`, `parsed`, `resolver`): `Promise`<[`DIDDocument`](verida_did_client._internal_.md#diddocument)\> - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `did` | `string` | -| `parsed` | [`ParsedDID`](../interfaces/verida_did_client._internal_.ParsedDID.md) | -| `resolver` | [`Resolvable`](../interfaces/verida_did_client._internal_.Resolvable.md) | - -##### Returns - -`Promise`<[`DIDDocument`](verida_did_client._internal_.md#diddocument)\> - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:166 - -___ - -### Listener - -Ƭ **Listener**: (...`args`: `any`[]) => `void` - -#### Type declaration - -▸ (...`args`): `void` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `...args` | `any`[] | - -##### Returns - -`void` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:122 - -___ - -### Network - -Ƭ **Network**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `chainId` | `number` | -| `ensAddress?` | `string` | -| `name` | `string` | -| `_defaultProvider?` | (`providers`: `any`, `options?`: `any`) => `any` | - -#### Defined in - -node_modules/@ethersproject/networks/lib/types.d.ts:1 - -___ - -### Record - -Ƭ **Record**<`K`, `T`\>: { [P in K]: T } - -Construct a type with a set of properties K of type T - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof `any` | -| `T` | `T` | - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1499 - -___ - -### ResolverRegistry - -Ƭ **ResolverRegistry**: [`Record`](verida_did_client._internal_.md#record)<`string`, [`DIDResolver`](verida_did_client._internal_.md#didresolver)\> - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:167 - -___ - -### ServiceEndpoint - -Ƭ **ServiceEndpoint**: `string` \| [`Record`](verida_did_client._internal_.md#record)<`string`, `any`\> - -Represents an endpoint of a Service entry in a DID document. - -**`see`** [https://www.w3.org/TR/did-core/#dfn-serviceendpoint](https://www.w3.org/TR/did-core/#dfn-serviceendpoint) - -**`see`** [https://www.w3.org/TR/did-core/#services](https://www.w3.org/TR/did-core/#services) - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:92 - -___ - -### TransactionRequest - -Ƭ **TransactionRequest**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `accessList?` | [`AccessListish`](verida_did_client._internal_.md#accesslistish) | -| `ccipReadEnabled?` | `boolean` | -| `chainId?` | `number` | -| `customData?` | [`Record`](verida_did_client._internal_.md#record)<`string`, `any`\> | -| `data?` | [`BytesLike`](verida_did_client._internal_.md#byteslike) | -| `from?` | `string` | -| `gasLimit?` | [`BigNumberish`](verida_did_client._internal_.md#bignumberish) | -| `gasPrice?` | [`BigNumberish`](verida_did_client._internal_.md#bignumberish) | -| `maxFeePerGas?` | [`BigNumberish`](verida_did_client._internal_.md#bignumberish) | -| `maxPriorityFeePerGas?` | [`BigNumberish`](verida_did_client._internal_.md#bignumberish) | -| `nonce?` | [`BigNumberish`](verida_did_client._internal_.md#bignumberish) | -| `to?` | `string` | -| `type?` | `number` | -| `value?` | [`BigNumberish`](verida_did_client._internal_.md#bignumberish) | - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:7 - -___ - -### VdaDidEndpointResponses - -Ƭ **VdaDidEndpointResponses**: [`Record`](verida_did_client._internal_.md#record)<`string`, [`VdaDidEndpointResponse`](../interfaces/verida_did_client._internal_.VdaDidEndpointResponse.md)\> - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:113 - -___ - -### VeridaWeb3ConfigurationOptions - -Ƭ **VeridaWeb3ConfigurationOptions**: [`Web3MetaTransactionConfig`](../interfaces/verida_did_client._internal_.Web3MetaTransactionConfig.md) \| [`Web3SelfTransactionConfig`](../interfaces/verida_did_client._internal_.Web3SelfTransactionConfig.md) - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:88 - -___ - -### Web3CallType - -Ƭ **Web3CallType**: ``"web3"`` \| ``"gasless"`` - -Web3 SDK running mode - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:5 - -___ - -### WrappedResolver - -Ƭ **WrappedResolver**: () => `Promise`<[`DIDResolutionResult`](../interfaces/verida_did_client._internal_.DIDResolutionResult.md)\> - -#### Type declaration - -▸ (): `Promise`<[`DIDResolutionResult`](../interfaces/verida_did_client._internal_.DIDResolutionResult.md)\> - -##### Returns - -`Promise`<[`DIDResolutionResult`](../interfaces/verida_did_client._internal_.DIDResolutionResult.md)\> - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:164 diff --git a/docs/api/verida-js/modules/verida_did_client.md b/docs/api/verida-js/modules/verida_did_client.md deleted file mode 100644 index f40c22e..0000000 --- a/docs/api/verida-js/modules/verida_did_client.md +++ /dev/null @@ -1,14 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / @verida/did-client - -# Module: @verida/did-client - -## Table of contents - -### Namespaces - -- [<internal\>](verida_did_client._internal_.md) - -### Classes - -- [DIDClient](../classes/verida_did_client.DIDClient.md) -- [Wallet](../classes/verida_did_client.Wallet.md) diff --git a/docs/api/verida-js/modules/verida_did_document.Interfaces.md b/docs/api/verida-js/modules/verida_did_document.Interfaces.md deleted file mode 100644 index 08b8d7b..0000000 --- a/docs/api/verida-js/modules/verida_did_document.Interfaces.md +++ /dev/null @@ -1,18 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/did-document](verida_did_document.md) / Interfaces - -# Namespace: Interfaces - -[@verida/did-document](verida_did_document.md).Interfaces - -## Table of contents - -### Enumerations - -- [EndpointType](../enums/verida_did_document.Interfaces.EndpointType.md) - -### Interfaces - -- [DIDDocumentStruct](../interfaces/verida_did_document.Interfaces.DIDDocumentStruct.md) -- [Endpoints](../interfaces/verida_did_document.Interfaces.Endpoints.md) -- [Proof](../interfaces/verida_did_document.Interfaces.Proof.md) -- [SecureContextEndpoint](../interfaces/verida_did_document.Interfaces.SecureContextEndpoint.md) diff --git a/docs/api/verida-js/modules/verida_did_document._internal_.md b/docs/api/verida-js/modules/verida_did_document._internal_.md deleted file mode 100644 index caef315..0000000 --- a/docs/api/verida-js/modules/verida_did_document._internal_.md +++ /dev/null @@ -1,107 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/did-document](verida_did_document.md) / - -# Namespace: - -[@verida/did-document](verida_did_document.md). - -## Table of contents - -### Enumerations - -- [SecureContextEndpointType](../enums/verida_did_document._internal_.SecureContextEndpointType.md) - -### Interfaces - -- [IDIDDocument](../interfaces/verida_did_document._internal_.IDIDDocument.md) -- [IKeyring](../interfaces/verida_did_document._internal_.IKeyring.md) -- [JsonWebKey](../interfaces/verida_did_document._internal_.JsonWebKey.md) -- [KeyringPublicKeys](../interfaces/verida_did_document._internal_.KeyringPublicKeys.md) -- [ProofInterface](../interfaces/verida_did_document._internal_.ProofInterface.md) -- [SecureContextEndpoint](../interfaces/verida_did_document._internal_.SecureContextEndpoint.md) -- [SecureContextEndpoints](../interfaces/verida_did_document._internal_.SecureContextEndpoints.md) -- [Service](../interfaces/verida_did_document._internal_.Service.md) -- [VeridaDocInterface](../interfaces/verida_did_document._internal_.VeridaDocInterface.md) -- [VerificationMethod](../interfaces/verida_did_document._internal_.VerificationMethod.md) - -### Type aliases - -- [DIDDocument](verida_did_document._internal_.md#diddocument) -- [Extensible](verida_did_document._internal_.md#extensible) -- [KeyCapabilitySection](verida_did_document._internal_.md#keycapabilitysection) -- [Record](verida_did_document._internal_.md#record) -- [ServiceEndpoint](verida_did_document._internal_.md#serviceendpoint) - -## Type aliases - -### DIDDocument - -Ƭ **DIDDocument**: { `@context?`: ``"https://www.w3.org/ns/did/v1"`` \| `string` \| `string`[] ; `alsoKnownAs?`: `string`[] ; `controller?`: `string` \| `string`[] ; `id`: `string` ; `publicKey?`: [`VerificationMethod`](../interfaces/verida_did_document._internal_.VerificationMethod.md)[] ; `service?`: [`Service`](../interfaces/verida_did_document._internal_.Service.md)[] ; `verificationMethod?`: [`VerificationMethod`](../interfaces/verida_did_document._internal_.VerificationMethod.md)[] } & { [x in KeyCapabilitySection]?: (string \| VerificationMethod)[] } - -Represents a DID document. - -**`see`** [https://www.w3.org/TR/did-core/#did-document-properties](https://www.w3.org/TR/did-core/#did-document-properties) - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:60 - -___ - -### Extensible - -Ƭ **Extensible**: [`Record`](verida_did_document._internal_.md#record)<`string`, `any`\> - -Defines an object type that can be extended with other properties. - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:4 - -___ - -### KeyCapabilitySection - -Ƭ **KeyCapabilitySection**: ``"authentication"`` \| ``"assertionMethod"`` \| ``"keyAgreement"`` \| ``"capabilityInvocation"`` \| ``"capabilityDelegation"`` - -Represents the Verification Relationship between a DID subject and a Verification Method. - -**`see`** [https://www.w3.org/TR/did-core/#verification-relationships](https://www.w3.org/TR/did-core/#verification-relationships) - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:54 - -___ - -### Record - -Ƭ **Record**<`K`, `T`\>: { [P in K]: T } - -Construct a type with a set of properties K of type T - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof `any` | -| `T` | `T` | - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1499 - -___ - -### ServiceEndpoint - -Ƭ **ServiceEndpoint**: `string` \| [`Record`](verida_did_document._internal_.md#record)<`string`, `any`\> - -Represents an endpoint of a Service entry in a DID document. - -**`see`** [https://www.w3.org/TR/did-core/#dfn-serviceendpoint](https://www.w3.org/TR/did-core/#dfn-serviceendpoint) - -**`see`** [https://www.w3.org/TR/did-core/#services](https://www.w3.org/TR/did-core/#services) - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:92 diff --git a/docs/api/verida-js/modules/verida_did_document.md b/docs/api/verida-js/modules/verida_did_document.md deleted file mode 100644 index 7e22681..0000000 --- a/docs/api/verida-js/modules/verida_did_document.md +++ /dev/null @@ -1,13 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / @verida/did-document - -# Module: @verida/did-document - -## Table of contents - -### Namespaces - -- [<internal\>](verida_did_document._internal_.md) - -### Classes - -- [DIDDocument](../classes/verida_did_document.DIDDocument.md) diff --git a/docs/api/verida-js/modules/verida_did_resolver._internal_.md b/docs/api/verida-js/modules/verida_did_resolver._internal_.md deleted file mode 100644 index f0a9148..0000000 --- a/docs/api/verida-js/modules/verida_did_resolver._internal_.md +++ /dev/null @@ -1,49 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/did-resolver](verida_did_resolver.md) / - -# Namespace: - -[@verida/did-resolver](verida_did_resolver.md). - -## Table of contents - -### Enumerations - -- [EnvironmentType](../enums/verida_did_resolver._internal_.EnvironmentType.md) - -### Interfaces - -- [DIDResolutionOptions](../interfaces/verida_did_resolver._internal_.DIDResolutionOptions.md) - -### Type aliases - -- [Extensible](verida_did_resolver._internal_.md#extensible) -- [Record](verida_did_resolver._internal_.md#record) - -## Type aliases - -### Extensible - -Ƭ **Extensible**: [`Record`](verida_did_resolver._internal_.md#record)<`string`, `any`\> - -#### Defined in - -packages/did-resolver/node_modules/did-resolver/lib/resolver.d.ts:1 - -___ - -### Record - -Ƭ **Record**<`K`, `T`\>: { [P in K]: T } - -Construct a type with a set of properties K of type T - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof `any` | -| `T` | `T` | - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1499 diff --git a/docs/api/verida-js/modules/verida_did_resolver.md b/docs/api/verida-js/modules/verida_did_resolver.md deleted file mode 100644 index 1e2f4f7..0000000 --- a/docs/api/verida-js/modules/verida_did_resolver.md +++ /dev/null @@ -1,25 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / @verida/did-resolver - -# Module: @verida/did-resolver - -## Table of contents - -### Namespaces - -- [<internal\>](verida_did_resolver._internal_.md) - -### Properties - -- [default](verida_did_resolver.md#default) - -## Properties - -### default - -• **default**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `getResolver` | (`environment`: [`EnvironmentType`](../enums/verida_did_resolver._internal_.EnvironmentType.md)) => [`DIDResolutionOptions`](../interfaces/verida_did_resolver._internal_.DIDResolutionOptions.md) | diff --git a/docs/api/verida-js/modules/verida_encryption_utils._internal_.md b/docs/api/verida-js/modules/verida_encryption_utils._internal_.md deleted file mode 100644 index c59724a..0000000 --- a/docs/api/verida-js/modules/verida_encryption_utils._internal_.md +++ /dev/null @@ -1,11 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/encryption-utils](verida_encryption_utils.md) / - -# Namespace: - -[@verida/encryption-utils](verida_encryption_utils.md). - -## Table of contents - -### Interfaces - -- [BoxKeyPair](../interfaces/verida_encryption_utils._internal_.BoxKeyPair.md) diff --git a/docs/api/verida-js/modules/verida_encryption_utils.md b/docs/api/verida-js/modules/verida_encryption_utils.md deleted file mode 100644 index ec06535..0000000 --- a/docs/api/verida-js/modules/verida_encryption_utils.md +++ /dev/null @@ -1,13 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / @verida/encryption-utils - -# Module: @verida/encryption-utils - -## Table of contents - -### Namespaces - -- [<internal\>](verida_encryption_utils._internal_.md) - -### Classes - -- [default](../classes/verida_encryption_utils.default.md) diff --git a/docs/api/verida-js/modules/verida_helpers._internal_.EventEmitter.md b/docs/api/verida-js/modules/verida_helpers._internal_.EventEmitter.md deleted file mode 100644 index 048b343..0000000 --- a/docs/api/verida-js/modules/verida_helpers._internal_.EventEmitter.md +++ /dev/null @@ -1,21 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/helpers](verida_helpers.md) / [](verida_helpers._internal_.md) / EventEmitter - -# Namespace: EventEmitter - -[@verida/helpers](verida_helpers.md).[](verida_helpers._internal_.md).EventEmitter - -## Table of contents - -### References - -- [EventEmitter](verida_helpers._internal_.EventEmitter.md#eventemitter) - -### Interfaces - -- [Abortable](../interfaces/verida_helpers._internal_.EventEmitter.Abortable.md) - -## References - -### EventEmitter - -Re-exports [EventEmitter](../classes/verida_helpers._internal_.EventEmitter-1.md) diff --git a/docs/api/verida-js/modules/verida_helpers._internal_.md b/docs/api/verida-js/modules/verida_helpers._internal_.md deleted file mode 100644 index 67d9ade..0000000 --- a/docs/api/verida-js/modules/verida_helpers._internal_.md +++ /dev/null @@ -1,143 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/helpers](verida_helpers.md) / - -# Namespace: - -[@verida/helpers](verida_helpers.md). - -## Table of contents - -### Namespaces - -- [EventEmitter](verida_helpers._internal_.EventEmitter.md) - -### Enumerations - -- [ContextEngineType](../enums/verida_helpers._internal_.ContextEngineType.md) -- [DatabasePermissionOptionsEnum](../enums/verida_helpers._internal_.DatabasePermissionOptionsEnum.md) - -### Classes - -- [EventEmitter](../classes/verida_helpers._internal_.EventEmitter-1.md) - -### Interfaces - -- [AccountConfig](../interfaces/verida_helpers._internal_.AccountConfig.md) -- [AsyncIterableIterator](../interfaces/verida_helpers._internal_.AsyncIterableIterator.md) -- [AsyncIterator](../interfaces/verida_helpers._internal_.AsyncIterator.md) -- [AuthContext](../interfaces/verida_helpers._internal_.AuthContext.md) -- [AuthTypeConfig](../interfaces/verida_helpers._internal_.AuthTypeConfig.md) -- [ContextCloseOptions](../interfaces/verida_helpers._internal_.ContextCloseOptions.md) -- [ContextDatabaseInfo](../interfaces/verida_helpers._internal_.ContextDatabaseInfo.md) -- [ContextInfo](../interfaces/verida_helpers._internal_.ContextInfo.md) -- [DOMEventTarget](../interfaces/verida_helpers._internal_.DOMEventTarget.md) -- [DatabaseCloseOptions](../interfaces/verida_helpers._internal_.DatabaseCloseOptions.md) -- [DatabaseDeleteConfig](../interfaces/verida_helpers._internal_.DatabaseDeleteConfig.md) -- [DatabaseOpenConfig](../interfaces/verida_helpers._internal_.DatabaseOpenConfig.md) -- [DatabasePermissionsConfig](../interfaces/verida_helpers._internal_.DatabasePermissionsConfig.md) -- [DatastoreOpenConfig](../interfaces/verida_helpers._internal_.DatastoreOpenConfig.md) -- [DbRegistryEntry](../interfaces/verida_helpers._internal_.DbRegistryEntry.md) -- [DbRegistryEntryEncryptionKey](../interfaces/verida_helpers._internal_.DbRegistryEntryEncryptionKey.md) -- [EndpointUsage](../interfaces/verida_helpers._internal_.EndpointUsage.md) -- [EventEmitterOptions](../interfaces/verida_helpers._internal_.EventEmitterOptions.md) -- [FetchUriParams](../interfaces/verida_helpers._internal_.FetchUriParams.md) -- [IAccount](../interfaces/verida_helpers._internal_.IAccount.md) -- [IClient](../interfaces/verida_helpers._internal_.IClient.md) -- [IContext](../interfaces/verida_helpers._internal_.IContext.md) -- [IDIDContextManager](../interfaces/verida_helpers._internal_.IDIDContextManager.md) -- [IDatabase](../interfaces/verida_helpers._internal_.IDatabase.md) -- [IDatastore](../interfaces/verida_helpers._internal_.IDatastore.md) -- [IDbRegistry](../interfaces/verida_helpers._internal_.IDbRegistry.md) -- [IKeyring](../interfaces/verida_helpers._internal_.IKeyring.md) -- [IMessaging](../interfaces/verida_helpers._internal_.IMessaging.md) -- [INotification](../interfaces/verida_helpers._internal_.INotification.md) -- [IProfile](../interfaces/verida_helpers._internal_.IProfile.md) -- [ISchema](../interfaces/verida_helpers._internal_.ISchema.md) -- [IStorageEngine](../interfaces/verida_helpers._internal_.IStorageEngine.md) -- [IteratorReturnResult](../interfaces/verida_helpers._internal_.IteratorReturnResult.md) -- [IteratorYieldResult](../interfaces/verida_helpers._internal_.IteratorYieldResult.md) -- [KeyringPublicKeys](../interfaces/verida_helpers._internal_.KeyringPublicKeys.md) -- [MessageSendConfig](../interfaces/verida_helpers._internal_.MessageSendConfig.md) -- [MessagesConfig](../interfaces/verida_helpers._internal_.MessagesConfig.md) -- [NodeEventTarget](../interfaces/verida_helpers._internal_.NodeEventTarget.md) -- [Number](../interfaces/verida_helpers._internal_.Number.md) -- [PromiseLike](../interfaces/verida_helpers._internal_.PromiseLike.md) -- [SecureContextConfig](../interfaces/verida_helpers._internal_.SecureContextConfig.md) -- [SecureContextEndpoint](../interfaces/verida_helpers._internal_.SecureContextEndpoint.md) -- [SecureContextPublicKey](../interfaces/verida_helpers._internal_.SecureContextPublicKey.md) -- [SecureContextServices](../interfaces/verida_helpers._internal_.SecureContextServices.md) -- [SecureStorageContextPublicKeys](../interfaces/verida_helpers._internal_.SecureStorageContextPublicKeys.md) -- [StaticEventEmitterOptions](../interfaces/verida_helpers._internal_.StaticEventEmitterOptions.md) - -### Type aliases - -- [IteratorResult](verida_helpers._internal_.md#iteratorresult) -- [Record](verida_helpers._internal_.md#record) -- [ServiceEndpoint](verida_helpers._internal_.md#serviceendpoint) - -### Variables - -- [Number](verida_helpers._internal_.md#number) - -## Type aliases - -### IteratorResult - -Ƭ **IteratorResult**<`T`, `TReturn`\>: [`IteratorYieldResult`](../interfaces/verida_helpers._internal_.IteratorYieldResult.md)<`T`\> \| [`IteratorReturnResult`](../interfaces/verida_helpers._internal_.IteratorReturnResult.md)<`TReturn`\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `T` | -| `TReturn` | `any` | - -#### Defined in - -node_modules/typescript/lib/lib.es2015.iterable.d.ts:41 - -___ - -### Record - -Ƭ **Record**<`K`, `T`\>: { [P in K]: T } - -Construct a type with a set of properties K of type T - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof `any` | -| `T` | `T` | - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1499 - -___ - -### ServiceEndpoint - -Ƭ **ServiceEndpoint**: `string` \| [`Record`](verida_helpers._internal_.md#record)<`string`, `any`\> - -Represents an endpoint of a Service entry in a DID document. - -**`see`** [https://www.w3.org/TR/did-core/#dfn-serviceendpoint](https://www.w3.org/TR/did-core/#dfn-serviceendpoint) - -**`see`** [https://www.w3.org/TR/did-core/#services](https://www.w3.org/TR/did-core/#services) - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:92 - -## Variables - -### Number - -• **Number**: `NumberConstructor` - -An object that represents a number of any kind. All JavaScript numbers are 64-bit floating-point numbers. - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:602 diff --git a/docs/api/verida-js/modules/verida_helpers.md b/docs/api/verida-js/modules/verida_helpers.md deleted file mode 100644 index f2c38f1..0000000 --- a/docs/api/verida-js/modules/verida_helpers.md +++ /dev/null @@ -1,220 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / @verida/helpers - -# Module: @verida/helpers - -## Table of contents - -### Namespaces - -- [<internal\>](verida_helpers._internal_.md) - -### Interfaces - -- [DIDParts](../interfaces/verida_helpers.DIDParts.md) - -### Functions - -- [buildVeridaUri](verida_helpers.md#buildveridauri) -- [decodeUri](verida_helpers.md#decodeuri) -- [encodeUri](verida_helpers.md#encodeuri) -- [explodeDID](verida_helpers.md#explodedid) -- [explodeVeridaUri](verida_helpers.md#explodeveridauri) -- [fetchVeridaUri](verida_helpers.md#fetchveridauri) -- [verifyDidControlsDomain](verida_helpers.md#verifydidcontrolsdomain) -- [wrapUri](verida_helpers.md#wrapuri) - -## Functions - -### buildVeridaUri - -▸ **buildVeridaUri**(`did`, `contextName`, `databaseName`, `itemId?`, `deepAttributes?`, `params?`): `string` - -Build a URI that represents a specific record in a database - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did` | `string` | -| `contextName` | `string` | -| `databaseName` | `string` | -| `itemId?` | `string` | -| `deepAttributes?` | `string`[] | -| `params?` | `Object` | -| `params.key?` | `string` | - -#### Returns - -`string` - -#### Defined in - -[packages/helpers/src/Utils.ts:16](https://github.com/verida/verida-js/blob/5040472/packages/helpers/src/Utils.ts#L16) - -___ - -### decodeUri - -▸ **decodeUri**(`encodedVeridaUri`): `string` - -Decode a Verida URI from base58 to it's `verida://` URI format - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `encodedVeridaUri` | `string` | - -#### Returns - -`string` - -#### Defined in - -[packages/helpers/src/Utils.ts:170](https://github.com/verida/verida-js/blob/5040472/packages/helpers/src/Utils.ts#L170) - -___ - -### encodeUri - -▸ **encodeUri**(`veridaUri`): `any` - -Encode a Verida URI in base58 to create a unique string reference on the network - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `veridaUri` | `string` | - -#### Returns - -`any` - -#### Defined in - -[packages/helpers/src/Utils.ts:161](https://github.com/verida/verida-js/blob/5040472/packages/helpers/src/Utils.ts#L161) - -___ - -### explodeDID - -▸ **explodeDID**(`did`): `Object` - -Get the `network` and `address` parts of a DID - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did` | `string` | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `address` | `string` | -| `network` | `string` | - -#### Defined in - -[packages/helpers/src/Utils.ts:186](https://github.com/verida/verida-js/blob/5040472/packages/helpers/src/Utils.ts#L186) - -___ - -### explodeVeridaUri - -▸ **explodeVeridaUri**(`uri`): [`FetchUriParams`](../interfaces/verida_helpers._internal_.FetchUriParams.md) - -Explode a Verida URI into it's individual pieces - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `uri` | `string` | - -#### Returns - -[`FetchUriParams`](../interfaces/verida_helpers._internal_.FetchUriParams.md) - -#### Defined in - -[packages/helpers/src/Utils.ts:54](https://github.com/verida/verida-js/blob/5040472/packages/helpers/src/Utils.ts#L54) - -___ - -### fetchVeridaUri - -▸ **fetchVeridaUri**(`uri`, `client`): `Promise`<`any`\> - -Fetch the data accessible from a Verida URI - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `uri` | `string` | Verida URI of the record to access. If `key` is in the query parameters, it is used as a (hex) encryption key to decode the data | -| `client` | [`IClient`](../interfaces/verida_helpers._internal_.IClient.md) | - | - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -[packages/helpers/src/Utils.ts:90](https://github.com/verida/verida-js/blob/5040472/packages/helpers/src/Utils.ts#L90) - -___ - -### verifyDidControlsDomain - -▸ **verifyDidControlsDomain**(`did`, `domain`): `Promise`<`boolean`\> - -Uses `/.well-known/did.json` standard - -**`see`** https://w3c-ccg.github.io/did-method-web/ - -**`see`** https://team.verida.network/.well-known/did.json - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `did` | `string` | DID that is expected to control the domain name | -| `domain` | `string` | Domain (ie: team.verida.network) that is expected to be controlled by the DID. If protocol is specified (ie: `https`) it will automatically be stripped. HTTPS is forced. | - -#### Returns - -`Promise`<`boolean`\> - -#### Defined in - -[packages/helpers/src/verification.ts:12](https://github.com/verida/verida-js/blob/5040472/packages/helpers/src/verification.ts#L12) - -___ - -### wrapUri - -▸ **wrapUri**(`veridaUri`, `wrapperUri?`): `string` - -Wrap a Verida URI in a wrapper URI that handles fetching the record and returning it. - -ie: wrapUri('http://data.verida.network', ...) - -#### Parameters - -| Name | Type | Default value | Description | -| :------ | :------ | :------ | :------ | -| `veridaUri` | `string` | `undefined` | Verida URI | -| `wrapperUri` | `string` | `'https://data.verida.network'` | HTTP(s) endpoint that fetches a Verida URI | - -#### Returns - -`string` - -#### Defined in - -[packages/helpers/src/Utils.ts:150](https://github.com/verida/verida-js/blob/5040472/packages/helpers/src/Utils.ts#L150) diff --git a/docs/api/verida-js/modules/verida_keyring._internal_.md b/docs/api/verida-js/modules/verida_keyring._internal_.md deleted file mode 100644 index b790dda..0000000 --- a/docs/api/verida-js/modules/verida_keyring._internal_.md +++ /dev/null @@ -1,18 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/keyring](verida_keyring.md) / - -# Namespace: - -[@verida/keyring](verida_keyring.md). - -## Table of contents - -### Enumerations - -- [KeyringKeyType](../enums/verida_keyring._internal_.KeyringKeyType.md) - -### Interfaces - -- [BoxKeyPair](../interfaces/verida_keyring._internal_.BoxKeyPair.md) -- [IKeyring](../interfaces/verida_keyring._internal_.IKeyring.md) -- [KeyringPublicKeys](../interfaces/verida_keyring._internal_.KeyringPublicKeys.md) -- [SignKeyPair](../interfaces/verida_keyring._internal_.SignKeyPair.md) diff --git a/docs/api/verida-js/modules/verida_keyring.md b/docs/api/verida-js/modules/verida_keyring.md deleted file mode 100644 index a6d37f4..0000000 --- a/docs/api/verida-js/modules/verida_keyring.md +++ /dev/null @@ -1,13 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / @verida/keyring - -# Module: @verida/keyring - -## Table of contents - -### Namespaces - -- [<internal\>](verida_keyring._internal_.md) - -### Classes - -- [Keyring](../classes/verida_keyring.Keyring.md) diff --git a/docs/api/verida-js/modules/verida_storage_link.Interfaces.md b/docs/api/verida-js/modules/verida_storage_link.Interfaces.md deleted file mode 100644 index 0f00fbc..0000000 --- a/docs/api/verida-js/modules/verida_storage_link.Interfaces.md +++ /dev/null @@ -1,15 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/storage-link](verida_storage_link.md) / Interfaces - -# Namespace: Interfaces - -[@verida/storage-link](verida_storage_link.md).Interfaces - -## Table of contents - -### Interfaces - -- [SecureContextConfig](../interfaces/verida_storage_link.Interfaces.SecureContextConfig.md) -- [SecureContextEndpoint](../interfaces/verida_storage_link.Interfaces.SecureContextEndpoint.md) -- [SecureContextPublicKey](../interfaces/verida_storage_link.Interfaces.SecureContextPublicKey.md) -- [SecureContextServices](../interfaces/verida_storage_link.Interfaces.SecureContextServices.md) -- [SecureStorageContextPublicKeys](../interfaces/verida_storage_link.Interfaces.SecureStorageContextPublicKeys.md) diff --git a/docs/api/verida-js/modules/verida_storage_link._internal_.md b/docs/api/verida-js/modules/verida_storage_link._internal_.md deleted file mode 100644 index 6e66f87..0000000 --- a/docs/api/verida-js/modules/verida_storage_link._internal_.md +++ /dev/null @@ -1,346 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/storage-link](verida_storage_link.md) / - -# Namespace: - -[@verida/storage-link](verida_storage_link.md). - -## Table of contents - -### Enumerations - -- [EnvironmentType](../enums/verida_storage_link._internal_.EnvironmentType.md) -- [SecureContextEndpointType](../enums/verida_storage_link._internal_.SecureContextEndpointType.md) - -### Classes - -- [BigNumber](../classes/verida_storage_link._internal_.BigNumber.md) -- [DIDClient](../classes/verida_storage_link._internal_.DIDClient.md) -- [Description](../classes/verida_storage_link._internal_.Description.md) -- [ForkEvent](../classes/verida_storage_link._internal_.ForkEvent.md) -- [Provider](../classes/verida_storage_link._internal_.Provider.md) -- [Signer](../classes/verida_storage_link._internal_.Signer.md) -- [default](../classes/verida_storage_link._internal_.default.md) - -### Interfaces - -- [ArrayLike](../interfaces/verida_storage_link._internal_.ArrayLike.md) -- [Block](../interfaces/verida_storage_link._internal_.Block.md) -- [BlockWithTransactions](../interfaces/verida_storage_link._internal_.BlockWithTransactions.md) -- [DIDClientConfig](../interfaces/verida_storage_link._internal_.DIDClientConfig.md) -- [EventFilter](../interfaces/verida_storage_link._internal_.EventFilter.md) -- [FeeData](../interfaces/verida_storage_link._internal_.FeeData.md) -- [Filter](../interfaces/verida_storage_link._internal_.Filter.md) -- [Hexable](../interfaces/verida_storage_link._internal_.Hexable.md) -- [IDIDClient](../interfaces/verida_storage_link._internal_.IDIDClient.md) -- [IDIDDocument](../interfaces/verida_storage_link._internal_.IDIDDocument.md) -- [IKeyring](../interfaces/verida_storage_link._internal_.IKeyring.md) -- [JsonWebKey](../interfaces/verida_storage_link._internal_.JsonWebKey.md) -- [KeyringPublicKeys](../interfaces/verida_storage_link._internal_.KeyringPublicKeys.md) -- [Log](../interfaces/verida_storage_link._internal_.Log.md) -- [OnceBlockable](../interfaces/verida_storage_link._internal_.OnceBlockable.md) -- [ProofInterface](../interfaces/verida_storage_link._internal_.ProofInterface.md) -- [SecureContextConfig](../interfaces/verida_storage_link._internal_.SecureContextConfig.md) -- [SecureContextEndpoint](../interfaces/verida_storage_link._internal_.SecureContextEndpoint.md) -- [SecureContextEndpoints](../interfaces/verida_storage_link._internal_.SecureContextEndpoints.md) -- [SecureContextPublicKey](../interfaces/verida_storage_link._internal_.SecureContextPublicKey.md) -- [SecureContextServices](../interfaces/verida_storage_link._internal_.SecureContextServices.md) -- [SecureStorageContextPublicKeys](../interfaces/verida_storage_link._internal_.SecureStorageContextPublicKeys.md) -- [Service](../interfaces/verida_storage_link._internal_.Service.md) -- [Transaction](../interfaces/verida_storage_link._internal_.Transaction.md) -- [TransactionReceipt](../interfaces/verida_storage_link._internal_.TransactionReceipt.md) -- [TransactionResponse](../interfaces/verida_storage_link._internal_.TransactionResponse.md) -- [VdaDidEndpointResponse](../interfaces/verida_storage_link._internal_.VdaDidEndpointResponse.md) -- [VeridaDocInterface](../interfaces/verida_storage_link._internal_.VeridaDocInterface.md) -- [VerificationMethod](../interfaces/verida_storage_link._internal_.VerificationMethod.md) -- [Web3GaslessPostConfig](../interfaces/verida_storage_link._internal_.Web3GaslessPostConfig.md) -- [Web3GaslessRequestConfig](../interfaces/verida_storage_link._internal_.Web3GaslessRequestConfig.md) -- [Web3MetaTransactionConfig](../interfaces/verida_storage_link._internal_.Web3MetaTransactionConfig.md) -- [Web3SelfTransactionConfigPart](../interfaces/verida_storage_link._internal_.Web3SelfTransactionConfigPart.md) -- [\_Block](../interfaces/verida_storage_link._internal_._Block.md) - -### Type aliases - -- [AccessList](verida_storage_link._internal_.md#accesslist) -- [AccessListish](verida_storage_link._internal_.md#accesslistish) -- [BigNumberish](verida_storage_link._internal_.md#bignumberish) -- [BlockTag](verida_storage_link._internal_.md#blocktag) -- [Bytes](verida_storage_link._internal_.md#bytes) -- [BytesLike](verida_storage_link._internal_.md#byteslike) -- [DIDDocument](verida_storage_link._internal_.md#diddocument) -- [Deferrable](verida_storage_link._internal_.md#deferrable) -- [EventType](verida_storage_link._internal_.md#eventtype) -- [Extensible](verida_storage_link._internal_.md#extensible) -- [KeyCapabilitySection](verida_storage_link._internal_.md#keycapabilitysection) -- [Listener](verida_storage_link._internal_.md#listener) -- [Network](verida_storage_link._internal_.md#network) -- [Record](verida_storage_link._internal_.md#record) -- [ServiceEndpoint](verida_storage_link._internal_.md#serviceendpoint) -- [ServiceEndpoint](verida_storage_link._internal_.md#serviceendpoint) -- [TransactionRequest](verida_storage_link._internal_.md#transactionrequest) -- [VdaDidEndpointResponses](verida_storage_link._internal_.md#vdadidendpointresponses) -- [Web3CallType](verida_storage_link._internal_.md#web3calltype) - -## Type aliases - -### AccessList - -Ƭ **AccessList**: { `address`: `string` ; `storageKeys`: `string`[] }[] - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:3 - -___ - -### AccessListish - -Ƭ **AccessListish**: [`AccessList`](verida_storage_link._internal_.md#accesslist) \| [`string`, `string`[]][] \| [`Record`](verida_storage_link._internal_.md#record)<`string`, `string`[]\> - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:7 - -___ - -### BigNumberish - -Ƭ **BigNumberish**: [`BigNumber`](../classes/verida_storage_link._internal_.BigNumber.md) \| [`Bytes`](verida_storage_link._internal_.md#bytes) \| `bigint` \| `string` \| `number` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:2 - -___ - -### BlockTag - -Ƭ **BlockTag**: `string` \| `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:33 - -___ - -### Bytes - -Ƭ **Bytes**: [`ArrayLike`](../interfaces/verida_storage_link._internal_.ArrayLike.md)<`number`\> - -#### Defined in - -node_modules/@ethersproject/bytes/lib/index.d.ts:1 - -___ - -### BytesLike - -Ƭ **BytesLike**: [`Bytes`](verida_storage_link._internal_.md#bytes) \| `string` - -#### Defined in - -node_modules/@ethersproject/bytes/lib/index.d.ts:2 - -___ - -### DIDDocument - -Ƭ **DIDDocument**: { `@context?`: ``"https://www.w3.org/ns/did/v1"`` \| `string` \| `string`[] ; `alsoKnownAs?`: `string`[] ; `controller?`: `string` \| `string`[] ; `id`: `string` ; `publicKey?`: [`VerificationMethod`](../interfaces/verida_storage_link._internal_.VerificationMethod.md)[] ; `service?`: [`Service`](../interfaces/verida_storage_link._internal_.Service.md)[] ; `verificationMethod?`: [`VerificationMethod`](../interfaces/verida_storage_link._internal_.VerificationMethod.md)[] } & { [x in KeyCapabilitySection]?: (string \| VerificationMethod)[] } - -Represents a DID document. - -**`see`** [https://www.w3.org/TR/did-core/#did-document-properties](https://www.w3.org/TR/did-core/#did-document-properties) - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:60 - -___ - -### Deferrable - -Ƭ **Deferrable**<`T`\>: { [K in keyof T]: T[K] \| Promise } - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Defined in - -node_modules/@ethersproject/properties/lib/index.d.ts:3 - -___ - -### EventType - -Ƭ **EventType**: `string` \| (`string` \| `string`[])[] \| [`EventFilter`](../interfaces/verida_storage_link._internal_.EventFilter.md) \| [`ForkEvent`](../classes/verida_storage_link._internal_.ForkEvent.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:121 - -___ - -### Extensible - -Ƭ **Extensible**: [`Record`](verida_storage_link._internal_.md#record)<`string`, `any`\> - -Defines an object type that can be extended with other properties. - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:4 - -___ - -### KeyCapabilitySection - -Ƭ **KeyCapabilitySection**: ``"authentication"`` \| ``"assertionMethod"`` \| ``"keyAgreement"`` \| ``"capabilityInvocation"`` \| ``"capabilityDelegation"`` - -Represents the Verification Relationship between a DID subject and a Verification Method. - -**`see`** [https://www.w3.org/TR/did-core/#verification-relationships](https://www.w3.org/TR/did-core/#verification-relationships) - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:54 - -___ - -### Listener - -Ƭ **Listener**: (...`args`: `any`[]) => `void` - -#### Type declaration - -▸ (...`args`): `void` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `...args` | `any`[] | - -##### Returns - -`void` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:122 - -___ - -### Network - -Ƭ **Network**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `chainId` | `number` | -| `ensAddress?` | `string` | -| `name` | `string` | -| `_defaultProvider?` | (`providers`: `any`, `options?`: `any`) => `any` | - -#### Defined in - -node_modules/@ethersproject/networks/lib/types.d.ts:1 - -___ - -### Record - -Ƭ **Record**<`K`, `T`\>: { [P in K]: T } - -Construct a type with a set of properties K of type T - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof `any` | -| `T` | `T` | - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1499 - -___ - -### ServiceEndpoint - -Ƭ **ServiceEndpoint**: `string` \| [`Record`](verida_storage_link._internal_.md#record)<`string`, `any`\> - -#### Defined in - -packages/storage-link/node_modules/did-resolver/lib/resolver.d.ts:46 - -___ - -### ServiceEndpoint - -Ƭ **ServiceEndpoint**: `string` \| [`Record`](verida_storage_link._internal_.md#record)<`string`, `any`\> - -Represents an endpoint of a Service entry in a DID document. - -**`see`** [https://www.w3.org/TR/did-core/#dfn-serviceendpoint](https://www.w3.org/TR/did-core/#dfn-serviceendpoint) - -**`see`** [https://www.w3.org/TR/did-core/#services](https://www.w3.org/TR/did-core/#services) - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:92 - -___ - -### TransactionRequest - -Ƭ **TransactionRequest**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `accessList?` | [`AccessListish`](verida_storage_link._internal_.md#accesslistish) | -| `ccipReadEnabled?` | `boolean` | -| `chainId?` | `number` | -| `customData?` | [`Record`](verida_storage_link._internal_.md#record)<`string`, `any`\> | -| `data?` | [`BytesLike`](verida_storage_link._internal_.md#byteslike) | -| `from?` | `string` | -| `gasLimit?` | [`BigNumberish`](verida_storage_link._internal_.md#bignumberish) | -| `gasPrice?` | [`BigNumberish`](verida_storage_link._internal_.md#bignumberish) | -| `maxFeePerGas?` | [`BigNumberish`](verida_storage_link._internal_.md#bignumberish) | -| `maxPriorityFeePerGas?` | [`BigNumberish`](verida_storage_link._internal_.md#bignumberish) | -| `nonce?` | [`BigNumberish`](verida_storage_link._internal_.md#bignumberish) | -| `to?` | `string` | -| `type?` | `number` | -| `value?` | [`BigNumberish`](verida_storage_link._internal_.md#bignumberish) | - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:7 - -___ - -### VdaDidEndpointResponses - -Ƭ **VdaDidEndpointResponses**: [`Record`](verida_storage_link._internal_.md#record)<`string`, [`VdaDidEndpointResponse`](../interfaces/verida_storage_link._internal_.VdaDidEndpointResponse.md)\> - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:113 - -___ - -### Web3CallType - -Ƭ **Web3CallType**: ``"web3"`` \| ``"gasless"`` - -Web3 SDK running mode - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:5 diff --git a/docs/api/verida-js/modules/verida_storage_link.md b/docs/api/verida-js/modules/verida_storage_link.md deleted file mode 100644 index 5ca17cf..0000000 --- a/docs/api/verida-js/modules/verida_storage_link.md +++ /dev/null @@ -1,14 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / @verida/storage-link - -# Module: @verida/storage-link - -## Table of contents - -### Namespaces - -- [<internal\>](verida_storage_link._internal_.md) - -### Classes - -- [DIDStorageConfig](../classes/verida_storage_link.DIDStorageConfig.md) -- [StorageLink](../classes/verida_storage_link.StorageLink.md) diff --git a/docs/api/verida-js/modules/verida_types._internal_.EventEmitter.md b/docs/api/verida-js/modules/verida_types._internal_.EventEmitter.md deleted file mode 100644 index c1cce21..0000000 --- a/docs/api/verida-js/modules/verida_types._internal_.EventEmitter.md +++ /dev/null @@ -1,21 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/types](verida_types.md) / [](verida_types._internal_.md) / EventEmitter - -# Namespace: EventEmitter - -[@verida/types](verida_types.md).[](verida_types._internal_.md).EventEmitter - -## Table of contents - -### References - -- [EventEmitter](verida_types._internal_.EventEmitter.md#eventemitter) - -### Interfaces - -- [Abortable](../interfaces/verida_types._internal_.EventEmitter.Abortable.md) - -## References - -### EventEmitter - -Re-exports [EventEmitter](../classes/verida_types._internal_.EventEmitter-1.md) diff --git a/docs/api/verida-js/modules/verida_types._internal_.md b/docs/api/verida-js/modules/verida_types._internal_.md deleted file mode 100644 index 56f094c..0000000 --- a/docs/api/verida-js/modules/verida_types._internal_.md +++ /dev/null @@ -1,408 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/types](verida_types.md) / - -# Namespace: - -[@verida/types](verida_types.md). - -## Table of contents - -### Namespaces - -- [EventEmitter](verida_types._internal_.EventEmitter.md) - -### Classes - -- [BigNumber](../classes/verida_types._internal_.BigNumber.md) -- [Description](../classes/verida_types._internal_.Description.md) -- [EventEmitter](../classes/verida_types._internal_.EventEmitter-1.md) -- [ForkEvent](../classes/verida_types._internal_.ForkEvent.md) -- [Provider](../classes/verida_types._internal_.Provider.md) -- [Signer](../classes/verida_types._internal_.Signer.md) - -### Interfaces - -- [ArrayLike](../interfaces/verida_types._internal_.ArrayLike.md) -- [AsyncIterableIterator](../interfaces/verida_types._internal_.AsyncIterableIterator.md) -- [AsyncIterator](../interfaces/verida_types._internal_.AsyncIterator.md) -- [Block](../interfaces/verida_types._internal_.Block.md) -- [BlockWithTransactions](../interfaces/verida_types._internal_.BlockWithTransactions.md) -- [CallSite](../interfaces/verida_types._internal_.CallSite.md) -- [Error](../interfaces/verida_types._internal_.Error.md) -- [EventEmitterOptions](../interfaces/verida_types._internal_.EventEmitterOptions.md) -- [EventFilter](../interfaces/verida_types._internal_.EventFilter.md) -- [FeeData](../interfaces/verida_types._internal_.FeeData.md) -- [Filter](../interfaces/verida_types._internal_.Filter.md) -- [Hexable](../interfaces/verida_types._internal_.Hexable.md) -- [IteratorReturnResult](../interfaces/verida_types._internal_.IteratorReturnResult.md) -- [IteratorYieldResult](../interfaces/verida_types._internal_.IteratorYieldResult.md) -- [JsonWebKey](../interfaces/verida_types._internal_.JsonWebKey.md) -- [Log](../interfaces/verida_types._internal_.Log.md) -- [Number](../interfaces/verida_types._internal_.Number.md) -- [OnceBlockable](../interfaces/verida_types._internal_.OnceBlockable.md) -- [PromiseLike](../interfaces/verida_types._internal_.PromiseLike.md) -- [Service](../interfaces/verida_types._internal_.Service.md) -- [StaticEventEmitterOptions](../interfaces/verida_types._internal_.StaticEventEmitterOptions.md) -- [Transaction](../interfaces/verida_types._internal_.Transaction.md) -- [TransactionReceipt](../interfaces/verida_types._internal_.TransactionReceipt.md) -- [TransactionResponse](../interfaces/verida_types._internal_.TransactionResponse.md) -- [VerificationMethod](../interfaces/verida_types._internal_.VerificationMethod.md) -- [\_Block](../interfaces/verida_types._internal_._Block.md) -- [\_DOMEventTarget](../interfaces/verida_types._internal_._DOMEventTarget.md) -- [\_NodeEventTarget](../interfaces/verida_types._internal_._NodeEventTarget.md) - -### Type aliases - -- [AccessList](verida_types._internal_.md#accesslist) -- [AccessListish](verida_types._internal_.md#accesslistish) -- [BigNumberish](verida_types._internal_.md#bignumberish) -- [BlockTag](verida_types._internal_.md#blocktag) -- [Bytes](verida_types._internal_.md#bytes) -- [BytesLike](verida_types._internal_.md#byteslike) -- [DIDDocument](verida_types._internal_.md#diddocument) -- [Deferrable](verida_types._internal_.md#deferrable) -- [EventType](verida_types._internal_.md#eventtype) -- [Exclude](verida_types._internal_.md#exclude) -- [Extensible](verida_types._internal_.md#extensible) -- [IteratorResult](verida_types._internal_.md#iteratorresult) -- [KeyCapabilitySection](verida_types._internal_.md#keycapabilitysection) -- [Listener](verida_types._internal_.md#listener) -- [Network](verida_types._internal_.md#network) -- [Omit](verida_types._internal_.md#omit) -- [Pick](verida_types._internal_.md#pick) -- [Record](verida_types._internal_.md#record) -- [ServiceEndpoint](verida_types._internal_.md#serviceendpoint) -- [TransactionRequest](verida_types._internal_.md#transactionrequest) - -### Variables - -- [Error](verida_types._internal_.md#error) -- [Number](verida_types._internal_.md#number) - -## Type aliases - -### AccessList - -Ƭ **AccessList**: { `address`: `string` ; `storageKeys`: `string`[] }[] - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:3 - -___ - -### AccessListish - -Ƭ **AccessListish**: [`AccessList`](verida_types._internal_.md#accesslist) \| [`string`, `string`[]][] \| [`Record`](verida_types._internal_.md#record)<`string`, `string`[]\> - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:7 - -___ - -### BigNumberish - -Ƭ **BigNumberish**: [`BigNumber`](../classes/verida_types._internal_.BigNumber.md) \| [`Bytes`](verida_types._internal_.md#bytes) \| `bigint` \| `string` \| `number` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:2 - -___ - -### BlockTag - -Ƭ **BlockTag**: `string` \| `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:33 - -___ - -### Bytes - -Ƭ **Bytes**: [`ArrayLike`](../interfaces/verida_types._internal_.ArrayLike.md)<`number`\> - -#### Defined in - -node_modules/@ethersproject/bytes/lib/index.d.ts:1 - -___ - -### BytesLike - -Ƭ **BytesLike**: [`Bytes`](verida_types._internal_.md#bytes) \| `string` - -#### Defined in - -node_modules/@ethersproject/bytes/lib/index.d.ts:2 - -___ - -### DIDDocument - -Ƭ **DIDDocument**: { `@context?`: ``"https://www.w3.org/ns/did/v1"`` \| `string` \| `string`[] ; `alsoKnownAs?`: `string`[] ; `controller?`: `string` \| `string`[] ; `id`: `string` ; `publicKey?`: [`VerificationMethod`](../interfaces/verida_types._internal_.VerificationMethod.md)[] ; `service?`: [`Service`](../interfaces/verida_types._internal_.Service.md)[] ; `verificationMethod?`: [`VerificationMethod`](../interfaces/verida_types._internal_.VerificationMethod.md)[] } & { [x in KeyCapabilitySection]?: (string \| VerificationMethod)[] } - -Represents a DID document. - -**`see`** [https://www.w3.org/TR/did-core/#did-document-properties](https://www.w3.org/TR/did-core/#did-document-properties) - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:60 - -___ - -### Deferrable - -Ƭ **Deferrable**<`T`\>: { [K in keyof T]: T[K] \| Promise } - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Defined in - -node_modules/@ethersproject/properties/lib/index.d.ts:3 - -___ - -### EventType - -Ƭ **EventType**: `string` \| (`string` \| `string`[])[] \| [`EventFilter`](../interfaces/verida_types._internal_.EventFilter.md) \| [`ForkEvent`](../classes/verida_types._internal_.ForkEvent.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:121 - -___ - -### Exclude - -Ƭ **Exclude**<`T`, `U`\>: `T` extends `U` ? `never` : `T` - -Exclude from T those types that are assignable to U - -#### Type parameters - -| Name | -| :------ | -| `T` | -| `U` | - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1506 - -___ - -### Extensible - -Ƭ **Extensible**: [`Record`](verida_types._internal_.md#record)<`string`, `any`\> - -Defines an object type that can be extended with other properties. - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:4 - -___ - -### IteratorResult - -Ƭ **IteratorResult**<`T`, `TReturn`\>: [`IteratorYieldResult`](../interfaces/verida_types._internal_.IteratorYieldResult.md)<`T`\> \| [`IteratorReturnResult`](../interfaces/verida_types._internal_.IteratorReturnResult.md)<`TReturn`\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `T` | -| `TReturn` | `any` | - -#### Defined in - -node_modules/typescript/lib/lib.es2015.iterable.d.ts:41 - -___ - -### KeyCapabilitySection - -Ƭ **KeyCapabilitySection**: ``"authentication"`` \| ``"assertionMethod"`` \| ``"keyAgreement"`` \| ``"capabilityInvocation"`` \| ``"capabilityDelegation"`` - -Represents the Verification Relationship between a DID subject and a Verification Method. - -**`see`** [https://www.w3.org/TR/did-core/#verification-relationships](https://www.w3.org/TR/did-core/#verification-relationships) - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:54 - -___ - -### Listener - -Ƭ **Listener**: (...`args`: `any`[]) => `void` - -#### Type declaration - -▸ (...`args`): `void` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `...args` | `any`[] | - -##### Returns - -`void` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:122 - -___ - -### Network - -Ƭ **Network**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `chainId` | `number` | -| `ensAddress?` | `string` | -| `name` | `string` | -| `_defaultProvider?` | (`providers`: `any`, `options?`: `any`) => `any` | - -#### Defined in - -node_modules/@ethersproject/networks/lib/types.d.ts:1 - -___ - -### Omit - -Ƭ **Omit**<`T`, `K`\>: [`Pick`](verida_types._internal_.md#pick)<`T`, [`Exclude`](verida_types._internal_.md#exclude)\> - -Construct a type with the properties of T except for those in type K. - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `T` | -| `K` | extends keyof `any` | - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1516 - -___ - -### Pick - -Ƭ **Pick**<`T`, `K`\>: { [P in K]: T[P] } - -From T, pick a set of properties whose keys are in the union K - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `T` | -| `K` | extends keyof `T` | - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1492 - -___ - -### Record - -Ƭ **Record**<`K`, `T`\>: { [P in K]: T } - -Construct a type with a set of properties K of type T - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof `any` | -| `T` | `T` | - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1499 - -___ - -### ServiceEndpoint - -Ƭ **ServiceEndpoint**: `string` \| [`Record`](verida_types._internal_.md#record)<`string`, `any`\> - -Represents an endpoint of a Service entry in a DID document. - -**`see`** [https://www.w3.org/TR/did-core/#dfn-serviceendpoint](https://www.w3.org/TR/did-core/#dfn-serviceendpoint) - -**`see`** [https://www.w3.org/TR/did-core/#services](https://www.w3.org/TR/did-core/#services) - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:92 - -___ - -### TransactionRequest - -Ƭ **TransactionRequest**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `accessList?` | [`AccessListish`](verida_types._internal_.md#accesslistish) | -| `ccipReadEnabled?` | `boolean` | -| `chainId?` | `number` | -| `customData?` | [`Record`](verida_types._internal_.md#record)<`string`, `any`\> | -| `data?` | [`BytesLike`](verida_types._internal_.md#byteslike) | -| `from?` | `string` | -| `gasLimit?` | [`BigNumberish`](verida_types._internal_.md#bignumberish) | -| `gasPrice?` | [`BigNumberish`](verida_types._internal_.md#bignumberish) | -| `maxFeePerGas?` | [`BigNumberish`](verida_types._internal_.md#bignumberish) | -| `maxPriorityFeePerGas?` | [`BigNumberish`](verida_types._internal_.md#bignumberish) | -| `nonce?` | [`BigNumberish`](verida_types._internal_.md#bignumberish) | -| `to?` | `string` | -| `type?` | `number` | -| `value?` | [`BigNumberish`](verida_types._internal_.md#bignumberish) | - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:7 - -## Variables - -### Error - -• **Error**: `ErrorConstructor` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:984 - -___ - -### Number - -• **Number**: `NumberConstructor` - -An object that represents a number of any kind. All JavaScript numbers are 64-bit floating-point numbers. - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:602 diff --git a/docs/api/verida-js/modules/verida_types.md b/docs/api/verida-js/modules/verida_types.md deleted file mode 100644 index c9a3063..0000000 --- a/docs/api/verida-js/modules/verida_types.md +++ /dev/null @@ -1,163 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / @verida/types - -# Module: @verida/types - -## Table of contents - -### Namespaces - -- [<internal\>](verida_types._internal_.md) - -### Enumerations - -- [ContextEngineType](../enums/verida_types.ContextEngineType.md) -- [DatabasePermissionOptionsEnum](../enums/verida_types.DatabasePermissionOptionsEnum.md) -- [EnumStatus](../enums/verida_types.EnumStatus.md) -- [EnvironmentType](../enums/verida_types.EnvironmentType.md) -- [KeyringKeyType](../enums/verida_types.KeyringKeyType.md) -- [SecureContextEndpointType](../enums/verida_types.SecureContextEndpointType.md) -- [VerificationMethodTypes](../enums/verida_types.VerificationMethodTypes.md) - -### Classes - -- [ContextAuthorizationError](../classes/verida_types.ContextAuthorizationError.md) - -### Interfaces - -- [AccountConfig](../interfaces/verida_types.AccountConfig.md) -- [AccountNodeConfig](../interfaces/verida_types.AccountNodeConfig.md) -- [AccountNodeDIDClientConfig](../interfaces/verida_types.AccountNodeDIDClientConfig.md) -- [AccountVaultConfig](../interfaces/verida_types.AccountVaultConfig.md) -- [AccountVaultRequest](../interfaces/verida_types.AccountVaultRequest.md) -- [AuthClientConfig](../interfaces/verida_types.AuthClientConfig.md) -- [AuthContext](../interfaces/verida_types.AuthContext.md) -- [AuthResponse](../interfaces/verida_types.AuthResponse.md) -- [AuthTypeConfig](../interfaces/verida_types.AuthTypeConfig.md) -- [ClientConfig](../interfaces/verida_types.ClientConfig.md) -- [ContextCloseOptions](../interfaces/verida_types.ContextCloseOptions.md) -- [ContextConfig](../interfaces/verida_types.ContextConfig.md) -- [ContextDatabaseInfo](../interfaces/verida_types.ContextDatabaseInfo.md) -- [ContextInfo](../interfaces/verida_types.ContextInfo.md) -- [DIDClientConfig](../interfaces/verida_types.DIDClientConfig.md) -- [DIDContextConfigs](../interfaces/verida_types.DIDContextConfigs.md) -- [DIDDocumentComparisonResult](../interfaces/verida_types.DIDDocumentComparisonResult.md) -- [DatabaseCloseOptions](../interfaces/verida_types.DatabaseCloseOptions.md) -- [DatabaseDeleteConfig](../interfaces/verida_types.DatabaseDeleteConfig.md) -- [DatabaseEngines](../interfaces/verida_types.DatabaseEngines.md) -- [DatabaseOpenConfig](../interfaces/verida_types.DatabaseOpenConfig.md) -- [DatabasePermissionsConfig](../interfaces/verida_types.DatabasePermissionsConfig.md) -- [DatastoreOpenConfig](../interfaces/verida_types.DatastoreOpenConfig.md) -- [DbRegistryEntry](../interfaces/verida_types.DbRegistryEntry.md) -- [DbRegistryEntryEncryptionKey](../interfaces/verida_types.DbRegistryEntryEncryptionKey.md) -- [DefaultClientConfig](../interfaces/verida_types.DefaultClientConfig.md) -- [DefaultEnvironmentConfig](../interfaces/verida_types.DefaultEnvironmentConfig.md) -- [EndpointUsage](../interfaces/verida_types.EndpointUsage.md) -- [FetchUriParams](../interfaces/verida_types.FetchUriParams.md) -- [IAccount](../interfaces/verida_types.IAccount.md) -- [IAuthType](../interfaces/verida_types.IAuthType.md) -- [IClient](../interfaces/verida_types.IClient.md) -- [IContext](../interfaces/verida_types.IContext.md) -- [IDIDClient](../interfaces/verida_types.IDIDClient.md) -- [IDIDContextManager](../interfaces/verida_types.IDIDContextManager.md) -- [IDIDDocument](../interfaces/verida_types.IDIDDocument.md) -- [IDatabase](../interfaces/verida_types.IDatabase.md) -- [IDatastore](../interfaces/verida_types.IDatastore.md) -- [IDbRegistry](../interfaces/verida_types.IDbRegistry.md) -- [IKeyring](../interfaces/verida_types.IKeyring.md) -- [IMessaging](../interfaces/verida_types.IMessaging.md) -- [INotification](../interfaces/verida_types.INotification.md) -- [IProfile](../interfaces/verida_types.IProfile.md) -- [ISchema](../interfaces/verida_types.ISchema.md) -- [IStorageEngine](../interfaces/verida_types.IStorageEngine.md) -- [KeyringPublicKeys](../interfaces/verida_types.KeyringPublicKeys.md) -- [MessageSendConfig](../interfaces/verida_types.MessageSendConfig.md) -- [MessagesConfig](../interfaces/verida_types.MessagesConfig.md) -- [NetworkConnectionConfig](../interfaces/verida_types.NetworkConnectionConfig.md) -- [ProfileDocument](../interfaces/verida_types.ProfileDocument.md) -- [ProofInterface](../interfaces/verida_types.ProofInterface.md) -- [SecureContextConfig](../interfaces/verida_types.SecureContextConfig.md) -- [SecureContextEndpoint](../interfaces/verida_types.SecureContextEndpoint.md) -- [SecureContextEndpoints](../interfaces/verida_types.SecureContextEndpoints.md) -- [SecureContextPublicKey](../interfaces/verida_types.SecureContextPublicKey.md) -- [SecureContextServices](../interfaces/verida_types.SecureContextServices.md) -- [SecureStorageContextPublicKeys](../interfaces/verida_types.SecureStorageContextPublicKeys.md) -- [StorageEngineTypes](../interfaces/verida_types.StorageEngineTypes.md) -- [VdaClientConfig](../interfaces/verida_types.VdaClientConfig.md) -- [VdaDidConfigurationOptions](../interfaces/verida_types.VdaDidConfigurationOptions.md) -- [VdaDidEndpointResponse](../interfaces/verida_types.VdaDidEndpointResponse.md) -- [VdaTransactionResult](../interfaces/verida_types.VdaTransactionResult.md) -- [VeridaDatabaseAuthContext](../interfaces/verida_types.VeridaDatabaseAuthContext.md) -- [VeridaDatabaseAuthTypeConfig](../interfaces/verida_types.VeridaDatabaseAuthTypeConfig.md) -- [VeridaDocInterface](../interfaces/verida_types.VeridaDocInterface.md) -- [WalletConnectConfig](../interfaces/verida_types.WalletConnectConfig.md) -- [Web3ContractInfo](../interfaces/verida_types.Web3ContractInfo.md) -- [Web3GasConfiguration](../interfaces/verida_types.Web3GasConfiguration.md) -- [Web3GaslessPostConfig](../interfaces/verida_types.Web3GaslessPostConfig.md) -- [Web3GaslessRequestConfig](../interfaces/verida_types.Web3GaslessRequestConfig.md) -- [Web3MetaTransactionConfig](../interfaces/verida_types.Web3MetaTransactionConfig.md) -- [Web3ProviderConfiguration](../interfaces/verida_types.Web3ProviderConfiguration.md) -- [Web3ResolverConfigurationOptions](../interfaces/verida_types.Web3ResolverConfigurationOptions.md) -- [Web3SelfTransactionConfig](../interfaces/verida_types.Web3SelfTransactionConfig.md) -- [Web3SelfTransactionConfigPart](../interfaces/verida_types.Web3SelfTransactionConfigPart.md) - -### Type aliases - -- [EIP1559GasMode](verida_types.md#eip1559gasmode) -- [VdaDidEndpointResponses](verida_types.md#vdadidendpointresponses) -- [VeridaWeb3Config](verida_types.md#veridaweb3config) -- [VeridaWeb3ConfigurationOptions](verida_types.md#veridaweb3configurationoptions) -- [Web3CallType](verida_types.md#web3calltype) - -## Type aliases - -### EIP1559GasMode - -Ƭ **EIP1559GasMode**: ``"safeLow"`` \| ``"standard"`` \| ``"fast"`` - -EIP1559 Gas Configuration speed - -#### Defined in - -[packages/types/src/Web3Interfaces.ts:17](https://github.com/verida/verida-js/blob/5040472/packages/types/src/Web3Interfaces.ts#L17) - -___ - -### VdaDidEndpointResponses - -Ƭ **VdaDidEndpointResponses**: [`Record`](verida_types._internal_.md#record)<`string`, [`VdaDidEndpointResponse`](../interfaces/verida_types.VdaDidEndpointResponse.md)\> - -#### Defined in - -[packages/types/src/Web3Interfaces.ts:135](https://github.com/verida/verida-js/blob/5040472/packages/types/src/Web3Interfaces.ts#L135) - -___ - -### VeridaWeb3Config - -Ƭ **VeridaWeb3Config**: [`Web3ContractInfo`](../interfaces/verida_types.Web3ContractInfo.md) & [`Web3SelfTransactionConfig`](../interfaces/verida_types.Web3SelfTransactionConfig.md) \| [`Web3MetaTransactionConfig`](../interfaces/verida_types.Web3MetaTransactionConfig.md) - -#### Defined in - -[packages/types/src/Web3Interfaces.ts:62](https://github.com/verida/verida-js/blob/5040472/packages/types/src/Web3Interfaces.ts#L62) - -___ - -### VeridaWeb3ConfigurationOptions - -Ƭ **VeridaWeb3ConfigurationOptions**: [`Web3MetaTransactionConfig`](../interfaces/verida_types.Web3MetaTransactionConfig.md) \| [`Web3SelfTransactionConfig`](../interfaces/verida_types.Web3SelfTransactionConfig.md) - -#### Defined in - -[packages/types/src/Web3Interfaces.ts:104](https://github.com/verida/verida-js/blob/5040472/packages/types/src/Web3Interfaces.ts#L104) - -___ - -### Web3CallType - -Ƭ **Web3CallType**: ``"web3"`` \| ``"gasless"`` - -Web3 SDK running mode - -#### Defined in - -[packages/types/src/Web3Interfaces.ts:7](https://github.com/verida/verida-js/blob/5040472/packages/types/src/Web3Interfaces.ts#L7) diff --git a/docs/api/verida-js/modules/verida_vda_common._internal_.md b/docs/api/verida-js/modules/verida_vda_common._internal_.md deleted file mode 100644 index e55339e..0000000 --- a/docs/api/verida-js/modules/verida_vda_common._internal_.md +++ /dev/null @@ -1,61 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-common](verida_vda_common.md) / - -# Namespace: - -[@verida/vda-common](verida_vda_common.md). - -## Table of contents - -### Classes - -- [BigNumber](../classes/verida_vda_common._internal_.BigNumber.md) - -### Interfaces - -- [ArrayLike](../interfaces/verida_vda_common._internal_.ArrayLike.md) -- [Hexable](../interfaces/verida_vda_common._internal_.Hexable.md) - -### Type aliases - -- [BigNumberish](verida_vda_common._internal_.md#bignumberish) -- [Bytes](verida_vda_common._internal_.md#bytes) -- [Record](verida_vda_common._internal_.md#record) - -## Type aliases - -### BigNumberish - -Ƭ **BigNumberish**: [`BigNumber`](../classes/verida_vda_common._internal_.BigNumber.md) \| [`Bytes`](verida_vda_common._internal_.md#bytes) \| `bigint` \| `string` \| `number` - -#### Defined in - -node_modules/ethers/node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:2 - -___ - -### Bytes - -Ƭ **Bytes**: [`ArrayLike`](../interfaces/verida_vda_common._internal_.ArrayLike.md)<`number`\> - -#### Defined in - -node_modules/ethers/node_modules/@ethersproject/bytes/lib/index.d.ts:1 - -___ - -### Record - -Ƭ **Record**<`K`, `T`\>: { [P in K]: T } - -Construct a type with a set of properties K of type T - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof `any` | -| `T` | `T` | - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1499 diff --git a/docs/api/verida-js/modules/verida_vda_common.md b/docs/api/verida-js/modules/verida_vda_common.md deleted file mode 100644 index 8d5fbd5..0000000 --- a/docs/api/verida-js/modules/verida_vda_common.md +++ /dev/null @@ -1,202 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / @verida/vda-common - -# Module: @verida/vda-common - -## Table of contents - -### Namespaces - -- [<internal\>](verida_vda_common._internal_.md) - -### Interfaces - -- [CONTRACT\_INFO](../interfaces/verida_vda_common.CONTRACT_INFO.md) - -### Type aliases - -- [CONTRACT\_NAMES](verida_vda_common.md#contract_names) - -### Variables - -- [CONTRACT\_ABI](verida_vda_common.md#contract_abi) -- [CONTRACT\_ADDRESS](verida_vda_common.md#contract_address) -- [RPC\_URLS](verida_vda_common.md#rpc_urls) - -### Functions - -- [getContractInfoForNetwork](verida_vda_common.md#getcontractinfofornetwork) -- [getDefaultRpcUrl](verida_vda_common.md#getdefaultrpcurl) -- [getVeridaSign](verida_vda_common.md#getveridasign) -- [getVeridaSignWithNonce](verida_vda_common.md#getveridasignwithnonce) -- [getWeb3ConfigDefaults](verida_vda_common.md#getweb3configdefaults) -- [interpretIdentifier](verida_vda_common.md#interpretidentifier) - -## Type aliases - -### CONTRACT\_NAMES - -Ƭ **CONTRACT\_NAMES**: ``"VeridaDIDRegistry"`` \| ``"NameRegistry"`` \| ``"SoulboundNFT"`` \| ``"VeridaDIDLinkage"`` \| ``"VeridaToken"`` \| ``"VDARewardContract"`` - -#### Defined in - -[packages/vda-common/src/contract.ts:2](https://github.com/verida/verida-js/blob/5040472/packages/vda-common/src/contract.ts#L2) - -## Variables - -### CONTRACT\_ABI - -• `Const` **CONTRACT\_ABI**: [`Record`](verida_vda_common._internal_.md#record)<[`CONTRACT_NAMES`](verida_vda_common.md#contract_names), `any`\> - -#### Defined in - -[packages/vda-common/src/contract.ts:63](https://github.com/verida/verida-js/blob/5040472/packages/vda-common/src/contract.ts#L63) - -___ - -### CONTRACT\_ADDRESS - -• `Const` **CONTRACT\_ADDRESS**: [`Record`](verida_vda_common._internal_.md#record)<[`CONTRACT_NAMES`](verida_vda_common.md#contract_names), [`Record`](verida_vda_common._internal_.md#record)<`string`, `string` \| ``null``\>\> - -#### Defined in - -[packages/vda-common/src/contract.ts:17](https://github.com/verida/verida-js/blob/5040472/packages/vda-common/src/contract.ts#L17) - -___ - -### RPC\_URLS - -• `Const` **RPC\_URLS**: [`Record`](verida_vda_common._internal_.md#record)<`string`, `string` \| ``null``\> - -#### Defined in - -[packages/vda-common/src/rpc.ts:1](https://github.com/verida/verida-js/blob/5040472/packages/vda-common/src/rpc.ts#L1) - -## Functions - -### getContractInfoForNetwork - -▸ **getContractInfoForNetwork**(`name`, `chainNameOrId`): [`CONTRACT_INFO`](../interfaces/verida_vda_common.CONTRACT_INFO.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | [`CONTRACT_NAMES`](verida_vda_common.md#contract_names) | -| `chainNameOrId` | `string` | - -#### Returns - -[`CONTRACT_INFO`](../interfaces/verida_vda_common.CONTRACT_INFO.md) - -#### Defined in - -[packages/vda-common/src/contract.ts:73](https://github.com/verida/verida-js/blob/5040472/packages/vda-common/src/contract.ts#L73) - -___ - -### getDefaultRpcUrl - -▸ **getDefaultRpcUrl**(`chainNameOrId`): ``null`` \| `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `chainNameOrId` | `any` | - -#### Returns - -``null`` \| `string` - -#### Defined in - -[packages/vda-common/src/rpc.ts:9](https://github.com/verida/verida-js/blob/5040472/packages/vda-common/src/rpc.ts#L9) - -___ - -### getVeridaSign - -▸ **getVeridaSign**(`rawMsg`, `privateKey`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `rawMsg` | `string` | -| `privateKey` | `string` | - -#### Returns - -`string` - -#### Defined in - -[packages/vda-common/src/utils.ts:38](https://github.com/verida/verida-js/blob/5040472/packages/vda-common/src/utils.ts#L38) - -___ - -### getVeridaSignWithNonce - -▸ **getVeridaSignWithNonce**(`rawMsg`, `privateKey`, `nonce`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `rawMsg` | `string` | -| `privateKey` | `string` | -| `nonce` | [`BigNumberish`](verida_vda_common._internal_.md#bignumberish) | - -#### Returns - -`string` - -#### Defined in - -[packages/vda-common/src/utils.ts:29](https://github.com/verida/verida-js/blob/5040472/packages/vda-common/src/utils.ts#L29) - -___ - -### getWeb3ConfigDefaults - -▸ **getWeb3ConfigDefaults**(`chainName`): `undefined` \| { `eip1559Mode`: `string` = 'fast'; `eip1559gasStationUrl`: `string` = 'https://gasstation-testnet.polygon.technology/v2'; `rpcUrl`: ``null`` \| `string` } - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `chainName` | `string` | - -#### Returns - -`undefined` \| { `eip1559Mode`: `string` = 'fast'; `eip1559gasStationUrl`: `string` = 'https://gasstation-testnet.polygon.technology/v2'; `rpcUrl`: ``null`` \| `string` } - -#### Defined in - -[packages/vda-common/src/defaults.ts:3](https://github.com/verida/verida-js/blob/5040472/packages/vda-common/src/defaults.ts#L3) - -___ - -### interpretIdentifier - -▸ **interpretIdentifier**(`identifier`): `Object` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `identifier` | `string` | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `address` | `string` | -| `network?` | `string` | -| `publicKey?` | `string` | - -#### Defined in - -[packages/vda-common/src/utils.ts:6](https://github.com/verida/verida-js/blob/5040472/packages/vda-common/src/utils.ts#L6) diff --git a/docs/api/verida-js/modules/verida_vda_common_test.md b/docs/api/verida-js/modules/verida_vda_common_test.md deleted file mode 100644 index 5c40756..0000000 --- a/docs/api/verida-js/modules/verida_vda_common_test.md +++ /dev/null @@ -1,114 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / @verida/vda-common-test - -# Module: @verida/vda-common-test - -## Table of contents - -### Interfaces - -- [DidInterface](../interfaces/verida_vda_common_test.DidInterface.md) - -### Variables - -- [DID\_LIST](verida_vda_common_test.md#did_list) -- [RECIPIENT\_WALLET](verida_vda_common_test.md#recipient_wallet) -- [TRUSTED\_SIGNER](verida_vda_common_test.md#trusted_signer) -- [ZERO\_ADDRESS](verida_vda_common_test.md#zero_address) - -### Functions - -- [getBlockchainAPIConfiguration](verida_vda_common_test.md#getblockchainapiconfiguration) -- [sleep](verida_vda_common_test.md#sleep) - -## Variables - -### DID\_LIST - -• `Const` **DID\_LIST**: [`DidInterface`](../interfaces/verida_vda_common_test.DidInterface.md)[] - -#### Defined in - -[packages/vda-common-test/src/const.ts:9](https://github.com/verida/verida-js/blob/5040472/packages/vda-common-test/src/const.ts#L9) - -___ - -### RECIPIENT\_WALLET - -• `Const` **RECIPIENT\_WALLET**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `address` | `string` | -| `privateKey` | `string` | -| `publicKey` | `string` | - -#### Defined in - -[packages/vda-common-test/src/const.ts:43](https://github.com/verida/verida-js/blob/5040472/packages/vda-common-test/src/const.ts#L43) - -___ - -### TRUSTED\_SIGNER - -• `Const` **TRUSTED\_SIGNER**: [`DidInterface`](../interfaces/verida_vda_common_test.DidInterface.md) - -#### Defined in - -[packages/vda-common-test/src/const.ts:37](https://github.com/verida/verida-js/blob/5040472/packages/vda-common-test/src/const.ts#L37) - -___ - -### ZERO\_ADDRESS - -• `Const` **ZERO\_ADDRESS**: ``"0x0000000000000000000000000000000000000000"`` - -#### Defined in - -[packages/vda-common-test/src/const.ts:49](https://github.com/verida/verida-js/blob/5040472/packages/vda-common-test/src/const.ts#L49) - -## Functions - -### getBlockchainAPIConfiguration - -▸ **getBlockchainAPIConfiguration**(`privateKey`): `Object` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `privateKey` | `string` | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `callType` | ``"gasless"`` \| ``"web3"`` | -| `web3Options` | {} | - -#### Defined in - -[packages/vda-common-test/src/utils.ts:9](https://github.com/verida/verida-js/blob/5040472/packages/vda-common-test/src/utils.ts#L9) - -___ - -### sleep - -▸ **sleep**(`ms`): `Promise`<`unknown`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `ms` | `number` | - -#### Returns - -`Promise`<`unknown`\> - -#### Defined in - -[packages/vda-common-test/src/utils.ts:3](https://github.com/verida/verida-js/blob/5040472/packages/vda-common-test/src/utils.ts#L3) diff --git a/docs/api/verida-js/modules/verida_vda_did._internal_.md b/docs/api/verida-js/modules/verida_vda_did._internal_.md deleted file mode 100644 index 7b341ce..0000000 --- a/docs/api/verida-js/modules/verida_vda_did._internal_.md +++ /dev/null @@ -1,560 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-did](verida_vda_did.md) / - -# Namespace: - -[@verida/vda-did](verida_vda_did.md). - -## Table of contents - -### Enumerations - -- [SecureContextEndpointType](../enums/verida_vda_did._internal_.SecureContextEndpointType.md) - -### Classes - -- [AbiCoder](../classes/verida_vda_did._internal_.AbiCoder.md) -- [BaseContract](../classes/verida_vda_did._internal_.BaseContract.md) -- [BigNumber](../classes/verida_vda_did._internal_.BigNumber.md) -- [Coder](../classes/verida_vda_did._internal_.Coder.md) -- [ConstructorFragment](../classes/verida_vda_did._internal_.ConstructorFragment.md) -- [Contract](../classes/verida_vda_did._internal_.Contract.md) -- [Description](../classes/verida_vda_did._internal_.Description.md) -- [ErrorDescription](../classes/verida_vda_did._internal_.ErrorDescription.md) -- [ErrorFragment](../classes/verida_vda_did._internal_.ErrorFragment.md) -- [EventFragment](../classes/verida_vda_did._internal_.EventFragment.md) -- [ForkEvent](../classes/verida_vda_did._internal_.ForkEvent.md) -- [Fragment](../classes/verida_vda_did._internal_.Fragment.md) -- [FunctionFragment](../classes/verida_vda_did._internal_.FunctionFragment.md) -- [Indexed](../classes/verida_vda_did._internal_.Indexed.md) -- [Interface](../classes/verida_vda_did._internal_.Interface.md) -- [LogDescription](../classes/verida_vda_did._internal_.LogDescription.md) -- [ParamType](../classes/verida_vda_did._internal_.ParamType.md) -- [Provider](../classes/verida_vda_did._internal_.Provider.md) -- [Reader](../classes/verida_vda_did._internal_.Reader.md) -- [RunningEvent](../classes/verida_vda_did._internal_.RunningEvent.md) -- [Signer](../classes/verida_vda_did._internal_.Signer.md) -- [TransactionDescription](../classes/verida_vda_did._internal_.TransactionDescription.md) -- [VeridaContract](../classes/verida_vda_did._internal_.VeridaContract.md) -- [Writer](../classes/verida_vda_did._internal_.Writer.md) -- [default](../classes/verida_vda_did._internal_.default.md) -- [default](../classes/verida_vda_did._internal_.default-1.md) - -### Interfaces - -- [ArrayLike](../interfaces/verida_vda_did._internal_.ArrayLike.md) -- [Block](../interfaces/verida_vda_did._internal_.Block.md) -- [BlockWithTransactions](../interfaces/verida_vda_did._internal_.BlockWithTransactions.md) -- [ConcatArray](../interfaces/verida_vda_did._internal_.ConcatArray.md) -- [Error](../interfaces/verida_vda_did._internal_.Error.md) -- [Event](../interfaces/verida_vda_did._internal_.Event.md) -- [EventFilter](../interfaces/verida_vda_did._internal_.EventFilter.md) -- [FeeData](../interfaces/verida_vda_did._internal_.FeeData.md) -- [Filter](../interfaces/verida_vda_did._internal_.Filter.md) -- [Hexable](../interfaces/verida_vda_did._internal_.Hexable.md) -- [IDIDDocument](../interfaces/verida_vda_did._internal_.IDIDDocument.md) -- [IKeyring](../interfaces/verida_vda_did._internal_.IKeyring.md) -- [IterableIterator](../interfaces/verida_vda_did._internal_.IterableIterator.md) -- [Iterator](../interfaces/verida_vda_did._internal_.Iterator.md) -- [IteratorReturnResult](../interfaces/verida_vda_did._internal_.IteratorReturnResult.md) -- [IteratorYieldResult](../interfaces/verida_vda_did._internal_.IteratorYieldResult.md) -- [JsonFragment](../interfaces/verida_vda_did._internal_.JsonFragment.md) -- [JsonFragmentType](../interfaces/verida_vda_did._internal_.JsonFragmentType.md) -- [JsonWebKey](../interfaces/verida_vda_did._internal_.JsonWebKey.md) -- [KeyringPublicKeys](../interfaces/verida_vda_did._internal_.KeyringPublicKeys.md) -- [Log](../interfaces/verida_vda_did._internal_.Log.md) -- [LookupResponse](../interfaces/verida_vda_did._internal_.LookupResponse.md) -- [OnceBlockable](../interfaces/verida_vda_did._internal_.OnceBlockable.md) -- [PopulatedTransaction](../interfaces/verida_vda_did._internal_.PopulatedTransaction.md) -- [ProofInterface](../interfaces/verida_vda_did._internal_.ProofInterface.md) -- [Result](../interfaces/verida_vda_did._internal_.Result.md) -- [SecureContextEndpoint](../interfaces/verida_vda_did._internal_.SecureContextEndpoint.md) -- [SecureContextEndpoints](../interfaces/verida_vda_did._internal_.SecureContextEndpoints.md) -- [Service](../interfaces/verida_vda_did._internal_.Service.md) -- [Transaction](../interfaces/verida_vda_did._internal_.Transaction.md) -- [TransactionReceipt](../interfaces/verida_vda_did._internal_.TransactionReceipt.md) -- [TransactionResponse](../interfaces/verida_vda_did._internal_.TransactionResponse.md) -- [VdaDidConfigurationOptions](../interfaces/verida_vda_did._internal_.VdaDidConfigurationOptions.md) -- [VdaDidEndpointResponse](../interfaces/verida_vda_did._internal_.VdaDidEndpointResponse.md) -- [VdaTransactionResult](../interfaces/verida_vda_did._internal_.VdaTransactionResult.md) -- [VeridaDocInterface](../interfaces/verida_vda_did._internal_.VeridaDocInterface.md) -- [VerificationMethod](../interfaces/verida_vda_did._internal_.VerificationMethod.md) -- [Web3ContractInfo](../interfaces/verida_vda_did._internal_.Web3ContractInfo.md) -- [Web3GasConfiguration](../interfaces/verida_vda_did._internal_.Web3GasConfiguration.md) -- [Web3GaslessPostConfig](../interfaces/verida_vda_did._internal_.Web3GaslessPostConfig.md) -- [Web3GaslessRequestConfig](../interfaces/verida_vda_did._internal_.Web3GaslessRequestConfig.md) -- [Web3MetaTransactionConfig](../interfaces/verida_vda_did._internal_.Web3MetaTransactionConfig.md) -- [Web3SelfTransactionConfig](../interfaces/verida_vda_did._internal_.Web3SelfTransactionConfig.md) -- [\_Block](../interfaces/verida_vda_did._internal_._Block.md) - -### Type aliases - -- [AccessList](verida_vda_did._internal_.md#accesslist) -- [AccessListish](verida_vda_did._internal_.md#accesslistish) -- [BigNumberish](verida_vda_did._internal_.md#bignumberish) -- [BlockTag](verida_vda_did._internal_.md#blocktag) -- [Bytes](verida_vda_did._internal_.md#bytes) -- [BytesLike](verida_vda_did._internal_.md#byteslike) -- [CoerceFunc](verida_vda_did._internal_.md#coercefunc) -- [CoerceFunc](verida_vda_did._internal_.md#coercefunc) -- [ContractFunction](verida_vda_did._internal_.md#contractfunction) -- [ContractInterface](verida_vda_did._internal_.md#contractinterface) -- [DIDDocument](verida_vda_did._internal_.md#diddocument) -- [Deferrable](verida_vda_did._internal_.md#deferrable) -- [EIP1559GasMode](verida_vda_did._internal_.md#eip1559gasmode) -- [EventFilter](verida_vda_did._internal_.md#eventfilter) -- [EventType](verida_vda_did._internal_.md#eventtype) -- [Extensible](verida_vda_did._internal_.md#extensible) -- [FlatArray](verida_vda_did._internal_.md#flatarray) -- [IteratorResult](verida_vda_did._internal_.md#iteratorresult) -- [KeyCapabilitySection](verida_vda_did._internal_.md#keycapabilitysection) -- [Listener](verida_vda_did._internal_.md#listener) -- [Network](verida_vda_did._internal_.md#network) -- [Record](verida_vda_did._internal_.md#record) -- [ServiceEndpoint](verida_vda_did._internal_.md#serviceendpoint) -- [TransactionRequest](verida_vda_did._internal_.md#transactionrequest) -- [VdaDidEndpointResponses](verida_vda_did._internal_.md#vdadidendpointresponses) -- [VeridaWeb3Config](verida_vda_did._internal_.md#veridaweb3config) -- [VeridaWeb3ConfigurationOptions](verida_vda_did._internal_.md#veridaweb3configurationoptions) -- [Web3CallType](verida_vda_did._internal_.md#web3calltype) - -### Variables - -- [Error](verida_vda_did._internal_.md#error) - -## Type aliases - -### AccessList - -Ƭ **AccessList**: { `address`: `string` ; `storageKeys`: `string`[] }[] - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:3 - -___ - -### AccessListish - -Ƭ **AccessListish**: [`AccessList`](verida_vda_did._internal_.md#accesslist) \| [`string`, `string`[]][] \| [`Record`](verida_vda_did._internal_.md#record)<`string`, `string`[]\> - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:7 - -___ - -### BigNumberish - -Ƭ **BigNumberish**: [`BigNumber`](../classes/verida_vda_did._internal_.BigNumber.md) \| [`Bytes`](verida_vda_did._internal_.md#bytes) \| `bigint` \| `string` \| `number` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:2 - -___ - -### BlockTag - -Ƭ **BlockTag**: `string` \| `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:33 - -___ - -### Bytes - -Ƭ **Bytes**: [`ArrayLike`](../interfaces/verida_vda_did._internal_.ArrayLike.md)<`number`\> - -#### Defined in - -node_modules/@ethersproject/bytes/lib/index.d.ts:1 - -___ - -### BytesLike - -Ƭ **BytesLike**: [`Bytes`](verida_vda_did._internal_.md#bytes) \| `string` - -#### Defined in - -node_modules/@ethersproject/bytes/lib/index.d.ts:2 - -___ - -### CoerceFunc - -Ƭ **CoerceFunc**: (`type`: `string`, `value`: `any`) => `any` - -#### Type declaration - -▸ (`type`, `value`): `any` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `type` | `string` | -| `value` | `any` | - -##### Returns - -`any` - -#### Defined in - -node_modules/@ethersproject/abi/lib/abi-coder.d.ts:4 - -___ - -### CoerceFunc - -Ƭ **CoerceFunc**: (`type`: `string`, `value`: `any`) => `any` - -#### Type declaration - -▸ (`type`, `value`): `any` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `type` | `string` | -| `value` | `any` | - -##### Returns - -`any` - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:10 - -___ - -### ContractFunction - -Ƭ **ContractFunction**<`T`\>: (...`args`: `any`[]) => `Promise`<`T`\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `any` | - -#### Type declaration - -▸ (...`args`): `Promise`<`T`\> - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `...args` | `any`[] | - -##### Returns - -`Promise`<`T`\> - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:45 - -___ - -### ContractInterface - -Ƭ **ContractInterface**: `string` \| `ReadonlyArray`<[`Fragment`](../classes/verida_vda_did._internal_.Fragment.md) \| [`JsonFragment`](../interfaces/verida_vda_did._internal_.JsonFragment.md) \| `string`\> \| [`Interface`](../classes/verida_vda_did._internal_.Interface.md) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:77 - -___ - -### DIDDocument - -Ƭ **DIDDocument**: { `@context?`: ``"https://www.w3.org/ns/did/v1"`` \| `string` \| `string`[] ; `alsoKnownAs?`: `string`[] ; `controller?`: `string` \| `string`[] ; `id`: `string` ; `publicKey?`: [`VerificationMethod`](../interfaces/verida_vda_did._internal_.VerificationMethod.md)[] ; `service?`: [`Service`](../interfaces/verida_vda_did._internal_.Service.md)[] ; `verificationMethod?`: [`VerificationMethod`](../interfaces/verida_vda_did._internal_.VerificationMethod.md)[] } & { [x in KeyCapabilitySection]?: (string \| VerificationMethod)[] } - -Represents a DID document. - -**`see`** [https://www.w3.org/TR/did-core/#did-document-properties](https://www.w3.org/TR/did-core/#did-document-properties) - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:60 - -___ - -### Deferrable - -Ƭ **Deferrable**<`T`\>: { [K in keyof T]: T[K] \| Promise } - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Defined in - -node_modules/@ethersproject/properties/lib/index.d.ts:3 - -___ - -### EIP1559GasMode - -Ƭ **EIP1559GasMode**: ``"safeLow"`` \| ``"standard"`` \| ``"fast"`` - -EIP1559 Gas Configuration speed - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:13 - -___ - -### EventFilter - -Ƭ **EventFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `address?` | `string` | -| `topics?` | (`string` \| `string`[])[] | - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:41 - -___ - -### EventType - -Ƭ **EventType**: `string` \| (`string` \| `string`[])[] \| [`EventFilter`](../interfaces/verida_vda_did._internal_.EventFilter.md) \| [`ForkEvent`](../classes/verida_vda_did._internal_.ForkEvent.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:121 - -___ - -### Extensible - -Ƭ **Extensible**: [`Record`](verida_vda_did._internal_.md#record)<`string`, `any`\> - -Defines an object type that can be extended with other properties. - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:4 - -___ - -### FlatArray - -Ƭ **FlatArray**<`Arr`, `Depth`\>: { `done`: `Arr` ; `recur`: `Arr` extends `ReadonlyArray` ? [`FlatArray`](verida_vda_did._internal_.md#flatarray)<`InnerArr`, [``-1``, ``0``, ``1``, ``2``, ``3``, ``4``, ``5``, ``6``, ``7``, ``8``, ``9``, ``10``, ``11``, ``12``, ``13``, ``14``, ``15``, ``16``, ``17``, ``18``, ``19``, ``20``][`Depth`]\> : `Arr` }[`Depth` extends ``-1`` ? ``"done"`` : ``"recur"``] - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `Arr` | `Arr` | -| `Depth` | extends `number` | - -#### Defined in - -node_modules/typescript/lib/lib.es2019.array.d.ts:21 - -___ - -### IteratorResult - -Ƭ **IteratorResult**<`T`, `TReturn`\>: [`IteratorYieldResult`](../interfaces/verida_vda_did._internal_.IteratorYieldResult.md)<`T`\> \| [`IteratorReturnResult`](../interfaces/verida_vda_did._internal_.IteratorReturnResult.md)<`TReturn`\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `T` | -| `TReturn` | `any` | - -#### Defined in - -node_modules/typescript/lib/lib.es2015.iterable.d.ts:41 - -___ - -### KeyCapabilitySection - -Ƭ **KeyCapabilitySection**: ``"authentication"`` \| ``"assertionMethod"`` \| ``"keyAgreement"`` \| ``"capabilityInvocation"`` \| ``"capabilityDelegation"`` - -Represents the Verification Relationship between a DID subject and a Verification Method. - -**`see`** [https://www.w3.org/TR/did-core/#verification-relationships](https://www.w3.org/TR/did-core/#verification-relationships) - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:54 - -___ - -### Listener - -Ƭ **Listener**: (...`args`: `any`[]) => `void` - -#### Type declaration - -▸ (...`args`): `void` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `...args` | `any`[] | - -##### Returns - -`void` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:122 - -___ - -### Network - -Ƭ **Network**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `chainId` | `number` | -| `ensAddress?` | `string` | -| `name` | `string` | -| `_defaultProvider?` | (`providers`: `any`, `options?`: `any`) => `any` | - -#### Defined in - -node_modules/@ethersproject/networks/lib/types.d.ts:1 - -___ - -### Record - -Ƭ **Record**<`K`, `T`\>: { [P in K]: T } - -Construct a type with a set of properties K of type T - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof `any` | -| `T` | `T` | - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1499 - -___ - -### ServiceEndpoint - -Ƭ **ServiceEndpoint**: `string` \| [`Record`](verida_vda_did._internal_.md#record)<`string`, `any`\> - -Represents an endpoint of a Service entry in a DID document. - -**`see`** [https://www.w3.org/TR/did-core/#dfn-serviceendpoint](https://www.w3.org/TR/did-core/#dfn-serviceendpoint) - -**`see`** [https://www.w3.org/TR/did-core/#services](https://www.w3.org/TR/did-core/#services) - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:92 - -___ - -### TransactionRequest - -Ƭ **TransactionRequest**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `accessList?` | [`AccessListish`](verida_vda_did._internal_.md#accesslistish) | -| `ccipReadEnabled?` | `boolean` | -| `chainId?` | `number` | -| `customData?` | [`Record`](verida_vda_did._internal_.md#record)<`string`, `any`\> | -| `data?` | [`BytesLike`](verida_vda_did._internal_.md#byteslike) | -| `from?` | `string` | -| `gasLimit?` | [`BigNumberish`](verida_vda_did._internal_.md#bignumberish) | -| `gasPrice?` | [`BigNumberish`](verida_vda_did._internal_.md#bignumberish) | -| `maxFeePerGas?` | [`BigNumberish`](verida_vda_did._internal_.md#bignumberish) | -| `maxPriorityFeePerGas?` | [`BigNumberish`](verida_vda_did._internal_.md#bignumberish) | -| `nonce?` | [`BigNumberish`](verida_vda_did._internal_.md#bignumberish) | -| `to?` | `string` | -| `type?` | `number` | -| `value?` | [`BigNumberish`](verida_vda_did._internal_.md#bignumberish) | - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:7 - -___ - -### VdaDidEndpointResponses - -Ƭ **VdaDidEndpointResponses**: [`Record`](verida_vda_did._internal_.md#record)<`string`, [`VdaDidEndpointResponse`](../interfaces/verida_vda_did._internal_.VdaDidEndpointResponse.md)\> - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:113 - -___ - -### VeridaWeb3Config - -Ƭ **VeridaWeb3Config**: [`Web3ContractInfo`](../interfaces/verida_vda_did._internal_.Web3ContractInfo.md) & [`Web3SelfTransactionConfig`](../interfaces/verida_vda_did._internal_.Web3SelfTransactionConfig.md) \| [`Web3MetaTransactionConfig`](../interfaces/verida_vda_did._internal_.Web3MetaTransactionConfig.md) - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:53 - -___ - -### VeridaWeb3ConfigurationOptions - -Ƭ **VeridaWeb3ConfigurationOptions**: [`Web3MetaTransactionConfig`](../interfaces/verida_vda_did._internal_.Web3MetaTransactionConfig.md) \| [`Web3SelfTransactionConfig`](../interfaces/verida_vda_did._internal_.Web3SelfTransactionConfig.md) - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:88 - -___ - -### Web3CallType - -Ƭ **Web3CallType**: ``"web3"`` \| ``"gasless"`` - -Web3 SDK running mode - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:5 - -## Variables - -### Error - -• **Error**: `ErrorConstructor` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:984 diff --git a/docs/api/verida-js/modules/verida_vda_did.md b/docs/api/verida-js/modules/verida_vda_did.md deleted file mode 100644 index e8572fd..0000000 --- a/docs/api/verida-js/modules/verida_vda_did.md +++ /dev/null @@ -1,13 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / @verida/vda-did - -# Module: @verida/vda-did - -## Table of contents - -### Namespaces - -- [<internal\>](verida_vda_did._internal_.md) - -### Classes - -- [VdaDid](../classes/verida_vda_did.VdaDid.md) diff --git a/docs/api/verida-js/modules/verida_vda_did_resolver._internal_.md b/docs/api/verida-js/modules/verida_vda_did_resolver._internal_.md deleted file mode 100644 index 0b19595..0000000 --- a/docs/api/verida-js/modules/verida_vda_did_resolver._internal_.md +++ /dev/null @@ -1,138 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-did-resolver](verida_vda_did_resolver.md) / - -# Namespace: - -[@verida/vda-did-resolver](verida_vda_did_resolver.md). - -## Table of contents - -### Enumerations - -- [EnvironmentType](../enums/verida_vda_did_resolver._internal_.EnvironmentType.md) - -### Interfaces - -- [DIDDocumentMetadata](../interfaces/verida_vda_did_resolver._internal_.DIDDocumentMetadata.md) -- [DIDResolutionMetadata](../interfaces/verida_vda_did_resolver._internal_.DIDResolutionMetadata.md) -- [DIDResolutionOptions](../interfaces/verida_vda_did_resolver._internal_.DIDResolutionOptions.md) -- [DIDResolutionResult](../interfaces/verida_vda_did_resolver._internal_.DIDResolutionResult.md) -- [JsonWebKey](../interfaces/verida_vda_did_resolver._internal_.JsonWebKey.md) -- [Params](../interfaces/verida_vda_did_resolver._internal_.Params.md) -- [ParsedDID](../interfaces/verida_vda_did_resolver._internal_.ParsedDID.md) -- [Resolvable](../interfaces/verida_vda_did_resolver._internal_.Resolvable.md) -- [Service](../interfaces/verida_vda_did_resolver._internal_.Service.md) -- [VerificationMethod](../interfaces/verida_vda_did_resolver._internal_.VerificationMethod.md) -- [Web3ResolverConfigurationOptions](../interfaces/verida_vda_did_resolver._internal_.Web3ResolverConfigurationOptions.md) - -### Type aliases - -- [DIDDocument](verida_vda_did_resolver._internal_.md#diddocument) -- [DIDResolver](verida_vda_did_resolver._internal_.md#didresolver) -- [Extensible](verida_vda_did_resolver._internal_.md#extensible) -- [KeyCapabilitySection](verida_vda_did_resolver._internal_.md#keycapabilitysection) -- [Record](verida_vda_did_resolver._internal_.md#record) -- [ServiceEndpoint](verida_vda_did_resolver._internal_.md#serviceendpoint) - -## Type aliases - -### DIDDocument - -Ƭ **DIDDocument**: { `@context?`: ``"https://www.w3.org/ns/did/v1"`` \| `string` \| `string`[] ; `alsoKnownAs?`: `string`[] ; `controller?`: `string` \| `string`[] ; `id`: `string` ; `publicKey?`: [`VerificationMethod`](../interfaces/verida_vda_did_resolver._internal_.VerificationMethod.md)[] ; `service?`: [`Service`](../interfaces/verida_vda_did_resolver._internal_.Service.md)[] ; `verificationMethod?`: [`VerificationMethod`](../interfaces/verida_vda_did_resolver._internal_.VerificationMethod.md)[] } & { [x in KeyCapabilitySection]?: (string \| VerificationMethod)[] } - -Represents a DID document. - -**`see`** [https://www.w3.org/TR/did-core/#did-document-properties](https://www.w3.org/TR/did-core/#did-document-properties) - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:60 - -___ - -### DIDResolver - -Ƭ **DIDResolver**: (`did`: `string`, `parsed`: [`ParsedDID`](../interfaces/verida_vda_did_resolver._internal_.ParsedDID.md), `resolver`: [`Resolvable`](../interfaces/verida_vda_did_resolver._internal_.Resolvable.md), `options`: [`DIDResolutionOptions`](../interfaces/verida_vda_did_resolver._internal_.DIDResolutionOptions.md)) => `Promise`<[`DIDResolutionResult`](../interfaces/verida_vda_did_resolver._internal_.DIDResolutionResult.md)\> - -#### Type declaration - -▸ (`did`, `parsed`, `resolver`, `options`): `Promise`<[`DIDResolutionResult`](../interfaces/verida_vda_did_resolver._internal_.DIDResolutionResult.md)\> - -The DID resolution function that DID Resolver implementations must implement. - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `did` | `string` | -| `parsed` | [`ParsedDID`](../interfaces/verida_vda_did_resolver._internal_.ParsedDID.md) | -| `resolver` | [`Resolvable`](../interfaces/verida_vda_did_resolver._internal_.Resolvable.md) | -| `options` | [`DIDResolutionOptions`](../interfaces/verida_vda_did_resolver._internal_.DIDResolutionOptions.md) | - -##### Returns - -`Promise`<[`DIDResolutionResult`](../interfaces/verida_vda_did_resolver._internal_.DIDResolutionResult.md)\> - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:163 - -___ - -### Extensible - -Ƭ **Extensible**: [`Record`](verida_vda_did_resolver._internal_.md#record)<`string`, `any`\> - -Defines an object type that can be extended with other properties. - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:4 - -___ - -### KeyCapabilitySection - -Ƭ **KeyCapabilitySection**: ``"authentication"`` \| ``"assertionMethod"`` \| ``"keyAgreement"`` \| ``"capabilityInvocation"`` \| ``"capabilityDelegation"`` - -Represents the Verification Relationship between a DID subject and a Verification Method. - -**`see`** [https://www.w3.org/TR/did-core/#verification-relationships](https://www.w3.org/TR/did-core/#verification-relationships) - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:54 - -___ - -### Record - -Ƭ **Record**<`K`, `T`\>: { [P in K]: T } - -Construct a type with a set of properties K of type T - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof `any` | -| `T` | `T` | - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1499 - -___ - -### ServiceEndpoint - -Ƭ **ServiceEndpoint**: `string` \| [`Record`](verida_vda_did_resolver._internal_.md#record)<`string`, `any`\> - -Represents an endpoint of a Service entry in a DID document. - -**`see`** [https://www.w3.org/TR/did-core/#dfn-serviceendpoint](https://www.w3.org/TR/did-core/#dfn-serviceendpoint) - -**`see`** [https://www.w3.org/TR/did-core/#services](https://www.w3.org/TR/did-core/#services) - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:92 diff --git a/docs/api/verida-js/modules/verida_vda_did_resolver.md b/docs/api/verida-js/modules/verida_vda_did_resolver.md deleted file mode 100644 index b39aabd..0000000 --- a/docs/api/verida-js/modules/verida_vda_did_resolver.md +++ /dev/null @@ -1,129 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / @verida/vda-did-resolver - -# Module: @verida/vda-did-resolver - -## Table of contents - -### Namespaces - -- [<internal\>](verida_vda_did_resolver._internal_.md) - -### Classes - -- [VdaDidResolver](../classes/verida_vda_did_resolver.VdaDidResolver.md) - -### Variables - -- [RPC\_URLS](verida_vda_did_resolver.md#rpc_urls) - -### Functions - -- [activeDIDCount](verida_vda_did_resolver.md#activedidcount) -- [getDIDs](verida_vda_did_resolver.md#getdids) -- [getResolver](verida_vda_did_resolver.md#getresolver) -- [lookup](verida_vda_did_resolver.md#lookup) - -## Variables - -### RPC\_URLS - -• `Const` **RPC\_URLS**: [`Record`](verida_vda_did_resolver._internal_.md#record)<`string`, `string` \| ``null``\> - -#### Defined in - -packages/vda-common/dist/rpc.d.ts:1 - -## Functions - -### activeDIDCount - -▸ **activeDIDCount**(`network`): `Promise`<`number`\> - -Call lookUp() function of DIDRegistry contract - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `network` | `string` | - -#### Returns - -`Promise`<`number`\> - -#### Defined in - -[packages/vda-did-resolver/src/activeDIDCount.ts:11](https://github.com/verida/verida-js/blob/5040472/packages/vda-did-resolver/src/activeDIDCount.ts#L11) - -___ - -### getDIDs - -▸ **getDIDs**(`network`, `startIndex?`, `count?`, `mostRecent?`): `Promise`<`string`[]\> - -Call lookUp() function of DIDRegistry contract - -#### Parameters - -| Name | Type | Default value | Description | -| :------ | :------ | :------ | :------ | -| `network` | [`EnvironmentType`](../enums/verida_vda_did_resolver._internal_.EnvironmentType.md) | `undefined` | Verida network to retreieve DIDs for | -| `startIndex` | `number` | `0` | Index to start | -| `count` | `number` | `20` | Total number of results to fetch | -| `mostRecent` | `boolean` | `true` | - | - -#### Returns - -`Promise`<`string`[]\> - -#### Defined in - -[packages/vda-did-resolver/src/getDIDs.ts:14](https://github.com/verida/verida-js/blob/5040472/packages/vda-did-resolver/src/getDIDs.ts#L14) - -___ - -### getResolver - -▸ **getResolver**(`options?`): [`Record`](verida_vda_did_resolver._internal_.md#record)<`string`, [`DIDResolver`](verida_vda_did_resolver._internal_.md#didresolver)\> - -Create a VdaDidResolver instance and return it - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `options?` | [`Web3ResolverConfigurationOptions`](../interfaces/verida_vda_did_resolver._internal_.Web3ResolverConfigurationOptions.md) | Configurations | - -#### Returns - -[`Record`](verida_vda_did_resolver._internal_.md#record)<`string`, [`DIDResolver`](verida_vda_did_resolver._internal_.md#didresolver)\> - -VdaDidResolver instance - -#### Defined in - -[packages/vda-did-resolver/src/resolver.ts:20](https://github.com/verida/verida-js/blob/5040472/packages/vda-did-resolver/src/resolver.ts#L20) - -___ - -### lookup - -▸ **lookup**(`didAddress`, `network`, `rpcUrl`): `Promise`<`string`[]\> - -Call lookUp() function of DIDRegistry contract - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `didAddress` | `string` | DID address to lookup | -| `network` | `string` | - | -| `rpcUrl` | `string` | URL | - -#### Returns - -`Promise`<`string`[]\> - -#### Defined in - -[packages/vda-did-resolver/src/lookup.ts:11](https://github.com/verida/verida-js/blob/5040472/packages/vda-did-resolver/src/lookup.ts#L11) diff --git a/docs/api/verida-js/modules/verida_vda_name_client._internal_.md b/docs/api/verida-js/modules/verida_vda_name_client._internal_.md deleted file mode 100644 index 4ee965b..0000000 --- a/docs/api/verida-js/modules/verida_vda_name_client._internal_.md +++ /dev/null @@ -1,464 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-name-client](verida_vda_name_client.md) / - -# Namespace: - -[@verida/vda-name-client](verida_vda_name_client.md). - -## Table of contents - -### Enumerations - -- [EnvironmentType](../enums/verida_vda_name_client._internal_.EnvironmentType.md) - -### Classes - -- [AbiCoder](../classes/verida_vda_name_client._internal_.AbiCoder.md) -- [BaseContract](../classes/verida_vda_name_client._internal_.BaseContract.md) -- [BigNumber](../classes/verida_vda_name_client._internal_.BigNumber.md) -- [Coder](../classes/verida_vda_name_client._internal_.Coder.md) -- [ConstructorFragment](../classes/verida_vda_name_client._internal_.ConstructorFragment.md) -- [Contract](../classes/verida_vda_name_client._internal_.Contract.md) -- [Description](../classes/verida_vda_name_client._internal_.Description.md) -- [ErrorDescription](../classes/verida_vda_name_client._internal_.ErrorDescription.md) -- [ErrorFragment](../classes/verida_vda_name_client._internal_.ErrorFragment.md) -- [EventFragment](../classes/verida_vda_name_client._internal_.EventFragment.md) -- [ForkEvent](../classes/verida_vda_name_client._internal_.ForkEvent.md) -- [Fragment](../classes/verida_vda_name_client._internal_.Fragment.md) -- [FunctionFragment](../classes/verida_vda_name_client._internal_.FunctionFragment.md) -- [Indexed](../classes/verida_vda_name_client._internal_.Indexed.md) -- [Interface](../classes/verida_vda_name_client._internal_.Interface.md) -- [LogDescription](../classes/verida_vda_name_client._internal_.LogDescription.md) -- [ParamType](../classes/verida_vda_name_client._internal_.ParamType.md) -- [Provider](../classes/verida_vda_name_client._internal_.Provider.md) -- [Reader](../classes/verida_vda_name_client._internal_.Reader.md) -- [RunningEvent](../classes/verida_vda_name_client._internal_.RunningEvent.md) -- [Signer](../classes/verida_vda_name_client._internal_.Signer.md) -- [TransactionDescription](../classes/verida_vda_name_client._internal_.TransactionDescription.md) -- [VeridaContract](../classes/verida_vda_name_client._internal_.VeridaContract.md) -- [Writer](../classes/verida_vda_name_client._internal_.Writer.md) - -### Interfaces - -- [ArrayLike](../interfaces/verida_vda_name_client._internal_.ArrayLike.md) -- [Block](../interfaces/verida_vda_name_client._internal_.Block.md) -- [BlockWithTransactions](../interfaces/verida_vda_name_client._internal_.BlockWithTransactions.md) -- [ConcatArray](../interfaces/verida_vda_name_client._internal_.ConcatArray.md) -- [Error](../interfaces/verida_vda_name_client._internal_.Error.md) -- [Event](../interfaces/verida_vda_name_client._internal_.Event.md) -- [EventFilter](../interfaces/verida_vda_name_client._internal_.EventFilter.md) -- [FeeData](../interfaces/verida_vda_name_client._internal_.FeeData.md) -- [Filter](../interfaces/verida_vda_name_client._internal_.Filter.md) -- [Hexable](../interfaces/verida_vda_name_client._internal_.Hexable.md) -- [IterableIterator](../interfaces/verida_vda_name_client._internal_.IterableIterator.md) -- [Iterator](../interfaces/verida_vda_name_client._internal_.Iterator.md) -- [IteratorReturnResult](../interfaces/verida_vda_name_client._internal_.IteratorReturnResult.md) -- [IteratorYieldResult](../interfaces/verida_vda_name_client._internal_.IteratorYieldResult.md) -- [JsonFragment](../interfaces/verida_vda_name_client._internal_.JsonFragment.md) -- [JsonFragmentType](../interfaces/verida_vda_name_client._internal_.JsonFragmentType.md) -- [Log](../interfaces/verida_vda_name_client._internal_.Log.md) -- [OnceBlockable](../interfaces/verida_vda_name_client._internal_.OnceBlockable.md) -- [PopulatedTransaction](../interfaces/verida_vda_name_client._internal_.PopulatedTransaction.md) -- [Result](../interfaces/verida_vda_name_client._internal_.Result.md) -- [Transaction](../interfaces/verida_vda_name_client._internal_.Transaction.md) -- [TransactionReceipt](../interfaces/verida_vda_name_client._internal_.TransactionReceipt.md) -- [TransactionResponse](../interfaces/verida_vda_name_client._internal_.TransactionResponse.md) -- [VdaClientConfig](../interfaces/verida_vda_name_client._internal_.VdaClientConfig.md) -- [VdaTransactionResult](../interfaces/verida_vda_name_client._internal_.VdaTransactionResult.md) -- [Web3ContractInfo](../interfaces/verida_vda_name_client._internal_.Web3ContractInfo.md) -- [Web3GasConfiguration](../interfaces/verida_vda_name_client._internal_.Web3GasConfiguration.md) -- [Web3GaslessPostConfig](../interfaces/verida_vda_name_client._internal_.Web3GaslessPostConfig.md) -- [Web3GaslessRequestConfig](../interfaces/verida_vda_name_client._internal_.Web3GaslessRequestConfig.md) -- [Web3MetaTransactionConfig](../interfaces/verida_vda_name_client._internal_.Web3MetaTransactionConfig.md) -- [Web3SelfTransactionConfig](../interfaces/verida_vda_name_client._internal_.Web3SelfTransactionConfig.md) -- [\_Block](../interfaces/verida_vda_name_client._internal_._Block.md) - -### Type aliases - -- [AccessList](verida_vda_name_client._internal_.md#accesslist) -- [AccessListish](verida_vda_name_client._internal_.md#accesslistish) -- [BigNumberish](verida_vda_name_client._internal_.md#bignumberish) -- [BlockTag](verida_vda_name_client._internal_.md#blocktag) -- [Bytes](verida_vda_name_client._internal_.md#bytes) -- [BytesLike](verida_vda_name_client._internal_.md#byteslike) -- [CoerceFunc](verida_vda_name_client._internal_.md#coercefunc) -- [CoerceFunc](verida_vda_name_client._internal_.md#coercefunc) -- [ContractFunction](verida_vda_name_client._internal_.md#contractfunction) -- [ContractInterface](verida_vda_name_client._internal_.md#contractinterface) -- [Deferrable](verida_vda_name_client._internal_.md#deferrable) -- [EIP1559GasMode](verida_vda_name_client._internal_.md#eip1559gasmode) -- [EventFilter](verida_vda_name_client._internal_.md#eventfilter) -- [EventType](verida_vda_name_client._internal_.md#eventtype) -- [FlatArray](verida_vda_name_client._internal_.md#flatarray) -- [IteratorResult](verida_vda_name_client._internal_.md#iteratorresult) -- [Listener](verida_vda_name_client._internal_.md#listener) -- [Network](verida_vda_name_client._internal_.md#network) -- [Record](verida_vda_name_client._internal_.md#record) -- [TransactionRequest](verida_vda_name_client._internal_.md#transactionrequest) -- [VeridaWeb3Config](verida_vda_name_client._internal_.md#veridaweb3config) -- [Web3CallType](verida_vda_name_client._internal_.md#web3calltype) - -### Variables - -- [Error](verida_vda_name_client._internal_.md#error) - -## Type aliases - -### AccessList - -Ƭ **AccessList**: { `address`: `string` ; `storageKeys`: `string`[] }[] - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:3 - -___ - -### AccessListish - -Ƭ **AccessListish**: [`AccessList`](verida_vda_name_client._internal_.md#accesslist) \| [`string`, `string`[]][] \| [`Record`](verida_vda_name_client._internal_.md#record)<`string`, `string`[]\> - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:7 - -___ - -### BigNumberish - -Ƭ **BigNumberish**: [`BigNumber`](../classes/verida_vda_name_client._internal_.BigNumber.md) \| [`Bytes`](verida_vda_name_client._internal_.md#bytes) \| `bigint` \| `string` \| `number` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:2 - -___ - -### BlockTag - -Ƭ **BlockTag**: `string` \| `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:33 - -___ - -### Bytes - -Ƭ **Bytes**: [`ArrayLike`](../interfaces/verida_vda_name_client._internal_.ArrayLike.md)<`number`\> - -#### Defined in - -node_modules/@ethersproject/bytes/lib/index.d.ts:1 - -___ - -### BytesLike - -Ƭ **BytesLike**: [`Bytes`](verida_vda_name_client._internal_.md#bytes) \| `string` - -#### Defined in - -node_modules/@ethersproject/bytes/lib/index.d.ts:2 - -___ - -### CoerceFunc - -Ƭ **CoerceFunc**: (`type`: `string`, `value`: `any`) => `any` - -#### Type declaration - -▸ (`type`, `value`): `any` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `type` | `string` | -| `value` | `any` | - -##### Returns - -`any` - -#### Defined in - -node_modules/@ethersproject/abi/lib/abi-coder.d.ts:4 - -___ - -### CoerceFunc - -Ƭ **CoerceFunc**: (`type`: `string`, `value`: `any`) => `any` - -#### Type declaration - -▸ (`type`, `value`): `any` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `type` | `string` | -| `value` | `any` | - -##### Returns - -`any` - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:10 - -___ - -### ContractFunction - -Ƭ **ContractFunction**<`T`\>: (...`args`: `any`[]) => `Promise`<`T`\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `any` | - -#### Type declaration - -▸ (...`args`): `Promise`<`T`\> - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `...args` | `any`[] | - -##### Returns - -`Promise`<`T`\> - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:45 - -___ - -### ContractInterface - -Ƭ **ContractInterface**: `string` \| `ReadonlyArray`<[`Fragment`](../classes/verida_vda_name_client._internal_.Fragment.md) \| [`JsonFragment`](../interfaces/verida_vda_name_client._internal_.JsonFragment.md) \| `string`\> \| [`Interface`](../classes/verida_vda_name_client._internal_.Interface.md) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:77 - -___ - -### Deferrable - -Ƭ **Deferrable**<`T`\>: { [K in keyof T]: T[K] \| Promise } - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Defined in - -node_modules/@ethersproject/properties/lib/index.d.ts:3 - -___ - -### EIP1559GasMode - -Ƭ **EIP1559GasMode**: ``"safeLow"`` \| ``"standard"`` \| ``"fast"`` - -EIP1559 Gas Configuration speed - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:13 - -___ - -### EventFilter - -Ƭ **EventFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `address?` | `string` | -| `topics?` | (`string` \| `string`[])[] | - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:41 - -___ - -### EventType - -Ƭ **EventType**: `string` \| (`string` \| `string`[])[] \| [`EventFilter`](../interfaces/verida_vda_name_client._internal_.EventFilter.md) \| [`ForkEvent`](../classes/verida_vda_name_client._internal_.ForkEvent.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:121 - -___ - -### FlatArray - -Ƭ **FlatArray**<`Arr`, `Depth`\>: { `done`: `Arr` ; `recur`: `Arr` extends `ReadonlyArray` ? [`FlatArray`](verida_vda_name_client._internal_.md#flatarray)<`InnerArr`, [``-1``, ``0``, ``1``, ``2``, ``3``, ``4``, ``5``, ``6``, ``7``, ``8``, ``9``, ``10``, ``11``, ``12``, ``13``, ``14``, ``15``, ``16``, ``17``, ``18``, ``19``, ``20``][`Depth`]\> : `Arr` }[`Depth` extends ``-1`` ? ``"done"`` : ``"recur"``] - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `Arr` | `Arr` | -| `Depth` | extends `number` | - -#### Defined in - -node_modules/typescript/lib/lib.es2019.array.d.ts:21 - -___ - -### IteratorResult - -Ƭ **IteratorResult**<`T`, `TReturn`\>: [`IteratorYieldResult`](../interfaces/verida_vda_name_client._internal_.IteratorYieldResult.md)<`T`\> \| [`IteratorReturnResult`](../interfaces/verida_vda_name_client._internal_.IteratorReturnResult.md)<`TReturn`\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `T` | -| `TReturn` | `any` | - -#### Defined in - -node_modules/typescript/lib/lib.es2015.iterable.d.ts:41 - -___ - -### Listener - -Ƭ **Listener**: (...`args`: `any`[]) => `void` - -#### Type declaration - -▸ (...`args`): `void` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `...args` | `any`[] | - -##### Returns - -`void` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:122 - -___ - -### Network - -Ƭ **Network**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `chainId` | `number` | -| `ensAddress?` | `string` | -| `name` | `string` | -| `_defaultProvider?` | (`providers`: `any`, `options?`: `any`) => `any` | - -#### Defined in - -node_modules/@ethersproject/networks/lib/types.d.ts:1 - -___ - -### Record - -Ƭ **Record**<`K`, `T`\>: { [P in K]: T } - -Construct a type with a set of properties K of type T - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof `any` | -| `T` | `T` | - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1499 - -___ - -### TransactionRequest - -Ƭ **TransactionRequest**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `accessList?` | [`AccessListish`](verida_vda_name_client._internal_.md#accesslistish) | -| `ccipReadEnabled?` | `boolean` | -| `chainId?` | `number` | -| `customData?` | [`Record`](verida_vda_name_client._internal_.md#record)<`string`, `any`\> | -| `data?` | [`BytesLike`](verida_vda_name_client._internal_.md#byteslike) | -| `from?` | `string` | -| `gasLimit?` | [`BigNumberish`](verida_vda_name_client._internal_.md#bignumberish) | -| `gasPrice?` | [`BigNumberish`](verida_vda_name_client._internal_.md#bignumberish) | -| `maxFeePerGas?` | [`BigNumberish`](verida_vda_name_client._internal_.md#bignumberish) | -| `maxPriorityFeePerGas?` | [`BigNumberish`](verida_vda_name_client._internal_.md#bignumberish) | -| `nonce?` | [`BigNumberish`](verida_vda_name_client._internal_.md#bignumberish) | -| `to?` | `string` | -| `type?` | `number` | -| `value?` | [`BigNumberish`](verida_vda_name_client._internal_.md#bignumberish) | - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:7 - -___ - -### VeridaWeb3Config - -Ƭ **VeridaWeb3Config**: [`Web3ContractInfo`](../interfaces/verida_vda_name_client._internal_.Web3ContractInfo.md) & [`Web3SelfTransactionConfig`](../interfaces/verida_vda_name_client._internal_.Web3SelfTransactionConfig.md) \| [`Web3MetaTransactionConfig`](../interfaces/verida_vda_name_client._internal_.Web3MetaTransactionConfig.md) - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:53 - -___ - -### Web3CallType - -Ƭ **Web3CallType**: ``"web3"`` \| ``"gasless"`` - -Web3 SDK running mode - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:5 - -## Variables - -### Error - -• **Error**: `ErrorConstructor` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:984 diff --git a/docs/api/verida-js/modules/verida_vda_name_client.md b/docs/api/verida-js/modules/verida_vda_name_client.md deleted file mode 100644 index 033b930..0000000 --- a/docs/api/verida-js/modules/verida_vda_name_client.md +++ /dev/null @@ -1,13 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / @verida/vda-name-client - -# Module: @verida/vda-name-client - -## Table of contents - -### Namespaces - -- [<internal\>](verida_vda_name_client._internal_.md) - -### Classes - -- [VeridaNameClient](../classes/verida_vda_name_client.VeridaNameClient.md) diff --git a/docs/api/verida-js/modules/verida_vda_sbt_client._internal_.md b/docs/api/verida-js/modules/verida_vda_sbt_client._internal_.md deleted file mode 100644 index 40f5bff..0000000 --- a/docs/api/verida-js/modules/verida_vda_sbt_client._internal_.md +++ /dev/null @@ -1,464 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/vda-sbt-client](verida_vda_sbt_client.md) / - -# Namespace: - -[@verida/vda-sbt-client](verida_vda_sbt_client.md). - -## Table of contents - -### Enumerations - -- [EnvironmentType](../enums/verida_vda_sbt_client._internal_.EnvironmentType.md) - -### Classes - -- [AbiCoder](../classes/verida_vda_sbt_client._internal_.AbiCoder.md) -- [BaseContract](../classes/verida_vda_sbt_client._internal_.BaseContract.md) -- [BigNumber](../classes/verida_vda_sbt_client._internal_.BigNumber.md) -- [Coder](../classes/verida_vda_sbt_client._internal_.Coder.md) -- [ConstructorFragment](../classes/verida_vda_sbt_client._internal_.ConstructorFragment.md) -- [Contract](../classes/verida_vda_sbt_client._internal_.Contract.md) -- [Description](../classes/verida_vda_sbt_client._internal_.Description.md) -- [ErrorDescription](../classes/verida_vda_sbt_client._internal_.ErrorDescription.md) -- [ErrorFragment](../classes/verida_vda_sbt_client._internal_.ErrorFragment.md) -- [EventFragment](../classes/verida_vda_sbt_client._internal_.EventFragment.md) -- [ForkEvent](../classes/verida_vda_sbt_client._internal_.ForkEvent.md) -- [Fragment](../classes/verida_vda_sbt_client._internal_.Fragment.md) -- [FunctionFragment](../classes/verida_vda_sbt_client._internal_.FunctionFragment.md) -- [Indexed](../classes/verida_vda_sbt_client._internal_.Indexed.md) -- [Interface](../classes/verida_vda_sbt_client._internal_.Interface.md) -- [LogDescription](../classes/verida_vda_sbt_client._internal_.LogDescription.md) -- [ParamType](../classes/verida_vda_sbt_client._internal_.ParamType.md) -- [Provider](../classes/verida_vda_sbt_client._internal_.Provider.md) -- [Reader](../classes/verida_vda_sbt_client._internal_.Reader.md) -- [RunningEvent](../classes/verida_vda_sbt_client._internal_.RunningEvent.md) -- [Signer](../classes/verida_vda_sbt_client._internal_.Signer.md) -- [TransactionDescription](../classes/verida_vda_sbt_client._internal_.TransactionDescription.md) -- [VeridaContract](../classes/verida_vda_sbt_client._internal_.VeridaContract.md) -- [Writer](../classes/verida_vda_sbt_client._internal_.Writer.md) - -### Interfaces - -- [ArrayLike](../interfaces/verida_vda_sbt_client._internal_.ArrayLike.md) -- [Block](../interfaces/verida_vda_sbt_client._internal_.Block.md) -- [BlockWithTransactions](../interfaces/verida_vda_sbt_client._internal_.BlockWithTransactions.md) -- [ConcatArray](../interfaces/verida_vda_sbt_client._internal_.ConcatArray.md) -- [Error](../interfaces/verida_vda_sbt_client._internal_.Error.md) -- [Event](../interfaces/verida_vda_sbt_client._internal_.Event.md) -- [EventFilter](../interfaces/verida_vda_sbt_client._internal_.EventFilter.md) -- [FeeData](../interfaces/verida_vda_sbt_client._internal_.FeeData.md) -- [Filter](../interfaces/verida_vda_sbt_client._internal_.Filter.md) -- [Hexable](../interfaces/verida_vda_sbt_client._internal_.Hexable.md) -- [IterableIterator](../interfaces/verida_vda_sbt_client._internal_.IterableIterator.md) -- [Iterator](../interfaces/verida_vda_sbt_client._internal_.Iterator.md) -- [IteratorReturnResult](../interfaces/verida_vda_sbt_client._internal_.IteratorReturnResult.md) -- [IteratorYieldResult](../interfaces/verida_vda_sbt_client._internal_.IteratorYieldResult.md) -- [JsonFragment](../interfaces/verida_vda_sbt_client._internal_.JsonFragment.md) -- [JsonFragmentType](../interfaces/verida_vda_sbt_client._internal_.JsonFragmentType.md) -- [Log](../interfaces/verida_vda_sbt_client._internal_.Log.md) -- [OnceBlockable](../interfaces/verida_vda_sbt_client._internal_.OnceBlockable.md) -- [PopulatedTransaction](../interfaces/verida_vda_sbt_client._internal_.PopulatedTransaction.md) -- [Result](../interfaces/verida_vda_sbt_client._internal_.Result.md) -- [Transaction](../interfaces/verida_vda_sbt_client._internal_.Transaction.md) -- [TransactionReceipt](../interfaces/verida_vda_sbt_client._internal_.TransactionReceipt.md) -- [TransactionResponse](../interfaces/verida_vda_sbt_client._internal_.TransactionResponse.md) -- [VdaClientConfig](../interfaces/verida_vda_sbt_client._internal_.VdaClientConfig.md) -- [VdaTransactionResult](../interfaces/verida_vda_sbt_client._internal_.VdaTransactionResult.md) -- [Web3ContractInfo](../interfaces/verida_vda_sbt_client._internal_.Web3ContractInfo.md) -- [Web3GasConfiguration](../interfaces/verida_vda_sbt_client._internal_.Web3GasConfiguration.md) -- [Web3GaslessPostConfig](../interfaces/verida_vda_sbt_client._internal_.Web3GaslessPostConfig.md) -- [Web3GaslessRequestConfig](../interfaces/verida_vda_sbt_client._internal_.Web3GaslessRequestConfig.md) -- [Web3MetaTransactionConfig](../interfaces/verida_vda_sbt_client._internal_.Web3MetaTransactionConfig.md) -- [Web3SelfTransactionConfig](../interfaces/verida_vda_sbt_client._internal_.Web3SelfTransactionConfig.md) -- [\_Block](../interfaces/verida_vda_sbt_client._internal_._Block.md) - -### Type aliases - -- [AccessList](verida_vda_sbt_client._internal_.md#accesslist) -- [AccessListish](verida_vda_sbt_client._internal_.md#accesslistish) -- [BigNumberish](verida_vda_sbt_client._internal_.md#bignumberish) -- [BlockTag](verida_vda_sbt_client._internal_.md#blocktag) -- [Bytes](verida_vda_sbt_client._internal_.md#bytes) -- [BytesLike](verida_vda_sbt_client._internal_.md#byteslike) -- [CoerceFunc](verida_vda_sbt_client._internal_.md#coercefunc) -- [CoerceFunc](verida_vda_sbt_client._internal_.md#coercefunc) -- [ContractFunction](verida_vda_sbt_client._internal_.md#contractfunction) -- [ContractInterface](verida_vda_sbt_client._internal_.md#contractinterface) -- [Deferrable](verida_vda_sbt_client._internal_.md#deferrable) -- [EIP1559GasMode](verida_vda_sbt_client._internal_.md#eip1559gasmode) -- [EventFilter](verida_vda_sbt_client._internal_.md#eventfilter) -- [EventType](verida_vda_sbt_client._internal_.md#eventtype) -- [FlatArray](verida_vda_sbt_client._internal_.md#flatarray) -- [IteratorResult](verida_vda_sbt_client._internal_.md#iteratorresult) -- [Listener](verida_vda_sbt_client._internal_.md#listener) -- [Network](verida_vda_sbt_client._internal_.md#network) -- [Record](verida_vda_sbt_client._internal_.md#record) -- [TransactionRequest](verida_vda_sbt_client._internal_.md#transactionrequest) -- [VeridaWeb3Config](verida_vda_sbt_client._internal_.md#veridaweb3config) -- [Web3CallType](verida_vda_sbt_client._internal_.md#web3calltype) - -### Variables - -- [Error](verida_vda_sbt_client._internal_.md#error) - -## Type aliases - -### AccessList - -Ƭ **AccessList**: { `address`: `string` ; `storageKeys`: `string`[] }[] - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:3 - -___ - -### AccessListish - -Ƭ **AccessListish**: [`AccessList`](verida_vda_sbt_client._internal_.md#accesslist) \| [`string`, `string`[]][] \| [`Record`](verida_vda_sbt_client._internal_.md#record)<`string`, `string`[]\> - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:7 - -___ - -### BigNumberish - -Ƭ **BigNumberish**: [`BigNumber`](../classes/verida_vda_sbt_client._internal_.BigNumber.md) \| [`Bytes`](verida_vda_sbt_client._internal_.md#bytes) \| `bigint` \| `string` \| `number` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:2 - -___ - -### BlockTag - -Ƭ **BlockTag**: `string` \| `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:33 - -___ - -### Bytes - -Ƭ **Bytes**: [`ArrayLike`](../interfaces/verida_vda_sbt_client._internal_.ArrayLike.md)<`number`\> - -#### Defined in - -node_modules/@ethersproject/bytes/lib/index.d.ts:1 - -___ - -### BytesLike - -Ƭ **BytesLike**: [`Bytes`](verida_vda_sbt_client._internal_.md#bytes) \| `string` - -#### Defined in - -node_modules/@ethersproject/bytes/lib/index.d.ts:2 - -___ - -### CoerceFunc - -Ƭ **CoerceFunc**: (`type`: `string`, `value`: `any`) => `any` - -#### Type declaration - -▸ (`type`, `value`): `any` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `type` | `string` | -| `value` | `any` | - -##### Returns - -`any` - -#### Defined in - -node_modules/@ethersproject/abi/lib/abi-coder.d.ts:4 - -___ - -### CoerceFunc - -Ƭ **CoerceFunc**: (`type`: `string`, `value`: `any`) => `any` - -#### Type declaration - -▸ (`type`, `value`): `any` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `type` | `string` | -| `value` | `any` | - -##### Returns - -`any` - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:10 - -___ - -### ContractFunction - -Ƭ **ContractFunction**<`T`\>: (...`args`: `any`[]) => `Promise`<`T`\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `any` | - -#### Type declaration - -▸ (...`args`): `Promise`<`T`\> - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `...args` | `any`[] | - -##### Returns - -`Promise`<`T`\> - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:45 - -___ - -### ContractInterface - -Ƭ **ContractInterface**: `string` \| `ReadonlyArray`<[`Fragment`](../classes/verida_vda_sbt_client._internal_.Fragment.md) \| [`JsonFragment`](../interfaces/verida_vda_sbt_client._internal_.JsonFragment.md) \| `string`\> \| [`Interface`](../classes/verida_vda_sbt_client._internal_.Interface.md) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:77 - -___ - -### Deferrable - -Ƭ **Deferrable**<`T`\>: { [K in keyof T]: T[K] \| Promise } - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Defined in - -node_modules/@ethersproject/properties/lib/index.d.ts:3 - -___ - -### EIP1559GasMode - -Ƭ **EIP1559GasMode**: ``"safeLow"`` \| ``"standard"`` \| ``"fast"`` - -EIP1559 Gas Configuration speed - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:13 - -___ - -### EventFilter - -Ƭ **EventFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `address?` | `string` | -| `topics?` | (`string` \| `string`[])[] | - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:41 - -___ - -### EventType - -Ƭ **EventType**: `string` \| (`string` \| `string`[])[] \| [`EventFilter`](../interfaces/verida_vda_sbt_client._internal_.EventFilter.md) \| [`ForkEvent`](../classes/verida_vda_sbt_client._internal_.ForkEvent.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:121 - -___ - -### FlatArray - -Ƭ **FlatArray**<`Arr`, `Depth`\>: { `done`: `Arr` ; `recur`: `Arr` extends `ReadonlyArray` ? [`FlatArray`](verida_vda_sbt_client._internal_.md#flatarray)<`InnerArr`, [``-1``, ``0``, ``1``, ``2``, ``3``, ``4``, ``5``, ``6``, ``7``, ``8``, ``9``, ``10``, ``11``, ``12``, ``13``, ``14``, ``15``, ``16``, ``17``, ``18``, ``19``, ``20``][`Depth`]\> : `Arr` }[`Depth` extends ``-1`` ? ``"done"`` : ``"recur"``] - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `Arr` | `Arr` | -| `Depth` | extends `number` | - -#### Defined in - -node_modules/typescript/lib/lib.es2019.array.d.ts:21 - -___ - -### IteratorResult - -Ƭ **IteratorResult**<`T`, `TReturn`\>: [`IteratorYieldResult`](../interfaces/verida_vda_sbt_client._internal_.IteratorYieldResult.md)<`T`\> \| [`IteratorReturnResult`](../interfaces/verida_vda_sbt_client._internal_.IteratorReturnResult.md)<`TReturn`\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `T` | -| `TReturn` | `any` | - -#### Defined in - -node_modules/typescript/lib/lib.es2015.iterable.d.ts:41 - -___ - -### Listener - -Ƭ **Listener**: (...`args`: `any`[]) => `void` - -#### Type declaration - -▸ (...`args`): `void` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `...args` | `any`[] | - -##### Returns - -`void` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:122 - -___ - -### Network - -Ƭ **Network**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `chainId` | `number` | -| `ensAddress?` | `string` | -| `name` | `string` | -| `_defaultProvider?` | (`providers`: `any`, `options?`: `any`) => `any` | - -#### Defined in - -node_modules/@ethersproject/networks/lib/types.d.ts:1 - -___ - -### Record - -Ƭ **Record**<`K`, `T`\>: { [P in K]: T } - -Construct a type with a set of properties K of type T - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof `any` | -| `T` | `T` | - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1499 - -___ - -### TransactionRequest - -Ƭ **TransactionRequest**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `accessList?` | [`AccessListish`](verida_vda_sbt_client._internal_.md#accesslistish) | -| `ccipReadEnabled?` | `boolean` | -| `chainId?` | `number` | -| `customData?` | [`Record`](verida_vda_sbt_client._internal_.md#record)<`string`, `any`\> | -| `data?` | [`BytesLike`](verida_vda_sbt_client._internal_.md#byteslike) | -| `from?` | `string` | -| `gasLimit?` | [`BigNumberish`](verida_vda_sbt_client._internal_.md#bignumberish) | -| `gasPrice?` | [`BigNumberish`](verida_vda_sbt_client._internal_.md#bignumberish) | -| `maxFeePerGas?` | [`BigNumberish`](verida_vda_sbt_client._internal_.md#bignumberish) | -| `maxPriorityFeePerGas?` | [`BigNumberish`](verida_vda_sbt_client._internal_.md#bignumberish) | -| `nonce?` | [`BigNumberish`](verida_vda_sbt_client._internal_.md#bignumberish) | -| `to?` | `string` | -| `type?` | `number` | -| `value?` | [`BigNumberish`](verida_vda_sbt_client._internal_.md#bignumberish) | - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:7 - -___ - -### VeridaWeb3Config - -Ƭ **VeridaWeb3Config**: [`Web3ContractInfo`](../interfaces/verida_vda_sbt_client._internal_.Web3ContractInfo.md) & [`Web3SelfTransactionConfig`](../interfaces/verida_vda_sbt_client._internal_.Web3SelfTransactionConfig.md) \| [`Web3MetaTransactionConfig`](../interfaces/verida_vda_sbt_client._internal_.Web3MetaTransactionConfig.md) - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:53 - -___ - -### Web3CallType - -Ƭ **Web3CallType**: ``"web3"`` \| ``"gasless"`` - -Web3 SDK running mode - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:5 - -## Variables - -### Error - -• **Error**: `ErrorConstructor` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:984 diff --git a/docs/api/verida-js/modules/verida_vda_sbt_client.md b/docs/api/verida-js/modules/verida_vda_sbt_client.md deleted file mode 100644 index 7e4fe05..0000000 --- a/docs/api/verida-js/modules/verida_vda_sbt_client.md +++ /dev/null @@ -1,13 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / @verida/vda-sbt-client - -# Module: @verida/vda-sbt-client - -## Table of contents - -### Namespaces - -- [<internal\>](verida_vda_sbt_client._internal_.md) - -### Classes - -- [VeridaSBTClient](../classes/verida_vda_sbt_client.VeridaSBTClient.md) diff --git a/docs/api/verida-js/modules/verida_verifiable_credentials._internal_.EventEmitter.md b/docs/api/verida-js/modules/verida_verifiable_credentials._internal_.EventEmitter.md deleted file mode 100644 index 1eba31c..0000000 --- a/docs/api/verida-js/modules/verida_verifiable_credentials._internal_.EventEmitter.md +++ /dev/null @@ -1,21 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](verida_verifiable_credentials.md) / [](verida_verifiable_credentials._internal_.md) / EventEmitter - -# Namespace: EventEmitter - -[@verida/verifiable-credentials](verida_verifiable_credentials.md).[](verida_verifiable_credentials._internal_.md).EventEmitter - -## Table of contents - -### References - -- [EventEmitter](verida_verifiable_credentials._internal_.EventEmitter.md#eventemitter) - -### Interfaces - -- [Abortable](../interfaces/verida_verifiable_credentials._internal_.EventEmitter.Abortable.md) - -## References - -### EventEmitter - -Re-exports [EventEmitter](../classes/verida_verifiable_credentials._internal_.EventEmitter-1.md) diff --git a/docs/api/verida-js/modules/verida_verifiable_credentials._internal_.md b/docs/api/verida-js/modules/verida_verifiable_credentials._internal_.md deleted file mode 100644 index 8b78b3d..0000000 --- a/docs/api/verida-js/modules/verida_verifiable_credentials._internal_.md +++ /dev/null @@ -1,188 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/verifiable-credentials](verida_verifiable_credentials.md) / - -# Namespace: - -[@verida/verifiable-credentials](verida_verifiable_credentials.md). - -## Table of contents - -### Namespaces - -- [EventEmitter](verida_verifiable_credentials._internal_.EventEmitter.md) - -### Enumerations - -- [ContextEngineType](../enums/verida_verifiable_credentials._internal_.ContextEngineType.md) -- [DatabasePermissionOptionsEnum](../enums/verida_verifiable_credentials._internal_.DatabasePermissionOptionsEnum.md) - -### Classes - -- [EventEmitter](../classes/verida_verifiable_credentials._internal_.EventEmitter-1.md) - -### Interfaces - -- [AbortSignal](../interfaces/verida_verifiable_credentials._internal_.AbortSignal.md) -- [AccountConfig](../interfaces/verida_verifiable_credentials._internal_.AccountConfig.md) -- [AsyncIterableIterator](../interfaces/verida_verifiable_credentials._internal_.AsyncIterableIterator.md) -- [AsyncIterator](../interfaces/verida_verifiable_credentials._internal_.AsyncIterator.md) -- [AuthContext](../interfaces/verida_verifiable_credentials._internal_.AuthContext.md) -- [AuthTypeConfig](../interfaces/verida_verifiable_credentials._internal_.AuthTypeConfig.md) -- [ContextCloseOptions](../interfaces/verida_verifiable_credentials._internal_.ContextCloseOptions.md) -- [ContextDatabaseInfo](../interfaces/verida_verifiable_credentials._internal_.ContextDatabaseInfo.md) -- [ContextInfo](../interfaces/verida_verifiable_credentials._internal_.ContextInfo.md) -- [DOMEventTarget](../interfaces/verida_verifiable_credentials._internal_.DOMEventTarget.md) -- [DatabaseCloseOptions](../interfaces/verida_verifiable_credentials._internal_.DatabaseCloseOptions.md) -- [DatabaseDeleteConfig](../interfaces/verida_verifiable_credentials._internal_.DatabaseDeleteConfig.md) -- [DatabaseOpenConfig](../interfaces/verida_verifiable_credentials._internal_.DatabaseOpenConfig.md) -- [DatabasePermissionsConfig](../interfaces/verida_verifiable_credentials._internal_.DatabasePermissionsConfig.md) -- [DatastoreOpenConfig](../interfaces/verida_verifiable_credentials._internal_.DatastoreOpenConfig.md) -- [DbRegistryEntry](../interfaces/verida_verifiable_credentials._internal_.DbRegistryEntry.md) -- [DbRegistryEntryEncryptionKey](../interfaces/verida_verifiable_credentials._internal_.DbRegistryEntryEncryptionKey.md) -- [EcdsaSignature](../interfaces/verida_verifiable_credentials._internal_.EcdsaSignature.md) -- [EndpointUsage](../interfaces/verida_verifiable_credentials._internal_.EndpointUsage.md) -- [EventEmitterOptions](../interfaces/verida_verifiable_credentials._internal_.EventEmitterOptions.md) -- [IAccount](../interfaces/verida_verifiable_credentials._internal_.IAccount.md) -- [IClient](../interfaces/verida_verifiable_credentials._internal_.IClient.md) -- [IContext](../interfaces/verida_verifiable_credentials._internal_.IContext.md) -- [IDIDContextManager](../interfaces/verida_verifiable_credentials._internal_.IDIDContextManager.md) -- [IDatabase](../interfaces/verida_verifiable_credentials._internal_.IDatabase.md) -- [IDatastore](../interfaces/verida_verifiable_credentials._internal_.IDatastore.md) -- [IDbRegistry](../interfaces/verida_verifiable_credentials._internal_.IDbRegistry.md) -- [IKeyring](../interfaces/verida_verifiable_credentials._internal_.IKeyring.md) -- [IMessaging](../interfaces/verida_verifiable_credentials._internal_.IMessaging.md) -- [INotification](../interfaces/verida_verifiable_credentials._internal_.INotification.md) -- [IProfile](../interfaces/verida_verifiable_credentials._internal_.IProfile.md) -- [ISchema](../interfaces/verida_verifiable_credentials._internal_.ISchema.md) -- [IStorageEngine](../interfaces/verida_verifiable_credentials._internal_.IStorageEngine.md) -- [Issuer](../interfaces/verida_verifiable_credentials._internal_.Issuer.md) -- [IteratorReturnResult](../interfaces/verida_verifiable_credentials._internal_.IteratorReturnResult.md) -- [IteratorYieldResult](../interfaces/verida_verifiable_credentials._internal_.IteratorYieldResult.md) -- [KeyringPublicKeys](../interfaces/verida_verifiable_credentials._internal_.KeyringPublicKeys.md) -- [MessageSendConfig](../interfaces/verida_verifiable_credentials._internal_.MessageSendConfig.md) -- [MessagesConfig](../interfaces/verida_verifiable_credentials._internal_.MessagesConfig.md) -- [NodeEventTarget](../interfaces/verida_verifiable_credentials._internal_.NodeEventTarget.md) -- [Number](../interfaces/verida_verifiable_credentials._internal_.Number.md) -- [PromiseLike](../interfaces/verida_verifiable_credentials._internal_.PromiseLike.md) -- [SecureContextConfig](../interfaces/verida_verifiable_credentials._internal_.SecureContextConfig.md) -- [SecureContextEndpoint](../interfaces/verida_verifiable_credentials._internal_.SecureContextEndpoint.md) -- [SecureContextPublicKey](../interfaces/verida_verifiable_credentials._internal_.SecureContextPublicKey.md) -- [SecureContextServices](../interfaces/verida_verifiable_credentials._internal_.SecureContextServices.md) -- [SecureStorageContextPublicKeys](../interfaces/verida_verifiable_credentials._internal_.SecureStorageContextPublicKeys.md) -- [StaticEventEmitterOptions](../interfaces/verida_verifiable_credentials._internal_.StaticEventEmitterOptions.md) -- [Web3ResolverConfigurationOptions](../interfaces/verida_verifiable_credentials._internal_.Web3ResolverConfigurationOptions.md) - -### Type aliases - -- [IteratorResult](verida_verifiable_credentials._internal_.md#iteratorresult) -- [Record](verida_verifiable_credentials._internal_.md#record) -- [ServiceEndpoint](verida_verifiable_credentials._internal_.md#serviceendpoint) -- [Signer](verida_verifiable_credentials._internal_.md#signer) - -### Variables - -- [AbortSignal](verida_verifiable_credentials._internal_.md#abortsignal) -- [Number](verida_verifiable_credentials._internal_.md#number) - -## Type aliases - -### IteratorResult - -Ƭ **IteratorResult**<`T`, `TReturn`\>: [`IteratorYieldResult`](../interfaces/verida_verifiable_credentials._internal_.IteratorYieldResult.md)<`T`\> \| [`IteratorReturnResult`](../interfaces/verida_verifiable_credentials._internal_.IteratorReturnResult.md)<`TReturn`\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `T` | -| `TReturn` | `any` | - -#### Defined in - -node_modules/typescript/lib/lib.es2015.iterable.d.ts:41 - -___ - -### Record - -Ƭ **Record**<`K`, `T`\>: { [P in K]: T } - -Construct a type with a set of properties K of type T - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof `any` | -| `T` | `T` | - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1499 - -___ - -### ServiceEndpoint - -Ƭ **ServiceEndpoint**: `string` \| [`Record`](verida_verifiable_credentials._internal_.md#record)<`string`, `any`\> - -Represents an endpoint of a Service entry in a DID document. - -**`see`** [https://www.w3.org/TR/did-core/#dfn-serviceendpoint](https://www.w3.org/TR/did-core/#dfn-serviceendpoint) - -**`see`** [https://www.w3.org/TR/did-core/#services](https://www.w3.org/TR/did-core/#services) - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:92 - -___ - -### Signer - -Ƭ **Signer**: (`data`: `string` \| `Uint8Array`) => `Promise`<[`EcdsaSignature`](../interfaces/verida_verifiable_credentials._internal_.EcdsaSignature.md) \| `string`\> - -#### Type declaration - -▸ (`data`): `Promise`<[`EcdsaSignature`](../interfaces/verida_verifiable_credentials._internal_.EcdsaSignature.md) \| `string`\> - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `string` \| `Uint8Array` | - -##### Returns - -`Promise`<[`EcdsaSignature`](../interfaces/verida_verifiable_credentials._internal_.EcdsaSignature.md) \| `string`\> - -#### Defined in - -node_modules/did-jwt/lib/JWT.d.ts:3 - -## Variables - -### AbortSignal - -• **AbortSignal**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `prototype` | [`AbortSignal`](verida_verifiable_credentials._internal_.md#abortsignal) | - -#### Defined in - -node_modules/@types/node/globals.d.ts:72 - -___ - -### Number - -• **Number**: `NumberConstructor` - -An object that represents a number of any kind. All JavaScript numbers are 64-bit floating-point numbers. - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:602 diff --git a/docs/api/verida-js/modules/verida_verifiable_credentials.md b/docs/api/verida-js/modules/verida_verifiable_credentials.md deleted file mode 100644 index dc2bb92..0000000 --- a/docs/api/verida-js/modules/verida_verifiable_credentials.md +++ /dev/null @@ -1,36 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / @verida/verifiable-credentials - -# Module: @verida/verifiable-credentials - -## Table of contents - -### Namespaces - -- [<internal\>](verida_verifiable_credentials._internal_.md) - -### Classes - -- [Credentials](../classes/verida_verifiable_credentials.Credentials.md) -- [SharingCredential](../classes/verida_verifiable_credentials.SharingCredential.md) - -### Interfaces - -- [CreateCredentialJWT](../interfaces/verida_verifiable_credentials.CreateCredentialJWT.md) -- [CreateCredentialOptions](../interfaces/verida_verifiable_credentials.CreateCredentialOptions.md) -- [VCResult](../interfaces/verida_verifiable_credentials.VCResult.md) -- [VeridaCredentialRecord](../interfaces/verida_verifiable_credentials.VeridaCredentialRecord.md) -- [VeridaCredentialSchema](../interfaces/verida_verifiable_credentials.VeridaCredentialSchema.md) - -### Variables - -- [VERIDA\_CREDENTIAL\_SCHEMA](verida_verifiable_credentials.md#verida_credential_schema) - -## Variables - -### VERIDA\_CREDENTIAL\_SCHEMA - -• `Const` **VERIDA\_CREDENTIAL\_SCHEMA**: ``"https://common.schemas.verida.io/credential/base/v0.2.0/schema.json"`` - -#### Defined in - -[packages/verifiable-credentials/src/interfaces.ts:3](https://github.com/verida/verida-js/blob/5040472/packages/verifiable-credentials/src/interfaces.ts#L3) diff --git a/docs/api/verida-js/modules/verida_web3._internal_.md b/docs/api/verida-js/modules/verida_web3._internal_.md deleted file mode 100644 index d213176..0000000 --- a/docs/api/verida-js/modules/verida_web3._internal_.md +++ /dev/null @@ -1,458 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web3](verida_web3.md) / - -# Namespace: - -[@verida/web3](verida_web3.md). - -## Table of contents - -### Classes - -- [AbiCoder](../classes/verida_web3._internal_.AbiCoder.md) -- [BaseContract](../classes/verida_web3._internal_.BaseContract.md) -- [BigNumber](../classes/verida_web3._internal_.BigNumber.md) -- [Coder](../classes/verida_web3._internal_.Coder.md) -- [ConstructorFragment](../classes/verida_web3._internal_.ConstructorFragment.md) -- [Contract](../classes/verida_web3._internal_.Contract.md) -- [Description](../classes/verida_web3._internal_.Description.md) -- [ErrorDescription](../classes/verida_web3._internal_.ErrorDescription.md) -- [ErrorFragment](../classes/verida_web3._internal_.ErrorFragment.md) -- [EventFragment](../classes/verida_web3._internal_.EventFragment.md) -- [ForkEvent](../classes/verida_web3._internal_.ForkEvent.md) -- [Fragment](../classes/verida_web3._internal_.Fragment.md) -- [FunctionFragment](../classes/verida_web3._internal_.FunctionFragment.md) -- [Indexed](../classes/verida_web3._internal_.Indexed.md) -- [Interface](../classes/verida_web3._internal_.Interface.md) -- [LogDescription](../classes/verida_web3._internal_.LogDescription.md) -- [ParamType](../classes/verida_web3._internal_.ParamType.md) -- [Provider](../classes/verida_web3._internal_.Provider.md) -- [Reader](../classes/verida_web3._internal_.Reader.md) -- [RunningEvent](../classes/verida_web3._internal_.RunningEvent.md) -- [Signer](../classes/verida_web3._internal_.Signer.md) -- [TransactionDescription](../classes/verida_web3._internal_.TransactionDescription.md) -- [Writer](../classes/verida_web3._internal_.Writer.md) - -### Interfaces - -- [ArrayLike](../interfaces/verida_web3._internal_.ArrayLike.md) -- [Block](../interfaces/verida_web3._internal_.Block.md) -- [BlockWithTransactions](../interfaces/verida_web3._internal_.BlockWithTransactions.md) -- [ConcatArray](../interfaces/verida_web3._internal_.ConcatArray.md) -- [Error](../interfaces/verida_web3._internal_.Error.md) -- [Event](../interfaces/verida_web3._internal_.Event.md) -- [EventFilter](../interfaces/verida_web3._internal_.EventFilter.md) -- [FeeData](../interfaces/verida_web3._internal_.FeeData.md) -- [Filter](../interfaces/verida_web3._internal_.Filter.md) -- [Hexable](../interfaces/verida_web3._internal_.Hexable.md) -- [IterableIterator](../interfaces/verida_web3._internal_.IterableIterator.md) -- [Iterator](../interfaces/verida_web3._internal_.Iterator.md) -- [IteratorReturnResult](../interfaces/verida_web3._internal_.IteratorReturnResult.md) -- [IteratorYieldResult](../interfaces/verida_web3._internal_.IteratorYieldResult.md) -- [JsonFragment](../interfaces/verida_web3._internal_.JsonFragment.md) -- [JsonFragmentType](../interfaces/verida_web3._internal_.JsonFragmentType.md) -- [Log](../interfaces/verida_web3._internal_.Log.md) -- [OnceBlockable](../interfaces/verida_web3._internal_.OnceBlockable.md) -- [PopulatedTransaction](../interfaces/verida_web3._internal_.PopulatedTransaction.md) -- [Result](../interfaces/verida_web3._internal_.Result.md) -- [Transaction](../interfaces/verida_web3._internal_.Transaction.md) -- [TransactionReceipt](../interfaces/verida_web3._internal_.TransactionReceipt.md) -- [TransactionResponse](../interfaces/verida_web3._internal_.TransactionResponse.md) -- [VdaTransactionResult](../interfaces/verida_web3._internal_.VdaTransactionResult.md) -- [Web3ContractInfo](../interfaces/verida_web3._internal_.Web3ContractInfo.md) -- [Web3GasConfiguration](../interfaces/verida_web3._internal_.Web3GasConfiguration.md) -- [Web3GaslessPostConfig](../interfaces/verida_web3._internal_.Web3GaslessPostConfig.md) -- [Web3GaslessRequestConfig](../interfaces/verida_web3._internal_.Web3GaslessRequestConfig.md) -- [Web3MetaTransactionConfig](../interfaces/verida_web3._internal_.Web3MetaTransactionConfig.md) -- [Web3SelfTransactionConfig](../interfaces/verida_web3._internal_.Web3SelfTransactionConfig.md) -- [\_Block](../interfaces/verida_web3._internal_._Block.md) - -### Type aliases - -- [AccessList](verida_web3._internal_.md#accesslist) -- [AccessListish](verida_web3._internal_.md#accesslistish) -- [BigNumberish](verida_web3._internal_.md#bignumberish) -- [BlockTag](verida_web3._internal_.md#blocktag) -- [Bytes](verida_web3._internal_.md#bytes) -- [BytesLike](verida_web3._internal_.md#byteslike) -- [CoerceFunc](verida_web3._internal_.md#coercefunc) -- [CoerceFunc](verida_web3._internal_.md#coercefunc) -- [ContractFunction](verida_web3._internal_.md#contractfunction) -- [ContractInterface](verida_web3._internal_.md#contractinterface) -- [Deferrable](verida_web3._internal_.md#deferrable) -- [EIP1559GasMode](verida_web3._internal_.md#eip1559gasmode) -- [EventFilter](verida_web3._internal_.md#eventfilter) -- [EventType](verida_web3._internal_.md#eventtype) -- [FlatArray](verida_web3._internal_.md#flatarray) -- [IteratorResult](verida_web3._internal_.md#iteratorresult) -- [Listener](verida_web3._internal_.md#listener) -- [Network](verida_web3._internal_.md#network) -- [Record](verida_web3._internal_.md#record) -- [TransactionRequest](verida_web3._internal_.md#transactionrequest) -- [VeridaWeb3Config](verida_web3._internal_.md#veridaweb3config) -- [Web3CallType](verida_web3._internal_.md#web3calltype) - -### Variables - -- [Error](verida_web3._internal_.md#error) - -## Type aliases - -### AccessList - -Ƭ **AccessList**: { `address`: `string` ; `storageKeys`: `string`[] }[] - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:3 - -___ - -### AccessListish - -Ƭ **AccessListish**: [`AccessList`](verida_web3._internal_.md#accesslist) \| [`string`, `string`[]][] \| [`Record`](verida_web3._internal_.md#record)<`string`, `string`[]\> - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:7 - -___ - -### BigNumberish - -Ƭ **BigNumberish**: [`BigNumber`](../classes/verida_web3._internal_.BigNumber.md) \| [`Bytes`](verida_web3._internal_.md#bytes) \| `bigint` \| `string` \| `number` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:2 - -___ - -### BlockTag - -Ƭ **BlockTag**: `string` \| `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:33 - -___ - -### Bytes - -Ƭ **Bytes**: [`ArrayLike`](../interfaces/verida_web3._internal_.ArrayLike.md)<`number`\> - -#### Defined in - -node_modules/@ethersproject/bytes/lib/index.d.ts:1 - -___ - -### BytesLike - -Ƭ **BytesLike**: [`Bytes`](verida_web3._internal_.md#bytes) \| `string` - -#### Defined in - -node_modules/@ethersproject/bytes/lib/index.d.ts:2 - -___ - -### CoerceFunc - -Ƭ **CoerceFunc**: (`type`: `string`, `value`: `any`) => `any` - -#### Type declaration - -▸ (`type`, `value`): `any` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `type` | `string` | -| `value` | `any` | - -##### Returns - -`any` - -#### Defined in - -node_modules/@ethersproject/abi/lib/abi-coder.d.ts:4 - -___ - -### CoerceFunc - -Ƭ **CoerceFunc**: (`type`: `string`, `value`: `any`) => `any` - -#### Type declaration - -▸ (`type`, `value`): `any` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `type` | `string` | -| `value` | `any` | - -##### Returns - -`any` - -#### Defined in - -node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:10 - -___ - -### ContractFunction - -Ƭ **ContractFunction**<`T`\>: (...`args`: `any`[]) => `Promise`<`T`\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `any` | - -#### Type declaration - -▸ (...`args`): `Promise`<`T`\> - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `...args` | `any`[] | - -##### Returns - -`Promise`<`T`\> - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:45 - -___ - -### ContractInterface - -Ƭ **ContractInterface**: `string` \| `ReadonlyArray`<[`Fragment`](../classes/verida_web3._internal_.Fragment.md) \| [`JsonFragment`](../interfaces/verida_web3._internal_.JsonFragment.md) \| `string`\> \| [`Interface`](../classes/verida_web3._internal_.Interface.md) - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:77 - -___ - -### Deferrable - -Ƭ **Deferrable**<`T`\>: { [K in keyof T]: T[K] \| Promise } - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Defined in - -node_modules/@ethersproject/properties/lib/index.d.ts:3 - -___ - -### EIP1559GasMode - -Ƭ **EIP1559GasMode**: ``"safeLow"`` \| ``"standard"`` \| ``"fast"`` - -EIP1559 Gas Configuration speed - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:13 - -___ - -### EventFilter - -Ƭ **EventFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `address?` | `string` | -| `topics?` | (`string` \| `string`[])[] | - -#### Defined in - -node_modules/@ethersproject/contracts/lib/index.d.ts:41 - -___ - -### EventType - -Ƭ **EventType**: `string` \| (`string` \| `string`[])[] \| [`EventFilter`](../interfaces/verida_web3._internal_.EventFilter.md) \| [`ForkEvent`](../classes/verida_web3._internal_.ForkEvent.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:121 - -___ - -### FlatArray - -Ƭ **FlatArray**<`Arr`, `Depth`\>: { `done`: `Arr` ; `recur`: `Arr` extends `ReadonlyArray` ? [`FlatArray`](verida_web3._internal_.md#flatarray)<`InnerArr`, [``-1``, ``0``, ``1``, ``2``, ``3``, ``4``, ``5``, ``6``, ``7``, ``8``, ``9``, ``10``, ``11``, ``12``, ``13``, ``14``, ``15``, ``16``, ``17``, ``18``, ``19``, ``20``][`Depth`]\> : `Arr` }[`Depth` extends ``-1`` ? ``"done"`` : ``"recur"``] - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `Arr` | `Arr` | -| `Depth` | extends `number` | - -#### Defined in - -node_modules/typescript/lib/lib.es2019.array.d.ts:21 - -___ - -### IteratorResult - -Ƭ **IteratorResult**<`T`, `TReturn`\>: [`IteratorYieldResult`](../interfaces/verida_web3._internal_.IteratorYieldResult.md)<`T`\> \| [`IteratorReturnResult`](../interfaces/verida_web3._internal_.IteratorReturnResult.md)<`TReturn`\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `T` | -| `TReturn` | `any` | - -#### Defined in - -node_modules/typescript/lib/lib.es2015.iterable.d.ts:41 - -___ - -### Listener - -Ƭ **Listener**: (...`args`: `any`[]) => `void` - -#### Type declaration - -▸ (...`args`): `void` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `...args` | `any`[] | - -##### Returns - -`void` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:122 - -___ - -### Network - -Ƭ **Network**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `chainId` | `number` | -| `ensAddress?` | `string` | -| `name` | `string` | -| `_defaultProvider?` | (`providers`: `any`, `options?`: `any`) => `any` | - -#### Defined in - -node_modules/@ethersproject/networks/lib/types.d.ts:1 - -___ - -### Record - -Ƭ **Record**<`K`, `T`\>: { [P in K]: T } - -Construct a type with a set of properties K of type T - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof `any` | -| `T` | `T` | - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1499 - -___ - -### TransactionRequest - -Ƭ **TransactionRequest**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `accessList?` | [`AccessListish`](verida_web3._internal_.md#accesslistish) | -| `ccipReadEnabled?` | `boolean` | -| `chainId?` | `number` | -| `customData?` | [`Record`](verida_web3._internal_.md#record)<`string`, `any`\> | -| `data?` | [`BytesLike`](verida_web3._internal_.md#byteslike) | -| `from?` | `string` | -| `gasLimit?` | [`BigNumberish`](verida_web3._internal_.md#bignumberish) | -| `gasPrice?` | [`BigNumberish`](verida_web3._internal_.md#bignumberish) | -| `maxFeePerGas?` | [`BigNumberish`](verida_web3._internal_.md#bignumberish) | -| `maxPriorityFeePerGas?` | [`BigNumberish`](verida_web3._internal_.md#bignumberish) | -| `nonce?` | [`BigNumberish`](verida_web3._internal_.md#bignumberish) | -| `to?` | `string` | -| `type?` | `number` | -| `value?` | [`BigNumberish`](verida_web3._internal_.md#bignumberish) | - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:7 - -___ - -### VeridaWeb3Config - -Ƭ **VeridaWeb3Config**: [`Web3ContractInfo`](../interfaces/verida_web3._internal_.Web3ContractInfo.md) & [`Web3SelfTransactionConfig`](../interfaces/verida_web3._internal_.Web3SelfTransactionConfig.md) \| [`Web3MetaTransactionConfig`](../interfaces/verida_web3._internal_.Web3MetaTransactionConfig.md) - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:53 - -___ - -### Web3CallType - -Ƭ **Web3CallType**: ``"web3"`` \| ``"gasless"`` - -Web3 SDK running mode - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:5 - -## Variables - -### Error - -• **Error**: `ErrorConstructor` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:984 diff --git a/docs/api/verida-js/modules/verida_web3.md b/docs/api/verida-js/modules/verida_web3.md deleted file mode 100644 index 580e542..0000000 --- a/docs/api/verida-js/modules/verida_web3.md +++ /dev/null @@ -1,42 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / @verida/web3 - -# Module: @verida/web3 - -## Table of contents - -### Namespaces - -- [<internal\>](verida_web3._internal_.md) - -### Classes - -- [VeridaContract](../classes/verida_web3.VeridaContract.md) - -### Functions - -- [getVeridaContract](verida_web3.md#getveridacontract) - -## Functions - -### getVeridaContract - -▸ **getVeridaContract**(`type`, `config`): [`VeridaContract`](../classes/verida_web3.VeridaContract.md) - -Create VeridaContract instance - that is verida-web3-sdk instance - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `type` | [`Web3CallType`](verida_web3._internal_.md#web3calltype) | Smart contract interaction mode | -| `config` | [`VeridaWeb3Config`](verida_web3._internal_.md#veridaweb3config) | Configuration to create Verida-web3-sdk instance | - -#### Returns - -[`VeridaContract`](../classes/verida_web3.VeridaContract.md) - -VeridaContract instance - -#### Defined in - -[packages/vda-web3-client/src/index.ts:11](https://github.com/verida/verida-js/blob/5040472/packages/vda-web3-client/src/index.ts#L11) diff --git a/docs/api/verida-js/modules/verida_web_helpers._internal_.EventEmitter.md b/docs/api/verida-js/modules/verida_web_helpers._internal_.EventEmitter.md deleted file mode 100644 index c13b082..0000000 --- a/docs/api/verida-js/modules/verida_web_helpers._internal_.EventEmitter.md +++ /dev/null @@ -1,21 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](verida_web_helpers.md) / [](verida_web_helpers._internal_.md) / EventEmitter - -# Namespace: EventEmitter - -[@verida/web-helpers](verida_web_helpers.md).[](verida_web_helpers._internal_.md).EventEmitter - -## Table of contents - -### References - -- [EventEmitter](verida_web_helpers._internal_.EventEmitter.md#eventemitter) - -### Interfaces - -- [Abortable](../interfaces/verida_web_helpers._internal_.EventEmitter.Abortable.md) - -## References - -### EventEmitter - -Re-exports [EventEmitter](../classes/verida_web_helpers._internal_.EventEmitter-1.md) diff --git a/docs/api/verida-js/modules/verida_web_helpers._internal_.md b/docs/api/verida-js/modules/verida_web_helpers._internal_.md deleted file mode 100644 index 7e7cfb6..0000000 --- a/docs/api/verida-js/modules/verida_web_helpers._internal_.md +++ /dev/null @@ -1,1575 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / [@verida/web-helpers](verida_web_helpers.md) / - -# Namespace: - -[@verida/web-helpers](verida_web_helpers.md). - -## Table of contents - -### Namespaces - -- [EventEmitter](verida_web_helpers._internal_.EventEmitter.md) - -### Enumerations - -- [ContextEngineType](../enums/verida_web_helpers._internal_.ContextEngineType.md) -- [DatabasePermissionOptionsEnum](../enums/verida_web_helpers._internal_.DatabasePermissionOptionsEnum.md) -- [EnvironmentType](../enums/verida_web_helpers._internal_.EnvironmentType.md) -- [SecureContextEndpointType](../enums/verida_web_helpers._internal_.SecureContextEndpointType.md) -- [Type](../enums/verida_web_helpers._internal_.Type.md) -- [UsedValueState](../enums/verida_web_helpers._internal_.UsedValueState.md) - -### Modules Classes - -- [Client](../classes/verida_web_helpers._internal_.Client.md) -- [Context](../classes/verida_web_helpers._internal_.Context.md) -- [DIDContextManager](../classes/verida_web_helpers._internal_.DIDContextManager.md) -- [Datastore](../classes/verida_web_helpers._internal_.Datastore.md) -- [DbRegistry](../classes/verida_web_helpers._internal_.DbRegistry.md) -- [Profile](../classes/verida_web_helpers._internal_.Profile.md) -- [Schema](../classes/verida_web_helpers._internal_.Schema.md) - -### Other Classes - -- [Ajv2020](../classes/verida_web_helpers._internal_.Ajv2020.md) -- [BigNumber](../classes/verida_web_helpers._internal_.BigNumber.md) -- [CodeGen](../classes/verida_web_helpers._internal_.CodeGen.md) -- [DIDClient](../classes/verida_web_helpers._internal_.DIDClient.md) -- [Description](../classes/verida_web_helpers._internal_.Description.md) -- [EventEmitter](../classes/verida_web_helpers._internal_.EventEmitter-1.md) -- [ForkEvent](../classes/verida_web_helpers._internal_.ForkEvent.md) -- [KeywordCxt](../classes/verida_web_helpers._internal_.KeywordCxt.md) -- [Name](../classes/verida_web_helpers._internal_.Name.md) -- [Provider](../classes/verida_web_helpers._internal_.Provider.md) -- [SchemaEnv](../classes/verida_web_helpers._internal_.SchemaEnv.md) -- [Scope](../classes/verida_web_helpers._internal_.Scope.md) -- [Signer](../classes/verida_web_helpers._internal_.Signer.md) -- [ValueScope](../classes/verida_web_helpers._internal_.ValueScope.md) -- [ValueScopeName](../classes/verida_web_helpers._internal_.ValueScopeName.md) -- [VaultAccount](../classes/verida_web_helpers._internal_.VaultAccount.md) -- [\_Code](../classes/verida_web_helpers._internal_._Code.md) -- [\_CodeOrName](../classes/verida_web_helpers._internal_._CodeOrName.md) -- [default](../classes/verida_web_helpers._internal_.default.md) -- [default](../classes/verida_web_helpers._internal_.default-1.md) -- [default](../classes/verida_web_helpers._internal_.default-2.md) -- [default](../classes/verida_web_helpers._internal_.default-3.md) -- [default](../classes/verida_web_helpers._internal_.default-4.md) -- [default](../classes/verida_web_helpers._internal_.default-5.md) - -### Interfaces - -- [AccountConfig](../interfaces/verida_web_helpers._internal_.AccountConfig.md) -- [AccountVaultConfig](../interfaces/verida_web_helpers._internal_.AccountVaultConfig.md) -- [AccountVaultRequest](../interfaces/verida_web_helpers._internal_.AccountVaultRequest.md) -- [ArrayLike](../interfaces/verida_web_helpers._internal_.ArrayLike.md) -- [AsyncFormatDefinition](../interfaces/verida_web_helpers._internal_.AsyncFormatDefinition.md) -- [AsyncIterableIterator](../interfaces/verida_web_helpers._internal_.AsyncIterableIterator.md) -- [AsyncIterator](../interfaces/verida_web_helpers._internal_.AsyncIterator.md) -- [AsyncSchema](../interfaces/verida_web_helpers._internal_.AsyncSchema.md) -- [AsyncValidateFunction](../interfaces/verida_web_helpers._internal_.AsyncValidateFunction.md) -- [AuthContext](../interfaces/verida_web_helpers._internal_.AuthContext.md) -- [AuthResponse](../interfaces/verida_web_helpers._internal_.AuthResponse.md) -- [AuthTypeConfig](../interfaces/verida_web_helpers._internal_.AuthTypeConfig.md) -- [Block](../interfaces/verida_web_helpers._internal_.Block.md) -- [BlockWithTransactions](../interfaces/verida_web_helpers._internal_.BlockWithTransactions.md) -- [CallSite](../interfaces/verida_web_helpers._internal_.CallSite.md) -- [ClientConfig](../interfaces/verida_web_helpers._internal_.ClientConfig.md) -- [CodeGenOptions](../interfaces/verida_web_helpers._internal_.CodeGenOptions.md) -- [CodeKeywordDefinition](../interfaces/verida_web_helpers._internal_.CodeKeywordDefinition.md) -- [CodeOptions](../interfaces/verida_web_helpers._internal_.CodeOptions.md) -- [ContextCloseOptions](../interfaces/verida_web_helpers._internal_.ContextCloseOptions.md) -- [ContextConfig](../interfaces/verida_web_helpers._internal_.ContextConfig.md) -- [ContextDatabaseInfo](../interfaces/verida_web_helpers._internal_.ContextDatabaseInfo.md) -- [ContextInfo](../interfaces/verida_web_helpers._internal_.ContextInfo.md) -- [CurrentOptions](../interfaces/verida_web_helpers._internal_.CurrentOptions.md) -- [DIDClientConfig](../interfaces/verida_web_helpers._internal_.DIDClientConfig.md) -- [DOMEventTarget](../interfaces/verida_web_helpers._internal_.DOMEventTarget.md) -- [DataValidateFunction](../interfaces/verida_web_helpers._internal_.DataValidateFunction.md) -- [DataValidationCxt](../interfaces/verida_web_helpers._internal_.DataValidationCxt.md) -- [DatabaseCloseOptions](../interfaces/verida_web_helpers._internal_.DatabaseCloseOptions.md) -- [DatabaseDeleteConfig](../interfaces/verida_web_helpers._internal_.DatabaseDeleteConfig.md) -- [DatabaseOpenConfig](../interfaces/verida_web_helpers._internal_.DatabaseOpenConfig.md) -- [DatabasePermissionsConfig](../interfaces/verida_web_helpers._internal_.DatabasePermissionsConfig.md) -- [DatastoreOpenConfig](../interfaces/verida_web_helpers._internal_.DatastoreOpenConfig.md) -- [DbRegistryEntry](../interfaces/verida_web_helpers._internal_.DbRegistryEntry.md) -- [DbRegistryEntryEncryptionKey](../interfaces/verida_web_helpers._internal_.DbRegistryEntryEncryptionKey.md) -- [DefaultClientConfig](../interfaces/verida_web_helpers._internal_.DefaultClientConfig.md) -- [DefaultEnvironmentConfig](../interfaces/verida_web_helpers._internal_.DefaultEnvironmentConfig.md) -- [DeprecatedOptions](../interfaces/verida_web_helpers._internal_.DeprecatedOptions.md) -- [EndpointUsage](../interfaces/verida_web_helpers._internal_.EndpointUsage.md) -- [Error](../interfaces/verida_web_helpers._internal_.Error.md) -- [ErrorObject](../interfaces/verida_web_helpers._internal_.ErrorObject.md) -- [ErrorPaths](../interfaces/verida_web_helpers._internal_.ErrorPaths.md) -- [ErrorsTextOptions](../interfaces/verida_web_helpers._internal_.ErrorsTextOptions.md) -- [Evaluated](../interfaces/verida_web_helpers._internal_.Evaluated.md) -- [EventEmitterOptions](../interfaces/verida_web_helpers._internal_.EventEmitterOptions.md) -- [EventFilter](../interfaces/verida_web_helpers._internal_.EventFilter.md) -- [FeeData](../interfaces/verida_web_helpers._internal_.FeeData.md) -- [Filter](../interfaces/verida_web_helpers._internal_.Filter.md) -- [FormatDefinition](../interfaces/verida_web_helpers._internal_.FormatDefinition.md) -- [FuncKeywordDefinition](../interfaces/verida_web_helpers._internal_.FuncKeywordDefinition.md) -- [Hexable](../interfaces/verida_web_helpers._internal_.Hexable.md) -- [IAccount](../interfaces/verida_web_helpers._internal_.IAccount.md) -- [IClient](../interfaces/verida_web_helpers._internal_.IClient.md) -- [IContext](../interfaces/verida_web_helpers._internal_.IContext.md) -- [IDIDClient](../interfaces/verida_web_helpers._internal_.IDIDClient.md) -- [IDIDContextManager](../interfaces/verida_web_helpers._internal_.IDIDContextManager.md) -- [IDIDDocument](../interfaces/verida_web_helpers._internal_.IDIDDocument.md) -- [IDatabase](../interfaces/verida_web_helpers._internal_.IDatabase.md) -- [IDatastore](../interfaces/verida_web_helpers._internal_.IDatastore.md) -- [IDbRegistry](../interfaces/verida_web_helpers._internal_.IDbRegistry.md) -- [IKeyring](../interfaces/verida_web_helpers._internal_.IKeyring.md) -- [IMessaging](../interfaces/verida_web_helpers._internal_.IMessaging.md) -- [INotification](../interfaces/verida_web_helpers._internal_.INotification.md) -- [IProfile](../interfaces/verida_web_helpers._internal_.IProfile.md) -- [ISchema](../interfaces/verida_web_helpers._internal_.ISchema.md) -- [IStorageEngine](../interfaces/verida_web_helpers._internal_.IStorageEngine.md) -- [InstanceCodeOptions](../interfaces/verida_web_helpers._internal_.InstanceCodeOptions.md) -- [IteratorReturnResult](../interfaces/verida_web_helpers._internal_.IteratorReturnResult.md) -- [IteratorYieldResult](../interfaces/verida_web_helpers._internal_.IteratorYieldResult.md) -- [JsonWebKey](../interfaces/verida_web_helpers._internal_.JsonWebKey.md) -- [KeyringPublicKeys](../interfaces/verida_web_helpers._internal_.KeyringPublicKeys.md) -- [KeywordErrorCxt](../interfaces/verida_web_helpers._internal_.KeywordErrorCxt.md) -- [KeywordErrorDefinition](../interfaces/verida_web_helpers._internal_.KeywordErrorDefinition.md) -- [Log](../interfaces/verida_web_helpers._internal_.Log.md) -- [Logger](../interfaces/verida_web_helpers._internal_.Logger.md) -- [MacroKeywordDefinition](../interfaces/verida_web_helpers._internal_.MacroKeywordDefinition.md) -- [MessageSendConfig](../interfaces/verida_web_helpers._internal_.MessageSendConfig.md) -- [MessagesConfig](../interfaces/verida_web_helpers._internal_.MessagesConfig.md) -- [NameValue](../interfaces/verida_web_helpers._internal_.NameValue.md) -- [NodeEventTarget](../interfaces/verida_web_helpers._internal_.NodeEventTarget.md) -- [Number](../interfaces/verida_web_helpers._internal_.Number.md) -- [NumberKeywords](../interfaces/verida_web_helpers._internal_.NumberKeywords.md) -- [OnceBlockable](../interfaces/verida_web_helpers._internal_.OnceBlockable.md) -- [PromiseLike](../interfaces/verida_web_helpers._internal_.PromiseLike.md) -- [ProofInterface](../interfaces/verida_web_helpers._internal_.ProofInterface.md) -- [RegExpEngine](../interfaces/verida_web_helpers._internal_.RegExpEngine.md) -- [RegExpLike](../interfaces/verida_web_helpers._internal_.RegExpLike.md) -- [Rule](../interfaces/verida_web_helpers._internal_.Rule.md) -- [RuleGroup](../interfaces/verida_web_helpers._internal_.RuleGroup.md) -- [SchemaCxt](../interfaces/verida_web_helpers._internal_.SchemaCxt.md) -- [SchemaEnvArgs](../interfaces/verida_web_helpers._internal_.SchemaEnvArgs.md) -- [SchemaObjCxt](../interfaces/verida_web_helpers._internal_.SchemaObjCxt.md) -- [SchemaObject](../interfaces/verida_web_helpers._internal_.SchemaObject.md) -- [SchemaValidateFunction](../interfaces/verida_web_helpers._internal_.SchemaValidateFunction.md) -- [ScopeOptions](../interfaces/verida_web_helpers._internal_.ScopeOptions.md) -- [ScopePath](../interfaces/verida_web_helpers._internal_.ScopePath.md) -- [SecureContextConfig](../interfaces/verida_web_helpers._internal_.SecureContextConfig.md) -- [SecureContextEndpoint](../interfaces/verida_web_helpers._internal_.SecureContextEndpoint.md) -- [SecureContextEndpoints](../interfaces/verida_web_helpers._internal_.SecureContextEndpoints.md) -- [SecureContextPublicKey](../interfaces/verida_web_helpers._internal_.SecureContextPublicKey.md) -- [SecureContextServices](../interfaces/verida_web_helpers._internal_.SecureContextServices.md) -- [SecureStorageContextPublicKeys](../interfaces/verida_web_helpers._internal_.SecureStorageContextPublicKeys.md) -- [Service](../interfaces/verida_web_helpers._internal_.Service.md) -- [SourceCode](../interfaces/verida_web_helpers._internal_.SourceCode.md) -- [StaticEventEmitterOptions](../interfaces/verida_web_helpers._internal_.StaticEventEmitterOptions.md) -- [StringKeywords](../interfaces/verida_web_helpers._internal_.StringKeywords.md) -- [Transaction](../interfaces/verida_web_helpers._internal_.Transaction.md) -- [TransactionReceipt](../interfaces/verida_web_helpers._internal_.TransactionReceipt.md) -- [TransactionResponse](../interfaces/verida_web_helpers._internal_.TransactionResponse.md) -- [URIComponents](../interfaces/verida_web_helpers._internal_.URIComponents.md) -- [UriResolver](../interfaces/verida_web_helpers._internal_.UriResolver.md) -- [VSOptions](../interfaces/verida_web_helpers._internal_.VSOptions.md) -- [ValidateFunction](../interfaces/verida_web_helpers._internal_.ValidateFunction.md) -- [ValidationRules](../interfaces/verida_web_helpers._internal_.ValidationRules.md) -- [ValueScopeOptions](../interfaces/verida_web_helpers._internal_.ValueScopeOptions.md) -- [VdaDidEndpointResponse](../interfaces/verida_web_helpers._internal_.VdaDidEndpointResponse.md) -- [VeridaDatabaseAuthContext](../interfaces/verida_web_helpers._internal_.VeridaDatabaseAuthContext.md) -- [VeridaDocInterface](../interfaces/verida_web_helpers._internal_.VeridaDocInterface.md) -- [VerificationMethod](../interfaces/verida_web_helpers._internal_.VerificationMethod.md) -- [Web3GaslessPostConfig](../interfaces/verida_web_helpers._internal_.Web3GaslessPostConfig.md) -- [Web3GaslessRequestConfig](../interfaces/verida_web_helpers._internal_.Web3GaslessRequestConfig.md) -- [Web3MetaTransactionConfig](../interfaces/verida_web_helpers._internal_.Web3MetaTransactionConfig.md) -- [Web3SelfTransactionConfigPart](../interfaces/verida_web_helpers._internal_.Web3SelfTransactionConfigPart.md) -- [\_Block](../interfaces/verida_web_helpers._internal_._Block.md) -- [\_KeywordDef](../interfaces/verida_web_helpers._internal_._KeywordDef.md) -- [\_SchemaObject](../interfaces/verida_web_helpers._internal_._SchemaObject.md) - -### Type aliases - -- [AccessList](verida_web_helpers._internal_.md#accesslist) -- [AccessListish](verida_web_helpers._internal_.md#accesslistish) -- [AddedFormat](verida_web_helpers._internal_.md#addedformat) -- [AddedKeywordDefinition](verida_web_helpers._internal_.md#addedkeyworddefinition) -- [AnySchema](verida_web_helpers._internal_.md#anyschema) -- [AnySchemaObject](verida_web_helpers._internal_.md#anyschemaobject) -- [AnyValidateFunction](verida_web_helpers._internal_.md#anyvalidatefunction) -- [AsyncFormatValidator](verida_web_helpers._internal_.md#asyncformatvalidator) -- [BigNumberish](verida_web_helpers._internal_.md#bignumberish) -- [Block](verida_web_helpers._internal_.md#block) -- [BlockTag](verida_web_helpers._internal_.md#blocktag) -- [Bytes](verida_web_helpers._internal_.md#bytes) -- [BytesLike](verida_web_helpers._internal_.md#byteslike) -- [Code](verida_web_helpers._internal_.md#code) -- [CodeItem](verida_web_helpers._internal_.md#codeitem) -- [CompileKeywordFunc](verida_web_helpers._internal_.md#compilekeywordfunc) -- [DIDDocument](verida_web_helpers._internal_.md#diddocument) -- [Deferrable](verida_web_helpers._internal_.md#deferrable) -- [EnumString](verida_web_helpers._internal_.md#enumstring) -- [EvaluatedItems](verida_web_helpers._internal_.md#evaluateditems) -- [EvaluatedProperties](verida_web_helpers._internal_.md#evaluatedproperties) -- [EventType](verida_web_helpers._internal_.md#eventtype) -- [Exclude](verida_web_helpers._internal_.md#exclude) -- [Extensible](verida_web_helpers._internal_.md#extensible) -- [Format](verida_web_helpers._internal_.md#format) -- [FormatCompare](verida_web_helpers._internal_.md#formatcompare) -- [FormatValidator](verida_web_helpers._internal_.md#formatvalidator) -- [InstanceOptions](verida_web_helpers._internal_.md#instanceoptions) -- [IsElements](verida_web_helpers._internal_.md#iselements) -- [IsEmptyRecord](verida_web_helpers._internal_.md#isemptyrecord) -- [IsEnum](verida_web_helpers._internal_.md#isenum) -- [IsRecord](verida_web_helpers._internal_.md#isrecord) -- [IsUnion](verida_web_helpers._internal_.md#isunion) -- [IsUnion\_](verida_web_helpers._internal_.md#isunion_) -- [IsValues](verida_web_helpers._internal_.md#isvalues) -- [IteratorResult](verida_web_helpers._internal_.md#iteratorresult) -- [JSONType](verida_web_helpers._internal_.md#jsontype) -- [JSONType](verida_web_helpers._internal_.md#jsontype) -- [JTDDataDef](verida_web_helpers._internal_.md#jtddatadef) -- [JTDDataType](verida_web_helpers._internal_.md#jtddatatype) -- [JTDSchemaType](verida_web_helpers._internal_.md#jtdschematype) -- [KeyCapabilitySection](verida_web_helpers._internal_.md#keycapabilitysection) -- [KeywordCxtParams](verida_web_helpers._internal_.md#keywordcxtparams) -- [KeywordDefinition](verida_web_helpers._internal_.md#keyworddefinition) -- [Known](verida_web_helpers._internal_.md#known) -- [Listener](verida_web_helpers._internal_.md#listener) -- [LocalRefs](verida_web_helpers._internal_.md#localrefs) -- [MacroKeywordFunc](verida_web_helpers._internal_.md#macrokeywordfunc) -- [Network](verida_web_helpers._internal_.md#network) -- [NonNullable](verida_web_helpers._internal_.md#nonnullable) -- [NullTypeEquality](verida_web_helpers._internal_.md#nulltypeequality) -- [Nullable](verida_web_helpers._internal_.md#nullable) -- [NumberType](verida_web_helpers._internal_.md#numbertype) -- [Omit](verida_web_helpers._internal_.md#omit) -- [OptionalKeys](verida_web_helpers._internal_.md#optionalkeys) -- [Options](verida_web_helpers._internal_.md#options) -- [Partial](verida_web_helpers._internal_.md#partial) -- [Pick](verida_web_helpers._internal_.md#pick) -- [Readonly](verida_web_helpers._internal_.md#readonly) -- [Record](verida_web_helpers._internal_.md#record) -- [RequiredInstanceOptions](verida_web_helpers._internal_.md#requiredinstanceoptions) -- [RequiredKeys](verida_web_helpers._internal_.md#requiredkeys) -- [SafeExpr](verida_web_helpers._internal_.md#safeexpr) -- [Schema](verida_web_helpers._internal_.md#schema) -- [SchemaRefs](verida_web_helpers._internal_.md#schemarefs) -- [ScopeStore](verida_web_helpers._internal_.md#scopestore) -- [ScopeValueSets](verida_web_helpers._internal_.md#scopevaluesets) -- [ScopeValues](verida_web_helpers._internal_.md#scopevalues) -- [ServiceEndpoint](verida_web_helpers._internal_.md#serviceendpoint) -- [SomeJTDSchemaType](verida_web_helpers._internal_.md#somejtdschematype) -- [StringType](verida_web_helpers._internal_.md#stringtype) -- [TransactionRequest](verida_web_helpers._internal_.md#transactionrequest) -- [TypeEquality](verida_web_helpers._internal_.md#typeequality) -- [UncheckedJSONSchemaType](verida_web_helpers._internal_.md#uncheckedjsonschematype) -- [UncheckedPartialSchema](verida_web_helpers._internal_.md#uncheckedpartialschema) -- [UncheckedPropertiesSchema](verida_web_helpers._internal_.md#uncheckedpropertiesschema) -- [UncheckedRequiredMembers](verida_web_helpers._internal_.md#uncheckedrequiredmembers) -- [UnionToIntersection](verida_web_helpers._internal_.md#uniontointersection) -- [UsedNames](verida_web_helpers._internal_.md#usednames) -- [UsedScopeValues](verida_web_helpers._internal_.md#usedscopevalues) -- [ValidationTypes](verida_web_helpers._internal_.md#validationtypes) -- [ValueReference](verida_web_helpers._internal_.md#valuereference) -- [VdaDidEndpointResponses](verida_web_helpers._internal_.md#vdadidendpointresponses) -- [Vocabulary](verida_web_helpers._internal_.md#vocabulary) -- [Web3CallType](verida_web_helpers._internal_.md#web3calltype) - -### Variables - -- [Error](verida_web_helpers._internal_.md#error) -- [EventEmitter](verida_web_helpers._internal_.md#eventemitter) -- [Number](verida_web_helpers._internal_.md#number) -- [\_jsonTypes](verida_web_helpers._internal_.md#_jsontypes) - -## Type aliases - -### AccessList - -Ƭ **AccessList**: { `address`: `string` ; `storageKeys`: `string`[] }[] - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:3 - -___ - -### AccessListish - -Ƭ **AccessListish**: [`AccessList`](verida_web_helpers._internal_.md#accesslist) \| [`string`, `string`[]][] \| [`Record`](verida_web_helpers._internal_.md#record)<`string`, `string`[]\> - -#### Defined in - -node_modules/@ethersproject/transactions/lib/index.d.ts:7 - -___ - -### AddedFormat - -Ƭ **AddedFormat**: ``true`` \| `RegExp` \| [`FormatValidator`](verida_web_helpers._internal_.md#formatvalidator)<`string`\> \| [`FormatDefinition`](../interfaces/verida_web_helpers._internal_.FormatDefinition.md)<`string`\> \| [`FormatDefinition`](../interfaces/verida_web_helpers._internal_.FormatDefinition.md)<`number`\> \| [`AsyncFormatDefinition`](../interfaces/verida_web_helpers._internal_.AsyncFormatDefinition.md)<`string`\> \| [`AsyncFormatDefinition`](../interfaces/verida_web_helpers._internal_.AsyncFormatDefinition.md)<`number`\> - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:169 - -___ - -### AddedKeywordDefinition - -Ƭ **AddedKeywordDefinition**: [`KeywordDefinition`](verida_web_helpers._internal_.md#keyworddefinition) & { `schemaType`: [`JSONType`](verida_web_helpers._internal_.md#jsontype)[] ; `type`: [`JSONType`](verida_web_helpers._internal_.md#jsontype)[] } - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:128 - -___ - -### AnySchema - -Ƭ **AnySchema**: [`Schema`](verida_web_helpers._internal_.md#schema) \| [`AsyncSchema`](../interfaces/verida_web_helpers._internal_.AsyncSchema.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:25 - -___ - -### AnySchemaObject - -Ƭ **AnySchemaObject**: [`SchemaObject`](../interfaces/verida_web_helpers._internal_.SchemaObject.md) \| [`AsyncSchema`](../interfaces/verida_web_helpers._internal_.AsyncSchema.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:23 - -___ - -### AnyValidateFunction - -Ƭ **AnyValidateFunction**<`T`\>: [`ValidateFunction`](../interfaces/verida_web_helpers._internal_.ValidateFunction.md)<`T`\> \| [`AsyncValidateFunction`](../interfaces/verida_web_helpers._internal_.AsyncValidateFunction.md)<`T`\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `any` | - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:73 - -___ - -### AsyncFormatValidator - -Ƭ **AsyncFormatValidator**<`T`\>: (`data`: `T`) => `Promise`<`boolean`\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | extends `string` \| `number` | - -#### Type declaration - -▸ (`data`): `Promise`<`boolean`\> - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `T` | - -##### Returns - -`Promise`<`boolean`\> - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:156 - -___ - -### BigNumberish - -Ƭ **BigNumberish**: [`BigNumber`](../classes/verida_web_helpers._internal_.BigNumber.md) \| [`Bytes`](verida_web_helpers._internal_.md#bytes) \| `bigint` \| `string` \| `number` - -#### Defined in - -node_modules/@ethersproject/bignumber/lib/bignumber.d.ts:2 - -___ - -### Block - -Ƭ **Block**: [`Code`](verida_web_helpers._internal_.md#code) \| () => `void` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/index.d.ts:7 - -___ - -### BlockTag - -Ƭ **BlockTag**: `string` \| `number` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:33 - -___ - -### Bytes - -Ƭ **Bytes**: [`ArrayLike`](../interfaces/verida_web_helpers._internal_.ArrayLike.md)<`number`\> - -#### Defined in - -node_modules/@ethersproject/bytes/lib/index.d.ts:1 - -___ - -### BytesLike - -Ƭ **BytesLike**: [`Bytes`](verida_web_helpers._internal_.md#bytes) \| `string` - -#### Defined in - -node_modules/@ethersproject/bytes/lib/index.d.ts:2 - -___ - -### Code - -Ƭ **Code**: [`_Code`](../classes/verida_web_helpers._internal_._Code.md) \| [`Name`](../classes/verida_web_helpers._internal_.Name.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/code.d.ts:27 - -___ - -### CodeItem - -Ƭ **CodeItem**: [`Name`](../classes/verida_web_helpers._internal_.Name.md) \| `string` \| `number` \| `boolean` \| ``null`` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/code.d.ts:25 - -___ - -### CompileKeywordFunc - -Ƭ **CompileKeywordFunc**: (`schema`: `any`, `parentSchema`: [`AnySchemaObject`](verida_web_helpers._internal_.md#anyschemaobject), `it`: [`SchemaObjCxt`](../interfaces/verida_web_helpers._internal_.SchemaObjCxt.md)) => [`DataValidateFunction`](../interfaces/verida_web_helpers._internal_.DataValidateFunction.md) - -#### Type declaration - -▸ (`schema`, `parentSchema`, `it`): [`DataValidateFunction`](../interfaces/verida_web_helpers._internal_.DataValidateFunction.md) - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `schema` | `any` | -| `parentSchema` | [`AnySchemaObject`](verida_web_helpers._internal_.md#anyschemaobject) | -| `it` | [`SchemaObjCxt`](../interfaces/verida_web_helpers._internal_.SchemaObjCxt.md) | - -##### Returns - -[`DataValidateFunction`](../interfaces/verida_web_helpers._internal_.DataValidateFunction.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:106 - -___ - -### DIDDocument - -Ƭ **DIDDocument**: { `@context?`: ``"https://www.w3.org/ns/did/v1"`` \| `string` \| `string`[] ; `alsoKnownAs?`: `string`[] ; `controller?`: `string` \| `string`[] ; `id`: `string` ; `publicKey?`: [`VerificationMethod`](../interfaces/verida_web_helpers._internal_.VerificationMethod.md)[] ; `service?`: [`Service`](../interfaces/verida_web_helpers._internal_.Service.md)[] ; `verificationMethod?`: [`VerificationMethod`](../interfaces/verida_web_helpers._internal_.VerificationMethod.md)[] } & { [x in KeyCapabilitySection]?: (string \| VerificationMethod)[] } - -Represents a DID document. - -**`see`** [https://www.w3.org/TR/did-core/#did-document-properties](https://www.w3.org/TR/did-core/#did-document-properties) - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:60 - -___ - -### Deferrable - -Ƭ **Deferrable**<`T`\>: { [K in keyof T]: T[K] \| Promise } - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Defined in - -node_modules/@ethersproject/properties/lib/index.d.ts:3 - -___ - -### EnumString - -Ƭ **EnumString**<`T`\>: [`T`] extends [`never`] ? ``null`` : `T` extends `string` ? `string` extends `T` ? ``null`` : `T` : ``null`` - -gets only the string literals of a type or null if a type isn't a string literal - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/jtd-schema.d.ts:49 - -___ - -### EvaluatedItems - -Ƭ **EvaluatedItems**: `number` \| ``true`` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:62 - -___ - -### EvaluatedProperties - -Ƭ **EvaluatedProperties**: { [K in string]?: true } \| ``true`` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:59 - -___ - -### EventType - -Ƭ **EventType**: `string` \| (`string` \| `string`[])[] \| [`EventFilter`](../interfaces/verida_web_helpers._internal_.EventFilter.md) \| [`ForkEvent`](../classes/verida_web_helpers._internal_.ForkEvent.md) - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:121 - -___ - -### Exclude - -Ƭ **Exclude**<`T`, `U`\>: `T` extends `U` ? `never` : `T` - -Exclude from T those types that are assignable to U - -#### Type parameters - -| Name | -| :------ | -| `T` | -| `U` | - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1506 - -___ - -### Extensible - -Ƭ **Extensible**: [`Record`](verida_web_helpers._internal_.md#record)<`string`, `any`\> - -Defines an object type that can be extended with other properties. - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:4 - -___ - -### Format - -Ƭ **Format**: [`AddedFormat`](verida_web_helpers._internal_.md#addedformat) \| `string` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:170 - -___ - -### FormatCompare - -Ƭ **FormatCompare**<`T`\>: (`data1`: `T`, `data2`: `T`) => `number` \| `undefined` - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | extends `string` \| `number` | - -#### Type declaration - -▸ (`data1`, `data2`): `number` \| `undefined` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `data1` | `T` | -| `data2` | `T` | - -##### Returns - -`number` \| `undefined` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:155 - -___ - -### FormatValidator - -Ƭ **FormatValidator**<`T`\>: (`data`: `T`) => `boolean` - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | extends `string` \| `number` | - -#### Type declaration - -▸ (`data`): `boolean` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `T` | - -##### Returns - -`boolean` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:154 - -___ - -### InstanceOptions - -Ƭ **InstanceOptions**: [`Options`](verida_web_helpers._internal_.md#options) & [`RequiredInstanceOptions`](verida_web_helpers._internal_.md#requiredinstanceoptions) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:100 - -___ - -### IsElements - -Ƭ **IsElements**<`T`\>: ``false`` extends [`IsUnion`](verida_web_helpers._internal_.md#isunion)<`T`\> ? [`T`] extends [readonly `unknown`[]] ? `undefined` extends `T`[``0.5``] ? ``false`` : ``true`` : ``false`` : ``false`` - -true only if all types are array types (not tuples) - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/jtd-schema.d.ts:53 - -___ - -### IsEmptyRecord - -Ƭ **IsEmptyRecord**<`T`\>: [`T`] extends [[`Record`](verida_web_helpers._internal_.md#record)<`string`, `never`\>] ? [`T`] extends [`never`] ? ``false`` : ``true`` : ``false`` - -true if type represents an empty record - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/jtd-schema.d.ts:59 - -___ - -### IsEnum - -Ƭ **IsEnum**<`T`\>: ``null`` extends [`EnumString`](verida_web_helpers._internal_.md#enumstring)<`T`\> ? ``false`` : ``true`` - -true if type is a union of string literals - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/jtd-schema.d.ts:51 - -___ - -### IsRecord - -Ƭ **IsRecord**<`T`, `Union`\>: `Union` extends [`IsUnion`](verida_web_helpers._internal_.md#isunion)<`T`\> ? ``null`` extends [`EnumString`](verida_web_helpers._internal_.md#enumstring) ? ``false`` : ``true`` : ``false`` - -true if type is a properties type and Union is false, or type is a discriminator type and Union is true - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `T` | -| `Union` | extends `boolean` | - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/jtd-schema.d.ts:57 - -___ - -### IsUnion - -Ƭ **IsUnion**<`T`\>: [`IsUnion_`](verida_web_helpers._internal_.md#isunion_)<`T`\> - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/jtd-schema.d.ts:43 - -___ - -### IsUnion\_ - -Ƭ **IsUnion\_**<`T`, `U`\>: ``false`` extends `T` extends `unknown` ? [`U`] extends [`T`] ? ``false`` : ``true`` : `never` ? ``false`` : ``true`` - -type is true if T is a union type - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `T` | -| `U` | extends `T` = `T` | - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/jtd-schema.d.ts:42 - -___ - -### IsValues - -Ƭ **IsValues**<`T`\>: ``false`` extends [`IsUnion`](verida_web_helpers._internal_.md#isunion)<`T`\> ? [`TypeEquality`](verida_web_helpers._internal_.md#typeequality) : ``false`` - -true if the the type is a values type - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/jtd-schema.d.ts:55 - -___ - -### IteratorResult - -Ƭ **IteratorResult**<`T`, `TReturn`\>: [`IteratorYieldResult`](../interfaces/verida_web_helpers._internal_.IteratorYieldResult.md)<`T`\> \| [`IteratorReturnResult`](../interfaces/verida_web_helpers._internal_.IteratorReturnResult.md)<`TReturn`\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `T` | -| `TReturn` | `any` | - -#### Defined in - -node_modules/typescript/lib/lib.es2015.iterable.d.ts:41 - -___ - -### JSONType - -Ƭ **JSONType**: typeof [`_jsonTypes`](verida_web_helpers._internal_.md#_jsontypes)[`number`] - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/rules.d.ts:3 - -___ - -### JSONType - -Ƭ **JSONType**<`T`, `IsPartial`\>: `IsPartial` extends ``true`` ? `T` \| `undefined` : `T` - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | extends `string` | -| `IsPartial` | extends `boolean` | - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/json-schema.d.ts:6 - -___ - -### JTDDataDef - -Ƭ **JTDDataDef**<`S`, `D`\>: `S` extends { `ref`: `string` } ? `D` extends { [K in S["ref"]]: infer V } ? [`JTDDataDef`](verida_web_helpers._internal_.md#jtddatadef)<`V`, `D`\> : `never` : `S` extends { `type`: [`NumberType`](verida_web_helpers._internal_.md#numbertype) } ? `number` : `S` extends { `type`: ``"boolean"`` } ? `boolean` : `S` extends { `type`: ``"string"`` } ? `string` : `S` extends { `type`: ``"timestamp"`` } ? `string` \| `Date` : `S` extends { `enum`: readonly infer E[] } ? `string` extends `E` ? `never` : [`E`] extends [`string`] ? `E` : `never` : `S` extends { `elements`: infer E } ? [`JTDDataDef`](verida_web_helpers._internal_.md#jtddatadef)<`E`, `D`\>[] : `S` extends { `additionalProperties?`: `boolean` ; `optionalProperties?`: [`Record`](verida_web_helpers._internal_.md#record)<`string`, `unknown`\> ; `properties`: [`Record`](verida_web_helpers._internal_.md#record)<`string`, `unknown`\> } ? { -readonly [K in keyof S["properties"]]-?: JTDDataDef } & { -readonly [K in keyof S["optionalProperties"]]?: JTDDataDef } & [`S`[``"additionalProperties"``]] extends [``true``] ? [`Record`](verida_web_helpers._internal_.md#record)<`string`, `unknown`\> : `unknown` : `S` extends { `additionalProperties?`: `boolean` ; `optionalProperties`: [`Record`](verida_web_helpers._internal_.md#record)<`string`, `unknown`\> ; `properties?`: [`Record`](verida_web_helpers._internal_.md#record)<`string`, `unknown`\> } ? { -readonly [K in keyof S["properties"]]-?: JTDDataDef } & { -readonly [K in keyof S["optionalProperties"]]?: JTDDataDef } & [`S`[``"additionalProperties"``]] extends [``true``] ? [`Record`](verida_web_helpers._internal_.md#record)<`string`, `unknown`\> : `unknown` : `S` extends { `values`: infer V } ? [`Record`](verida_web_helpers._internal_.md#record)<`string`, [`JTDDataDef`](verida_web_helpers._internal_.md#jtddatadef)<`V`, `D`\>\> : `S` extends { `discriminator`: infer M ; `mapping`: [`Record`](verida_web_helpers._internal_.md#record)<`string`, `unknown`\> } ? [`M`] extends [`string`] ? { [K in keyof S["mapping"]]: JTDDataDef & { [KM in M]: K } }[keyof `S`[``"mapping"``]] : `never` : `unknown` \| `S` extends { `nullable`: ``true`` } ? ``null`` : `never` - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `S` | `S` | -| `D` | extends [`Record`](verida_web_helpers._internal_.md#record)<`string`, `unknown`\> | - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/jtd-schema.d.ts:126 - -___ - -### JTDDataType - -Ƭ **JTDDataType**<`S`\>: `S` extends { `definitions`: [`Record`](verida_web_helpers._internal_.md#record)<`string`, `unknown`\> } ? [`JTDDataDef`](verida_web_helpers._internal_.md#jtddatadef)<`S`, `S`[``"definitions"``]\> : [`JTDDataDef`](verida_web_helpers._internal_.md#jtddatadef)<`S`, [`Record`](verida_web_helpers._internal_.md#record)<`string`, `never`\>\> - -#### Type parameters - -| Name | -| :------ | -| `S` | - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/jtd-schema.d.ts:171 - -___ - -### JTDSchemaType - -Ƭ **JTDSchemaType**<`T`, `D`\>: ``null`` extends [`EnumString`](verida_web_helpers._internal_.md#enumstring) ? `never` : { [K in keyof D]: [T] extends [D[K]] ? Object : never }[keyof `D`] & { `nullable?`: ``false`` } \| ``null`` extends `T` ? { [K in keyof D]: [Exclude] extends [Exclude] ? Object : never }[keyof `D`] & { `nullable`: ``true`` } : `never` \| `unknown` extends `T` ? { `nullable?`: `boolean` } : `never` \| ``true`` extends [`NullTypeEquality`](verida_web_helpers._internal_.md#nulltypeequality)<`T`, `number`\> ? { `type`: [`NumberType`](verida_web_helpers._internal_.md#numbertype) } : ``true`` extends [`NullTypeEquality`](verida_web_helpers._internal_.md#nulltypeequality)<`T`, `boolean`\> ? { `type`: ``"boolean"`` } : ``true`` extends [`NullTypeEquality`](verida_web_helpers._internal_.md#nulltypeequality)<`T`, `string`\> ? { `type`: [`StringType`](verida_web_helpers._internal_.md#stringtype) } : ``true`` extends [`NullTypeEquality`](verida_web_helpers._internal_.md#nulltypeequality)<`T`, `Date`\> ? { `type`: ``"timestamp"`` } : ``true`` extends [`IsEnum`](verida_web_helpers._internal_.md#isenum)<[`Exclude`](verida_web_helpers._internal_.md#exclude)<`T`, ``null``\>\> ? { `enum`: [`EnumString`](verida_web_helpers._internal_.md#enumstring)<[`Exclude`](verida_web_helpers._internal_.md#exclude)<`T`, ``null``\>\>[] } : ``true`` extends [`IsElements`](verida_web_helpers._internal_.md#iselements)<[`Exclude`](verida_web_helpers._internal_.md#exclude)<`T`, ``null``\>\> ? `T` extends readonly infer E[] ? { `elements`: [`JTDSchemaType`](verida_web_helpers._internal_.md#jtdschematype)<`E`, `D`\> } : `never` : ``true`` extends [`IsEmptyRecord`](verida_web_helpers._internal_.md#isemptyrecord)<[`Exclude`](verida_web_helpers._internal_.md#exclude)<`T`, ``null``\>\> ? { `optionalProperties?`: [`Record`](verida_web_helpers._internal_.md#record)<`string`, `never`\> ; `properties`: [`Record`](verida_web_helpers._internal_.md#record)<`string`, `never`\> } \| { `optionalProperties`: [`Record`](verida_web_helpers._internal_.md#record)<`string`, `never`\> } : ``true`` extends [`IsValues`](verida_web_helpers._internal_.md#isvalues)<[`Exclude`](verida_web_helpers._internal_.md#exclude)<`T`, ``null``\>\> ? `T` extends [`Record`](verida_web_helpers._internal_.md#record)<`string`, infer V\> ? { `values`: [`JTDSchemaType`](verida_web_helpers._internal_.md#jtdschematype)<`V`, `D`\> } : `never` : ``true`` extends [`IsRecord`](verida_web_helpers._internal_.md#isrecord)<[`Exclude`](verida_web_helpers._internal_.md#exclude)<`T`, ``null``\>, ``false``\> ? [[`RequiredKeys`](verida_web_helpers._internal_.md#requiredkeys)<[`Exclude`](verida_web_helpers._internal_.md#exclude)<`T`, ``null``\>\>] extends [`never`] ? { `properties?`: [`Record`](verida_web_helpers._internal_.md#record)<`string`, `never`\> } : { `properties`: { [K in RequiredKeys]: JTDSchemaType } } & [[`OptionalKeys`](verida_web_helpers._internal_.md#optionalkeys)<[`Exclude`](verida_web_helpers._internal_.md#exclude)<`T`, ``null``\>\>] extends [`never`] ? { `optionalProperties?`: [`Record`](verida_web_helpers._internal_.md#record)<`string`, `never`\> } : { `optionalProperties`: { [K in OptionalKeys]: JTDSchemaType, D\> } } & { `additionalProperties?`: `boolean` } : ``true`` extends [`IsRecord`](verida_web_helpers._internal_.md#isrecord)<[`Exclude`](verida_web_helpers._internal_.md#exclude)<`T`, ``null``\>, ``true``\> ? { [K in keyof Exclude]-?: Exclude[K] extends string ? Object : never }[keyof [`Exclude`](verida_web_helpers._internal_.md#exclude)<`T`, ``null``\>] : `never` & ``null`` extends `T` ? { `nullable`: ``true`` } : { `nullable?`: ``false`` } & { `definitions?`: { [K in keyof D]: JTDSchemaType } ; `metadata?`: [`Record`](verida_web_helpers._internal_.md#record)<`string`, `unknown`\> } - -actual schema - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `T` | -| `D` | extends [`Record`](verida_web_helpers._internal_.md#record)<`string`, `unknown`\> = [`Record`](verida_web_helpers._internal_.md#record)<`string`, `never`\> | - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/jtd-schema.d.ts:61 - -___ - -### KeyCapabilitySection - -Ƭ **KeyCapabilitySection**: ``"authentication"`` \| ``"assertionMethod"`` \| ``"keyAgreement"`` \| ``"capabilityInvocation"`` \| ``"capabilityDelegation"`` - -Represents the Verification Relationship between a DID subject and a Verification Method. - -**`see`** [https://www.w3.org/TR/did-core/#verification-relationships](https://www.w3.org/TR/did-core/#verification-relationships) - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:54 - -___ - -### KeywordCxtParams - -Ƭ **KeywordCxtParams**: { [P in string]?: Code \| string \| number } - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:151 - -___ - -### KeywordDefinition - -Ƭ **KeywordDefinition**: [`CodeKeywordDefinition`](../interfaces/verida_web_helpers._internal_.CodeKeywordDefinition.md) \| [`FuncKeywordDefinition`](../interfaces/verida_web_helpers._internal_.FuncKeywordDefinition.md) \| [`MacroKeywordDefinition`](../interfaces/verida_web_helpers._internal_.MacroKeywordDefinition.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:127 - -___ - -### Known - -Ƭ **Known**: { `[key: string]`: [`Known`](verida_web_helpers._internal_.md#known); } \| [[`Known`](verida_web_helpers._internal_.md#known), ...Known[]] \| [`Known`](verida_web_helpers._internal_.md#known)[] \| `number` \| `string` \| `boolean` \| ``null`` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/json-schema.d.ts:101 - -___ - -### Listener - -Ƭ **Listener**: (...`args`: `any`[]) => `void` - -#### Type declaration - -▸ (...`args`): `void` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `...args` | `any`[] | - -##### Returns - -`void` - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:122 - -___ - -### LocalRefs - -Ƭ **LocalRefs**: { [Ref in string]?: AnySchemaObject } - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/resolve.d.ts:4 - -___ - -### MacroKeywordFunc - -Ƭ **MacroKeywordFunc**: (`schema`: `any`, `parentSchema`: [`AnySchemaObject`](verida_web_helpers._internal_.md#anyschemaobject), `it`: [`SchemaCxt`](../interfaces/verida_web_helpers._internal_.SchemaCxt.md)) => [`AnySchema`](verida_web_helpers._internal_.md#anyschema) - -#### Type declaration - -▸ (`schema`, `parentSchema`, `it`): [`AnySchema`](verida_web_helpers._internal_.md#anyschema) - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `schema` | `any` | -| `parentSchema` | [`AnySchemaObject`](verida_web_helpers._internal_.md#anyschemaobject) | -| `it` | [`SchemaCxt`](../interfaces/verida_web_helpers._internal_.SchemaCxt.md) | - -##### Returns - -[`AnySchema`](verida_web_helpers._internal_.md#anyschema) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:105 - -___ - -### Network - -Ƭ **Network**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `chainId` | `number` | -| `ensAddress?` | `string` | -| `name` | `string` | -| `_defaultProvider?` | (`providers`: `any`, `options?`: `any`) => `any` | - -#### Defined in - -node_modules/@ethersproject/networks/lib/types.d.ts:1 - -___ - -### NonNullable - -Ƭ **NonNullable**<`T`\>: `T` extends ``null`` \| `undefined` ? `never` : `T` - -Exclude null and undefined from T - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1521 - -___ - -### NullTypeEquality - -Ƭ **NullTypeEquality**<`T`, `E`\>: [`TypeEquality`](verida_web_helpers._internal_.md#typeequality)<`T` \| ``null``, `E` \| ``null``\> - -type is true if T or null is identically E or null - -#### Type parameters - -| Name | -| :------ | -| `T` | -| `E` | - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/jtd-schema.d.ts:47 - -___ - -### Nullable - -Ƭ **Nullable**<`T`\>: `undefined` extends `T` ? { `const?`: ``null`` ; `default?`: `T` \| ``null`` ; `enum?`: [`Readonly`](verida_web_helpers._internal_.md#readonly)<(`T` \| ``null``)[]\> ; `nullable`: ``true`` } : { `const?`: `T` ; `default?`: `T` ; `enum?`: [`Readonly`](verida_web_helpers._internal_.md#readonly)<`T`[]\> ; `nullable?`: ``false`` } - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/json-schema.d.ts:114 - -___ - -### NumberType - -Ƭ **NumberType**: ``"float32"`` \| ``"float64"`` \| ``"int8"`` \| ``"uint8"`` \| ``"int16"`` \| ``"uint16"`` \| ``"int32"`` \| ``"uint32"`` - -numeric strings - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/jtd-schema.d.ts:2 - -___ - -### Omit - -Ƭ **Omit**<`T`, `K`\>: [`Pick`](verida_web_helpers._internal_.md#pick)<`T`, [`Exclude`](verida_web_helpers._internal_.md#exclude)\> - -Construct a type with the properties of T except for those in type K. - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `T` | -| `K` | extends keyof `any` | - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1516 - -___ - -### OptionalKeys - -Ƭ **OptionalKeys**<`T`\>: { [K in keyof T]-?: undefined extends T[K] ? K : never }[keyof `T`] - -optional or undifined-able keys of an object - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/jtd-schema.d.ts:38 - -___ - -### Options - -Ƭ **Options**: [`CurrentOptions`](../interfaces/verida_web_helpers._internal_.CurrentOptions.md) & [`DeprecatedOptions`](../interfaces/verida_web_helpers._internal_.DeprecatedOptions.md) - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:21 - -___ - -### Partial - -Ƭ **Partial**<`T`\>: { [P in keyof T]?: T[P] } - -Make all properties in T optional - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1471 - -___ - -### Pick - -Ƭ **Pick**<`T`, `K`\>: { [P in K]: T[P] } - -From T, pick a set of properties whose keys are in the union K - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `T` | -| `K` | extends keyof `T` | - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1492 - -___ - -### Readonly - -Ƭ **Readonly**<`T`\>: { readonly [P in keyof T]: T[P] } - -Make all properties in T readonly - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1485 - -___ - -### Record - -Ƭ **Record**<`K`, `T`\>: { [P in K]: T } - -Construct a type with a set of properties K of type T - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof `any` | -| `T` | `T` | - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1499 - -___ - -### RequiredInstanceOptions - -Ƭ **RequiredInstanceOptions**: { [K in "strictSchema" \| "strictNumbers" \| "strictTypes" \| "strictTuples" \| "strictRequired" \| "inlineRefs" \| "loopRequired" \| "loopEnum" \| "meta" \| "messages" \| "schemaId" \| "addUsedSchema" \| "validateSchema" \| "validateFormats" \| "int32range" \| "unicodeRegExp" \| "uriResolver"]: NonNullable } & { `code`: [`InstanceCodeOptions`](../interfaces/verida_web_helpers._internal_.InstanceCodeOptions.md) } - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/core.d.ts:95 - -___ - -### RequiredKeys - -Ƭ **RequiredKeys**<`T`\>: { [K in keyof T]-?: undefined extends T[K] ? never : K }[keyof `T`] - -required keys of an object, not undefined - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/jtd-schema.d.ts:34 - -___ - -### SafeExpr - -Ƭ **SafeExpr**: [`Code`](verida_web_helpers._internal_.md#code) \| `number` \| `boolean` \| ``null`` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/index.d.ts:6 - -___ - -### Schema - -Ƭ **Schema**: [`SchemaObject`](../interfaces/verida_web_helpers._internal_.SchemaObject.md) \| `boolean` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:24 - -___ - -### SchemaRefs - -Ƭ **SchemaRefs**: { [Ref in string]?: SchemaEnv \| AnySchema } - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/index.d.ts:7 - -___ - -### ScopeStore - -Ƭ **ScopeStore**: [`Record`](verida_web_helpers._internal_.md#record)<`string`, [`ValueReference`](verida_web_helpers._internal_.md#valuereference)[] \| `undefined`\> - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/scope.d.ts:21 - -___ - -### ScopeValueSets - -Ƭ **ScopeValueSets**: { [Prefix in string]?: Set } - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/scope.d.ts:25 - -___ - -### ScopeValues - -Ƭ **ScopeValues**: { [Prefix in string]?: Map } - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/scope.d.ts:22 - -___ - -### ServiceEndpoint - -Ƭ **ServiceEndpoint**: `string` \| [`Record`](verida_web_helpers._internal_.md#record)<`string`, `any`\> - -Represents an endpoint of a Service entry in a DID document. - -**`see`** [https://www.w3.org/TR/did-core/#dfn-serviceendpoint](https://www.w3.org/TR/did-core/#dfn-serviceendpoint) - -**`see`** [https://www.w3.org/TR/did-core/#services](https://www.w3.org/TR/did-core/#services) - -#### Defined in - -node_modules/did-resolver/lib/resolver.d.ts:92 - -___ - -### SomeJTDSchemaType - -Ƭ **SomeJTDSchemaType**: { `ref`: `string` } \| { `type`: [`NumberType`](verida_web_helpers._internal_.md#numbertype) \| [`StringType`](verida_web_helpers._internal_.md#stringtype) \| ``"boolean"`` } \| { `enum`: `string`[] } \| { `elements`: [`SomeJTDSchemaType`](verida_web_helpers._internal_.md#somejtdschematype) } \| { `values`: [`SomeJTDSchemaType`](verida_web_helpers._internal_.md#somejtdschematype) } \| { `additionalProperties?`: `boolean` ; `optionalProperties?`: [`Record`](verida_web_helpers._internal_.md#record)<`string`, [`SomeJTDSchemaType`](verida_web_helpers._internal_.md#somejtdschematype)\> ; `properties`: [`Record`](verida_web_helpers._internal_.md#record)<`string`, [`SomeJTDSchemaType`](verida_web_helpers._internal_.md#somejtdschematype)\> } \| { `additionalProperties?`: `boolean` ; `optionalProperties`: [`Record`](verida_web_helpers._internal_.md#record)<`string`, [`SomeJTDSchemaType`](verida_web_helpers._internal_.md#somejtdschematype)\> ; `properties?`: [`Record`](verida_web_helpers._internal_.md#record)<`string`, [`SomeJTDSchemaType`](verida_web_helpers._internal_.md#somejtdschematype)\> } \| { `discriminator`: `string` ; `mapping`: [`Record`](verida_web_helpers._internal_.md#record)<`string`, [`SomeJTDSchemaType`](verida_web_helpers._internal_.md#somejtdschematype)\> } \| {} & { `definitions?`: [`Record`](verida_web_helpers._internal_.md#record)<`string`, [`SomeJTDSchemaType`](verida_web_helpers._internal_.md#somejtdschematype)\> ; `metadata?`: [`Record`](verida_web_helpers._internal_.md#record)<`string`, `unknown`\> ; `nullable?`: `boolean` } - -Generic JTD Schema without inference of the represented type - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/jtd-schema.d.ts:6 - -___ - -### StringType - -Ƭ **StringType**: ``"string"`` \| ``"timestamp"`` - -string strings - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/jtd-schema.d.ts:4 - -___ - -### TransactionRequest - -Ƭ **TransactionRequest**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `accessList?` | [`AccessListish`](verida_web_helpers._internal_.md#accesslistish) | -| `ccipReadEnabled?` | `boolean` | -| `chainId?` | `number` | -| `customData?` | [`Record`](verida_web_helpers._internal_.md#record)<`string`, `any`\> | -| `data?` | [`BytesLike`](verida_web_helpers._internal_.md#byteslike) | -| `from?` | `string` | -| `gasLimit?` | [`BigNumberish`](verida_web_helpers._internal_.md#bignumberish) | -| `gasPrice?` | [`BigNumberish`](verida_web_helpers._internal_.md#bignumberish) | -| `maxFeePerGas?` | [`BigNumberish`](verida_web_helpers._internal_.md#bignumberish) | -| `maxPriorityFeePerGas?` | [`BigNumberish`](verida_web_helpers._internal_.md#bignumberish) | -| `nonce?` | [`BigNumberish`](verida_web_helpers._internal_.md#bignumberish) | -| `to?` | `string` | -| `type?` | `number` | -| `value?` | [`BigNumberish`](verida_web_helpers._internal_.md#bignumberish) | - -#### Defined in - -node_modules/@ethersproject/abstract-provider/lib/index.d.ts:7 - -___ - -### TypeEquality - -Ƭ **TypeEquality**<`T`, `E`\>: [`T`] extends [`E`] ? [`E`] extends [`T`] ? ``true`` : ``false`` : ``false`` - -type is true if T is identically E - -#### Type parameters - -| Name | -| :------ | -| `T` | -| `E` | - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/jtd-schema.d.ts:45 - -___ - -### UncheckedJSONSchemaType - -Ƭ **UncheckedJSONSchemaType**<`T`, `IsPartial`\>: { `anyOf`: readonly [`UncheckedJSONSchemaType`](verida_web_helpers._internal_.md#uncheckedjsonschematype)<`T`, `IsPartial`\>[] } \| { `oneOf`: readonly [`UncheckedJSONSchemaType`](verida_web_helpers._internal_.md#uncheckedjsonschematype)<`T`, `IsPartial`\>[] } \| { `type`: readonly `T` extends `number` ? [`JSONType`](verida_web_helpers._internal_.md#jsontype)<``"number"`` \| ``"integer"``, `IsPartial`\> : `T` extends `string` ? [`JSONType`](verida_web_helpers._internal_.md#jsontype)<``"string"``, `IsPartial`\> : `T` extends `boolean` ? [`JSONType`](verida_web_helpers._internal_.md#jsontype)<``"boolean"``, `IsPartial`\> : `never`[] } & [`UnionToIntersection`](verida_web_helpers._internal_.md#uniontointersection)<`T` extends `number` ? [`NumberKeywords`](../interfaces/verida_web_helpers._internal_.NumberKeywords.md) : `T` extends `string` ? [`StringKeywords`](../interfaces/verida_web_helpers._internal_.StringKeywords.md) : `T` extends `boolean` ? {} : `never`\> \| `T` extends `number` ? { `type`: [`JSONType`](verida_web_helpers._internal_.md#jsontype)<``"number"`` \| ``"integer"``, `IsPartial`\> } & [`NumberKeywords`](../interfaces/verida_web_helpers._internal_.NumberKeywords.md) : `T` extends `string` ? { `type`: [`JSONType`](verida_web_helpers._internal_.md#jsontype)<``"string"``, `IsPartial`\> } & [`StringKeywords`](../interfaces/verida_web_helpers._internal_.StringKeywords.md) : `T` extends `boolean` ? { `type`: [`JSONType`](verida_web_helpers._internal_.md#jsontype)<``"boolean"``, `IsPartial`\> } : `T` extends readonly [`any`, ...any[]] ? { `items`: { readonly [K in keyof T]-?: UncheckedJSONSchemaType & Nullable } & { `length`: `T`[``"length"``] } ; `minItems`: `T`[``"length"``] ; `type`: [`JSONType`](verida_web_helpers._internal_.md#jsontype)<``"array"``, `IsPartial`\> } & { `maxItems`: `T`[``"length"``] } \| { `additionalItems`: ``false`` } : `T` extends readonly `any`[] ? { `additionalItems?`: `never` ; `contains?`: [`UncheckedPartialSchema`](verida_web_helpers._internal_.md#uncheckedpartialschema)<`T`[``0``]\> ; `items`: [`UncheckedJSONSchemaType`](verida_web_helpers._internal_.md#uncheckedjsonschematype)<`T`[``0``], ``false``\> ; `maxContains?`: `number` ; `maxItems?`: `number` ; `minContains?`: `number` ; `minItems?`: `number` ; `type`: [`JSONType`](verida_web_helpers._internal_.md#jsontype)<``"array"``, `IsPartial`\> ; `uniqueItems?`: ``true`` } : `T` extends [`Record`](verida_web_helpers._internal_.md#record)<`string`, `any`\> ? { `additionalProperties?`: `boolean` \| [`UncheckedJSONSchemaType`](verida_web_helpers._internal_.md#uncheckedjsonschematype)<`T`[`string`], ``false``\> ; `dependencies?`: { [K in keyof T]?: Readonly<(keyof T)[]\> \| UncheckedPartialSchema } ; `dependentRequired?`: { [K in keyof T]?: Readonly<(keyof T)[]\> } ; `dependentSchemas?`: { [K in keyof T]?: UncheckedPartialSchema } ; `maxProperties?`: `number` ; `minProperties?`: `number` ; `patternProperties?`: [`Record`](verida_web_helpers._internal_.md#record)<`string`, [`UncheckedJSONSchemaType`](verida_web_helpers._internal_.md#uncheckedjsonschematype)<`T`[`string`], ``false``\>\> ; `properties?`: `IsPartial` extends ``true`` ? [`Partial`](verida_web_helpers._internal_.md#partial)<[`UncheckedPropertiesSchema`](verida_web_helpers._internal_.md#uncheckedpropertiesschema)<`T`\>\> : [`UncheckedPropertiesSchema`](verida_web_helpers._internal_.md#uncheckedpropertiesschema)<`T`\> ; `propertyNames?`: [`Omit`](verida_web_helpers._internal_.md#omit)<[`UncheckedJSONSchemaType`](verida_web_helpers._internal_.md#uncheckedjsonschematype)<`string`, ``false``\>, ``"type"``\> & { `type?`: ``"string"`` } ; `type`: [`JSONType`](verida_web_helpers._internal_.md#jsontype)<``"object"``, `IsPartial`\> ; `unevaluatedProperties?`: `boolean` \| [`UncheckedJSONSchemaType`](verida_web_helpers._internal_.md#uncheckedjsonschematype)<`T`[`string`], ``false``\> } & `IsPartial` extends ``true`` ? { `required`: [`Readonly`](verida_web_helpers._internal_.md#readonly) } : [[`UncheckedRequiredMembers`](verida_web_helpers._internal_.md#uncheckedrequiredmembers)<`T`\>] extends [`never`] ? { `required?`: [`Readonly`](verida_web_helpers._internal_.md#readonly)<[`UncheckedRequiredMembers`](verida_web_helpers._internal_.md#uncheckedrequiredmembers)<`T`\>[]\> } : { `required`: [`Readonly`](verida_web_helpers._internal_.md#readonly)<[`UncheckedRequiredMembers`](verida_web_helpers._internal_.md#uncheckedrequiredmembers)<`T`\>[]\> } : `T` extends ``null`` ? { `nullable`: ``true`` ; `type`: [`JSONType`](verida_web_helpers._internal_.md#jsontype)<``"null"``, `IsPartial`\> } : `never` & { `allOf?`: [`Readonly`](verida_web_helpers._internal_.md#readonly)<[`UncheckedPartialSchema`](verida_web_helpers._internal_.md#uncheckedpartialschema)<`T`\>[]\> ; `anyOf?`: [`Readonly`](verida_web_helpers._internal_.md#readonly)<[`UncheckedPartialSchema`](verida_web_helpers._internal_.md#uncheckedpartialschema)<`T`\>[]\> ; `else?`: [`UncheckedPartialSchema`](verida_web_helpers._internal_.md#uncheckedpartialschema)<`T`\> ; `if?`: [`UncheckedPartialSchema`](verida_web_helpers._internal_.md#uncheckedpartialschema)<`T`\> ; `not?`: [`UncheckedPartialSchema`](verida_web_helpers._internal_.md#uncheckedpartialschema)<`T`\> ; `oneOf?`: [`Readonly`](verida_web_helpers._internal_.md#readonly)<[`UncheckedPartialSchema`](verida_web_helpers._internal_.md#uncheckedpartialschema)<`T`\>[]\> ; `then?`: [`UncheckedPartialSchema`](verida_web_helpers._internal_.md#uncheckedpartialschema)<`T`\> } & { `[keyword: string]`: `any`; `$defs?`: [`Record`](verida_web_helpers._internal_.md#record)<`string`, [`UncheckedJSONSchemaType`](verida_web_helpers._internal_.md#uncheckedjsonschematype)<[`Known`](verida_web_helpers._internal_.md#known), ``true``\>\> ; `$id?`: `string` ; `$ref?`: `string` ; `definitions?`: [`Record`](verida_web_helpers._internal_.md#record)<`string`, [`UncheckedJSONSchemaType`](verida_web_helpers._internal_.md#uncheckedjsonschematype)<[`Known`](verida_web_helpers._internal_.md#known), ``true``\>\> } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `T` | -| `IsPartial` | extends `boolean` | - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/json-schema.d.ts:21 - -___ - -### UncheckedPartialSchema - -Ƭ **UncheckedPartialSchema**<`T`\>: [`Partial`](verida_web_helpers._internal_.md#partial)<[`UncheckedJSONSchemaType`](verida_web_helpers._internal_.md#uncheckedjsonschematype)<`T`, ``true``\>\> - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/json-schema.d.ts:4 - -___ - -### UncheckedPropertiesSchema - -Ƭ **UncheckedPropertiesSchema**<`T`\>: { [K in keyof T]-?: UncheckedJSONSchemaType & Nullable \| Object } - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/json-schema.d.ts:104 - -___ - -### UncheckedRequiredMembers - -Ƭ **UncheckedRequiredMembers**<`T`\>: { [K in keyof T]-?: undefined extends T[K] ? never : K }[keyof `T`] - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/json-schema.d.ts:110 - -___ - -### UnionToIntersection - -Ƭ **UnionToIntersection**<`U`\>: `U` extends `any` ? (`_`: `U`) => `void` : `never` extends (`_`: infer I) => `void` ? `I` : `never` - -#### Type parameters - -| Name | -| :------ | -| `U` | - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/json-schema.d.ts:2 - -___ - -### UsedNames - -Ƭ **UsedNames**: [`Record`](verida_web_helpers._internal_.md#record)<`string`, `number` \| `undefined`\> - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/code.d.ts:26 - -___ - -### UsedScopeValues - -Ƭ **UsedScopeValues**: { [Prefix in string]?: Map } - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/scope.d.ts:32 - -___ - -### ValidationTypes - -Ƭ **ValidationTypes**: { [K in JSONType]: boolean \| RuleGroup \| undefined } - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/rules.d.ts:5 - -___ - -### ValueReference - -Ƭ **ValueReference**: `unknown` - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/codegen/scope.d.ts:11 - -___ - -### VdaDidEndpointResponses - -Ƭ **VdaDidEndpointResponses**: [`Record`](verida_web_helpers._internal_.md#record)<`string`, [`VdaDidEndpointResponse`](../interfaces/verida_web_helpers._internal_.VdaDidEndpointResponse.md)\> - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:113 - -___ - -### Vocabulary - -Ƭ **Vocabulary**: ([`KeywordDefinition`](verida_web_helpers._internal_.md#keyworddefinition) \| `string`)[] - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/types/index.d.ts:136 - -___ - -### Web3CallType - -Ƭ **Web3CallType**: ``"web3"`` \| ``"gasless"`` - -Web3 SDK running mode - -#### Defined in - -packages/types/dist/Web3Interfaces.d.ts:5 - -## Variables - -### Error - -• **Error**: `ErrorConstructor` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:984 - -___ - -### EventEmitter - -• `Const` **EventEmitter**: `any` - -#### Defined in - -packages/client-ts/dist/context/profiles/profile.d.ts:2 - -___ - -### Number - -• **Number**: `NumberConstructor` - -An object that represents a number of any kind. All JavaScript numbers are 64-bit floating-point numbers. - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:602 - -___ - -### \_jsonTypes - -• `Const` **\_jsonTypes**: readonly [``"string"``, ``"number"``, ``"integer"``, ``"boolean"``, ``"null"``, ``"object"``, ``"array"``] - -#### Defined in - -packages/client-ts/node_modules/ajv/dist/compile/rules.d.ts:2 diff --git a/docs/api/verida-js/modules/verida_web_helpers.md b/docs/api/verida-js/modules/verida_web_helpers.md deleted file mode 100644 index a83231d..0000000 --- a/docs/api/verida-js/modules/verida_web_helpers.md +++ /dev/null @@ -1,39 +0,0 @@ -[root](../README.md) / [Modules](../modules.md) / @verida/web-helpers - -# Module: @verida/web-helpers - -## Table of contents - -### Namespaces - -- [<internal\>](verida_web_helpers._internal_.md) - -### Interfaces - -- [WebUserConfig](../interfaces/verida_web_helpers.WebUserConfig.md) -- [WebUserMessage](../interfaces/verida_web_helpers.WebUserMessage.md) -- [WebUserMessageLink](../interfaces/verida_web_helpers.WebUserMessageLink.md) -- [WebUserProfile](../interfaces/verida_web_helpers.WebUserProfile.md) - -### Events - -- [WebUser](verida_web_helpers.md#webuser) - -## Events - -### WebUser - -• **WebUser**: `Object` - -Usage: - -1. Create a new instance of this class with the required configuration. -2. Check if the user is logged in with this.isConnected() -3. Log the user in with this.connect() -4. Listen to when the user has logged in with this.on('connected') -5. Listen to when the user updates their profile with this.on('profileUpdated') -5. Listen to when the user logs out with this.on('disconnected') - -#### Defined in - -[packages/web-helpers/src/WebUser.ts:48](https://github.com/verida/verida-js/blob/5040472/packages/web-helpers/src/WebUser.ts#L48) diff --git a/package.json b/package.json index 117d085..9795b6b 100644 --- a/package.json +++ b/package.json @@ -11,8 +11,7 @@ "clear": "docusaurus clear", "serve": "NODE_OPTIONS=--max-old-space-size=8192 docusaurus serve", "write-translations": "docusaurus write-translations", - "write-heading-ids": "docusaurus write-heading-ids", - "update-api-docs": "./update-api-docs.sh" + "write-heading-ids": "docusaurus write-heading-ids" }, "dependencies": { "@cmfcmf/docusaurus-search-local": "^1.1.0", diff --git a/src/pages/index.js b/src/pages/index.js index 2149b32..b3cad5b 100644 --- a/src/pages/index.js +++ b/src/pages/index.js @@ -12,7 +12,6 @@ import PartnerShipCard from "../components/cards/PartnershipCard"; import GithubCard from "../components/cards/GithubCard"; import Footer from "../components/Footer"; import ReadDocsIcon from "@site/static/img/read_docs.svg"; -import ExploreAPiICon from "@site/static/img/explore_api.svg"; import IntTutorialIcon from "@site/static/img/interactive_tutorial.svg"; import DemosIcon from "@site/static/img/demos.svg"; import { @@ -25,27 +24,27 @@ import { const CONTENT_CARD_LIST = [ { title: "Read the Documentation", - icon: , + icon: , link: "/docs/intro", externalLink: false, }, - { - title: "See API Documentation", - icon: , - link: "/docs/api/verida-js/", - externalLink: true, - }, + // { + // title: "API Docs", + // icon: , + // link: "", + // externalLink: true, + // }, { title: "Interactive Tutorial", description: `Check out the interactive tutorials for an introduction to Verida's Web3 APIs`, - icon: , + icon: , link: "/docs/tutorial/introduction", externalLink: false, }, { title: "Demos", description: "Explore Verida technologies with demo applications", - icon: , + icon: , link: "/docs/extras/demos", externalLink: false, }, diff --git a/src/pages/index.module.css b/src/pages/index.module.css index 122f1e3..fa8d129 100644 --- a/src/pages/index.module.css +++ b/src/pages/index.module.css @@ -64,7 +64,7 @@ .contentCard { display: grid; - grid-template-columns: 1fr 1fr 1fr 1fr; + grid-template-columns: 1fr 1fr 1fr; } .githubCardSection {